org.wildfly.security.auth.client

Enum CallbackKind

java.lang.Object

java.lang.Enum<CallbackKind>

org.wildfly.security.auth.client.CallbackKind

All Implemented Interfaces:

Serializable, Comparable<CallbackKind>

public enum CallbackKind
extends Enum<CallbackKind>

The kinds of callbacks which can be handled by the user's callback.

Author:

David M. Lloyd

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL_BINDING Callbacks which configure channel binding options: ChannelBindingCallback
CHOICE Callbacks which extend ChoiceCallback (not including RealmChoiceCallback).
CREDENTIAL Callbacks which select a credential to use for authentication: PasswordCallback and CredentialCallback
CREDENTIAL_RESET Callbacks which handle local credential-reset requests: PasswordResetCallback
GENERAL_INPUT Callbacks which provide general input: TextInputCallback
GENERAL_OUTPUT Callbacks which provide general output: TextOutputCallback
PARAMETERS Callbacks which select algorithm parameters to use for authentication: ParameterCallback
PEER_CREDENTIAL Callbacks which handle or verify the peer's credentials: EvidenceVerifyCallback
PEER_PRINCIPAL Callbacks which accept the peer's name or principal: server side NameCallback
PRINCIPAL Callbacks which select a user name or principal: client side NameCallback
REALM Callbacks which select the mechanism realm: RealmChoiceCallback and RealmCallback
SERVER_TRUSTED_AUTHORITIES Callbacks which accept the server's trusted authorities: TrustedAuthoritiesCallback
SSL Callbacks which deal with SSL configuration: SSLCallback

Method Summary

Modifier and Type	Method and Description
boolean	in(CallbackKind... values) Determine whether this instance is equal to one of the given instances.
boolean	in(CallbackKind v1) Determine whether this instance is equal to one of the given instances.
boolean	in(CallbackKind v1, CallbackKind v2) Determine whether this instance is equal to one of the given instances.
boolean	in(CallbackKind v1, CallbackKind v2, CallbackKind v3) Determine whether this instance is equal to one of the given instances.
static boolean	isFull(EnumSet<CallbackKind> set) Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.
static CallbackKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static CallbackKind[]	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

PRINCIPAL

public static final CallbackKind PRINCIPAL

Callbacks which select a user name or principal: client side NameCallback

CREDENTIAL

public static final CallbackKind CREDENTIAL

Callbacks which select a credential to use for authentication: PasswordCallback and CredentialCallback

CREDENTIAL_RESET

public static final CallbackKind CREDENTIAL_RESET

Callbacks which handle local credential-reset requests: PasswordResetCallback

REALM

public static final CallbackKind REALM

Callbacks which select the mechanism realm: RealmChoiceCallback and RealmCallback

PEER_PRINCIPAL

public static final CallbackKind PEER_PRINCIPAL

Callbacks which accept the peer's name or principal: server side NameCallback

PEER_CREDENTIAL

public static final CallbackKind PEER_CREDENTIAL

Callbacks which handle or verify the peer's credentials: EvidenceVerifyCallback

CHOICE

public static final CallbackKind CHOICE

Callbacks which extend ChoiceCallback (not including RealmChoiceCallback).

PARAMETERS

public static final CallbackKind PARAMETERS

Callbacks which select algorithm parameters to use for authentication: ParameterCallback

SERVER_TRUSTED_AUTHORITIES

public static final CallbackKind SERVER_TRUSTED_AUTHORITIES

Callbacks which accept the server's trusted authorities: TrustedAuthoritiesCallback

GENERAL_OUTPUT

public static final CallbackKind GENERAL_OUTPUT

Callbacks which provide general output: TextOutputCallback

GENERAL_INPUT

public static final CallbackKind GENERAL_INPUT

Callbacks which provide general input: TextInputCallback

SSL

public static final CallbackKind SSL

Callbacks which deal with SSL configuration: SSLCallback

CHANNEL_BINDING

public static final CallbackKind CHANNEL_BINDING

Callbacks which configure channel binding options: ChannelBindingCallback

Method Detail

values

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

Returns:

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

valueOf

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

isFull

public static boolean isFull(EnumSet<CallbackKind> set)

Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.

Parameters:

set - the set

Returns:

true if the set is full, false otherwise

in

public boolean in(CallbackKind v1)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(CallbackKind v1,
                  CallbackKind v2)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(CallbackKind v1,
                  CallbackKind v2,
                  CallbackKind v3)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

v3 - the third instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(CallbackKind... values)

Determine whether this instance is equal to one of the given instances.

Parameters:

values - the possible values

Returns:

true if one of the instances matches this one, false otherwise