CallMediatorFactory.java
/*
* 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.synapse.config.xml;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMAttribute;
import org.apache.axiom.om.OMElement;
import org.apache.commons.lang.StringUtils;
import org.apache.synapse.Mediator;
import org.apache.synapse.config.xml.endpoints.EndpointFactory;
import org.apache.synapse.endpoints.Endpoint;
import org.apache.synapse.mediators.builtin.CallMediator;
import org.apache.synapse.mediators.elementary.EnrichMediator;
import org.apache.synapse.mediators.elementary.Source;
import org.apache.synapse.mediators.elementary.Target;
import org.apache.synapse.util.CallMediatorEnrichUtil;
import org.jaxen.JaxenException;
import javax.xml.namespace.QName;
import java.io.File;
import java.util.Properties;
/**
* Factory for {@link org.apache.synapse.mediators.builtin.CallMediator} instances.
* <p>
* The <call> element is used to send messages out of Synapse to some endpoint. In the simplest case,
* the place to send the message to is implicit in the message (via a property of the message itself)-
* that is indicated by the following:
* <pre>
* <call/>
* </pre>
*
* If the message is to be sent to a endpoint, then the following is used:
* <pre>
* <call>
* (endpointref | endpoint)
* </call>
* </pre>
* where the endpointref token refers to the following:
* <pre>
* <endpoint ref="name"/>
* </pre>
* and the endpoint token refers to an anonymous endpoint defined inline:
* <pre>
* <endpoint address="url"/>
* </pre>
* If the message is to be sent to an endpoint selected by load balancing across a set of endpoints,
* then it is indicated by the following:
* <pre>
* <call>
* <load-balance algorithm="uri">
* (endpointref | endpoint)+
* </load-balance>
* </call>
* </pre>
* Similarly, if the message is to be sent to an endpoint with failover semantics, then it is indicated by the following:
* <pre>
* <call>
* <failover>
* (endpointref | endpoint)+
* </failover>
* </call>
* </pre>
*/
public class CallMediatorFactory extends AbstractMediatorFactory {
private static final QName CALL_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "call");
private static final QName ENDPOINT_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "endpoint");
private static final QName BLOCKING_Q = new QName("blocking");
private static final QName ATT_INIT_AXIS2_CLIENT_OPTIONS = new QName("initAxis2ClientOptions");
private static final QName ATT_AXIS2XML = new QName("axis2xml");
private static final QName ATT_REPOSITORY = new QName("repository");
public static final QName SOURCE_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "source");
public static final QName TARGET_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "target");
private static final QName ATT_TYPE = new QName("type");
private static final QName CONTENT_TYPE = new QName("contentType");
public Mediator createSpecificMediator(OMElement elem, Properties properties) {
CallMediator callMediator = new CallMediator();
// after successfully creating the mediator
// set its common attributes such as tracing etc
processAuditStatus(callMediator, elem);
OMElement sourceEle = elem.getFirstChildWithName(SOURCE_Q);
if (sourceEle != null) {
Source source = new Source();
populateSource(callMediator, source, sourceEle);
callMediator.setSourceForOutboundPayload(source);
}
OMElement targetEle = elem.getFirstChildWithName(TARGET_Q);
if (targetEle != null) {
if (sourceEle == null) {
Source source = CallMediatorEnrichUtil.createSourceWithBody();
callMediator.setSourceAvailable(true);
callMediator.setSourceForOutboundPayload(source);
}
Target target = new Target();
populateTarget(callMediator, target, targetEle);
callMediator.setTargetForInboundPayload(target);
}
OMElement epElement = elem.getFirstChildWithName(ENDPOINT_Q);
if (epElement != null) {
// create the endpoint and set it in the call mediator
Endpoint endpoint = EndpointFactory.getEndpointFromElement(epElement, true, properties);
if (endpoint != null) {
callMediator.setEndpoint(endpoint);
}
}
OMAttribute blockingAtt = elem.getAttribute(BLOCKING_Q);
if (blockingAtt != null) {
callMediator.setBlocking(Boolean.parseBoolean(blockingAtt.getAttributeValue()));
if (callMediator.isBlocking()) {
OMAttribute initAxis2ClientOptions = elem.getAttribute(ATT_INIT_AXIS2_CLIENT_OPTIONS);
OMAttribute axis2xmlAttr = elem.getAttribute(ATT_AXIS2XML);
OMAttribute repoAttr = elem.getAttribute(ATT_REPOSITORY);
if (initAxis2ClientOptions != null) {
callMediator.setInitClientOptions(Boolean.parseBoolean(initAxis2ClientOptions.getAttributeValue()));
}
if (axis2xmlAttr != null && axis2xmlAttr.getAttributeValue() != null) {
File axis2xml = new File(axis2xmlAttr.getAttributeValue());
if (axis2xml.exists() && axis2xml.isFile()) {
callMediator.setAxis2xml(axis2xmlAttr.getAttributeValue());
} else {
handleException("Invalid axis2.xml path: " + axis2xmlAttr.getAttributeValue());
}
}
if (repoAttr != null && repoAttr.getAttributeValue() != null) {
File repo = new File(repoAttr.getAttributeValue());
if (repo.exists() && repo.isDirectory()) {
callMediator.setClientRepository(repoAttr.getAttributeValue());
} else {
handleException("Invalid repository path: " + repoAttr.getAttributeValue());
}
}
}
}
addAllCommentChildrenToList(elem, callMediator.getCommentsList());
return callMediator;
}
private void populateSource(CallMediator callMediator, Source source, OMElement sourceEle) {
OMAttribute typeAttr = sourceEle.getAttribute(ATT_TYPE);
if (typeAttr != null && typeAttr.getAttributeValue() != null) {
source.setSourceType(CallMediatorEnrichUtil.convertTypeToInt(typeAttr.getAttributeValue()));
}
OMAttribute contentTypeAtt = sourceEle.getAttribute(CONTENT_TYPE);
if (contentTypeAtt != null && contentTypeAtt.getAttributeValue() != null) {
callMediator.setSourceMessageType(contentTypeAtt.getAttributeValue());
}
source.setClone(false);
if (source.getSourceType() == EnrichMediator.CUSTOM) {
String xpathExpressionElement = sourceEle.getText();
if (xpathExpressionElement != null) {
try {
source.setXpath(SynapsePathFactory.getSynapsePathfromExpression(sourceEle, xpathExpressionElement));
callMediator.setSourceAvailable(true);
} catch (JaxenException e) {
handleException("Invalid XPath expression: " + xpathExpressionElement);
}
} else {
handleException("Xpath attribute is required for CUSTOM type");
}
} else if (source.getSourceType() == EnrichMediator.PROPERTY) {
String propertyValue = sourceEle.getText();
if (propertyValue != null) {
source.setProperty(propertyValue);
callMediator.setSourceAvailable(true);
} else {
handleException("Property value is required for PROPERTY type");
}
} else if (source.getSourceType() == EnrichMediator.INLINE) {
OMElement inlineElem = null;
if (sourceEle.getFirstElement() != null) {
inlineElem = sourceEle.getFirstElement().cloneOMElement();
}
if (inlineElem != null) {
source.setInlineOMNode(inlineElem);
} else if (!StringUtils.isBlank(sourceEle.getText())) {
source.setInlineOMNode(OMAbstractFactory.getOMFactory().createOMText(sourceEle.getText()));
} else {
handleException("XML element is required for INLINE type");
}
callMediator.setSourceAvailable(true);
} else if (source.getSourceType() == EnrichMediator.BODY) {
callMediator.setSourceAvailable(false);
}
}
private void populateTarget(CallMediator callMediator, Target target, OMElement sourceEle) {
OMAttribute typeAttr = sourceEle.getAttribute(ATT_TYPE);
target.setAction("replace");
if (typeAttr != null && typeAttr.getAttributeValue() != null) {
int type = CallMediatorEnrichUtil.convertTypeToInt(typeAttr.getAttributeValue());
if (type >= 0) {
target.setTargetType(type);
} else {
handleException("Un-expected type : " + typeAttr.getAttributeValue());
}
}
if (target.getTargetType() == EnrichMediator.PROPERTY) {
String propertyName = sourceEle.getText();
if (propertyName != null) {
target.setProperty(propertyName);
callMediator.setTargetAvailable(true);
} else {
handleException("Property name is required for PROPERTY type");
}
} else if (target.getTargetType() == EnrichMediator.BODY) {
callMediator.setTargetAvailable(false);
}
}
public QName getTagQName() {
return CALL_Q;
}
}