Enum Class RemoteServers.CheckRemoteServerResult.ConnectionState
- All Implemented Interfaces:
Serializable
,Comparable<RemoteServers.CheckRemoteServerResult.ConnectionState>
,Constable
- Enclosing interface:
- RemoteServers.CheckRemoteServerResult
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INACTIVE
The connection is inactive.This is the initial state for all types.
For a
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
The remote server is connected.For a
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
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
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
The named remote server did not exist.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-