Package org.wildfly.security.auth.realm

Class FailoverSecurityRealm.FailoverRealmIdentity

java.lang.Object

org.wildfly.security.auth.realm.FailoverSecurityRealm.FailoverRealmIdentity

All Implemented Interfaces:

RealmIdentity

Enclosing class:

FailoverSecurityRealm

protected abstract class FailoverSecurityRealm.FailoverRealmIdentity
extends Object
implements RealmIdentity

Field Summary

Fields

Modifier and Type	Field	Description
protected RealmIdentity	delegate
protected boolean	failed

Fields inherited from interface org.wildfly.security.auth.server.RealmIdentity

ANONYMOUS, NON_EXISTENT

Constructor Summary

Constructors

Constructor	Description
FailoverRealmIdentity(RealmIdentity identity)

Method Summary

Modifier and Type	Method	Description
<C extends Credential,R> R	applyToCredential(Class<C> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec, Function<C,R> function)	Apply the given function to the acquired credential, if it is set and of the given type, algorithm, and parameters.
<C extends Credential,R> R	applyToCredential(Class<C> credentialType, String algorithmName, Function<C,R> function)	Apply the given function to the acquired credential, if it is set and of the given type and algorithm.
<C extends Credential,R> R	applyToCredential(Class<C> credentialType, Function<C,R> function)	Apply the given function to the acquired credential, if it is set and of the given type.
protected void	disableFailover()
void	dispose()	Dispose this realm identity after a completed authentication attempt.
boolean	exists()	Determine if the identity exists in lieu of verifying or acquiring a credential.
protected RealmIdentity	failover(RealmUnavailableException rue)
Attributes	getAttributes()	Get the attributes for the realm identity.
AuthorizationIdentity	getAuthorizationIdentity()	Get an authorization identity for this pre-authenticated identity.
<C extends Credential> C	getCredential(Class<C> credentialType)	Acquire a credential of the given type.
<C extends Credential> C	getCredential(Class<C> credentialType, String algorithmName)	Acquire a credential of the given type and algorithm name.
<C extends Credential> C	getCredential(Class<C> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec)	Acquire a credential of the given type and algorithm name.
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec)	Determine whether a given credential type is definitely obtainable, possibly obtainable, or definitely not obtainable for this identity.
SupportLevel	getEvidenceVerifySupport(Class<? extends Evidence> evidenceType, String algorithmName)	Determine whether a given type of evidence is definitely verifiable, possibly verifiable, or definitely not verifiable.
protected abstract RealmIdentity	getFailoverIdentity()
Principal	getRealmIdentityPrincipal()	Get the principal that canonically identifies the identity within the realm.
void	updateCredential(Credential credential)	Update a credential of this realm identity.
boolean	verifyEvidence(Evidence evidence)	Verify the given evidence against a credential of this identity.

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.server.RealmIdentity

getCredentialAcquireSupport

Field Detail

delegate

protected RealmIdentity delegate

failed

protected boolean failed

Constructor Detail

FailoverRealmIdentity

public FailoverRealmIdentity(RealmIdentity identity)

Method Detail

getFailoverIdentity

protected abstract RealmIdentity getFailoverIdentity()
                                              throws RealmUnavailableException

Throws:

RealmUnavailableException

getCredentialAcquireSupport

public SupportLevel getCredentialAcquireSupport(Class<? extends Credential> credentialType,
                                                String algorithmName,
                                                AlgorithmParameterSpec parameterSpec)
                                         throws RealmUnavailableException

Description copied from interface: RealmIdentity

Determine whether a given credential type is definitely obtainable, possibly obtainable, or definitely not obtainable for this identity.

Specified by:

getCredentialAcquireSupport in interface RealmIdentity

Parameters:

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

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

Returns:

the level of support for this credential type (may not be null)

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

getCredential

public <C extends Credential> C getCredential(Class<C> credentialType)
                                       throws RealmUnavailableException

Description copied from interface: RealmIdentity

Acquire a credential of the given type.

Specified by:

getCredential in interface RealmIdentity

Type Parameters:

C - the credential type

Parameters:

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

Returns:

the credential, or null if no such credential exists

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

getEvidenceVerifySupport

public SupportLevel getEvidenceVerifySupport(Class<? extends Evidence> evidenceType,
                                             String algorithmName)
                                      throws RealmUnavailableException

Description copied from interface: RealmIdentity

Determine whether a given type of evidence is definitely verifiable, possibly verifiable, or definitely not verifiable.

Specified by:

getEvidenceVerifySupport in interface RealmIdentity

Parameters:

evidenceType - the type of evidence to be verified (must not be null)

algorithmName - the algorithm name, or null if any algorithm is acceptable or the evidence type does not support algorithm names

Returns:

the level of support for this evidence type

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

verifyEvidence

public boolean verifyEvidence(Evidence evidence)
                       throws RealmUnavailableException

Description copied from interface: RealmIdentity

Verify the given evidence against a credential of this identity. The credential to be used is selected based on the evidence type.

Specified by:

verifyEvidence in interface RealmIdentity

Parameters:

evidence - the evidence to verify

Returns:

true if verification was successful, false otherwise

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

exists

