Package org.codice.ddf.security.handler

Class BaseAuthenticationToken

java.lang.Object

org.codice.ddf.security.handler.BaseAuthenticationToken

All Implemented Interfaces:

Serializable, org.apache.shiro.authc.AuthenticationToken

Direct Known Subclasses:

GuestAuthenticationToken, OidcAuthenticationToken, SAMLAuthenticationToken, SessionToken

public class BaseAuthenticationToken
extends Object
implements org.apache.shiro.authc.AuthenticationToken

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowGuest
protected Object	credentials	Represents the credentials submitted by the user during the authentication process that verifies the submitted Principal account identity.
protected String	ip
protected Object	principal	Represents the account identity submitted during the authentication process.

Constructor Summary

Constructors

Constructor	Description
BaseAuthenticationToken(Object principal, Object credentials, String ip)

Method Summary

Modifier and Type	Method	Description
boolean	getAllowGuest()
Object	getCredentials()
String	getCredentialsAsString()
String	getIpAddress()
Object	getPrincipal()
String	getRequestURI()
AuthenticationTokenType	getType()
X509Certificate[]	getX509Certs()
void	setAllowGuest(boolean allowGuest)
protected void	setCredentials(Object o)
void	setRequestURI(String requestURI)
void	setType(AuthenticationTokenType type)
void	setX509Certs(X509Certificate[] x509Certs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

principal

protected Object principal

Represents the account identity submitted during the authentication process.

Most application authentications are username/password based and have this object represent a username. However, this can also represent the DN from an X509 certificate, or any other unique identifier.

Ultimately, the object is application specific and can represent any account identity (user id, X.509 certificate, etc).

credentials

protected Object credentials

Represents the credentials submitted by the user during the authentication process that verifies the submitted Principal account identity.

Most application authentications are username/password based and have this object represent a submitted password.

Ultimately, the credentials Object is application specific and can represent any credential mechanism.

ip

protected String ip

allowGuest

protected boolean allowGuest

Constructor Details

BaseAuthenticationToken

public BaseAuthenticationToken(Object principal,
 Object credentials,
 String ip)

Method Details

getType

public AuthenticationTokenType getType()

setType

public void setType(AuthenticationTokenType type)

getAllowGuest

public boolean getAllowGuest()

setAllowGuest

public void setAllowGuest(boolean allowGuest)

getPrincipal

public Object getPrincipal()

Specified by:

getPrincipal in interface org.apache.shiro.authc.AuthenticationToken

getCredentials

public Object getCredentials()

Specified by:

getCredentials in interface org.apache.shiro.authc.AuthenticationToken

setCredentials

protected void setCredentials(Object o)

setX509Certs

public void setX509Certs(X509Certificate[] x509Certs)

getX509Certs

public X509Certificate[] getX509Certs()

getRequestURI

public String getRequestURI()

setRequestURI

public void setRequestURI(String requestURI)

getCredentialsAsString

public String getCredentialsAsString()

getIpAddress

public String getIpAddress()