com.ibm.wbiserver.manualrecovery

Interface MQEvent

All Superinterfaces:
FailedEvent

  1. public interface MQEvent
  2. 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

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
MQPER_NOT_PERSISTENT
  1. static
  2. int
MQPER_PERSISTENCE_AS_Q_DEF
  1. static
  2. int
MQPER_PERSISTENT
Fields inherited from interface com.ibm.wbiserver.manualrecovery.FailedEvent
STATUS_FAILED, STATUS_STOPPED, STATUS_TERMINATED, TYPE_BFMHOLD, TYPE_BPC, TYPE_JMS, TYPE_MQ, TYPE_SCA

Method Summary

Modifier and Type Method and Description
  1. byte[]
getCorrelationID()
  1. java.lang.String
getDeliveryMode()
  1. java.lang.String
getDestination()
  1. java.util.Date
getExpiration()
  1. java.util.List<FailedEventParameter>
getPayload()
Return parameters of the failed event.
  1. java.util.List<FailedEventParameter>
getPayload(java.util.Properties adminClientProperties)
Return parameters of the failed event with admin client connection properties.
  1. int
getPriority()
  1. boolean
getRedelivered()
  1. java.lang.String
getReplyTo()
  1. java.lang.String
getReplyToQMgr()
  1. java.lang.String
getType()
  1. void
setPayload(java.util.List<FailedEventParameter> payload)
Methods inherited from interface com.ibm.wbiserver.manualrecovery.FailedEvent
didInitiateStore, getCorrelationId, getDeploymentTarget, getDestinationComponentName, getDestinationMethodName, getDestinationModuleName, getFailureDateTime, getFailureMessage, getInteractionType, getMsgId, getOwner, getResubmitDestination, getSessionId, getSourceComponentName, getSourceModuleName, getStatus, isESQualified, isProcessResponse

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

MQPER_PERSISTENT

  1. static final int MQPER_PERSISTENT
See Also:

MQPER_NOT_PERSISTENT

  1. static final int MQPER_NOT_PERSISTENT
See Also:

MQPER_PERSISTENCE_AS_Q_DEF

  1. static final int MQPER_PERSISTENCE_AS_Q_DEF
See Also:

Method Detail

getPayload

  1. 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

  1. 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

  1. byte[] getCorrelationID()
Returns:
JMS correlation ID

getDeliveryMode

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

getDestination

  1. java.lang.String getDestination( )
Returns:
MQ destination

getExpiration

  1. java.util.Date getExpiration()
Returns:
MQ expiration

getPriority

  1. int getPriority()

getRedelivered

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

getReplyTo

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

getReplyToQMgr

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

getType

  1. java.lang.String getType()
Description copied from interface: FailedEvent
Get event type
Specified by:
getType in interface FailedEvent
Returns:
MQ type

setPayload

  1. void setPayload(java.util.List<FailedEventParameter> payload)
Parameters:
payload -