public boolean exists()
               throws RealmUnavailableException

Description copied from interface: RealmIdentity

Determine if the identity exists in lieu of verifying or acquiring a credential. This method is intended to be used to verify an identity for non-authentication purposes only. Implementations of this method should return false up until the point it is known that a call to RealmIdentity.getAuthorizationIdentity() can successfully return an identity. If a realm can load an identity independently of credential acquisition and evidence verification if not already loaded it should be loaded at the time of this call to return an accurate result.

Specified by:

exists in interface RealmIdentity

Returns:

true if the identity exists in this realm, false otherwise

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

updateCredential

public void updateCredential(Credential credential)
                      throws RealmUnavailableException

Description copied from interface: RealmIdentity

Update a credential of this realm identity.

Specified by:

updateCredential in interface RealmIdentity

Parameters:

credential - the new credential (must not be null)

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

getRealmIdentityPrincipal

public Principal getRealmIdentityPrincipal()

Description copied from interface: RealmIdentity

Get the principal that canonically identifies the identity within the realm. This method may return the principal object which was passed in as a parameter to SecurityRealm.getRealmIdentity(Principal) (a.k.a. domain principal), but is not required to do so. Any existent realm identity (i.e. any identity which returns true on invocation of RealmIdentity.exists()) must return a non-null principal.

Specified by:

getRealmIdentityPrincipal in interface RealmIdentity

Returns:

the principal for this realm identity (may not be null)

getCredential

public <C extends Credential> C getCredential(Class<C> credentialType,
                                              String algorithmName)
                                       throws RealmUnavailableException

Description copied from interface: RealmIdentity

Acquire a credential of the given type and algorithm name. Realms which support more than one credential of a given type must override this method.

Specified by:

getCredential in interface RealmIdentity

Type Parameters:

C - the credential type

Parameters:

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

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

Returns:

the credential, or null if no such credential exists

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

getCredential

public <C extends Credential> C getCredential(Class<C> credentialType,
                                              String algorithmName,
                                              AlgorithmParameterSpec parameterSpec)
                                       throws RealmUnavailableException

Description copied from interface: RealmIdentity

Acquire a credential of the given type and algorithm name. Realms which support more than one credential of a given type and algorithm must override this method.

Specified by:

getCredential in interface RealmIdentity

Type Parameters:

C - the credential type

Parameters:

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

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

Returns:

the credential, or null if no such credential exists

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

applyToCredential

public <C extends Credential,R> R applyToCredential(Class<C> credentialType,
                                                          Function<C,R> function)
                                                   throws RealmUnavailableException

Description copied from interface: RealmIdentity

Apply the given function to the acquired credential, if it is set and of the given type.

Specified by:

applyToCredential in interface RealmIdentity

Type Parameters:

C - the credential type

R - the return type

Parameters:

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

function - the function to apply (must not be null)

Returns:

the result of the function, or null if the criteria are not met

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

applyToCredential

public <C extends Credential,R> R applyToCredential(Class<C> credentialType,
                                                          String algorithmName,
                                                          Function<C,R> function)
                                                   throws RealmUnavailableException

Description copied from interface: RealmIdentity

Apply the given function to the acquired credential, if it is set and of the given type and algorithm.

Specified by:

applyToCredential in interface RealmIdentity

Type Parameters:

C - the credential type

R - the return type

Parameters:

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

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

function - the function to apply (must not be null)

Returns:

the result of the function, or null if the criteria are not met

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

applyToCredential

public <C extends Credential,R> R applyToCredential(Class<C> credentialType,
                                                          String algorithmName,
                                                          AlgorithmParameterSpec parameterSpec,
                                                          Function<C,R> function)
                                                   throws RealmUnavailableException

Description copied from interface: RealmIdentity

Apply the given function to the acquired credential, if it is set and of the given type, algorithm, and parameters.

Specified by:

applyToCredential in interface RealmIdentity

Type Parameters:

C - the credential type

R - the return type

Parameters:

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

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

function - the function to apply (must not be null)

Returns:

the result of the function, or null if the criteria are not met

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

dispose

public void dispose()

Description copied from interface: RealmIdentity

Dispose this realm identity after a completed authentication attempt.

Specified by:

dispose in interface RealmIdentity

getAuthorizationIdentity

public AuthorizationIdentity getAuthorizationIdentity()
                                               throws RealmUnavailableException

Description copied from interface: RealmIdentity

Get an authorization identity for this pre-authenticated identity.

Specified by:

getAuthorizationIdentity in interface RealmIdentity

Returns:

the authorization identity (may not be null)

Throws:

RealmUnavailableException - if the realm is not able to handle requests for any reason

getAttributes

public Attributes getAttributes()
                         throws RealmUnavailableException

Description copied from interface: RealmIdentity

Get the attributes for the realm identity.

Specified by:

getAttributes in interface RealmIdentity

Returns:

the attributes, or null if the implementing class does not support getting attributes

Throws:

RealmUnavailableException - if accessing the attributes fails for some reason

failover

protected RealmIdentity failover(RealmUnavailableException rue)
                          throws RealmUnavailableException

Throws:

RealmUnavailableException

disableFailover

protected void disableFailover()