Package org.certificateservices.messages.pkimessages.manager

Interface MessageHandler

  • All Known Implementing Classes:
    DummyMessageHandler
    public interface MessageHandler
    Interface that a MQ message handler should implement in order to send and recieve messages directly.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Method called by service if the MessageHandler should disconnect from the MessageQueue server.
      void connect()
      Method called by service if the MessageHandler should connect to the MessageQueue server and start processing incoming calls.
      java.lang.Object getConnectionFactory()
      Method returning the connection factory used to set-up the message queues.
      void init​(java.util.Properties config, PKIMessageParser parser, MessageResponseCallback callback)
      Method called after instantiation and should check configuration and prepare everything for connection with the message queue server.
      boolean isConnected()
      Method returning if the handler is currently connected to the JMS broker.
      void sendMessage​(java.lang.String messageId, byte[] message)
      Method to send a message to the MQ server out queue.

    • Method Detail

      • init

        void init​(java.util.Properties config,
          PKIMessageParser parser,
          MessageResponseCallback callback)
   throws MessageException
        Method called after instantiation and should check configuration and prepare everything for connection with the message queue server.
        Parameters:
        config - the configuration.
        parser - the message parser configuration.
        callback - the callback interface where response messages are sent.
        Throws:
        MessageException - if configuration problems or other internal problems occurred.

      • getConnectionFactory

        java.lang.Object getConnectionFactory()
                               throws MessageException,
                                      java.io.IOException
        Method returning the connection factory used to set-up the message queues. Used only for special purposes when not extending the implementing class. Required method for extending classes to provide the connection factory to use when connecting to the message server.
        Returns:
        a connection factory to use to set up the message processing environment, never null.
        Throws:
        MessageException - if internal error or configuration problems occurred.
        java.io.IOException - if communication problems occurred with the message service.

      • connect

        void connect()
      throws MessageException,
             java.io.IOException
        Method called by service if the MessageHandler should connect to the MessageQueue server and start processing incoming calls.
        Throws:
        MessageException - if configuration problems or other internal problems occurred connecting to the MQ server.
        java.io.IOException - if communication problems occurred connecting from the message server.

      • sendMessage

        void sendMessage​(java.lang.String messageId,
                 byte[] message)
          throws MessageException,
                 java.io.IOException
        Method to send a message to the MQ server out queue.
        Parameters:
        messageId - the id of the message
        the - message data to send
        Throws:
        MessageException - if configuration problems or other internal problems occurred connecting to the MQ server.
        java.io.IOException - if communication problems occurred connecting and sending to the message server.

      • isConnected

        boolean isConnected()
        Method returning if the handler is currently connected to the JMS broker.
        Returns:
        true if connected.

      • close

        void close()
    throws java.io.IOException
        Method called by service if the MessageHandler should disconnect from the MessageQueue server.
        Throws:
        java.io.IOException - if communication problems occurred disconnecting from the message server.