io.stargate.auth

Enum SourceAPI

java.lang.Object

java.lang.Enum<SourceAPI>

io.stargate.auth.SourceAPI

All Implemented Interfaces:

Serializable, Comparable<SourceAPI>

public enum SourceAPI
extends Enum<SourceAPI>

Defines what API is a source of the request performing the authorization.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CQL Used for CQL traffic (and gRPC).
GRAPHQL Used for GraphQL API.
REST Used for REST and Docs API, as historically they were one.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_PAYLOAD_KEY

Method Summary

Modifier and Type	Method and Description
static SourceAPI	fromCustomPayload(Map<String,ByteBuffer> customPayload, SourceAPI defaultIfMissing)
String	getName()
void	toCustomPayload(Map<String,ByteBuffer> customPayload)
static SourceAPI	valueOf(String name) Returns the enum constant of this type with the specified name.
static SourceAPI[]	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

GRAPHQL

public static final SourceAPI GRAPHQL

Used for GraphQL API.

CQL

public static final SourceAPI CQL

Used for CQL traffic (and gRPC).

REST

public static final SourceAPI REST

Used for REST and Docs API, as historically they were one.

Field Detail

CUSTOM_PAYLOAD_KEY

public static final String CUSTOM_PAYLOAD_KEY

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

toCustomPayload

public void toCustomPayload(Map<String,ByteBuffer> customPayload)

fromCustomPayload

public static SourceAPI fromCustomPayload(Map<String,ByteBuffer> customPayload,
                                          SourceAPI defaultIfMissing)