org.seedstack.seed.security

Interface AuthenticationToken

All Superinterfaces:

Serializable

All Known Implementing Classes:

UsernamePasswordToken, X509CertificateToken

public interface AuthenticationToken
extends Serializable

An AuthenticationToken is a consolidation of an account's principals and supporting credentials submitted by a user during an authentication attempt.

Because applications represent user data and credentials in different ways, implementations of this interface are application-specific. You are free to acquire a user's principals and credentials however you wish (e.g. web form, Swing form, fingerprint identification, etc) and then submit them to the framework in the form of an implementation of this interface.

If your application's authentication process is username/password based (like most), instead of implementing this interface yourself, take a look at the UsernamePasswordToken class, as it is probably sufficient for your needs.

Method Summary

Modifier and Type	Method and Description
Object	getCredentials() Returns the credentials submitted by the user during the authentication process that verifies the submitted account identity.
Object	getPrincipal() Returns the account identity submitted during the authentication process.

Method Detail

getPrincipal

Object getPrincipal()

Returns the account identity submitted during the authentication process.

Most application authentications are username/password based and have this object represent a username. If this is the case for your application, take a look at the UsernamePasswordToken, as it is probably sufficient for your use.

Ultimately, the object returned is application specific and can represent any account identity.

Returns:

the account identity submitted during the authentication process.

See Also:

UsernamePasswordToken

getCredentials

Object getCredentials()

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

Most application authentications are username/password based and have this object represent a submitted password. If this is the case for your application, take a look at the UsernamePasswordToken, as it is probably sufficient for your use.

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

Returns:

the credential submitted by the user during the authentication process.