Package org.wildfly.security.auth.callback

Class IdentityCredentialCallback

java.lang.Object

org.wildfly.security.auth.callback.IdentityCredentialCallback

All Implemented Interfaces:

Callback, ExtendedCallback

public final class IdentityCredentialCallback
extends Object
implements ExtendedCallback

A callback to inform a server authentication mechanism of a credential which may be cached on the authentication identity (if any). The credential may be public or private.

Author:

David M. Lloyd

Field Summary

Fields

Modifier and Type	Field	Description
private Credential	credential
private boolean	isPrivate

Constructor Summary

Constructors

Constructor	Description
IdentityCredentialCallback(Credential credential, boolean isPrivate)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
Credential	getCredential()	Get the credential.
boolean	isPrivate()	Determine whether the credential should be treated as private.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.auth.callback.ExtendedCallback

isOptional, needsInformation

Field Detail

credential

private final Credential credential

isPrivate

private final boolean isPrivate

Constructor Detail

IdentityCredentialCallback

public IdentityCredentialCallback(Credential credential,
                                  boolean isPrivate)

Construct a new instance.

Parameters:

credential - the credential (must not be null)

isPrivate - true if the credential should be private, false if it can be public

Method Detail

getCredential

public Credential getCredential()

Get the credential.

Returns:

the credential (not null)

isPrivate

public boolean isPrivate()

Determine whether the credential should be treated as private.

Returns:

true to treat the credential as private, false otherwise