Package org.wildfly.security.auth.callback

Class ServerCredentialCallback

java.lang.Object

org.wildfly.security.auth.callback.AbstractCredentialCallback

org.wildfly.security.auth.callback.ServerCredentialCallback

All Implemented Interfaces:

Callback, ExtendedCallback

public final class ServerCredentialCallback
extends AbstractCredentialCallback

A callback used to acquire the server (or "host") credential. This callback is only used on the server side of authentication mechanisms; client callback handlers do not need to recognize this callback. The callback handler is expected to provide a credential to this callback. If no credential is available, null is set, and authentication may fail. If an unsupported credential type is set, an exception is thrown.

Author:

David M. Lloyd

Constructor Summary

Constructors

Constructor	Description
ServerCredentialCallback(Class<? extends Credential> credentialType)	Construct a new instance which accepts any algorithm name.
ServerCredentialCallback(Class<? extends Credential> credentialType, String algorithm)	Construct a new instance.
ServerCredentialCallback(Class<? extends Credential> credentialType, String algorithm, AlgorithmParameterSpec parameterSpec)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	isOptional()	Determine if this callback is optional.

Methods inherited from class org.wildfly.security.auth.callback.AbstractCredentialCallback

applyToCredential, applyToCredential, applyToCredential, getAlgorithm, getCredential, getCredential, getCredential, getCredential, getCredentialType, getParameterSpec, isCredentialSupported, isCredentialTypeSupported, isCredentialTypeSupported, isCredentialTypeSupported, needsInformation, setCredential

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerCredentialCallback

public ServerCredentialCallback(Class<? extends Credential> credentialType,
                                String algorithm,
                                AlgorithmParameterSpec parameterSpec)

Construct a new instance.

Parameters:

credentialType - the desired credential type (must not be null)

algorithm - the algorithm name, or null if any algorithm is suitable or the credential type does not use algorithm names

parameterSpec - the parameters to use or null for no parameters

ServerCredentialCallback

public ServerCredentialCallback(Class<? extends Credential> credentialType,
                                String algorithm)

Construct a new instance.

Parameters:

credentialType - the desired credential type (must not be null)

algorithm - the algorithm name, or null if any algorithm is suitable or the credential type does not use algorithm names

ServerCredentialCallback

public ServerCredentialCallback(Class<? extends Credential> credentialType)

Construct a new instance which accepts any algorithm name.

Parameters:

credentialType - the desired credential type (must not be null)

Method Detail

isOptional

public boolean isOptional()

Description copied from interface: ExtendedCallback

Determine if this callback is optional.

Returns:

true if the callback is optional, false if it is mandatory