cz.ues.platform.security.authn.oauth

Class OAuthAuthenticationToken

java.lang.Object

cz.ues.platform.security.authn.oauth.OAuthAuthenticationToken

All Implemented Interfaces:

UESAuthenticationToken

public class OAuthAuthenticationToken
extends java.lang.Object
implements UESAuthenticationToken

OAuth authentication token.

Since:

UES8-23

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	realm OAuth realm.
private java.lang.String	subjectId Subject Id.

Constructor Summary

Constructors

Constructor and Description
OAuthAuthenticationToken(java.lang.String realm, java.lang.String subjectId) Creates a new instance of OAuthAuthenticationToken.

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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

realm

private realm

OAuth realm.

subjectId

private subjectId

Subject Id.

Constructor Detail

OAuthAuthenticationToken

public OAuthAuthenticationToken(java.lang.String realm,
java.lang.String subjectId)

Creates a new instance of OAuthAuthenticationToken.

Parameters:

realm - OAuth realm

subjectId - subject Id

Since:

UES8-23

Method Detail

getCredentials

public 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.

Specified by:

getCredentials in interface UESAuthenticationToken

Returns:

the credentials that prove the identity of the Principal

Since:

UES8-23

getDetails

public 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.

Specified by:

getDetails in interface UESAuthenticationToken

Returns:

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

Since:

UES8-23

getPrincipal

public Principal getPrincipal()

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

Specified by:

getPrincipal in interface UESAuthenticationToken

Returns:

the Principal being authenticated

Since:

UES8-23

getSecurityRealm

public java.lang.String getSecurityRealm()

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

Specified by:

getSecurityRealm in interface UESAuthenticationToken

Returns:

The security realm

Since:

UES8-23

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

UES8-23