org.apereo.cas.authentication

Class AuthenticationCredentialsLocalBinder

java.lang.Object

org.apereo.cas.authentication.AuthenticationCredentialsLocalBinder

public class AuthenticationCredentialsLocalBinder
extends java.lang.Object

ThreadLocal based holder for current set of credentials and/or authentication object for any current CAS authentication transaction. Useful for making this information available to all the interested CAS components that are not tightly coupled with core CAS APIs, for example audit principal resolver component, etc.

The thread local state carried by this class should be set by core CAS components processing core authentication and CAS protocol events e.g. AuthenticationManager, CentralAuthenticationService, etc.

The clearing of this state at the end of a thread execution path is the responsibility of AuthenticationCredentialsLocalBinderClearingFilter

Since:

5.0.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthenticationCredentialsLocalBinder()

Method Summary

Modifier and Type	Method and Description
static void	bindCurrent(org.apereo.cas.authentication.Authentication authentication) Bind Authentication to ThreadLocal.
static void	bindCurrent(org.apereo.cas.authentication.AuthenticationBuilder builder) Bind AuthenticationBuilder to ThreadLocal.
static void	bindCurrent(java.util.Collection<org.apereo.cas.authentication.Credential> credentials) Bind credentials to ThreadLocal.
static void	bindCurrent(org.apereo.cas.authentication.Credential... credentials) Bind credentials to ThreadLocal.
static void	clear() Clear ThreadLocal state.
static org.apereo.cas.authentication.Authentication	getCurrentAuthentication() Get Authentication from ThreadLocal.
static org.apereo.cas.authentication.AuthenticationBuilder	getCurrentAuthenticationBuilder() Get AuthenticationBuilder from ThreadLocal.
static java.lang.String[]	getCurrentCredentialIds() Get credential ids from ThreadLocal.
static java.lang.String	getCurrentCredentialIdsAsString() Get credential ids String representation from ThreadLocal.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationCredentialsLocalBinder

protected AuthenticationCredentialsLocalBinder()

Method Detail

bindCurrent

public static void bindCurrent(java.util.Collection<org.apereo.cas.authentication.Credential> credentials)

Bind credentials to ThreadLocal.

Parameters:

credentials - the credentials

bindCurrent

public static void bindCurrent(org.apereo.cas.authentication.Credential... credentials)

Bind credentials to ThreadLocal.

Parameters:

credentials - the credentials

bindCurrent

public static void bindCurrent(org.apereo.cas.authentication.Authentication authentication)

Bind Authentication to ThreadLocal.

Parameters:

authentication - the authentication

bindCurrent

public static void bindCurrent(org.apereo.cas.authentication.AuthenticationBuilder builder)

Bind AuthenticationBuilder to ThreadLocal.

Parameters:

builder - the authentication builder

getCurrentCredentialIds

public static java.lang.String[] getCurrentCredentialIds()

Get credential ids from ThreadLocal.

Returns:

credential ids

getCurrentCredentialIdsAsString

public static java.lang.String getCurrentCredentialIdsAsString()

Get credential ids String representation from ThreadLocal.

Returns:

credential ids String representation

getCurrentAuthenticationBuilder

public static org.apereo.cas.authentication.AuthenticationBuilder getCurrentAuthenticationBuilder()

Get AuthenticationBuilder from ThreadLocal.

Returns:

authentication builder

getCurrentAuthentication

public static org.apereo.cas.authentication.Authentication getCurrentAuthentication()

Get Authentication from ThreadLocal.

Returns:

authentication

clear

public static void clear()

Clear ThreadLocal state.