Class SendMediatorFactory

  • All Implemented Interfaces:
    MediatorFactory

    public class SendMediatorFactory
    extends AbstractMediatorFactory
    Factory for SendMediator instances.

    TODO: document endpoints, failover and load balacing

    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:

      <send/>
     
    If the message is to be sent to one or more endpoints, then the following is used:
      <send>
       (endpointref | endpoint)+
      </send>
     
    where the endpointref token refers to the following:
     <endpoint ref="name"/>
     
    and the endpoint token refers to an anonymous endpoint defined inline:
      <endpoint address="url"/>
     
    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:
     <send>
       <load-balance algorithm="uri">
         (endpointref | endpoint)+
       </load-balance>
     </send>
     
    Similarly, if the message is to be sent to an endpoint with failover semantics, then it is indicated by the following:
     <send>
       <failover>
         (endpointref | endpoint)+
       </failover>
     </send>
     
    • Constructor Detail

      • SendMediatorFactory

        public SendMediatorFactory()
    • Method Detail

      • createSpecificMediator

        public Mediator createSpecificMediator​(org.apache.axiom.om.OMElement elem,
                                               Properties properties)
        Description copied from class: AbstractMediatorFactory
        Specific mediator factory implementations should implement this method to build the Mediator by the given XML configuration
        Specified by:
        createSpecificMediator in class AbstractMediatorFactory
        Parameters:
        elem - configuration element describing the properties of the mediator
        properties - bag of properties to pass in any information to the factory
        Returns:
        built mediator of that specific type
      • getTagQName

        public QName getTagQName()
        Description copied from interface: MediatorFactory
        The QName of this mediator element in the XML config
        Returns:
        QName of the mediator element