io.mats3.matssocket

Enum AuthenticationPlugin.DebugOption

java.lang.Object

java.lang.Enum<AuthenticationPlugin.DebugOption>

io.mats3.matssocket.AuthenticationPlugin.DebugOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuthenticationPlugin.DebugOption>

Enclosing interface:

AuthenticationPlugin

public static enum AuthenticationPlugin.DebugOption
extends java.lang.Enum<AuthenticationPlugin.DebugOption>

These bit-field enums (bit-field) is used by the Client to request different types of debug/meta information from Server-side, and used by the AuthenticationPlugin to tell the MatsSocketServer which types of information the specific user is allowed to request - the resulting debug/meta information provided is the intersection of the requested + allowed.

In addition to the functionality from the MatsSocket system, there is two "Custom Options" (CUSTOM_A and CUSTOM_B) that are not employed by the MatsSocket system, but instead can be utilized and given meaning by the MatsSocket employing service/application. Notice, however: You might be just as well off by implementing such functionality on the Principal returned by the AuthenticationPlugin ("this user is allowed to request these things") - and on the request DTOs from the Client ("I would like to request these things").

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM_A AuthenticationPlugin-specific "Option A" - this is not used by MatsSocket itself, but can be employed and given a meaning by the AuthenticationPlugin.
CUSTOM_B AuthenticationPlugin-specific "Option B" - this is not used by MatsSocket itself, but can be employed and given a meaning by the AuthenticationPlugin.
NODES Node-name of the handling nodes of the separate phases.
TIMESTAMPS Timestamp info for the separate phases.

Method Summary

Modifier and Type	Method and Description
static java.util.EnumSet<AuthenticationPlugin.DebugOption>	enumSetOf(int flags)
static java.util.EnumSet<AuthenticationPlugin.DebugOption>	enumSetOf(java.lang.Integer flags)
static int	flags(java.util.EnumSet<AuthenticationPlugin.DebugOption> debugOptions)
static AuthenticationPlugin.DebugOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuthenticationPlugin.DebugOption[]	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

TIMESTAMPS

public static final AuthenticationPlugin.DebugOption TIMESTAMPS

Timestamp info for the separate phases. Note that time-skew between different nodes must be taken into account.

NODES

public static final AuthenticationPlugin.DebugOption NODES

Node-name of the handling nodes of the separate phases.

CUSTOM_A

public static final AuthenticationPlugin.DebugOption CUSTOM_A

AuthenticationPlugin-specific "Option A" - this is not used by MatsSocket itself, but can be employed and given a meaning by the AuthenticationPlugin.

Notice: You might be just as well off by implementing such functionality on the Principal returned by the AuthenticationPlugin ("this user is allowed to request these things") - and on the request DTOs from the Client ("I would like to request these things").

CUSTOM_B

public static final AuthenticationPlugin.DebugOption CUSTOM_B

AuthenticationPlugin-specific "Option B" - this is not used by MatsSocket itself, but can be employed and given a meaning by the AuthenticationPlugin.

Notice: You might be just as well off by implementing such functionality on the Principal returned by the AuthenticationPlugin ("this user is allowed to request these things") - and on the request DTOs from the Client ("I would like to request these things").

Method Detail

values

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

Returns:

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

valueOf

public static AuthenticationPlugin.DebugOption 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

enumSetOf

public static java.util.EnumSet<AuthenticationPlugin.DebugOption> enumSetOf(int flags)

enumSetOf

public static java.util.EnumSet<AuthenticationPlugin.DebugOption> enumSetOf(java.lang.Integer flags)

flags

public static int flags(java.util.EnumSet<AuthenticationPlugin.DebugOption> debugOptions)