com.pushtechnology.diffusion.client.features.control

Enum RemoteServers.CheckRemoteServerResult.ConnectionState

java.lang.Object

java.lang.Enum<RemoteServers.CheckRemoteServerResult.ConnectionState>

com.pushtechnology.diffusion.client.features.control.RemoteServers.CheckRemoteServerResult.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<RemoteServers.CheckRemoteServerResult.ConnectionState>

Enclosing interface:

RemoteServers.CheckRemoteServerResult

public static enum RemoteServers.CheckRemoteServerResult.ConnectionState
extends Enum<RemoteServers.CheckRemoteServerResult.ConnectionState>

Represents the current connection state of the remote server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED The remote server is connected.
FAILED The connection has failed.
INACTIVE The connection is inactive.
MISSING The named remote server did not exist.
RETRYING The connection has failed but is retrying.

Method Summary

Modifier and Type	Method and Description
static RemoteServers.CheckRemoteServerResult.ConnectionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static RemoteServers.CheckRemoteServerResult.ConnectionState[]	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

INACTIVE

public static final RemoteServers.CheckRemoteServerResult.ConnectionState INACTIVE

The connection is inactive.

This is the initial state for all types.

For a RemoteServers.SecondaryInitiator this could also mean that the remote server can successfully connect but a physical connection is not being maintained as there are no components that require the remote server.

If in an inactive or failed state, a test connection will have been tried to check that the connection can be made and the connection will then have been closed.

CONNECTED

public static final RemoteServers.CheckRemoteServerResult.ConnectionState CONNECTED

The remote server is connected.

For a RemoteServers.SecondaryInitiator this means that there are components actually using it.

A RemoteServers.SecondaryAcceptor can be in this state even if there are no components using it as a reverse connection is always maintained.

A RemoteServers.PrimaryInitiator will only be in this state if it has a successful connection to all secondary acceptors configured for it. If any secondary acceptor connection has failed then it will be in a FAILED state even if there are some active connections.

RETRYING

public static final RemoteServers.CheckRemoteServerResult.ConnectionState RETRYING

The connection has failed but is retrying.

In this case RemoteServers.CheckRemoteServerResult.getFailureMessage() will provide details of the failure that resulted in a retry.

FAILED

public static final RemoteServers.CheckRemoteServerResult.ConnectionState FAILED

The connection has failed.

If the connection was in an inactive or failed state state, a test connection was tried and failed.

In this case RemoteServers.CheckRemoteServerResult.getFailureMessage() will provide more detail.

MISSING

public static final RemoteServers.CheckRemoteServerResult.ConnectionState MISSING

The named remote server did not exist.

Method Detail

values

public static RemoteServers.CheckRemoteServerResult.ConnectionState[] 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 (RemoteServers.CheckRemoteServerResult.ConnectionState c : RemoteServers.CheckRemoteServerResult.ConnectionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static RemoteServers.CheckRemoteServerResult.ConnectionState valueOf(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:

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

NullPointerException - if the argument is null