com.ibm.wbiserver.manualrecovery
Interface BPCEvent

All Superinterfaces:

FailedEvent

public interface BPCEvent
extends FailedEvent

The BPCEvent is an interface to obtain detailed information of a failed event, and set new information for failed event resubmission. The detailed information includes

• Process Instance Name
• Top Level Process ID
• Input Message
• Stopped Activitis in the failed event
• Process Instance ID

Field Summary

static 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

java.util.List<FailedEventParameter>	getInputMessage() Return parameters of the BPC failed event.
java.util.List<FailedEventParameter>	getInputMessage(java.util.Properties adminClientProperties) Return parameters of the failed event with admin client connection properties.
java.lang.String	getPiid()
java.lang.String	getProcessInstanceName() Return the process instance name for the failed event
BPCActivity[]	getStoppedActivities() Return the stopped activity list for the BPC failed event(running-stopped)
java.lang.String	getTopLevelProcessId() The top level process ID for the process instance of the failed event
boolean	isTopLevelProcess() The procecss intance for the failed event is the top level process or not

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

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

getProcessInstanceName

java.lang.String getProcessInstanceName()

Return the process instance name for the failed event

Returns:

String

isTopLevelProcess

boolean isTopLevelProcess()

The procecss intance for the failed event is the top level process or not

Returns:

getTopLevelProcessId

java.lang.String getTopLevelProcessId()

The top level process ID for the process instance of the failed event

Returns:

getInputMessage

java.util.List<FailedEventParameter> getInputMessage()

Return parameters of the BPC 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:

Input message for process instance

getInputMessage

java.util.List<FailedEventParameter> getInputMessage(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 -

Returns:

input message of the process instance related the failed event

getStoppedActivities

BPCActivity[] getStoppedActivities()

Return the stopped activity list for the BPC failed event(running-stopped)

Returns:

a array

getPiid

java.lang.String getPiid()

Returns:

process instance ID