com.ibm.wbiserver.manualrecovery

Interface MQEvent

  • All Superinterfaces:
    FailedEvent


    public interface MQEvent
    extends FailedEvent
    The JMSEvent is an interface to obtain detailed information of a failed event, and set new information for failed event resubmission. The detailed information includes
    • Failed event parameters
    • CEI trace level
    • Expiration time
    • Method Detail

      • getPayload

        java.util.List<FailedEventParameter> getPayload()
        Return parameters of the failed event. This API is used in the following two scenarios.

        1. The client is in the same cell as WPS runtime.

        2. The client is in a different cell as WPS runtime, and the admin client properties have been put into Java system environment.

        This API does not explicitly throw exception. However, if exception happens such as failed to load BO schema and BO deserialization fails, FailedEventRuntimeException will be throw as runtime exception.

        Returns:
        Parameter list of the failed event
      • getPayload

        java.util.List<FailedEventParameter> getPayload(java.util.Properties adminClientProperties)
        Return parameters of the failed event with admin client connection properties. This API is used when the client is in a different cell as WPS runtime, and the admin client properties are not in Java system environment.

        The admin client properties should included the following information.

        • AdminClient.CONNECTOR_TYPE
        • AdminClient.CONNECTOR_HOST
        • AdminClient.CONNECTOR_PORT

        When security is enabled, additional information are required.

        • AdminClient.CONNECTOR_SECURITY_ENABLED
        • AdminClient.USERNAME
        • AdminClient.PASSWORD

        For SOAP based connection, some other properties may also be required in order to make a SSL connection.

        • javax.net.ssl.trustStore
        • javax.net.ssl.keyStore
        • javax.net.ssl.trustStorePassword
        • javax.net.ssl.keyStorePassword

        An easy way to use this API is to obtain the properties from the existing admin client.
        For example,

         List parameters = getFailedEventParameters(adminClient.getConnectorProperties());
         

        This API does not explicitly throw exception. However, if exception happens such as failed to load BO schema and BO deserialization fails, FailedEventDataException will be throw as runtime exception.

        Parameters:
        adminClientProperties - the admin client properties
        Returns:
        parameter list of the failed event
      • getCorrelationID

        byte[] getCorrelationID()
        Returns:
        JMS correlation ID
      • getDeliveryMode

        java.lang.String getDeliveryMode()
        Returns:
        MQ delivery mode
      • getDestination

        java.lang.String getDestination()
        Returns:
        MQ destination
      • getExpiration

        java.util.Date getExpiration()
        Returns:
        MQ expiration
      • getPriority

        int getPriority()
      • getRedelivered

        boolean getRedelivered()
        Returns:
        ture MQ message is redelivered false MQ message is delivered for the first time
      • getReplyTo

        java.lang.String getReplyTo()
        Returns:
        MQ reply to destination
      • getReplyToQMgr

        java.lang.String getReplyToQMgr()
        Returns:
        reply to Queue manager
      • getType

        java.lang.String getType()
        Description copied from interface: FailedEvent
        Get event type
        Specified by:
        getType in interface FailedEvent
        Returns:
        MQ type
IBM Business Process ManagerTM
Release 8