com.sap.aii.af.service.administration.api.monitoring

Class ProcessState

java.lang.Object

com.sap.aii.af.service.administration.api.monitoring.ProcessState

All Implemented Interfaces:

Serializable, Comparable

public class ProcessState
extends Object
implements Serializable, Comparable

The ProcessState class is a typed enumeration for the status of a channel's processing operation in the Adapter Monitoring API. Its static members can be used to express a certain process state. Available states are:

• FATAL
• ERROR
• OK

The states have a precedence in the above shown order. To set a process state, use the MonitoringManager interface.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ProcessState	ERROR Indicates that an error has occurred during the adapter's message processing.
static ProcessState	FATAL Indicates that a fatal (i.e.
static ProcessState	OK Indicates that a processing step during an adapter's message processing completed successfully.
protected String	text

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessState(String text, int value) Protected constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compare two ProcessState instances.
int	compareTo(ProcessState s) Compare two ProcessState instances.
protected Object	readResolve() This is called after the deserialization of an instance of this class has taken place.
String	toString() Converts this object into a string representation.
static ProcessState	valueOf(String statusString) Get one of the static class members from their depending String as returned from toString.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FATAL

public static final ProcessState FATAL

Indicates that a fatal (i.e. non-recoverable) error has occurred during the adapter's message processing.

ERROR

public static final ProcessState ERROR

Indicates that an error has occurred during the adapter's message processing.

OK

public static final ProcessState OK

Indicates that a processing step during an adapter's message processing completed successfully.

text

protected String text

Constructor Detail

ProcessState

protected ProcessState(String text,
                       int value)

Protected constructor.

Parameters:

text - the state text

value - the state value (for comparison purposes)

Method Detail

toString

public String toString()

Converts this object into a string representation.

Overrides:

toString in class Object

Returns:

the string representation of this ProcessState

valueOf

public static ProcessState valueOf(String statusString)

Get one of the static class members from their depending String as returned from toString.

Parameters:

statusString - a String as returned by the toString method

Returns:

one of the static members of this class

Throws:

NullPointerException - if the argument is null

IllegalArgumentException - if the argument is a unknown status String

readResolve

protected Object readResolve()
                      throws ObjectStreamException

This is called after the deserialization of an instance of this class has taken place. The Object returned by this method is the one that will be used as the deserialized one. we will ensure that only the static class instanced above will exist.

Returns:

an object of type ProcessState

Throws:

ObjectStreamException - In case there's an error in the deserialization

compareTo

public int compareTo(Object o)

Compare two ProcessState instances.

Specified by:

compareTo in interface Comparable

Parameters:

o - Another ProcessState instance

Returns:

the value 0 if the argument is the same ProcessState as this ProcessState; a value less than 0 if the argument is a ProcessState with a higher precedence than this ProcessState; and a value greater than 0 if the argument is a ProcessState with a lower precedence less than this ProcessState.

Throws:

ClassCastException - if the argument is not of type ProcessState

NullPointerException - if the argument is null

compareTo

public int compareTo(ProcessState s)

Compare two ProcessState instances.

Parameters:

s - Another ProcessState instance

Returns:

the value 0 if the argument is the same ProcessState as this ProcessState; a value less than 0 if the argument is a ProcessState with a higher precedence than this ProcessState; and a value greater than 0 if the argument is a ProcessState with a lower precedence less than this ProcessState.

Throws:

NullPointerException - if the argumant is null