com.exalead.papi.framework.connectors

Enum ConnectorStatus

java.lang.Object

java.lang.Enum<ConnectorStatus>

com.exalead.papi.framework.connectors.ConnectorStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConnectorStatus>

public enum ConnectorStatus
extends java.lang.Enum<ConnectorStatus>

Status of a connector.

See Also:

which enforces the state transitions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTING The connector is aborting, that is, an operation is being cancelled.
DISABLED The connector has been disabled by a call to setEnabled(false) Valid transitions are: IDLE, ERROR
ERROR The connector is in a fatal error state (incorrect configuration, failed to instantiate).
IDLE The connector is idle and ready to process a command.
NOT_INITIALIZED The connector is not yet initialized ; that is, a call to init() has not yet been issued by the server.
RESUMING The connector is resuming a suspended operation.
SUSPENDED An operation has been suspended (and can be resumed).
SUSPENDING The connector is suspending an operation.
WORKING The connector is working (synchronizing) Valid transitions are: IDLE, ABORTING, SUSPENDING, ERROR

Method Summary

Modifier and Type	Method and Description
static ConnectorStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConnectorStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_INITIALIZED

public static final ConnectorStatus NOT_INITIALIZED

The connector is not yet initialized ; that is, a call to init() has not yet been issued by the server. Valid transitions are: IDLE, ERROR

IDLE

public static final ConnectorStatus IDLE

The connector is idle and ready to process a command. Valid transitions are: DISABLED, WORKING, ERROR

WORKING

public static final ConnectorStatus WORKING

The connector is working (synchronizing) Valid transitions are: IDLE, ABORTING, SUSPENDING, ERROR

SUSPENDED

public static final ConnectorStatus SUSPENDED

An operation has been suspended (and can be resumed). Valid transitions are: RESUMING, ERROR

SUSPENDING

public static final ConnectorStatus SUSPENDING

The connector is suspending an operation. Valid transitions are: SUSPENDED, ERROR

ABORTING

public static final ConnectorStatus ABORTING

The connector is aborting, that is, an operation is being cancelled. Valid transitions are: IDLE, ERROR

RESUMING

public static final ConnectorStatus RESUMING

The connector is resuming a suspended operation. Valid transitions are: WORKING, ERROR

ERROR

public static final ConnectorStatus ERROR

The connector is in a fatal error state (incorrect configuration, failed to instantiate). This state is not recoverable, connector config must be updated.

DISABLED

public static final ConnectorStatus DISABLED

The connector has been disabled by a call to setEnabled(false) Valid transitions are: IDLE, ERROR

Method Detail

values

public static ConnectorStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConnectorStatus c : ConnectorStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConnectorStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null