Class OneTimeTokenAuthenticationToken
java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.authentication.ott.OneTimeTokenAuthenticationToken
- All Implemented Interfaces:
Serializable
,Principal
,Authentication
,CredentialsContainer
Represents a One-Time Token authentication that can be authenticated or not.
- Since:
- 6.4
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>
Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication
Authentication.Builder<B extends Authentication.Builder<B>>
-
Constructor Summary
ConstructorsConstructorDescriptionOneTimeTokenAuthenticationToken
(@Nullable Object principal, String tokenValue) Deprecated, for removal: This API element is subject to removal in a future version.OneTimeTokenAuthenticationToken
(Object principal, Collection<? extends GrantedAuthority> authorities) Deprecated, for removal: This API element is subject to removal in a future version.Please useOneTimeTokenAuthentication
insteadOneTimeTokenAuthenticationToken
(String tokenValue) -
Method Summary
Modifier and TypeMethodDescriptionauthenticated
(Object principal, Collection<? extends GrantedAuthority> authorities) Deprecated, for removal: This API element is subject to removal in a future version.Please useOneTimeTokenAuthentication
instead@Nullable Object
The credentials that prove the principal is correct.@Nullable Object
The identity of the principal being authenticated.@Nullable String
Returns the one-time token valueunauthenticated
(@Nullable String tokenValue) Deprecated, for removal: This API element is subject to removal in a future version.Please use constructor that takes aString
insteadunauthenticated
(Object principal, String tokenValue) Deprecated, for removal: This API element is subject to removal in a future version.Please use constructor that takes aString
insteadMethods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.security.core.Authentication
toBuilder
-
Constructor Details
-
OneTimeTokenAuthenticationToken
@Deprecated(forRemoval=true, since="7.0") public OneTimeTokenAuthenticationToken(@Nullable Object principal, String tokenValue) Deprecated, for removal: This API element is subject to removal in a future version.Please use constructor that takes aString
instead -
OneTimeTokenAuthenticationToken
-
OneTimeTokenAuthenticationToken
@Deprecated(forRemoval=true, since="7.0") public OneTimeTokenAuthenticationToken(Object principal, Collection<? extends GrantedAuthority> authorities) Deprecated, for removal: This API element is subject to removal in a future version.Please useOneTimeTokenAuthentication
instead
-
-
Method Details
-
unauthenticated
@Deprecated(forRemoval=true, since="7.0") public static OneTimeTokenAuthenticationToken unauthenticated(@Nullable String tokenValue) Deprecated, for removal: This API element is subject to removal in a future version.Please use constructor that takes aString
insteadCreates an unauthenticated token- Parameters:
tokenValue
- the one-time token value- Returns:
- an unauthenticated
OneTimeTokenAuthenticationToken
-
unauthenticated
@Deprecated(forRemoval=true, since="7.0") public static OneTimeTokenAuthenticationToken unauthenticated(Object principal, String tokenValue) Deprecated, for removal: This API element is subject to removal in a future version.Please use constructor that takes aString
insteadCreates an unauthenticated token- Parameters:
principal
- the principaltokenValue
- the one-time token value- Returns:
- an unauthenticated
OneTimeTokenAuthenticationToken
-
authenticated
@Deprecated(forRemoval=true, since="7.0") public static OneTimeTokenAuthenticationToken authenticated(Object principal, Collection<? extends GrantedAuthority> authorities) Deprecated, for removal: This API element is subject to removal in a future version.Please useOneTimeTokenAuthentication
insteadCreates an unauthenticated token- Parameters:
principal
- the principalauthorities
- the principal authorities- Returns:
- an authenticated
OneTimeTokenAuthenticationToken
-
getTokenValue
Returns the one-time token value- Returns:
-
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.- Returns:
- the credentials that prove the identity of the
Principal
-
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.- Returns:
- the
Principal
being authenticated or the authenticated principal after authentication.
-
String
instead