IBM WebSphere Application ServerTM
Release 8

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


Field Summary
static java.lang.String COPYRIGHT
           
static int MQPER_NOT_PERSISTENT
           
static int MQPER_PERSISTENCE_AS_Q_DEF
           
static 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
 byte[] getCorrelationID()
           
 java.lang.String getDeliveryMode()
           
 java.lang.String getDestination()
           
 java.util.Date getExpiration()
           
 java.util.List<FailedEventParameter> getPayload()
          Return parameters of the failed event.
 java.util.List<FailedEventParameter> getPayload(java.util.Properties adminClientProperties)
          Return parameters of the failed event with admin client connection properties.
 int getPriority()
           
 boolean getRedelivered()
           
 java.lang.String getReplyTo()
           
 java.lang.String getReplyToQMgr()
           
 java.lang.String getType()
          Get event type
 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

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

MQPER_PERSISTENT

static final int MQPER_PERSISTENT
See Also:
Constant Field Values

MQPER_NOT_PERSISTENT

static final int MQPER_NOT_PERSISTENT
See Also:
Constant Field Values

MQPER_PERSISTENCE_AS_Q_DEF

static final int MQPER_PERSISTENCE_AS_Q_DEF
See Also:
Constant Field Values
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.

When security is enabled, additional information are required.

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

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

setPayload

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

IBM WebSphere Application ServerTM
Release 8