com.ibm.wbiserver.manualrecovery

Interface BPCActivity


  1. public interface BPCActivity
The BPCActivity is an interface to obtain detailed information of a stopped activity in a BPC 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

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getActivityName()
Return the Activity Name
  1. java.lang.String
getAiid()
Return the activity instance ID
  1. java.util.Date
getFailureDateTime()
Return the last state change time for the activity
  1. java.util.List<FailedEventParameter>
getInputMessage()
Return the input message of the stopped activity.
  1. java.util.List<FailedEventParameter>
getInputMessage(java.util.Properties adminClientProperties)
Return input message of a stopped activity in the BPC failed event with admin client connection properties.
  1. void
setInputMessage(java.util.List<FailedEventParameter> inputMessage)
Set the input message for activity forceRetry

Field Detail

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

Method Detail

getAiid

  1. java.lang.String getAiid()
Return the activity instance ID
Returns:
String

getActivityName

  1. java.lang.String getActivityName( )
Return the Activity Name
Returns:
String

getInputMessage

  1. java.util.List<FailedEventParameter> getInputMessage( )
Return the input message of the stopped activity. 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:
List

getInputMessage

  1. java.util.List<FailedEventParameter> getInputMessage( java.util.Properties adminClientProperties)
Return input message of a stopped activity in the BPC 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:
List

setInputMessage

  1. void setInputMessage(java.util.List<FailedEventParameter> inputMessage)
Set the input message for activity forceRetry
Parameters:
inputMessage -

getFailureDateTime

  1. java.util.Date getFailureDateTime( )
Return the last state change time for the activity
Returns:
Date