Class CasServiceTicketAuthenticationToken
- All Implemented Interfaces:
Serializable,Principal,Authentication,CredentialsContainer
Authentication implementation that is
designed to process CAS service ticket.- Since:
- 6.1
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classCasServiceTicketAuthenticationToken.Builder<B extends CasServiceTicketAuthenticationToken.Builder<B>>A builder ofCasServiceTicketAuthenticationTokeninstancesNested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>> -
Constructor Summary
ConstructorsModifierConstructorDescriptionCasServiceTicketAuthenticationToken(String identifier, Object credentials) This constructor can be safely used by any code that wishes to create aCasServiceTicketAuthenticationToken, as theAbstractAuthenticationToken.isAuthenticated()will returnfalse.CasServiceTicketAuthenticationToken(String identifier, Object credentials, Collection<? extends GrantedAuthority> authorities) This constructor should only be used byAuthenticationManagerorAuthenticationProviderimplementations that are satisfied with producing a trusted (i.e.protected -
Method Summary
Modifier and TypeMethodDescriptionvoidChecks thecredentials,principalanddetailsobjects, invoking theeraseCredentialsmethod on any which implementCredentialsContainer.@Nullable ObjectThe credentials that prove the principal is correct.The identity of the principal being authenticated.booleanvoidsetAuthenticated(boolean isAuthenticated) SeeAuthentication.isAuthenticated()for a full description.Return anAuthentication.Builderbased on this instance.Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
equals, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setDetails, toString
-
Constructor Details
-
CasServiceTicketAuthenticationToken
This constructor can be safely used by any code that wishes to create aCasServiceTicketAuthenticationToken, as theAbstractAuthenticationToken.isAuthenticated()will returnfalse. -
CasServiceTicketAuthenticationToken
public CasServiceTicketAuthenticationToken(String identifier, Object credentials, Collection<? extends GrantedAuthority> authorities) This constructor should only be used byAuthenticationManagerorAuthenticationProviderimplementations that are satisfied with producing a trusted (i.e.AbstractAuthenticationToken.isAuthenticated()=true) authentication token.- Parameters:
identifier-credentials-authorities-
-
CasServiceTicketAuthenticationToken
protected CasServiceTicketAuthenticationToken(CasServiceTicketAuthenticationToken.Builder<?> builder)
-
-
Method Details
-
stateful
-
stateless
-
isStateless
public boolean isStateless() -
getCredentials
Description copied from interface:AuthenticationThe 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.- Returns:
- the credentials that prove the identity of the
Principal
-
getPrincipal
Description copied from interface:AuthenticationThe 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
UserDetailsobject as the principal.- Returns:
- the
Principalbeing authenticated or the authenticated principal after authentication.
-
setAuthenticated
Description copied from interface:AuthenticationSeeAuthentication.isAuthenticated()for a full description.Implementations should always allow this method to be called with a
falseparameter, as this is used by various classes to specify the authentication token should not be trusted. If an implementation wishes to reject an invocation with atrueparameter (which would indicate the authentication token is trusted - a potential security risk) the implementation should throw anIllegalArgumentException.- Specified by:
setAuthenticatedin interfaceAuthentication- Overrides:
setAuthenticatedin classAbstractAuthenticationToken- Parameters:
isAuthenticated-trueif the token should be trusted (which may result in an exception) orfalseif the token should not be trusted- Throws:
IllegalArgumentException- if an attempt to make the authentication token trusted (by passingtrueas the argument) is rejected due to the implementation being immutable or implementing its own alternative approach toAuthentication.isAuthenticated()
-
eraseCredentials
public void eraseCredentials()Description copied from class:AbstractAuthenticationTokenChecks thecredentials,principalanddetailsobjects, invoking theeraseCredentialsmethod on any which implementCredentialsContainer.- Specified by:
eraseCredentialsin interfaceCredentialsContainer- Overrides:
eraseCredentialsin classAbstractAuthenticationToken
-
toBuilder
Description copied from interface:AuthenticationReturn anAuthentication.Builderbased on this instance. By default, returns a builder that builds aSimpleAuthentication.Although a
defaultmethod, allAuthenticationimplementations should implement this. The reason is to ensure that theAuthenticationtype 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
Authenticationinterface and that custom information is often contained in theAuthentication.getPrincipal()value.- Returns:
- an
Authentication.Builderfor building a newAuthenticationbased on this instance
-