Package com.authlete.common.types

Enum FapiMode

java.lang.Object

java.lang.Enum<FapiMode>

com.authlete.common.types.FapiMode

All Implemented Interfaces:

Serializable, Comparable<FapiMode>

public enum FapiMode
extends Enum<FapiMode>

FAPI mode.

Since:

3.80

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAPI1_ADVANCED	"fapi1_advanced" (2).
FAPI1_BASELINE	"fapi1_baseline" (1).
FAPI2_MESSAGE_SIGNING_AUTH_REQ	"fapi2_message_signing_auth_req" (4).
FAPI2_MESSAGE_SIGNING_AUTH_RES	"fapi2_message_signing_auth_res" (5).
FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES	"fapi2_message_signing_introspection_res" (6).
FAPI2_MESSAGE_SIGNING_RESOURCE_REQ	"fapi2_message_signing_resource_req" (7).
FAPI2_MESSAGE_SIGNING_RESOURCE_RES	"fapi2_message_signing_resource_res" (8).
FAPI2_SECURITY	"fapi2_security" (3).

Method Summary

Modifier and Type	Method	Description
static FapiMode	getByValue(short value)	Find an instance of this enum by a value.
short	getValue()	Get the integer representation of this enum instance.
static FapiMode	parse(String fapiMode)	Convert String to FapiMode.
static FapiMode[]	toArray(int bits)
int	toBits()	Convert the value to bits.
static int	toBits(EnumSet<FapiMode> set)
static EnumSet<FapiMode>	toSet(int bits)
static EnumSet<FapiMode>	toSet(FapiMode[] array)
String	toString()
static FapiMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FapiMode[]	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

FAPI1_BASELINE

public static final FapiMode FAPI1_BASELINE

"fapi1_baseline" (1).

The FAPI mode for " Financial-grade API Security Profile 1.0 - Part 1: Baseline".

FAPI1_ADVANCED

public static final FapiMode FAPI1_ADVANCED

"fapi1_advanced" (2).

The FAPI mode for " Financial-grade API Security Profile 1.0 - Part 2: Advanced".

FAPI2_SECURITY

public static final FapiMode FAPI2_SECURITY

"fapi2_security" (3).

The FAPI mode for " FAPI 2.0 Security Profile".

FAPI2_MESSAGE_SIGNING_AUTH_REQ

public static final FapiMode FAPI2_MESSAGE_SIGNING_AUTH_REQ

"fapi2_message_signing_auth_req" (4).

The FAPI mode for " 5.3. Signing Authorization Requests" of "FAPI 2.0 Message Signing Profile".

FAPI2_MESSAGE_SIGNING_AUTH_RES

public static final FapiMode FAPI2_MESSAGE_SIGNING_AUTH_RES

"fapi2_message_signing_auth_res" (5).

The FAPI mode for " 5.4. Signing Authorization Responses" of "FAPI 2.0 Message Signing Profile".

FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES

public static final FapiMode FAPI2_MESSAGE_SIGNING_INTROSPECTION_RES

"fapi2_message_signing_introspection_res" (6).

The FAPI mode for " 5.5. Signing Introspection Responses" of "FAPI 2.0 Message Signing Profile".

FAPI2_MESSAGE_SIGNING_RESOURCE_REQ

public static final FapiMode FAPI2_MESSAGE_SIGNING_RESOURCE_REQ

"fapi2_message_signing_resource_req" (7).

The FAPI mode for "5.6.1. Requirements for signing and verifying resource requests" of "FAPI 2.0 Message Signing".

Since:

4.10

FAPI2_MESSAGE_SIGNING_RESOURCE_RES

public static final FapiMode FAPI2_MESSAGE_SIGNING_RESOURCE_RES

"fapi2_message_signing_resource_res" (8).

The FAPI mode for "5.6.2. Requirements for signing and verifying resource responses" of "FAPI 2.0 Message Signing".

Since:

4.10

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public short getValue()

Get the integer representation of this enum instance.

toString

public String toString()

Overrides:

toString in class Enum<FapiMode>

toBits

public int toBits()

Convert the value to bits.

getByValue

public static FapiMode getByValue(short value)

Find an instance of this enum by a value.

Parameters:

value - The integer representation of the instance to find.

Returns:

An instance of this enum, or null if not found.

parse

public static FapiMode parse(String fapiMode)

Convert String to FapiMode.

Parameters:

fapiMode - A FAPI mode. For example, "fapi1_advanced".

Returns:

FapiMode instance, or null.

toBits

public static int toBits(EnumSet<FapiMode> set)

toArray

public static FapiMode[] toArray(int bits)

toSet

public static EnumSet<FapiMode> toSet(int bits)

toSet

public static EnumSet<FapiMode> toSet(FapiMode[] array)