Package org.apache.synapse.commons.handlers

# Interface MessagingHandler

public interface MessagingHandler
Interface for MessagingHandler.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `destroy(ConnectionId connectionId)`
  Triggered to release and dispose any sort of resources hold against a particular message flow.
  `void`
  `handleError(ConnectionId connectionId)`
  Handle Error.
  `HandlerResponse`
  `handleRequest(org.apache.axis2.context.MessageContext axis2MessageContext)`
  Handle request.

- ## Method Details

  - ### handleRequest

    HandlerResponse handleRequest(org.apache.axis2.context.MessageContext axis2MessageContext)
    Handle request.
    Parameters:
      `axis2MessageContext` - axis2 message context.

  - ### handleError

    void handleError(ConnectionId connectionId)
    Handle Error. This method is invoked whenever an exception occurs in the request flow so that the implementations can clear any in-memory resources.
    Parameters:
      `connectionId` - Identifier of the connection.

  - ### destroy

    void destroy(ConnectionId connectionId)
    Triggered to release and dispose any sort of resources hold against a particular message flow. For example, if a WebSocket connection is terminated, this method can be used to notify the handler about this event.
    Parameters:
      `connectionId` - Identifier of the connection.