org.apache.nifi.web.security.token

Class LoginAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.apache.nifi.web.security.token.LoginAuthenticationToken

All Implemented Interfaces:

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

public class LoginAuthenticationToken
extends org.springframework.security.authentication.AbstractAuthenticationToken

This is an Authentication Token for logging in. Once a user is authenticated, they can be issued an ID token.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private long	expiration
private String	identity
private String	issuer
private String	username

Constructor Summary

Constructors

Constructor and Description
LoginAuthenticationToken(String identity, long expiration, String issuer) Creates a representation of the authentication token for a user.
LoginAuthenticationToken(String identity, String username, long expiration, String issuer) Creates a representation of the authentication token for a user.
LoginAuthenticationToken(String identity, String username, long expiration, String issuer, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities) Creates a representation of the authentication token for a user.

Method Summary

Modifier and Type	Method and Description
Object	getCredentials()
long	getExpiration() Returns the expiration instant in milliseconds.
String	getIssuer()
String	getName()
Object	getPrincipal()
String	toString()

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

equals, eraseCredentials, getAuthorities, getDetails, hashCode, isAuthenticated, setAuthenticated, setDetails

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Field Detail

identity

private final String identity

username

private final String username

expiration

private final long expiration

issuer

private final String issuer

Constructor Detail

LoginAuthenticationToken

public LoginAuthenticationToken(String identity,
                                long expiration,
                                String issuer)

Creates a representation of the authentication token for a user.

Parameters:

identity - The unique identifier for this user

expiration - The relative time to expiration in milliseconds

issuer - The IdentityProvider implementation that generated this token

LoginAuthenticationToken

public LoginAuthenticationToken(String identity,
                                String username,
                                long expiration,
                                String issuer)

Creates a representation of the authentication token for a user.

Parameters:

identity - The unique identifier for this user (cannot be null or empty)

username - The preferred username for this user

expiration - The relative time to expiration in milliseconds

issuer - The IdentityProvider implementation that generated this token

LoginAuthenticationToken

public LoginAuthenticationToken(String identity,
                                String username,
                                long expiration,
                                String issuer,
                                Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

Creates a representation of the authentication token for a user.

Parameters:

identity - The unique identifier for this user (cannot be null or empty)

username - The preferred username for this user

expiration - The relative time to expiration in milliseconds

issuer - The IdentityProvider implementation that generated this token

authorities - The authorities that have been granted this token.

Method Detail

getCredentials

public Object getCredentials()

getPrincipal

public Object getPrincipal()

getExpiration

public long getExpiration()

Returns the expiration instant in milliseconds. This value is an absolute point in time (i.e. Nov 16, 2015 11:30:00.000 GMT), not a relative time (i.e. 60 minutes). It is calculated by adding the relative expiration from the constructor to the timestamp at object creation.

Returns:

the expiration in millis

getIssuer

public String getIssuer()

getName

public String getName()

Specified by:

getName in interface Principal

Overrides:

getName in class org.springframework.security.authentication.AbstractAuthenticationToken

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class org.springframework.security.authentication.AbstractAuthenticationToken