net.unicon.cas.mfa.web.flow.util

Class MultiFactorRequestContextUtils

java.lang.Object

net.unicon.cas.mfa.web.flow.util.MultiFactorRequestContextUtils

public final class MultiFactorRequestContextUtils
extends Object

Utility methods that facilitate retrieval and storage of MFA objects inside RequestContext.

Author:

Misagh Moayyed

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAS_AUTHENTICATION_ATTR_NAME Attribute name by which the authentication context can be retrieved/placed in the flow.
static String	CAS_MFA_CREDENTIALS_ATTR_NAME Attribute name by which the MFA credentials can be retrieved/placed in the flow.
static String	CAS_MFA_REQ_AUTHN_METHOD Attribute name by which the required authentication method can be retrieved/placed in the flow.
static String	CAS_TICKET_GRANTING_TICKET_ATTR_NAME Attribute name by which the TGT can be retrieved/placed in the flow.

Method Summary

Methods

Modifier and Type	Method and Description
static org.jasig.cas.authentication.Authentication	getAuthentication(org.springframework.webflow.execution.RequestContext context) Gets the authentication.
static <T> T	getAuthenticationExceptionInFlowScope(org.springframework.webflow.execution.RequestContext context, Class<T> clazz) Gets authentication exception in flow scope.
static MultiFactorCredentials	getMfaCredentials(org.springframework.webflow.execution.RequestContext context) Gets the mfa credentials.
static MultiFactorAuthenticationTransactionContext	getMfaTransaction(org.springframework.webflow.execution.RequestContext context) Fetch MultiFactorAuthenticationTransactionContext from flow scope.
static org.jasig.cas.authentication.principal.Principal	getMultiFactorPrimaryPrincipal(org.springframework.webflow.execution.RequestContext context) Gets the principal id.
static MultiFactorAuthenticationSupportingWebApplicationService	getMultifactorWebApplicationService(org.springframework.webflow.execution.RequestContext context) Get mfa service from flow scope.
static String	getRequiredAuthenticationMethod(org.springframework.webflow.execution.RequestContext context) Get required authentication method from flow scope.
static String	getTicketGrantingTicketId(org.springframework.webflow.execution.RequestContext context) Gets the ticket granting ticket id.
static void	setAuthentication(org.springframework.webflow.execution.RequestContext context, org.jasig.cas.authentication.Authentication auth) Sets the authentication.
static void	setAuthenticationExceptionInFlowScope(org.springframework.webflow.execution.RequestContext context, org.jasig.cas.authentication.handler.AuthenticationException e) Sets exception in flow scope.
static void	setMfaCredentials(org.springframework.webflow.execution.RequestContext context, MultiFactorCredentials credentials) Sets the mfa credentials.
static void	setMfaTransaction(org.springframework.webflow.execution.RequestContext context, MultiFactorAuthenticationTransactionContext mfaTransaction) Set mfa transaction into conversation scope.
static void	setMultifactorWebApplicationService(org.springframework.webflow.execution.RequestContext context, MultiFactorAuthenticationSupportingWebApplicationService svc) Sets the multifactor web application service.
static void	setRequiredAuthenticationMethod(org.springframework.webflow.execution.RequestContext context, String requiredAuthenticationMethod) Sets the required authentication method.
static void	setTicketGrantingTicketId(org.springframework.webflow.execution.RequestContext context, String tgtId) Sets the ticket granting ticket id.

Methods inherited from class java.lang.Object

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

Field Detail

CAS_AUTHENTICATION_ATTR_NAME

public static final String CAS_AUTHENTICATION_ATTR_NAME

Attribute name by which the authentication context can be retrieved/placed in the flow.

See Also:

Constant Field Values

CAS_TICKET_GRANTING_TICKET_ATTR_NAME

public static final String CAS_TICKET_GRANTING_TICKET_ATTR_NAME

Attribute name by which the TGT can be retrieved/placed in the flow.

See Also:

Constant Field Values

CAS_MFA_CREDENTIALS_ATTR_NAME

public static final String CAS_MFA_CREDENTIALS_ATTR_NAME

Attribute name by which the MFA credentials can be retrieved/placed in the flow.

See Also:

Constant Field Values

