org.springframework.security.oauth2.provider.token

Class DefaultAccessTokenConverter

java.lang.Object

org.springframework.security.oauth2.provider.token.DefaultAccessTokenConverter

All Implemented Interfaces:

AccessTokenConverter

public class DefaultAccessTokenConverter
extends Object
implements AccessTokenConverter

Default implementation of AccessTokenConverter.

Author:

Dave Syer, Vedran Pavic

Field Summary

Fields inherited from interface org.springframework.security.oauth2.provider.token.AccessTokenConverter

ATI, AUD, AUTHORITIES, CLIENT_ID, EXP, GRANT_TYPE, JTI, SCOPE

Constructor Summary

Constructors

Constructor and Description
DefaultAccessTokenConverter()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,?>	convertAccessToken(OAuth2AccessToken token, OAuth2Authentication authentication)
OAuth2AccessToken	extractAccessToken(String value, Map<String,?> map) Recover an access token from the converted value.
OAuth2Authentication	extractAuthentication(Map<String,?> map) Recover an OAuth2Authentication from the converted access token.
void	setClientIdAttribute(String clientIdAttribute) Set client id attribute name to be used in the converted token.
void	setIncludeGrantType(boolean includeGrantType) Flag to indicate the the grant type should be included in the converted token.
void	setScopeAttribute(String scopeAttribute) Set scope attribute name to be used in the converted token.
void	setUserTokenConverter(UserAuthenticationConverter userTokenConverter) Converter for the part of the data in the token representing a user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAccessTokenConverter

public DefaultAccessTokenConverter()

Method Detail

setUserTokenConverter

public void setUserTokenConverter(UserAuthenticationConverter userTokenConverter)

Converter for the part of the data in the token representing a user.

Parameters:

userTokenConverter - the userTokenConverter to set

setIncludeGrantType

public void setIncludeGrantType(boolean includeGrantType)

Flag to indicate the the grant type should be included in the converted token.

Parameters:

includeGrantType - the flag value (default false)

setScopeAttribute

public void setScopeAttribute(String scopeAttribute)

Set scope attribute name to be used in the converted token. Defaults to AccessTokenConverter.SCOPE.

Parameters:

scopeAttribute - the scope attribute name to use

setClientIdAttribute

public void setClientIdAttribute(String clientIdAttribute)

Set client id attribute name to be used in the converted token. Defaults to AccessTokenConverter.CLIENT_ID.

Parameters:

clientIdAttribute - the client id attribute name to use

convertAccessToken

public Map<String,?> convertAccessToken(OAuth2AccessToken token,
                               OAuth2Authentication authentication)

Specified by:

convertAccessToken in interface AccessTokenConverter

Parameters:

token - an access token

authentication - the current OAuth authentication

Returns:

a map representation of the token suitable for a JSON response

extractAccessToken

public OAuth2AccessToken extractAccessToken(String value,
                                   Map<String,?> map)

Description copied from interface: AccessTokenConverter

Recover an access token from the converted value. Half the inverse of AccessTokenConverter.convertAccessToken(OAuth2AccessToken, OAuth2Authentication).

Specified by:

extractAccessToken in interface AccessTokenConverter

Parameters:

value - the token value

map - information decoded from an access token

Returns:

an access token

extractAuthentication

public OAuth2Authentication extractAuthentication(Map<String,?> map)

Description copied from interface: AccessTokenConverter

Recover an OAuth2Authentication from the converted access token. Half the inverse of AccessTokenConverter.convertAccessToken(OAuth2AccessToken, OAuth2Authentication).

Specified by:

extractAuthentication in interface AccessTokenConverter

Parameters:

map - information decoded from an access token

Returns:

an authentication representing the client and user (if there is one)