net.unicon.cas.mfa

Class AbstractMultiFactorAuthenticationProtocolValidationSpecification

java.lang.Object

org.jasig.cas.validation.AbstractCasProtocolValidationSpecification

org.jasig.cas.validation.Cas20ProtocolValidationSpecification

net.unicon.cas.mfa.AbstractMultiFactorAuthenticationProtocolValidationSpecification

All Implemented Interfaces:

org.jasig.cas.validation.ValidationSpecification

Direct Known Subclasses:

AbstractMultiFactorAuthenticationProtocolValidationSpecification.WithoutProxy, AbstractMultiFactorAuthenticationProtocolValidationSpecification.WithProxy

public abstract class AbstractMultiFactorAuthenticationProtocolValidationSpecification
extends org.jasig.cas.validation.Cas20ProtocolValidationSpecification

Validate the requested protocol spec, primarily based on the requested authentication method.

Author:

Misagh Moayyed

See Also:

MultiFactorServiceValidateController

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMultiFactorAuthenticationProtocolValidationSpecification.WithoutProxy An MFA validator that does not handles proxy authentications.
static class	AbstractMultiFactorAuthenticationProtocolValidationSpecification.WithProxy An MFA validator that handles proxy authentications.

Constructor Summary

Constructors

Constructor and Description
AbstractMultiFactorAuthenticationProtocolValidationSpecification(boolean validateProxyAuthenticationRequests) Constructor to spin up the validation spec instance.
AbstractMultiFactorAuthenticationProtocolValidationSpecification(String authnMethod) Constructor to spin up the validation spec instance, requiring a particular authentication method.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthenticationMethod()
protected boolean	isSatisfiedByInternal(org.jasig.cas.validation.Assertion assertion)
void	setAuthenticationMethod(String authnMethod)

Methods inherited from class org.jasig.cas.validation.AbstractCasProtocolValidationSpecification

isRenew, isSatisfiedBy, setRenew

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMultiFactorAuthenticationProtocolValidationSpecification

public AbstractMultiFactorAuthenticationProtocolValidationSpecification(boolean validateProxyAuthenticationRequests)

Constructor to spin up the validation spec instance. No restrictions on the requested authentication method.

Parameters:

validateProxyAuthenticationRequests - flag

AbstractMultiFactorAuthenticationProtocolValidationSpecification

public AbstractMultiFactorAuthenticationProtocolValidationSpecification(String authnMethod)

Constructor to spin up the validation spec instance, requiring a particular authentication method.

Parameters:

authnMethod - required authentication method to match against.

Method Detail

setAuthenticationMethod

public final void setAuthenticationMethod(String authnMethod)

getAuthenticationMethod

public final String getAuthenticationMethod()

isSatisfiedByInternal

protected final boolean isSatisfiedByInternal(org.jasig.cas.validation.Assertion assertion)

Validate the requested authentication method for this validation request. If the produced assertion cannot satisfy the authentication method requested, an instance of UnacceptableMultiFactorAuthenticationMethodException will be thrown. If the authentication method used by the assertion is not blank, but does not match the requested authentication method, an instance of UnrecognizedMultiFactorAuthenticationMethodException will be thrown.

Note: The current isSatisfiedByInternal(Assertion) method signature only allows for returning of a boolean value indicating whether the assertion can satisfy the requested protocol. This is not sufficient to fully explain the context of a validation failure, as in the case of multifactor authentication, whether the authentication method is unrecognized or unacceptable. In order to accommodate this, and rather than changing the method signature to return more than just a boolean, the implementation opts to throwing specific exceptions in order to indicate the context of the failure. Exceptions are unchecked, yet are expected to be caught by the caller in order to digest the failure.

Overrides:

isSatisfiedByInternal in class org.jasig.cas.validation.Cas20ProtocolValidationSpecification

See Also:

UnacceptableMultiFactorAuthenticationMethodException, UnrecognizedMultiFactorAuthenticationMethodException