/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.tuscany.sca.assembly.xml;
import static javax.xml.XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI;
import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.dom.DOMSource;
import org.apache.tuscany.sca.assembly.AbstractContract;
import org.apache.tuscany.sca.assembly.AbstractProperty;
import org.apache.tuscany.sca.assembly.AbstractReference;
import org.apache.tuscany.sca.assembly.AssemblyFactory;
import org.apache.tuscany.sca.assembly.Base;
import org.apache.tuscany.sca.assembly.Binding;
import org.apache.tuscany.sca.assembly.ComponentService;
import org.apache.tuscany.sca.assembly.ComponentType;
import org.apache.tuscany.sca.assembly.ConfiguredOperation;
import org.apache.tuscany.sca.assembly.ConstrainingType;
import org.apache.tuscany.sca.assembly.Contract;
import org.apache.tuscany.sca.assembly.Implementation;
import org.apache.tuscany.sca.assembly.Multiplicity;
import org.apache.tuscany.sca.assembly.OperationsConfigurator;
import org.apache.tuscany.sca.assembly.Reference;
import org.apache.tuscany.sca.assembly.Service;
import org.apache.tuscany.sca.contribution.ContributionFactory;
import org.apache.tuscany.sca.contribution.processor.BaseStAXArtifactProcessor;
import org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor;
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
import org.apache.tuscany.sca.contribution.service.ContributionReadException;
import org.apache.tuscany.sca.contribution.service.ContributionResolveException;
import org.apache.tuscany.sca.interfacedef.InterfaceContract;
import org.apache.tuscany.sca.policy.Intent;
import org.apache.tuscany.sca.policy.IntentAttachPoint;
import org.apache.tuscany.sca.policy.IntentAttachPointType;
import org.apache.tuscany.sca.policy.PolicyFactory;
import org.apache.tuscany.sca.policy.PolicySet;
import org.apache.tuscany.sca.policy.PolicySetAttachPoint;
import org.apache.tuscany.sca.policy.util.PolicyValidationUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* A base class with utility methods for the other artifact processors in this module.
*
* @version $Rev: 602988 $ $Date: 2007-12-10 18:34:08 +0000 (Mon, 10 Dec 2007) $
*/
abstract class BaseAssemblyProcessor extends BaseStAXArtifactProcessor implements Constants {
protected ContributionFactory contributionFactory;
protected AssemblyFactory assemblyFactory;
protected PolicyFactory policyFactory;
protected StAXArtifactProcessor<Object> extensionProcessor;
protected PolicyAttachPointProcessor policyProcessor;
private DocumentBuilderFactory documentBuilderFactory;
/**
* Construcst a new BaseArtifactProcessor.
* @param contribFactory
* @param factory
* @param policyFactory
*/
@SuppressWarnings("unchecked")
public BaseAssemblyProcessor(ContributionFactory contribFactory,
AssemblyFactory factory,
PolicyFactory policyFactory,
StAXArtifactProcessor extensionProcessor) {
this.assemblyFactory = factory;
this.policyFactory = policyFactory;
this.extensionProcessor = (StAXArtifactProcessor<Object>)extensionProcessor;
this.contributionFactory = contribFactory;
this.policyProcessor = new PolicyAttachPointProcessor(policyFactory);
}
/**
* Construcst a new BaseArtifactProcessor.
* @param factory
* @param policyFactory
*/
@SuppressWarnings("unchecked")
public BaseAssemblyProcessor(AssemblyFactory factory,
PolicyFactory policyFactory,
StAXArtifactProcessor extensionProcessor) {
this.assemblyFactory = factory;
this.policyFactory = policyFactory;
this.extensionProcessor = (StAXArtifactProcessor<Object>)extensionProcessor;
this.policyProcessor = new PolicyAttachPointProcessor(policyFactory);
}
/**
* Start an element.
* @param writer
* @param name
* @param attrs
* @throws XMLStreamException
*/
protected void writeStart(XMLStreamWriter writer, String name, XAttr... attrs) throws XMLStreamException {
writeStart(writer, SCA10_NS, name, attrs);
}
/**
* Start a document.
* @param writer
* @throws XMLStreamException
*/
protected void writeStartDocument(XMLStreamWriter writer, String name, XAttr... attrs) throws XMLStreamException {
writer.writeStartDocument();
writer.setDefaultNamespace(SCA10_NS);
writeStart(writer, SCA10_NS, name, attrs);
writer.writeDefaultNamespace(SCA10_NS);
}
/**
* Read list of reference targets
* @param reference
* @param reader
*/
protected void readTargets(Reference reference, XMLStreamReader reader) {
String value = reader.getAttributeValue(null, TARGET);
ComponentService target = null;
if (value != null) {
for (StringTokenizer tokens = new StringTokenizer(value); tokens.hasMoreTokens();) {
target = assemblyFactory.createComponentService();
target.setUnresolved(true);
target.setName(tokens.nextToken());
reference.getTargets().add(target);
}
}
}
/**
* Write a list of targets into an attribute
* @param reference
* @return
*/
protected XAttr writeTargets(Reference reference) {
List<String> targets = new ArrayList<String>();
for (Service target : reference.getTargets()) {
targets.add(target.getName());
}
return new XAttr(TARGET, targets);
}
/**
* Read a multiplicity attribute.
* @param reference
* @param reader
*/
protected void readMultiplicity(AbstractReference reference, XMLStreamReader reader) {
String value = reader.getAttributeValue(null, MULTIPLICITY);
if (ZERO_ONE.equals(value)) {
reference.setMultiplicity(Multiplicity.ZERO_ONE);
} else if (ONE_N.equals(value)) {
reference.setMultiplicity(Multiplicity.ONE_N);
} else if (ZERO_N.equals(value)) {
reference.setMultiplicity(Multiplicity.ZERO_N);
}
}
/**
* Returns the value of a constrainingType attribute.
* @param reader
* @return
*/
protected ConstrainingType readConstrainingType(XMLStreamReader reader) {
QName constrainingTypeName = getQName(reader, Constants.CONSTRAINING_TYPE);
if (constrainingTypeName != null) {
ConstrainingType constrainingType = assemblyFactory.createConstrainingType();
constrainingType.setName(constrainingTypeName);
constrainingType.setUnresolved(true);
return constrainingType;
} else {
return null;
}
}
/**
* Reads an abstract property element.
* @param property
* @param reader
* @throws XMLStreamException
* @throws ContributionReadException
*/
protected void readAbstractProperty(AbstractProperty property, XMLStreamReader reader) throws XMLStreamException,
ContributionReadException {
property.setName(getString(reader, NAME));
property.setMany(getBoolean(reader, MANY));
property.setMustSupply(getBoolean(reader, MUST_SUPPLY));
property.setXSDElement(getQName(reader, ELEMENT));
property.setXSDType(getQName(reader, TYPE));
}
/**
* Resolve an implementation.
* @param implementation
* @param resolver
* @return
* @throws ContributionResolveException
*/
protected Implementation resolveImplementation(Implementation implementation, ModelResolver resolver)
throws ContributionResolveException {
if (implementation != null) {
if (implementation.isUnresolved()) {
implementation = resolver.resolveModel(Implementation.class, implementation);
// Lazily resolve implementations
if (implementation.isUnresolved()) {
extensionProcessor.resolve(implementation, resolver);
if (!implementation.isUnresolved()) {
resolver.addModel(implementation);
}
}
}
}
return implementation;
}
/**
* Resolve interface, callback interface and bindings on a list of contracts.
* @param contracts the list of contracts
* @param resolver the resolver to use to resolve models
*/
protected <C extends Contract> void resolveContracts(List<C> contracts, ModelResolver resolver)
throws ContributionResolveException {
resolveContracts(null, contracts, resolver);
}
/**
* Resolve interface, callback interface and bindings on a list of contracts.
* @param parent element for the contracts
* @param contracts the list of contracts
* @param resolver the resolver to use to resolve models
*/
protected <C extends Contract> void resolveContracts(Base parent, List<C> contracts, ModelResolver resolver)
throws ContributionResolveException {
for (Contract contract : contracts) {
//resolve the intents and policysets as they need to be copied over into the
//child binding elements
resolveIntents(contract.getRequiredIntents(), resolver);
resolvePolicySets(contract.getPolicySets(), resolver);
//inherit the composite / component level policy intents and policysets
if ( parent != null && parent instanceof PolicySetAttachPoint ) {
addInheritedIntents(((PolicySetAttachPoint)parent).getRequiredIntents(), contract.getRequiredIntents());
addInheritedPolicySets(((PolicySetAttachPoint)parent).getPolicySets(), contract.getPolicySets());
}
for ( ConfiguredOperation confOp : contract.getConfiguredOperations() ) {
resolveIntents(confOp.getRequiredIntents(), resolver);
resolvePolicySets(confOp.getPolicySets(), resolver);
}
// Resolve the interface contract
InterfaceContract interfaceContract = contract.getInterfaceContract();
if (interfaceContract != null) {
extensionProcessor.resolve(interfaceContract, resolver);
}
// Resolve bindings
for (int i = 0, n = contract.getBindings().size(); i < n; i++) {
Binding binding = contract.getBindings().get(i);
extensionProcessor.resolve(binding, resolver);
if (binding instanceof IntentAttachPoint) {
IntentAttachPoint policiedBinding = (IntentAttachPoint)binding;
resolveIntents(policiedBinding.getRequiredIntents(), resolver);
}
if (binding instanceof PolicySetAttachPoint) {
PolicySetAttachPoint policiedBinding = (PolicySetAttachPoint)binding;
resolvePolicySets(policiedBinding.getPolicySets(), resolver);
//validate if attached policysets apply to the binding
validatePolicySets(contract, policiedBinding);
}
if (binding instanceof OperationsConfigurator) {
OperationsConfigurator opConfigurator = (OperationsConfigurator)binding;
for (ConfiguredOperation confOp : opConfigurator.getConfiguredOperations()) {
resolveIntents(confOp.getRequiredIntents(), resolver);
resolvePolicySets(confOp.getPolicySets(), resolver);
}
}
}
// Resolve callback bindings
if (contract.getCallback() != null) {
resolveIntents(contract.getCallback().getRequiredIntents(), resolver);
resolvePolicySets(contract.getCallback().getPolicySets(), resolver);
//inherit the contract's policy intents and policysets
addInheritedIntents(contract.getRequiredIntents(), contract.getCallback().getRequiredIntents());
addInheritedPolicySets(contract.getPolicySets(), contract.getCallback().getPolicySets());
for (int i = 0, n = contract.getCallback().getBindings().size(); i < n; i++) {
Binding binding = contract.getCallback().getBindings().get(i);
extensionProcessor.resolve(binding, resolver);
if (binding instanceof IntentAttachPoint) {
IntentAttachPoint policiedBinding = (IntentAttachPoint)binding;
resolveIntents(policiedBinding.getRequiredIntents(), resolver);
}
if (binding instanceof PolicySetAttachPoint) {
PolicySetAttachPoint policiedBinding = (PolicySetAttachPoint)binding;
resolvePolicySets(policiedBinding.getPolicySets(), resolver);
validatePolicySets(contract.getCallback(), policiedBinding);
}
if (binding instanceof OperationsConfigurator) {
OperationsConfigurator opConfigurator = (OperationsConfigurator)binding;
for (ConfiguredOperation confOp : opConfigurator.getConfiguredOperations()) {
resolveIntents(confOp.getRequiredIntents(), resolver);
resolvePolicySets(confOp.getPolicySets(), resolver);
}
}
}
}
}
}
/**
* Resolve interface and callback interface on a list of abstract contracts.
* @param contracts the list of contracts
* @param resolver the resolver to use to resolve models
*/
protected <C extends AbstractContract> void resolveAbstractContracts(List<C> contracts, ModelResolver resolver)
throws ContributionResolveException {
for (AbstractContract contract : contracts) {
// Resolve the interface contract
InterfaceContract interfaceContract = contract.getInterfaceContract();
if (interfaceContract != null) {
extensionProcessor.resolve(interfaceContract, resolver);
}
}
}
/**
* Returns a constrainingType attribute.
* @param componentType
* @return
*/
protected XAttr writeConstrainingType(ComponentType componentType) {
ConstrainingType constrainingType = componentType.getConstrainingType();
if (constrainingType != null)
return new XAttr(Constants.CONSTRAINING_TYPE, constrainingType.getName());
else
return null;
}
/**
* Read a property value into a DOM document.
* @param element
* @param type
* @param reader
* @return
* @throws XMLStreamException
* @throws ContributionReadException
* @throws ParserConfigurationException
*/
protected Document readPropertyValue(QName element, QName type, XMLStreamReader reader) throws XMLStreamException,
ContributionReadException {
Document document;
try {
if (documentBuilderFactory == null) {
documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
}
document = documentBuilderFactory.newDocumentBuilder().newDocument();
} catch (ParserConfigurationException e) {
throw new ContributionReadException(e);
}
// root element has no namespace and local name "value"
Element root = document.createElementNS(null, "value");
if (type != null) {
org.w3c.dom.Attr xsi = document.createAttributeNS(XMLNS_ATTRIBUTE_NS_URI, "xmlns:xsi");
xsi.setValue(W3C_XML_SCHEMA_INSTANCE_NS_URI);
root.setAttributeNodeNS(xsi);
String prefix = type.getPrefix();
if (prefix == null || prefix.length() == 0) {
prefix = "ns";
}
declareNamespace(root, prefix, type.getNamespaceURI());
org.w3c.dom.Attr xsiType = document.createAttributeNS(W3C_XML_SCHEMA_INSTANCE_NS_URI, "xsi:type");
xsiType.setValue(prefix + ":" + type.getLocalPart());
root.setAttributeNodeNS(xsiType);
}
document.appendChild(root);
loadElement(reader, root);
return document;
}
/**
* Create a DOM element
* @param document
* @param name
* @return
*/
private Element createElement(Document document, QName name) {
String prefix = name.getPrefix();
String qname =
(prefix != null && prefix.length() > 0) ? prefix + ":" + name.getLocalPart() : name.getLocalPart();
return document.createElementNS(name.getNamespaceURI(), qname);
}
/**
* Declare a namespace.
* @param element
* @param prefix
* @param ns
*/
private void declareNamespace(Element element, String prefix, String ns) {
if (ns == null) {
ns = "";
}
if (prefix == null) {
prefix = "";
}
String qname = null;
if ("".equals(prefix)) {
qname = "xmlns";
} else {
qname = "xmlns:" + prefix;
}
Node node = element;
boolean declared = false;
while (node != null && node.getNodeType() == Node.ELEMENT_NODE) {
NamedNodeMap attrs = node.getAttributes();
if (attrs == null) {
break;
}
Node attr = attrs.getNamedItem(qname);
if (attr != null) {
declared = ns.equals(attr.getNodeValue());
break;
}
node = node.getParentNode();
}
if (!declared) {
org.w3c.dom.Attr attr = element.getOwnerDocument().createAttributeNS(XMLNS_ATTRIBUTE_NS_URI, qname);
attr.setValue(ns);
element.setAttributeNodeNS(attr);
}
}
/**
* Load a property value specification from an StAX stream into a DOM
* Document. Only elements, text and attributes are processed; all comments
* and other whitespace are ignored.
*
* @param reader the stream to read from
* @param root the DOM node to load
* @throws javax.xml.stream.XMLStreamException
*/
private void loadElement(XMLStreamReader reader, Element root) throws XMLStreamException {
Document document = root.getOwnerDocument();
Node current = root;
while (true) {
switch (reader.next()) {
case XMLStreamConstants.START_ELEMENT:
QName name = reader.getName();
Element child = createElement(document, name);
// push the new element and make it the current one
current.appendChild(child);
current = child;
int count = reader.getNamespaceCount();
for (int i = 0; i < count; i++) {
String prefix = reader.getNamespacePrefix(i);
String ns = reader.getNamespaceURI(i);
declareNamespace(child, prefix, ns);
}
if (!"".equals(name.getNamespaceURI())) {
declareNamespace(child, name.getPrefix(), name.getNamespaceURI());
}
// add the attributes for this element
count = reader.getAttributeCount();
for (int i = 0; i < count; i++) {
String ns = reader.getAttributeNamespace(i);
String prefix = reader.getAttributePrefix(i);
String qname = reader.getAttributeLocalName(i);
String value = reader.getAttributeValue(i);
if (prefix != null && prefix.length() != 0) {
qname = prefix + ":" + qname;
}
child.setAttributeNS(ns, qname, value);
if (ns != null) {
declareNamespace(child, prefix, ns);
}
}
break;
case XMLStreamConstants.CDATA:
current.appendChild(document.createCDATASection(reader.getText()));
break;
case XMLStreamConstants.CHARACTERS:
current.appendChild(document.createTextNode(reader.getText()));
break;
case XMLStreamConstants.END_ELEMENT:
// if we are back at the root then we are done
if (current == root) {
return;
}
// pop the element off the stack
current = current.getParentNode();
}
}
}
/**
* Resolve policy intents attached to a specific SCA Artifact
* @param policyIntents list of policy intents
* @param resolver
*/
protected void resolveIntents(List<Intent> policyIntents, ModelResolver resolver) {
List<Intent> requiredIntents = new ArrayList<Intent>();
Intent resolvedIntent = null;
for (Intent intent : policyIntents) {
resolvedIntent = resolver.resolveModel(Intent.class, intent);
requiredIntents.add(resolvedIntent);
}
policyIntents.clear();
policyIntents.addAll(requiredIntents);
}
/**
* Resolve policy sets attached to a specific SCA Construct
* @param policySets list of attached policy sets
* @param resolver
*/
protected void resolvePolicySets(List<PolicySet> policySets, ModelResolver resolver) {
List<PolicySet> resolvedPolicySets = new ArrayList<PolicySet>();
PolicySet resolvedPolicySet = null;
for (PolicySet policySet : policySets) {
resolvedPolicySet = resolver.resolveModel(PolicySet.class, policySet);
resolvedPolicySets.add(resolvedPolicySet);
}
policySets.clear();
policySets.addAll(resolvedPolicySets);
}
/**
* Write the value of a property
* @param document
* @param element
* @param type
* @param writer
* @throws XMLStreamException
*/
protected void writePropertyValue(Object propertyValue, QName element, QName type, XMLStreamWriter writer)
throws XMLStreamException {
if (propertyValue instanceof Document) {
Document document = (Document)propertyValue;
NodeList nodeList = document.getDocumentElement().getChildNodes();
for (int item = 0; item < nodeList.getLength(); ++item) {
if (nodeList.item(item).getNodeType() == Node.ELEMENT_NODE) {
XMLStreamReader reader =
XMLInputFactory.newInstance().createXMLStreamReader(new DOMSource(nodeList.item(item)));
while (reader.hasNext()) {
switch (reader.next()) {
case XMLStreamConstants.START_ELEMENT:
QName name = reader.getName();
writer.writeStartElement(name.getPrefix(), name.getLocalPart(), name.getNamespaceURI());
int namespaces = reader.getNamespaceCount();
for (int i = 0; i < namespaces; i++) {
String prefix = reader.getNamespacePrefix(i);
String ns = reader.getNamespaceURI(i);
writer.writeNamespace(prefix, ns);
}
if (!"".equals(name.getNamespaceURI())) {
writer.writeNamespace(name.getPrefix(), name.getNamespaceURI());
}
// add the attributes for this element
namespaces = reader.getAttributeCount();
for (int i = 0; i < namespaces; i++) {
String ns = reader.getAttributeNamespace(i);
String prefix = reader.getAttributePrefix(i);
String qname = reader.getAttributeLocalName(i);
String value = reader.getAttributeValue(i);
writer.writeAttribute(prefix, ns, qname, value);
}
break;
case XMLStreamConstants.CDATA:
writer.writeCData(reader.getText());
break;
case XMLStreamConstants.CHARACTERS:
writer.writeCharacters(reader.getText());
break;
case XMLStreamConstants.END_ELEMENT:
writer.writeEndElement();
break;
}
}
}
}
}
}
protected void addInheritedIntents(List<Intent> sourceList, List<Intent> targetList) {
if (sourceList != null) {
targetList.addAll(sourceList);
}
}
protected void addInheritedPolicySets(List<PolicySet> sourceList, List<PolicySet> targetList) {
if (sourceList != null) {
targetList.addAll(sourceList);
}
}
protected void validatePolicySets(Base parent, PolicySetAttachPoint policySetAttachPoint) throws ContributionResolveException {
String appliesTo = null;
IntentAttachPointType attachPointType = policySetAttachPoint.getType();
String scdlFragment = ""; //need to write the 'parent' as scdl xml string
if ( attachPointType != null ) {
//validate policysets specified for the attachPoint
for (PolicySet policySet : policySetAttachPoint.getPolicySets()) {
appliesTo = policySet.getAppliesTo();
if ( !policySet.isUnresolved() ) {
if (!PolicyValidationUtils.isPolicySetApplicable(scdlFragment, appliesTo, attachPointType)) {
throw new ContributionResolveException("Policy Set '" + policySet.getName()
+ "' does not apply to binding type "
+ attachPointType.getName());
} }
else {
throw new ContributionResolveException("Policy Set '" + policySet.getName()
+ "' is not defined in this domain ");
}
}
}
}
}