Package org.apache.synapse.endpoints

Class RecipientListEndpoint

  • All Implemented Interfaces:
    Endpoint, ManagedLifecycle, Nameable, PropertyInclude, SynapseArtifact
    public class RecipientListEndpoint
extends AbstractEndpoint
    Author:
    nuwan

    A Recipient List endpoint can contain multiple child endpoints or member elements. It routes cloned copies of messages to each child recipient. This will assume that all immediate child endpoints are identical in state (state is replicated) or state is not maintained at those endpoints.

    • Constructor Detail

      • RecipientListEndpoint

        public RecipientListEndpoint​(int poolsize)

      • RecipientListEndpoint

        public RecipientListEndpoint()

    • Method Detail

      • init

        public void init​(SynapseEnvironment synapseEnvironment)
        Description copied from interface: ManagedLifecycle
        This method should implement the initialization of the implemented parts of the configuration.
        Specified by:
        init in interface ManagedLifecycle
        Overrides:
        init in class AbstractEndpoint
        Parameters:
        synapseEnvironment - SynapseEnvironment to be used for initialization

      • send

        public void send​(MessageContext synCtx)
        Description copied from interface: Endpoint
        Sends the message context according to an endpoint specific behavior.
        Specified by:
        send in interface Endpoint
        Overrides:
        send in class AbstractEndpoint
        Parameters:
        synCtx - MessageContext to be sent.

      • readyToSend

        public boolean readyToSend()
        Description copied from interface: Endpoint
        Returns true to indicate that the endpoint is ready to service requests
        Specified by:
        readyToSend in interface Endpoint
        Overrides:
        readyToSend in class AbstractEndpoint
        Returns:
        true if endpoint is ready to service requests

      • onChildEndpointFail

        public void onChildEndpointFail​(Endpoint endpoint,
                                MessageContext synMessageContext)
        Description copied from interface: Endpoint
        Endpoints that contain other endpoints should implement this method. It will be called if a child endpoint causes an exception. Action to be taken on such failure is up to the implementation. But it is good practice to first try addressing the issue. If it can't be addressed propagate the exception to parent endpoint by calling parent endpoint's onChildEndpointFail(...) method.
        Specified by:
        onChildEndpointFail in interface Endpoint
        Overrides:
        onChildEndpointFail in class AbstractEndpoint
        Parameters:
        endpoint - The child endpoint which caused the exception.
        synMessageContext - MessageContext that was used in the failed attempt.

      • getMembers

        public List<org.apache.axis2.clustering.Member> getMembers()

      • setMembers

        public void setMembers​(List<org.apache.axis2.clustering.Member> members)

      • isFailover

        public boolean isFailover()

      • setFailover

        public void setFailover​(boolean failover)

      • getDynamicEnpointSet

        public Value getDynamicEnpointSet()

      • setDynamicEnpointSet

        public void setDynamicEnpointSet​(Value dynamicEnpointSet)

      • getCurrentPoolSize

        public int getCurrentPoolSize()