CAS_MFA_REQ_AUTHN_METHOD

public static final String CAS_MFA_REQ_AUTHN_METHOD

Attribute name by which the required authentication method can be retrieved/placed in the flow.

See Also:

Constant Field Values

Method Detail

getMfaCredentials

public static MultiFactorCredentials getMfaCredentials(org.springframework.webflow.execution.RequestContext context)

Gets the mfa credentials.

Parameters:

context - the context

Returns:

the mfa credentials

getTicketGrantingTicketId

public static String getTicketGrantingTicketId(org.springframework.webflow.execution.RequestContext context)

Gets the ticket granting ticket id.

Parameters:

context - the context

Returns:

the ticket granting ticket id

getAuthentication

public static org.jasig.cas.authentication.Authentication getAuthentication(org.springframework.webflow.execution.RequestContext context)

Gets the authentication.

Parameters:

context - the context

Returns:

the authentication

setMfaCredentials

public static void setMfaCredentials(org.springframework.webflow.execution.RequestContext context,
                     MultiFactorCredentials credentials)

Sets the mfa credentials.

Parameters:

context - the context

credentials - the credentials

setAuthentication

public static void setAuthentication(org.springframework.webflow.execution.RequestContext context,
                     org.jasig.cas.authentication.Authentication auth)

Sets the authentication.

Parameters:

context - the context

auth - the auth

getMultiFactorPrimaryPrincipal

public static org.jasig.cas.authentication.principal.Principal getMultiFactorPrimaryPrincipal(org.springframework.webflow.execution.RequestContext context)

Gets the principal id.

Parameters:

context - the context

Returns:

the principal id

setTicketGrantingTicketId

public static void setTicketGrantingTicketId(org.springframework.webflow.execution.RequestContext context,
                             String tgtId)

Sets the ticket granting ticket id.

Parameters:

context - the context

tgtId - the tgt id

setRequiredAuthenticationMethod

public static void setRequiredAuthenticationMethod(org.springframework.webflow.execution.RequestContext context,
                                   String requiredAuthenticationMethod)

Sets the required authentication method.

Parameters:

context - the context

requiredAuthenticationMethod - the required authentication method

getRequiredAuthenticationMethod

public static String getRequiredAuthenticationMethod(org.springframework.webflow.execution.RequestContext context)

Get required authentication method from flow scope.

Parameters:

context - the context

Returns:

authentication method or null

setMultifactorWebApplicationService

public static void setMultifactorWebApplicationService(org.springframework.webflow.execution.RequestContext context,
                                       MultiFactorAuthenticationSupportingWebApplicationService svc)

Sets the multifactor web application service.

Parameters:

context - the context

svc - the svc

getMultifactorWebApplicationService

public static MultiFactorAuthenticationSupportingWebApplicationService getMultifactorWebApplicationService(org.springframework.webflow.execution.RequestContext context)

Get mfa service from flow scope.

Parameters:

context - the context

Returns:

mfa service or null

getMfaTransaction

public static MultiFactorAuthenticationTransactionContext getMfaTransaction(org.springframework.webflow.execution.RequestContext context)

Fetch MultiFactorAuthenticationTransactionContext from flow scope.

Parameters:

context - the context

Returns:

mfa transaction or null

setMfaTransaction

public static void setMfaTransaction(org.springframework.webflow.execution.RequestContext context,
                     MultiFactorAuthenticationTransactionContext mfaTransaction)

Set mfa transaction into conversation scope.

Parameters:

context - the context

mfaTransaction - ths mfa transaction

setAuthenticationExceptionInFlowScope

public static void setAuthenticationExceptionInFlowScope(org.springframework.webflow.execution.RequestContext context,
                                         org.jasig.cas.authentication.handler.AuthenticationException e)

Sets exception in flow scope.

Parameters:

context - the context

e - the e

getAuthenticationExceptionInFlowScope

public static <T> T getAuthenticationExceptionInFlowScope(org.springframework.webflow.execution.RequestContext context,
                                          Class<T> clazz)

Gets authentication exception in flow scope.

Type Parameters:

T - the generic type to note the exception class

Parameters:

context - the context

clazz - the clazz

Returns:

the authentication exception in flow scope