IBM WebSphere Application ServerTM
Release 7

com.ibm.wbiserver.manualrecovery
Interface FailedEventWithParameters

All Superinterfaces:
FailedEvent

Deprecated.

public interface FailedEventWithParameters
extends FailedEvent

Since:
6.2
Version:
6.0.1
See Also:
SCAEvent

Field Summary
static java.lang.String COPYRIGHT
          Deprecated.  
 
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.lang.String getCEITraceControl()
          Deprecated. Return CEI trace control
 java.util.Date getExpirationTime()
          Deprecated. Return expiration time
 java.util.List getFailedEventParameters()
          Deprecated. Return parameters of the failed event.
 java.util.List getFailedEventParameters(java.util.Properties adminClientProperties)
          Deprecated. Return parameters of the failed event with admin client connection properties.
 void setCEITraceControl(java.lang.String ceiTraceControl)
          Deprecated. Set new CEI trace control
 void setExpirationTime(java.util.Date expirationTime)
          Deprecated. Set new expiration time
 void setFailedEventParameters(java.util.List failedEventParameters)
          Deprecated. Set new parameters to the failed event
 
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
Deprecated. 
See Also:
Constant Field Values
Method Detail

getFailedEventParameters

java.util.List getFailedEventParameters()
Deprecated. 
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

getFailedEventParameters

java.util.List getFailedEventParameters(java.util.Properties adminClientProperties)
Deprecated. 
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

setFailedEventParameters

void setFailedEventParameters(java.util.List failedEventParameters)
Deprecated. 
Set new parameters to the failed event

Parameters:
failedEventParameters - new failed event parameters

getCEITraceControl

java.lang.String getCEITraceControl()
Deprecated. 
Return CEI trace control

Returns:
the CEI trace control

setCEITraceControl

void setCEITraceControl(java.lang.String ceiTraceControl)
Deprecated. 
Set new CEI trace control

Parameters:
ceiTraceControl - the new CEI trace control

getExpirationTime

java.util.Date getExpirationTime()
Deprecated. 
Return expiration time

Returns:
expiration time

setExpirationTime

void setExpirationTime(java.util.Date expirationTime)
Deprecated. 
Set new expiration time

Parameters:
expirationTime - the new expiration time

IBM WebSphere Application ServerTM
Release 7