io.apiman.gateway.engine.auth

Enum RequiredAuthType

java.lang.Object

java.lang.Enum<RequiredAuthType>

io.apiman.gateway.engine.auth.RequiredAuthType

All Implemented Interfaces:

Serializable, Comparable<RequiredAuthType>

public enum RequiredAuthType
extends Enum<RequiredAuthType>

Enum representing Authorization types, with aliases.

Author:

Marc Savy

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC BASIC
DEFAULT Default (nothing)
MTLS Certificate-based mutual TLS/SSL

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_AUTHORIZATION_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
static RequiredAuthType	fromValue(String value) From string to enum
static RequiredAuthType	parseType(io.apiman.gateway.engine.beans.Service service) Parse service endpoint properties to retrieve enum value (if any)
static RequiredAuthType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RequiredAuthType[]	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

MTLS

public static final RequiredAuthType MTLS

Certificate-based mutual TLS/SSL

BASIC

public static final RequiredAuthType BASIC

BASIC

DEFAULT

public static final RequiredAuthType DEFAULT

Default (nothing)

Field Detail

ENDPOINT_AUTHORIZATION_TYPE

public static final String ENDPOINT_AUTHORIZATION_TYPE

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

fromValue

public static RequiredAuthType fromValue(String value)

From string to enum

Parameters:

value - the string

Returns:

the enum

parseType

public static RequiredAuthType parseType(io.apiman.gateway.engine.beans.Service service)

Parse service endpoint properties to retrieve enum value (if any)

Parameters:

service - the service

Returns:

the required auth type