org.apereo.cas.adaptors.authy

Class AuthyAuthenticationHandler

java.lang.Object

org.apereo.cas.authentication.AbstractAuthenticationHandler

org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

org.apereo.cas.adaptors.authy.AuthyAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler, PrePostAuthenticationHandler, org.springframework.core.Ordered

public class AuthyAuthenticationHandler
extends AbstractPreAndPostProcessingAuthenticationHandler

Authy authentication handler for CAS.

Since:

5.0

Field Summary

Fields inherited from class org.apereo.cas.authentication.AbstractAuthenticationHandler

principalFactory, servicesManager

Fields inherited from interface org.apereo.cas.authentication.AuthenticationHandler

SUCCESSFUL_AUTHENTICATION_HANDLERS

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AuthyAuthenticationHandler(java.lang.String name, ServicesManager servicesManager, PrincipalFactory principalFactory, AuthyClientInstance instance, boolean forceVerification)

Method Summary

Modifier and Type	Method and Description
protected HandlerResult	doAuthentication(Credential credential) Performs the details of authentication and returns an authentication handler result on success.
boolean	supports(Credential credential) Determines whether the handler has the capability to authenticate the given credential.

Methods inherited from class org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

authenticate, createHandlerResult

Methods inherited from class org.apereo.cas.authentication.AbstractAuthenticationHandler

getName, getOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.authentication.PrePostAuthenticationHandler

postAuthenticate, preAuthenticate

Methods inherited from interface org.apereo.cas.authentication.AuthenticationHandler

getName

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Detail

AuthyAuthenticationHandler

public AuthyAuthenticationHandler(java.lang.String name,
                                  ServicesManager servicesManager,
                                  PrincipalFactory principalFactory,
                                  AuthyClientInstance instance,
                                  boolean forceVerification)

Method Detail

doAuthentication

protected HandlerResult doAuthentication(Credential credential)
                                  throws java.security.GeneralSecurityException,
                                         PreventedException

Description copied from class: AbstractPreAndPostProcessingAuthenticationHandler

Performs the details of authentication and returns an authentication handler result on success.

Specified by:

doAuthentication in class AbstractPreAndPostProcessingAuthenticationHandler

Parameters:

credential - Credential to authenticate.

Returns:

Authentication handler result on success.

Throws:

java.security.GeneralSecurityException - On authentication failure that is thrown out to the caller of AbstractPreAndPostProcessingAuthenticationHandler.authenticate(Credential).

PreventedException - On the indeterminate case when authentication is prevented.

supports

public boolean supports(Credential credential)

Description copied from interface: AuthenticationHandler

Determines whether the handler has the capability to authenticate the given credential. In practical terms, the AuthenticationHandler.authenticate(Credential) method MUST be capable of processing a given credential if supports returns true on the same credential.

Parameters:

credential - The credential to check.

Returns:

True if the handler supports the Credential, false otherwise.