Package org.apache.synapse

Interface SynapseHandler

  • All Known Subinterfaces:
    ExtendedSynapseHandler
    All Known Implementing Classes:
    AbstractExtendedSynapseHandler, AbstractSynapseHandler
    public interface SynapseHandler
    Interface For Synapse Handlers

    Synapse Handlers are invoked when a message received to the mediation engine or a message sent out from the engine.

    When a message received to the engine, handles are invoked just before the mediation flow When a message is sent out from the engine, handlers are invoked just after the mediation flow There are two requests coming into the engine and two responses going out from the engine. For all four messages relevant method is invoked

    • Method Detail

      • handleRequestInFlow

        boolean handleRequestInFlow​(MessageContext synCtx)
        Handle request message coming into the engine
        Parameters:
        synCtx - incoming request message context
        Returns:
        whether mediation flow should continue

      • handleRequestOutFlow

        boolean handleRequestOutFlow​(MessageContext synCtx)
        Handle request message going out from the engine
        Parameters:
        synCtx - outgoing request message context
        Returns:
        whether mediation flow should continue

      • handleResponseInFlow

        boolean handleResponseInFlow​(MessageContext synCtx)
        Handle response message coming into the engine
        Parameters:
        synCtx - incoming response message context
        Returns:
        whether mediation flow should continue

      • handleResponseOutFlow

        boolean handleResponseOutFlow​(MessageContext synCtx)
        Handle response message going out from the engine
        Parameters:
        synCtx - outgoing response message context
        Returns:
        whether mediation flow should continue

      • addProperty

        void addProperty​(String name,
                 Object value)
        Add a handler property
        Parameters:
        name - property name
        value - property value

      • getProperties

        Map getProperties()
        Get all handler properties
        Returns:
        Map of handler properties

      • getName

        String getName()
        Get the name of the handler
        Returns:
        handler name

      • setName

        void setName​(String name)
        Set the handler name
        Parameters:
        name - handler name