Class CasAuthenticationToken
- All Implemented Interfaces:
Serializable
,Principal
,Authentication
,CredentialsContainer
Authentication
.- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>
-
Constructor Summary
ConstructorsModifierConstructorDescriptionCasAuthenticationToken
(String key, Object principal, Object credentials, Collection<? extends GrantedAuthority> authorities, UserDetails userDetails, org.apereo.cas.client.validation.Assertion assertion) Constructor.protected
CasAuthenticationToken
(CasAuthenticationToken.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
org.apereo.cas.client.validation.Assertion
The credentials that prove the principal is correct.int
The identity of the principal being authenticated.int
hashCode()
Return anAuthentication.Builder
based on this instance.toString()
Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
eraseCredentials, getAuthorities, getDetails, getName, isAuthenticated, setAuthenticated, setDetails
-
Constructor Details
-
CasAuthenticationToken
public CasAuthenticationToken(String key, Object principal, Object credentials, Collection<? extends GrantedAuthority> authorities, UserDetails userDetails, org.apereo.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:
IllegalArgumentException
- if anull
was passed
-
CasAuthenticationToken
-
-
Method Details
-
equals
- Specified by:
equals
in interfacePrincipal
- Overrides:
equals
in classAbstractAuthenticationToken
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacePrincipal
- Overrides:
hashCode
in classAbstractAuthenticationToken
-
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
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.apereo.cas.client.validation.Assertion getAssertion() -
getUserDetails
-
toBuilder
Description copied from interface:Authentication
Return anAuthentication.Builder
based on this instance. By default, returns a builder that builds aSimpleAuthentication
.Although a
default
method, allAuthentication
implementations should implement this. The reason is to ensure that theAuthentication
type is preserved whenAuthentication.Builder.build()
is invoked. This is especially important in the event that your authentication implementation contains custom fields.This isn't strictly necessary since it is recommended that applications code to the
Authentication
interface and that custom information is often contained in theAuthentication.getPrincipal()
value.- Specified by:
toBuilder
in interfaceAuthentication
- Returns:
- an
Authentication.Builder
for building a newAuthentication
based on this instance
-
toString
- Specified by:
toString
in interfacePrincipal
- Overrides:
toString
in classAbstractAuthenticationToken
-