org.apache.cxf.rs.security.oauth2.provider

Class DefaultEHCacheOAuthDataProvider

java.lang.Object

org.apache.cxf.rs.security.oauth2.provider.AbstractOAuthDataProvider

org.apache.cxf.rs.security.oauth2.provider.DefaultEHCacheOAuthDataProvider

All Implemented Interfaces:

ClientRegistrationProvider, OAuthDataProvider

Direct Known Subclasses:

DefaultEHCacheCodeDataProvider

public class DefaultEHCacheOAuthDataProvider
extends AbstractOAuthDataProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_TOKEN_CACHE_KEY
protected net.sf.ehcache.CacheManager	cacheManager
static String	CLIENT_CACHE_KEY
static String	DEFAULT_CONFIG_URL
static String	REFRESH_TOKEN_CACHE_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultEHCacheOAuthDataProvider()
DefaultEHCacheOAuthDataProvider(String configFileURL, Bus bus)
DefaultEHCacheOAuthDataProvider(String configFileURL, Bus bus, String clientCacheKey, String accessTokenKey, String refreshTokenKey)

Method Summary

Modifier and Type	Method and Description
void	close()
protected static net.sf.ehcache.Ehcache	createCache(net.sf.ehcache.CacheManager cacheManager, String cacheKey)
protected Client	doRemoveClient(Client c)
ServerAccessToken	getAccessToken(String accessToken) Get access token
List<ServerAccessToken>	getAccessTokens(Client c, UserSubject sub) Return all access tokens associated with a given client
protected static <T> T	getCacheValue(net.sf.ehcache.Ehcache cache, String key, Class<T> cls)
Client	getClient(String clientId) Returns the previously registered third-party Client
List<Client>	getClients(UserSubject resourceOwner) Get a list of clients registered by a resource owner.
protected RefreshToken	getRefreshToken(String refreshTokenKey)
List<RefreshToken>	getRefreshTokens(Client c, UserSubject sub) Return all refresh tokens associated with a given client
protected static boolean	isTokenMatched(ServerAccessToken token, Client c, UserSubject sub)
protected static void	putCacheValue(net.sf.ehcache.Ehcache cache, String key, Object value, long ttl)
Client	removeClient(String clientId) Remove a Client with the given id
protected ServerAccessToken	revokeAccessToken(String accessTokenKey)
protected RefreshToken	revokeRefreshToken(String refreshTokenKey)
protected void	saveAccessToken(ServerAccessToken serverToken)
protected void	saveRefreshToken(ServerAccessToken at, RefreshToken refreshToken)
void	setClient(Client client) Set a Client
void	setClients(List<Client> clients)

Methods inherited from class org.apache.cxf.rs.security.oauth2.provider.AbstractOAuthDataProvider

convertScopeToPermissions, createAccessToken, createNewAccessToken, createNewRefreshToken, doCreateAccessToken, doCreateNewRefreshToken, doRefreshAccessToken, getDefaultScopes, getInvisibleToClientScopes, getMessageContext, getPermissionMap, getPreauthorizedToken, getRequiredScopes, handleLinkedRefreshToken, init, isRefreshTokenSupported, isSupportPreauthorizedTokens, refreshAccessToken, removeAccessToken, removeClientTokens, revokeAccessTokens, revokeToken, setAccessTokenLifetime, setDefaultScopes, setInvisibleToClientScopes, setMessageContext, setPermissionMap, setRecycleRefreshTokens, setRefreshTokenLifetime, setRequiredScopes, setSupportedScopes, setSupportPreauthorizedTokens, unlinkRefreshAccessToken, updateRefreshToken

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_CACHE_KEY

public static final String CLIENT_CACHE_KEY

See Also:

Constant Field Values

ACCESS_TOKEN_CACHE_KEY

public static final String ACCESS_TOKEN_CACHE_KEY

See Also:

Constant Field Values

REFRESH_TOKEN_CACHE_KEY

public static final String REFRESH_TOKEN_CACHE_KEY

See Also:

