Package com.ongres.scram.common
Enum Gs2Attributes
- java.lang.Object
-
- java.lang.Enum<Gs2Attributes>
-
- com.ongres.scram.common.Gs2Attributes
-
- All Implemented Interfaces:
CharSupplier
,java.io.Serializable
,java.lang.Comparable<Gs2Attributes>
enum Gs2Attributes extends java.lang.Enum<Gs2Attributes> implements CharSupplier
Possible values of a GS2 Attribute.- See Also:
- [RFC5802] Formal Syntax
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AUTHZID
SCRAM attribute.CHANNEL_BINDING_REQUIRED
Channel binding attribute.CLIENT_NOT
Channel binding attribute.CLIENT_YES_SERVER_NOT
Channel binding attribute.
-
Field Summary
Fields Modifier and Type Field Description private char
flag
private boolean
requiredValue
-
Constructor Summary
Constructors Modifier Constructor Description private
Gs2Attributes(char flag, boolean requiredValue)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) static @NotNull Gs2Attributes
byChar(char c)
(package private) static @NotNull Gs2Attributes
byGs2CbindFlag(Gs2CbindFlag cbindFlag)
char
getChar()
Return the char used to represent this attribute.(package private) boolean
isRequiredValue()
static Gs2Attributes
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static Gs2Attributes[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CLIENT_NOT
public static final Gs2Attributes CLIENT_NOT
Channel binding attribute. Client doesn't support channel binding.
-
CLIENT_YES_SERVER_NOT
public static final Gs2Attributes CLIENT_YES_SERVER_NOT
Channel binding attribute. Client does support channel binding but thinks the server does not.
-
CHANNEL_BINDING_REQUIRED
public static final Gs2Attributes CHANNEL_BINDING_REQUIRED
Channel binding attribute. Client requires channel binding. The selected channel binding follows "p=".
-
AUTHZID
public static final Gs2Attributes AUTHZID
SCRAM attribute. This attribute specifies an authorization identity.
-
-
Method Detail
-
values
public static Gs2Attributes[] 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 (Gs2Attributes c : Gs2Attributes.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Gs2Attributes valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getChar
public char getChar()
Description copied from interface:CharSupplier
Return the char used to represent this attribute.- Specified by:
getChar
in interfaceCharSupplier
- Returns:
- The character of the attribute
-
isRequiredValue
boolean isRequiredValue()
-
byChar
@NotNull static @NotNull Gs2Attributes byChar(char c)
-
byGs2CbindFlag
@NotNull static @NotNull Gs2Attributes byGs2CbindFlag(Gs2CbindFlag cbindFlag)
-
-