Package org.wildfly.security.mechanism

Enum ScramServerErrorCode

java.lang.Object

java.lang.Enum<ScramServerErrorCode>

org.wildfly.security.mechanism.ScramServerErrorCode

All Implemented Interfaces:

Serializable, Comparable<ScramServerErrorCode>

public enum ScramServerErrorCode
extends Enum<ScramServerErrorCode>

Author:

David M. Lloyd

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANNEL_BINDING_NOT_PROVIDED
CHANNEL_BINDING_NOT_SUPPORTED
CHANNEL_BINDINGS_DONT_MATCH
EXTENSIONS_NOT_SUPPORTED
INVALID_ENCODING
INVALID_PROOF
INVALID_USERNAME_ENCODING
NO_RESOURCES
OTHER_ERROR
SERVER_DOES_NOT_SUPPORT_CHANNEL_BINDING
SERVER_DOES_SUPPORT_CHANNEL_BINDING
UNKNOWN_USER
UNSUPPORTED_CHANNEL_BINDING_TYPE

Method Summary

Modifier and Type	Method	Description
static ScramServerErrorCode	fromErrorString(String value)
byte[]	getMessageBytes()
String	getText()
boolean	in(ScramServerErrorCode v1)	Determine whether this instance is equal to one of the given instances.
boolean	in(ScramServerErrorCode... values)	Determine whether this instance is equal to one of the given instances.
boolean	in(ScramServerErrorCode v1, ScramServerErrorCode v2)	Determine whether this instance is equal to one of the given instances.
boolean	in(ScramServerErrorCode v1, ScramServerErrorCode v2, ScramServerErrorCode v3)	Determine whether this instance is equal to one of the given instances.
static boolean	isFull(EnumSet<ScramServerErrorCode> set)	Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.
static ScramServerErrorCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScramServerErrorCode[]	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

INVALID_ENCODING

public static final ScramServerErrorCode INVALID_ENCODING

EXTENSIONS_NOT_SUPPORTED

public static final ScramServerErrorCode EXTENSIONS_NOT_SUPPORTED

INVALID_PROOF

public static final ScramServerErrorCode INVALID_PROOF

CHANNEL_BINDINGS_DONT_MATCH

public static final ScramServerErrorCode CHANNEL_BINDINGS_DONT_MATCH

SERVER_DOES_NOT_SUPPORT_CHANNEL_BINDING

public static final ScramServerErrorCode SERVER_DOES_NOT_SUPPORT_CHANNEL_BINDING

SERVER_DOES_SUPPORT_CHANNEL_BINDING

public static final ScramServerErrorCode SERVER_DOES_SUPPORT_CHANNEL_BINDING

CHANNEL_BINDING_NOT_SUPPORTED

public static final ScramServerErrorCode CHANNEL_BINDING_NOT_SUPPORTED

CHANNEL_BINDING_NOT_PROVIDED

public static final ScramServerErrorCode CHANNEL_BINDING_NOT_PROVIDED

UNSUPPORTED_CHANNEL_BINDING_TYPE

public static final ScramServerErrorCode UNSUPPORTED_CHANNEL_BINDING_TYPE

UNKNOWN_USER

public static final ScramServerErrorCode UNKNOWN_USER

INVALID_USERNAME_ENCODING

public static final ScramServerErrorCode INVALID_USERNAME_ENCODING

NO_RESOURCES

public static final ScramServerErrorCode NO_RESOURCES

OTHER_ERROR

public static final ScramServerErrorCode OTHER_ERROR

Method Detail

values

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

Returns:

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

valueOf

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

getText

public String getText()

getMessageBytes

public byte[] getMessageBytes()

fromErrorString

public static ScramServerErrorCode fromErrorString(String value)

isFull

public static boolean isFull(EnumSet<ScramServerErrorCode> set)

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

Parameters:

set - the set

Returns:

true if the set is full, false otherwise

in

public boolean in(ScramServerErrorCode v1)

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

Parameters:

v1 - the first instance

Returns:

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

in

public boolean in(ScramServerErrorCode v1,
                  ScramServerErrorCode v2)

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

Parameters:

v1 - the first instance

v2 - the second instance

Returns:

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

in

public boolean in(ScramServerErrorCode v1,
                  ScramServerErrorCode v2,
                  ScramServerErrorCode v3)

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

Parameters:

v1 - the first instance

v2 - the second instance

v3 - the third instance

Returns:

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

in

public boolean in(ScramServerErrorCode... values)

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

Parameters:

values - the possible values

Returns:

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