org.ikasan.console.security.service.authentication

Class LdapAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.ikasan.console.security.service.authentication.LdapAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

public class LdapAuthenticationToken
extends org.springframework.security.authentication.AbstractAuthenticationToken

Authentication token to use when an application needs further access to the LDAP context used to authenticate the user.

When this is the Authentication object stored in the Spring Security context, an application can retrieve the current LDAP context thusly:

 LdapAuthenticationToken ldapAuth = (LdapAuthenticationToken) SecurityContextHolder.getContext().getAuthentication();
 InitialLdapContext ldapContext = ldapAuth.getContext();
 

Author:

Ikasan Development Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LdapAuthenticationToken(org.springframework.security.core.Authentication auth, org.springframework.security.core.GrantedAuthority defaultAuthority) Construct a new LdapAuthenticationToken, using an existing Authentication object and a default authority.
LdapAuthenticationToken(org.springframework.security.core.Authentication auth, String defaultAuthority) Construct a new LdapAuthenticationToken, using an existing Authentication object and a default authority.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthorities(Collection<? extends org.springframework.security.core.GrantedAuthority> authoritiesToAdd) Add authorities to the list of granted authorities
void	addAuthority(org.springframework.security.core.GrantedAuthority authority) Add an authority to the list of granted authorities
Collection<org.springframework.security.core.GrantedAuthority>	getAuthorities()
InitialLdapContext	getContext() Retrieve the LDAP context attached to this user's authentication object.
Object	getCredentials()
Object	getPrincipal()
void	setContext(InitialLdapContext context) Attach an LDAP context to this user's authentication object.

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LdapAuthenticationToken

public LdapAuthenticationToken(org.springframework.security.core.Authentication auth,
                       org.springframework.security.core.GrantedAuthority defaultAuthority)

Construct a new LdapAuthenticationToken, using an existing Authentication object and a default authority.

Parameters:

auth -

defaultAuthority -

LdapAuthenticationToken

public LdapAuthenticationToken(org.springframework.security.core.Authentication auth,
                       String defaultAuthority)

Construct a new LdapAuthenticationToken, using an existing Authentication object and a default authority.

Parameters:

auth -

defaultAuthority -

Method Detail

getAuthorities

public Collection<org.springframework.security.core.GrantedAuthority> getAuthorities()

Specified by:

getAuthorities in interface org.springframework.security.core.Authentication

Overrides:

getAuthorities in class org.springframework.security.authentication.AbstractAuthenticationToken

addAuthority

public void addAuthority(org.springframework.security.core.GrantedAuthority authority)

Add an authority to the list of granted authorities

Parameters:

authority - - authority to be added

addAuthorities

public void addAuthorities(Collection<? extends org.springframework.security.core.GrantedAuthority> authoritiesToAdd)

Add authorities to the list of granted authorities

Parameters:

authoritiesToAdd - - authorities to be added

getCredentials

public Object getCredentials()

getPrincipal

public Object getPrincipal()

getContext

public InitialLdapContext getContext()

Retrieve the LDAP context attached to this user's authentication object.

Returns:

the LDAP context

setContext

public void setContext(InitialLdapContext context)

Attach an LDAP context to this user's authentication object.

Parameters:

context - the LDAP context