io.rsocket.metadata

Enum WellKnownAuthType

java.lang.Object

java.lang.Enum<WellKnownAuthType>

io.rsocket.metadata.WellKnownAuthType

All Implemented Interfaces:

Serializable, Comparable<WellKnownAuthType>

public enum WellKnownAuthType
extends Enum<WellKnownAuthType>

Enumeration of Well Known Auth Types, as defined in the eponymous extension. Such auth types are used in composite metadata (which can include routing and/or tracing metadata). Per specification, identifiers are between 0 and 127 (inclusive).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEARER
SIMPLE
UNKNOWN_RESERVED_AUTH_TYPE
UNPARSEABLE_AUTH_TYPE

Method Summary

Modifier and Type	Method and Description
static WellKnownAuthType	fromIdentifier(int id) Find the WellKnownAuthType for the given identifier (as an int).
static WellKnownAuthType	fromString(String authType) Find the WellKnownAuthType for the given String representation.
byte	getIdentifier()
String	getString()
String	toString()
static WellKnownAuthType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WellKnownAuthType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNPARSEABLE_AUTH_TYPE

public static final WellKnownAuthType UNPARSEABLE_AUTH_TYPE

UNKNOWN_RESERVED_AUTH_TYPE

public static final WellKnownAuthType UNKNOWN_RESERVED_AUTH_TYPE

SIMPLE

public static final WellKnownAuthType SIMPLE

BEARER

public static final WellKnownAuthType BEARER

Method Detail

values

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

Returns:

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

valueOf

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

fromIdentifier

public static WellKnownAuthType fromIdentifier(int id)

Find the WellKnownAuthType for the given identifier (as an int). Valid identifiers are defined to be integers between 0 and 127, inclusive. Identifiers outside of this range will produce the UNPARSEABLE_AUTH_TYPE. Additionally, some identifiers in that range are still only reserved and don't have a type associated yet: this method returns the UNKNOWN_RESERVED_AUTH_TYPE when passing such an identifier, which lets call sites potentially detect this and keep the original representation when transmitting the associated metadata buffer.

Parameters:

id - the looked up identifier

Returns:

the WellKnownAuthType, or UNKNOWN_RESERVED_AUTH_TYPE if the id is out of the specification's range, or UNKNOWN_RESERVED_AUTH_TYPE if the id is one that is merely reserved but unknown to this implementation.

fromString

public static WellKnownAuthType fromString(String authType)

Find the WellKnownAuthType for the given String representation. If the representation is null or doesn't match a WellKnownAuthType, the UNPARSEABLE_AUTH_TYPE is returned.

Parameters:

authType - the looked up auth type

Returns:

the matching WellKnownAuthType, or UNPARSEABLE_AUTH_TYPE if none matches

getIdentifier

public byte getIdentifier()

Returns:

the byte identifier of the auth type, guaranteed to be positive or zero.

getString

public String getString()

Returns:

the auth type represented as a String, which is made of US_ASCII compatible characters only

toString

public String toString()

Overrides:

toString in class Enum<WellKnownAuthType>

See Also:

getString()