Class CredentialUpdateCallback

java.lang.Object

org.wildfly.security.auth.callback.CredentialUpdateCallback

All Implemented Interfaces:

Callback, ExtendedCallback

public final class CredentialUpdateCallback
extends Object
implements ExtendedCallback

A callback to inform the callback handler of a credential change.

Author:

Farah Juma

Constructor Summary

Constructors

Constructor	Description
CredentialUpdateCallback(org.wildfly.security.credential.Credential credential)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
org.wildfly.security.credential.Credential	getCredential()	Get the new credential.
<C extends org.wildfly.security.credential.Credential> C	getCredential(Class<C> credentialClass)	Get the new credential, if it is of the given credential class.
boolean	isOptional()	Determine if this callback is optional.

Methods inherited from class Object

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

Methods inherited from interface ExtendedCallback

needsInformation

Constructor Details

CredentialUpdateCallback

public CredentialUpdateCallback(org.wildfly.security.credential.Credential credential)

Construct a new instance.

Parameters:

credential - the new credential

Method Details

getCredential

public org.wildfly.security.credential.Credential getCredential()

Get the new credential.

Returns:

the new credential

getCredential

public <C extends org.wildfly.security.credential.Credential>
C getCredential(Class<C> credentialClass)

Get the new credential, if it is of the given credential class.

Type Parameters:

C - the credential type

Parameters:

credentialClass - the credential class

Returns:

the credential, or null if it is not of the given type

isOptional

public boolean isOptional()

Description copied from interface: ExtendedCallback

Determine if this callback is optional.

Specified by:

isOptional in interface ExtendedCallback

Returns:

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