Package org.wildfly.security.ssl

Enum Protocol

java.lang.Object

java.lang.Enum<Protocol>

org.wildfly.security.ssl.Protocol

All Implemented Interfaces:

Serializable, Comparable<Protocol>

public enum Protocol
extends Enum<Protocol>

The protocol type for SSL/TLS cipher suite selection and protocol selection.

Author:

David M. Lloyd

Enum Constant Summary

Enum Constants

Enum Constant	Description
SSLv2	The SSL version 2 protocol.
SSLv3	The SSL version 3 protocol.
TLSv1	The TLS version 1.0 protocol.
TLSv1_1	The TLS version 1.1 protocol.
TLSv1_2	The TLS version 1.2 protocol.
TLSv1_3	The TLS version 1.3 protocol.

Field Summary

Fields

Modifier and Type	Field	Description
String	name

Method Summary

Modifier and Type	Method	Description
static Protocol	forName(String name)	Gets an enum item for given protocol name.
boolean	in(Protocol... values)	Determine whether this instance is equal to one of the given instances.
boolean	in(Protocol value1, Protocol value2)	Determine whether this instance is equal to one of the given instances.
boolean	in(Protocol value1, Protocol value2, Protocol value3)	Determine whether this instance is equal to one of the given instances.
static boolean	isFull(EnumSet<Protocol> protocols)	Determine whether the given set is "full" (meaning it contains all possible values).
static Protocol	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Protocol[]	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

SSLv2

public static final Protocol SSLv2

The SSL version 2 protocol.

SSLv3

public static final Protocol SSLv3

The SSL version 3 protocol.

TLSv1

public static final Protocol TLSv1

The TLS version 1.0 protocol.

TLSv1_1

public static final Protocol TLSv1_1

The TLS version 1.1 protocol. Note that there are no cipher suites which are specifically defined in this protocol.

TLSv1_2

public static final Protocol TLSv1_2

The TLS version 1.2 protocol.

TLSv1_3

public static final Protocol TLSv1_3

The TLS version 1.3 protocol.

Field Detail

name

public final String name

Method Detail

values

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

Returns:

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

valueOf

public static Protocol 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

forName

public static Protocol forName(String name)

Gets an enum item for given protocol name.

Parameters:

name - the protocol name

Returns:

an enum item

isFull

public static boolean isFull(EnumSet<Protocol> protocols)

Determine whether the given set is "full" (meaning it contains all possible values).

Parameters:

protocols - the set

Returns:

true if the set is full, false otherwise

in

public boolean in(Protocol value1,
                  Protocol value2)

Determine whether this instance is equal to one of the given instances.

Parameters:

value1 - the first instance

value2 - the second instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(Protocol value1,
                  Protocol value2,
                  Protocol value3)

Determine whether this instance is equal to one of the given instances.

Parameters:

value1 - the first instance

value2 - the second instance

value3 - the third instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(Protocol... values)

Determine whether this instance is equal to one of the given instances.

Parameters:

values - the values to match against

Returns:

true if one of the instances matches this one, false otherwise