Class CasAuthenticationToken
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
-
- org.springframework.security.cas.authentication.CasAuthenticationToken
-
- All Implemented Interfaces:
java.io.Serializable
,java.security.Principal
,Authentication
,CredentialsContainer
public class CasAuthenticationToken extends AbstractAuthenticationToken implements java.io.Serializable
Represents a successful CASAuthentication
.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CasAuthenticationToken(java.lang.String key, java.lang.Object principal, java.lang.Object credentials, java.util.Collection<? extends GrantedAuthority> authorities, UserDetails userDetails, org.jasig.cas.client.validation.Assertion assertion)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
org.jasig.cas.client.validation.Assertion
getAssertion()
java.lang.Object
getCredentials()
The credentials that prove the principal is correct.int
getKeyHash()
java.lang.Object
getPrincipal()
The identity of the principal being authenticated.UserDetails
getUserDetails()
int
hashCode()
java.lang.String
toString()
-
Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
eraseCredentials, getAuthorities, getDetails, getName, isAuthenticated, setAuthenticated, setDetails
-
-
-
-
Constructor Detail
-
CasAuthenticationToken
public CasAuthenticationToken(java.lang.String key, java.lang.Object principal, java.lang.Object credentials, java.util.Collection<? extends GrantedAuthority> authorities, UserDetails userDetails, org.jasig.cas.client.validation.Assertion assertion)
Constructor.- Parameters:
key
- to identify if this object made by a givenCasAuthenticationProvider
principal
- typically the UserDetails object (cannot benull
)credentials
- the service/proxy ticket ID from CAS (cannot benull
)authorities
- the authorities granted to the user (from theUserDetailsService
) (cannot benull
)userDetails
- the user details (from theUserDetailsService
) (cannot benull
)assertion
- the assertion returned from the CAS servers. It contains the principal and how to obtain a proxy ticket for the user.- Throws:
java.lang.IllegalArgumentException
- if anull
was passed
-
-
Method Detail
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacejava.security.Principal
- Overrides:
equals
in classAbstractAuthenticationToken
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacejava.security.Principal
- Overrides:
hashCode
in classAbstractAuthenticationToken
-
getCredentials
public java.lang.Object getCredentials()
Description copied from interface:Authentication
The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to theAuthenticationManager
. Callers are expected to populate the credentials.- Specified by:
getCredentials
in interfaceAuthentication
- Returns:
- the credentials that prove the identity of the
Principal
-
getKeyHash
public int getKeyHash()
-
getPrincipal
public java.lang.Object getPrincipal()
Description copied from interface:Authentication
The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a
UserDetails
object as the principal.- Specified by:
getPrincipal
in interfaceAuthentication
- Returns:
- the
Principal
being authenticated or the authenticated principal after authentication.
-
getAssertion
public org.jasig.cas.client.validation.Assertion getAssertion()
-
getUserDetails
public UserDetails getUserDetails()
-
toString
public java.lang.String toString()
- Specified by:
toString
in interfacejava.security.Principal
- Overrides:
toString
in classAbstractAuthenticationToken
-
-