cz.ues.platform.security.authn.token

Interface UESAuthenticationToken

All Known Implementing Classes:

OAuthAuthenticationToken, UESAccessCodesAuthnToken, UESPasswordAuthnToken

public interface UESAuthenticationToken

Represents an authentication request.

An AuthenticationToken object is not considered authenticated until it is processed by an UESAuthenticationService.

Since:

UES6-00

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getCredentials() The credentials that prove the principal is correct.
java.util.Map<java.lang.String,java.lang.Object>	getDetails() Stores additional details about the authentication request.
Principal	getPrincipal() The identity of the principal being authenticated.
java.lang.String	getSecurityRealm() The security realm which should be used for authentication.

Method Detail

getCredentials

java.lang.Object getCredentials()

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the UESAuthenticationService. Callers are expected to populate the credentials.

Returns:

the credentials that prove the identity of the Principal

Since:

UES6-00

getDetails

java.util.Map<java.lang.String,java.lang.Object> getDetails()

Stores additional details about the authentication request. These might be an IP address, certificate serial number etc.

Returns:

additional details about the authentication request, or null if not used

Since:

UES6-00

getPrincipal

Principal getPrincipal()

The identity of the principal being authenticated. This is usually a user-name. Callers are expected to populate the principal.

Returns:

the Principal being authenticated

Since:

UES6-00

getSecurityRealm

java.lang.String getSecurityRealm()

The security realm which should be used for authentication. (may be in form of regular expression pattern)

Returns:

The security realm

Since:

UES7-06