io.rsocket.routing.common

Enum WellKnownKey

java.lang.Object

java.lang.Enum<WellKnownKey>

io.rsocket.routing.common.WellKnownKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WellKnownKey>

public enum WellKnownKey
extends java.lang.Enum<WellKnownKey>

https://github.com/rsocket/rsocket/blob/feature/rf/Extensions/Routing-And-Forwarding.md#well-known-keys

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROKER_EXTENSION
CLUSTER_NAME
COUNTRY
DEVICE
DNS
ENVIRONMENT
INSTANCE_NAME
IPV4
IPV6
LB_METHOD
MAJOR_VERSION
MINOR_VERSION
NO_TAG
OS
PATCH_VERSION
PROVIDER
REGION
ROUTE_ID
SERVICE_NAME
SHARD_KEY
SHARD_METHOD
STICKY_ROUTE_KEY
TESTC_ELL
TIME_ZONE
UNKNOWN_RESERVED_KEY
UNPARSEABLE_KEY
USER_ID
USER_NAME
VERSION
WELL_KNOWN_EXTENSION
ZONE

Method Summary

Modifier and Type	Method and Description
static WellKnownKey	fromIdentifier(int id)
static WellKnownKey	fromMimeType(java.lang.String mimeType)
byte	getIdentifier()
Key	getKey()
java.lang.String	getString()
java.lang.String	toString()
static WellKnownKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WellKnownKey[]	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_KEY

public static final WellKnownKey UNPARSEABLE_KEY

UNKNOWN_RESERVED_KEY

public static final WellKnownKey UNKNOWN_RESERVED_KEY

NO_TAG

public static final WellKnownKey NO_TAG

SERVICE_NAME

public static final WellKnownKey SERVICE_NAME

ROUTE_ID

public static final WellKnownKey ROUTE_ID

INSTANCE_NAME

public static final WellKnownKey INSTANCE_NAME

CLUSTER_NAME

public static final WellKnownKey CLUSTER_NAME

PROVIDER

public static final WellKnownKey PROVIDER

REGION

public static final WellKnownKey REGION

ZONE

public static final WellKnownKey ZONE

DEVICE

public static final WellKnownKey DEVICE

OS

public static final WellKnownKey OS

USER_NAME

public static final WellKnownKey USER_NAME

USER_ID

public static final WellKnownKey USER_ID

MAJOR_VERSION

public static final WellKnownKey MAJOR_VERSION

MINOR_VERSION

public static final WellKnownKey MINOR_VERSION

PATCH_VERSION

public static final WellKnownKey PATCH_VERSION

VERSION

public static final WellKnownKey VERSION

ENVIRONMENT

public static final WellKnownKey ENVIRONMENT

TESTC_ELL

public static final WellKnownKey TESTC_ELL

DNS

public static final WellKnownKey DNS

IPV4

public static final WellKnownKey IPV4

IPV6

public static final WellKnownKey IPV6

COUNTRY

public static final WellKnownKey COUNTRY

TIME_ZONE

public static final WellKnownKey TIME_ZONE

SHARD_KEY

public static final WellKnownKey SHARD_KEY

SHARD_METHOD

public static final WellKnownKey SHARD_METHOD

STICKY_ROUTE_KEY

public static final WellKnownKey STICKY_ROUTE_KEY

LB_METHOD

public static final WellKnownKey LB_METHOD

BROKER_EXTENSION

public static final WellKnownKey BROKER_EXTENSION

WELL_KNOWN_EXTENSION

public static final WellKnownKey WELL_KNOWN_EXTENSION

Method Detail

values

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

Returns:

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

valueOf

public static WellKnownKey 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 name

java.lang.NullPointerException - if the argument is null

fromIdentifier

public static WellKnownKey fromIdentifier(int id)

fromMimeType

public static WellKnownKey fromMimeType(java.lang.String mimeType)

getIdentifier

public byte getIdentifier()

Returns:

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

getString

public java.lang.String getString()

Returns:

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

getKey

public Key getKey()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<WellKnownKey>

See Also:

getString()