/*
* 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.OMElement;
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.SendMediator;
import javax.xml.namespace.QName;
import java.util.Properties;
/**
* Factory for {@link SendMediator} instances.
* <p>
* TODO: document endpoints, failover and load balacing
* <p>
* The <send> 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>
* <send/>
* </pre>
*
* If the message is to be sent to one or more endpoints, then the following is used:
* <pre>
* <send>
* (endpointref | endpoint)+
* </send>
* </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>
* <send>
* <load-balance algorithm="uri">
* (endpointref | endpoint)+
* </load-balance>
* </send>
* </pre>
* Similarly, if the message is to be sent to an endpoint with failover semantics, then it is indicated by the following:
* <pre>
* <send>
* <failover>
* (endpointref | endpoint)+
* </failover>
* </send>
* </pre>
*/
public class SendMediatorFactory extends AbstractMediatorFactory {
private static final QName SEND_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "send");
private static final QName ENDPOINT_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "endpoint");
protected Mediator createSpecificMediator(OMElement elem, Properties properties) {
SendMediator sm = new SendMediator();
// after successfully creating the mediator
// set its common attributes such as tracing etc
processAuditStatus(sm,elem);
OMElement epElement = elem.getFirstChildWithName(ENDPOINT_Q);
if (epElement != null) {
// create the endpoint and set it in the send mediator
Endpoint endpoint = EndpointFactory.getEndpointFromElement(epElement, true, properties);
if (endpoint != null) {
sm.setEndpoint(endpoint);
}
}
return sm;
}
public QName getTagQName() {
return SEND_Q;
}
}