Constant Field Values

DEFAULT_CONFIG_URL

public static final String DEFAULT_CONFIG_URL

See Also:

Constant Field Values

cacheManager

protected net.sf.ehcache.CacheManager cacheManager

Constructor Detail

DefaultEHCacheOAuthDataProvider

public DefaultEHCacheOAuthDataProvider()

DefaultEHCacheOAuthDataProvider

public DefaultEHCacheOAuthDataProvider(String configFileURL,
                                       Bus bus)

DefaultEHCacheOAuthDataProvider

public DefaultEHCacheOAuthDataProvider(String configFileURL,
                                       Bus bus,
                                       String clientCacheKey,
                                       String accessTokenKey,
                                       String refreshTokenKey)

Method Detail

getClient

public Client getClient(String clientId)
                 throws OAuthServiceException

Description copied from interface: OAuthDataProvider

Returns the previously registered third-party Client

Parameters:

clientId - the client id

Returns:

Client

Throws:

OAuthServiceException

setClient

public void setClient(Client client)

Description copied from interface: ClientRegistrationProvider

Set a Client

Parameters:

client - the client

setClients

public void setClients(List<Client> clients)

removeClient

public Client removeClient(String clientId)

Description copied from interface: ClientRegistrationProvider

Remove a Client with the given id

Parameters:

clientId - the client id

Returns:

Client

doRemoveClient

protected Client doRemoveClient(Client c)

getClients

public List<Client> getClients(UserSubject resourceOwner)

Description copied from interface: ClientRegistrationProvider

Get a list of clients registered by a resource owner.

Parameters:

resourceOwner - the resource owner, can be null

Returns:

the list of clients

getAccessTokens

public List<ServerAccessToken> getAccessTokens(Client c,
                                               UserSubject sub)

Description copied from interface: OAuthDataProvider

Return all access tokens associated with a given client

Parameters:

c - the client

sub - the user subject, can be null

Returns:

list of access tokens

getRefreshTokens

public List<RefreshToken> getRefreshTokens(Client c,
                                           UserSubject sub)

Description copied from interface: OAuthDataProvider

Return all refresh tokens associated with a given client

Parameters:

c - the client

sub - the user subject, can be null

Returns:

list of refresh tokens

isTokenMatched

protected static boolean isTokenMatched(ServerAccessToken token,
                                        Client c,
                                        UserSubject sub)

getAccessToken

public ServerAccessToken getAccessToken(String accessToken)
                                 throws OAuthServiceException

Description copied from interface: OAuthDataProvider

Get access token

Parameters:

accessToken - the token key

Returns:

AccessToken

Throws:

OAuthServiceException

revokeAccessToken

protected ServerAccessToken revokeAccessToken(String accessTokenKey)

Specified by:

revokeAccessToken in class AbstractOAuthDataProvider

getRefreshToken

protected RefreshToken getRefreshToken(String refreshTokenKey)

Specified by:

getRefreshToken in class AbstractOAuthDataProvider

revokeRefreshToken

protected RefreshToken revokeRefreshToken(String refreshTokenKey)

Specified by:

revokeRefreshToken in class AbstractOAuthDataProvider

saveAccessToken

protected void saveAccessToken(ServerAccessToken serverToken)

Specified by:

saveAccessToken in class AbstractOAuthDataProvider

saveRefreshToken

protected void saveRefreshToken(ServerAccessToken at,
                                RefreshToken refreshToken)

Specified by:

saveRefreshToken in class AbstractOAuthDataProvider

getCacheValue

protected static <T> T getCacheValue(net.sf.ehcache.Ehcache cache,
                                     String key,
                                     Class<T> cls)

putCacheValue

protected static void putCacheValue(net.sf.ehcache.Ehcache cache,
                                    String key,
                                    Object value,
                                    long ttl)

createCache

protected static net.sf.ehcache.Ehcache createCache(net.sf.ehcache.CacheManager cacheManager,
                                                    String cacheKey)

close

public void close()

Overrides:

close in class AbstractOAuthDataProvider