public interface JMSEvent extends FailedEvent
JMSEvent
is an interface to obtain detailed information
of a failed event, and set new information for failed event resubmission.
The detailed information includes
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
STATUS_FAILED, STATUS_STOPPED, STATUS_TERMINATED, TYPE_BFMHOLD, TYPE_BPC, TYPE_JMS, TYPE_MQ, TYPE_SCA
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getJMSCorrelationID() |
java.lang.String |
getJMSDeliveryMode() |
java.lang.String |
getJMSDestination() |
java.util.Date |
getJMSExpiration() |
int |
getJMSPriority() |
boolean |
getJMSRedelivered() |
java.lang.String |
getJMSReplyTo() |
java.lang.String |
getJMSType() |
int |
getJMSXDeliveryCount() |
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.
|
void |
setJMSExpiration(java.util.Date expiration) |
void |
setPayload(java.util.List payload) |
didInitiateStore, getCorrelationId, getDeploymentTarget, getDestinationComponentName, getDestinationMethodName, getDestinationModuleName, getFailureDateTime, getFailureMessage, getInteractionType, getMsgId, getOwner, getResubmitDestination, getSessionId, getSourceComponentName, getSourceModuleName, getStatus, getType, isESQualified, isProcessResponse
static final java.lang.String COPYRIGHT
java.util.List<FailedEventParameter> getPayload()
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.
java.util.List<FailedEventParameter> getPayload(java.util.Properties adminClientProperties)
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.
adminClientProperties
- the admin client propertiesjava.lang.String getJMSCorrelationID()
java.lang.String getJMSDeliveryMode()
java.lang.String getJMSDestination()
java.util.Date getJMSExpiration()
int getJMSPriority()
boolean getJMSRedelivered()
java.lang.String getJMSReplyTo()
java.lang.String getJMSType()
int getJMSXDeliveryCount()
void setPayload(java.util.List payload)
payload
- void setJMSExpiration(java.util.Date expiration)
expiration
-