com.ibm.wbiserver.manualrecovery

Interface JMSEvent

All Superinterfaces:
FailedEvent

  1. public interface JMSEvent
  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
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. java.lang.String
getJMSCorrelationID()
  1. java.lang.String
getJMSDeliveryMode()
  1. java.lang.String
getJMSDestination()
  1. java.util.Date
getJMSExpiration()
  1. int
getJMSPriority()
  1. boolean
getJMSRedelivered()
  1. java.lang.String
getJMSReplyTo()
  1. java.lang.String
getJMSType()
  1. int
getJMSXDeliveryCount()
  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. void
setJMSExpiration(java.util.Date expiration)
  1. void
setPayload(java.util.List 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, getType, isESQualified, isProcessResponse

Field Detail

  1. static final java.lang.String COPYRIGHT
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

getJMSCorrelationID

  1. java.lang.String getJMSCorrelationID( )
Returns:
JMS correlation ID

getJMSDeliveryMode

  1. java.lang.String getJMSDeliveryMode( )
Returns:
JMS delivery mode

getJMSDestination

  1. java.lang.String getJMSDestination( )
Returns:
JMS destination

getJMSExpiration

  1. java.util.Date getJMSExpiration( )
Returns:
JMS expiration

getJMSPriority

  1. int getJMSPriority()
Returns:
JMS priority

getJMSRedelivered

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

getJMSReplyTo

  1. java.lang.String getJMSReplyTo( )
Returns:
JMS reply to destination

getJMSType

  1. java.lang.String getJMSType()
Returns:
JMS type

getJMSXDeliveryCount

  1. int getJMSXDeliveryCount()
Returns:
JMS delivery count

setPayload

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

setJMSExpiration

  1. void setJMSExpiration(java.util.Date expiration)
Parameters:
expiration -