com.broadleafcommerce.auth.user.session

Class FormLoginAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.authentication.UsernamePasswordAuthenticationToken

com.broadleafcommerce.auth.user.session.FormLoginAuthenticationToken

All Implemented Interfaces:

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

Direct Known Subclasses:

EmbeddedLoginAuthenticationToken

public class FormLoginAuthenticationToken
extends org.springframework.security.authentication.UsernamePasswordAuthenticationToken

An Authentication implementation that is designed for simple presentation of an OAuth2 clientId, username, and password.

Author:

Nick Crum (ncrum)

See Also:

FormLoginAuthenticationFilter, FormLoginAuthenticationProvider, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormLoginAuthenticationToken(String clientId, Object principal, Object credentials) This constructor can be safely used by any code that wishes to create a OAuth2ClientAuthenticationToken, as the AbstractAuthenticationToken.isAuthenticated() will return false.
FormLoginAuthenticationToken(String clientId, Object principal, Object credentials, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities) This constructor should only be used by AuthenticationManager or AuthenticationProvider implementations that are satisfied with producing a trusted (i.e.

Method Summary

Modifier and Type	Method and Description
String	getClientId()

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

eraseCredentials, getCredentials, getPrincipal, setAuthenticated

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

equals, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Constructor Detail

FormLoginAuthenticationToken

public FormLoginAuthenticationToken(String clientId,
                                    Object principal,
                                    Object credentials)

This constructor can be safely used by any code that wishes to create a OAuth2ClientAuthenticationToken, as the AbstractAuthenticationToken.isAuthenticated() will return false.

FormLoginAuthenticationToken

public FormLoginAuthenticationToken(String clientId,
                                    Object principal,
                                    Object credentials,
                                    Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

This constructor should only be used by AuthenticationManager or AuthenticationProvider implementations that are satisfied with producing a trusted (i.e. AbstractAuthenticationToken.isAuthenticated() = true) authentication token.

Parameters:

clientId -

principal -

credentials -

authorities -

Method Detail

getClientId

public String getClientId()