Package de.aristaflow.adept2.base.configuration

Enum Class ConfigurationConstants.CommunicationProtocol

java.lang.Object

java.lang.Enum<ConfigurationConstants.CommunicationProtocol>

de.aristaflow.adept2.base.configuration.ConfigurationConstants.CommunicationProtocol

All Implemented Interfaces:

Serializable, Comparable<ConfigurationConstants.CommunicationProtocol>, java.lang.constant.Constable

Enclosing class:

ConfigurationConstants

public static enum ConfigurationConstants.CommunicationProtocol
extends Enum<ConfigurationConstants.CommunicationProtocol>

The names for all supported communication protocols (which are equal to the instance names of the corresponding communication services). These are needed to choose an appropriate URI for communicating with a remote service. The order of this enumeration can be used for choosing, whereas a lower position has a higher priority (SSL is always preferred).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMM_GLOBAL	The name of the communication protocol for an address resolved by the global registry.
COMM_LOCAL	The name of the communication protocol for local communication.
COMM_NETTY	The name of the communication protocol using Netty and Java serialisation.
COMM_NETTY_ONE_CONN_ONLY	The name of the communication protocol using Netty, Java serialisation and no server port for a client (the one and only connection is used from both directions).
COMM_NETTY_ONE_CONN_SSL	The name of the communication protocol using Netty, Java serialisation, no server port for a client (the one and only connection is used from both directions) and SSL.
COMM_NETTY_SSL	The name of the communication protocol using Netty, Java serialisation and SSL.

Method Summary

Modifier and Type	Method	Description
static ConfigurationConstants.CommunicationProtocol	fromString(String scheme)	Tries to convert the designated scheme to a corresponding communication protocol.
final String	getScheme()	Gets the scheme of this protocol as used in the corresponding URIs.
static ConfigurationConstants.CommunicationProtocol	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfigurationConstants.CommunicationProtocol[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COMM_LOCAL

public static final ConfigurationConstants.CommunicationProtocol COMM_LOCAL

The name of the communication protocol for local communication.

COMM_NETTY_SSL

public static final ConfigurationConstants.CommunicationProtocol COMM_NETTY_SSL

The name of the communication protocol using Netty, Java serialisation and SSL.

COMM_NETTY_ONE_CONN_SSL

public static final ConfigurationConstants.CommunicationProtocol COMM_NETTY_ONE_CONN_SSL

The name of the communication protocol using Netty, Java serialisation, no server port for a client (the one and only connection is used from both directions) and SSL.

COMM_NETTY

public static final ConfigurationConstants.CommunicationProtocol COMM_NETTY

The name of the communication protocol using Netty and Java serialisation.

COMM_NETTY_ONE_CONN_ONLY

public static final ConfigurationConstants.CommunicationProtocol COMM_NETTY_ONE_CONN_ONLY

The name of the communication protocol using Netty, Java serialisation and no server port for a client (the one and only connection is used from both directions).

COMM_GLOBAL

public static final ConfigurationConstants.CommunicationProtocol COMM_GLOBAL

The name of the communication protocol for an address resolved by the global registry.

Method Details

values

public static ConfigurationConstants.CommunicationProtocol[] 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

public static ConfigurationConstants.CommunicationProtocol valueOf(String name)

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 name

NullPointerException - if the argument is null

getScheme

public final String getScheme()

Gets the scheme of this protocol as used in the corresponding URIs.

Returns:

The scheme of this protocol as used in the corresponding URIs.

fromString

public static ConfigurationConstants.CommunicationProtocol fromString(String scheme)

Tries to convert the designated scheme to a corresponding communication protocol. If the designated scheme does not specify a communication protocol, an IllegalArgumentException will be thrown.
This is similar to Enum.valueOf(Class, String) but the scheme may have a "." and arbitrary characters following to allow for several communication services using the same communication protocol.

Parameters:

scheme - The name of the scheme to get the communication protocol for. Only the prefix before "." is relevant.

Returns:

The communication protocol for the designated scheme.

Throws:

IllegalArgumentException - If the designated scheme does not specify a communication protocol or it is null, an IllegalArgumentException will be thrown.