org.springframework.security.oauth2.provider.authentication

Class OAuth2AuthenticationDetails

java.lang.Object

org.springframework.security.oauth2.provider.authentication.OAuth2AuthenticationDetails

All Implemented Interfaces:

Serializable

public class OAuth2AuthenticationDetails
extends Object
implements Serializable

A holder of selected HTTP details related to an OAuth2 authentication request.

Author:

Dave Syer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_TOKEN_TYPE
static String	ACCESS_TOKEN_VALUE

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthenticationDetails(javax.servlet.http.HttpServletRequest request) Records the access token value and remote address and will also set the session Id if a session already exists (it won't create one).

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDecodedDetails() The authentication details obtained by decoding the access token if available.
String	getRemoteAddress() Indicates the TCP/IP address the authentication request was received from.
String	getSessionId() Indicates the HttpSession id the authentication request was received from.
String	getTokenType() The access token type used to authenticate the request (normally in an authorization header).
String	getTokenValue() The access token value used to authenticate the request (normally in an authorization header).
void	setDecodedDetails(Object decodedDetails) The authentication details obtained by decoding the access token if available.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN_VALUE

public static final String ACCESS_TOKEN_VALUE

ACCESS_TOKEN_TYPE

public static final String ACCESS_TOKEN_TYPE

Constructor Detail

OAuth2AuthenticationDetails

public OAuth2AuthenticationDetails(javax.servlet.http.HttpServletRequest request)

Records the access token value and remote address and will also set the session Id if a session already exists (it won't create one).

Parameters:

request - that the authentication request was received from

Method Detail

getTokenValue

public String getTokenValue()

The access token value used to authenticate the request (normally in an authorization header).

Returns:

the tokenValue used to authenticate the request

getTokenType

public String getTokenType()

The access token type used to authenticate the request (normally in an authorization header).

Returns:

the tokenType used to authenticate the request if known

getRemoteAddress

public String getRemoteAddress()

Indicates the TCP/IP address the authentication request was received from.

Returns:

the address

getSessionId

public String getSessionId()

Indicates the HttpSession id the authentication request was received from.

Returns:

the session ID

getDecodedDetails

public Object getDecodedDetails()

The authentication details obtained by decoding the access token if available.

Returns:

the decodedDetails if available (default null)

setDecodedDetails

public void setDecodedDetails(Object decodedDetails)

The authentication details obtained by decoding the access token if available.

Parameters:

decodedDetails - the decodedDetails to set

toString

public String toString()

Overrides:

toString in class Object