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 accessTokenCacheKey, String refreshTokenCacheKey)

Method Summary

Modifier and Type	Method and Description
void	close()
protected static net.sf.ehcache.Ehcache	createCache(net.sf.ehcache.CacheManager cacheManager, String cacheKey)
Client	doGetClient(String clientId)
protected void	doRemoveClient(Client c)
protected void	doRevokeAccessToken(ServerAccessToken at)
protected void	doRevokeRefreshToken(RefreshToken rt)
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)
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
boolean	isStoreJwtTokenKeyOnly()
protected static void	putCacheValue(net.sf.ehcache.Ehcache cache, String key, Object value, long ttl)
protected void	saveAccessToken(ServerAccessToken serverToken)
protected void	saveRefreshToken(RefreshToken refreshToken)
void	setClient(Client client) Set a Client
void	setJwtTokenConsumer(JoseJwtConsumer jwtTokenConsumer)
void	setStoreJwtTokenKeyOnly(boolean storeJwtTokenKeyOnly)

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

authenticateUnregisteredClient, checkRequestedScopes, convertScopeToPermissions, convertSingleScopeToPermission, createAccessToken, createClientCredentialsClient, createJwtAccessToken, createNewAccessToken, createNewRefreshToken, doCreateAccessToken, doCreateNewRefreshToken, doRefreshAccessToken, getClient, getCurrentClientSecret, getCurrentRequestedGrantType, getCurrentTokenRequestParams, getDefaultScopes, getInvisibleToClientScopes, getJwtAccessTokenClaimMap, getJwtAccessTokenProducer, getMessageContext, getPermissionMap, getPreauthorizedToken, getRequiredScopes, handleLinkedRefreshToken, init, isClientMatched, isRecycleRefreshTokens, isRefreshTokenSupported, isSupportPreauthorizedTokens, isTokenMatched, isUseJwtFormatForAccessTokens, linkAccessTokenToRefreshToken, linkRefreshTokenToAccessToken, processJwtAccessToken, refreshAccessToken, removeClient, removeClientTokens, revokeAccessToken, revokeAccessTokens, revokeRefreshToken, revokeToken, setAccessTokenLifetime, setAuthenticationStrategy, setClients, setDefaultScopes, setInvisibleToClientScopes, setJwtAccessTokenClaimMap, setJwtAccessTokenProducer, setMessageContext, setPermissionMap, setRecycleRefreshTokens, setRefreshTokenLifetime, setRequiredScopes, setSupportedScopes, setSupportPreauthorizedTokens, setUseJwtFormatForAccessTokens, unlinkRefreshAccessToken, updateExistingRefreshToken, 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 accessTokenCacheKey,
                                       String refreshTokenCacheKey)

Method Detail

doGetClient

public Client doGetClient(String clientId)
                   throws OAuthServiceException

Specified by:

doGetClient in class AbstractOAuthDataProvider

Throws:

OAuthServiceException

setClient

public void setClient(Client client)

Description copied from interface: ClientRegistrationProvider

Set a Client

Parameters:

client - the client

doRemoveClient

protected void doRemoveClient(Client c)

Specified by:

doRemoveClient in class AbstractOAuthDataProvider

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

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

doRevokeAccessToken

protected void doRevokeAccessToken(ServerAccessToken at)

Specified by:

doRevokeAccessToken in class AbstractOAuthDataProvider

getRefreshToken

protected RefreshToken getRefreshToken(String refreshTokenKey)

Specified by:

getRefreshToken in class AbstractOAuthDataProvider

doRevokeRefreshToken

protected void doRevokeRefreshToken(RefreshToken rt)

Specified by:

doRevokeRefreshToken in class AbstractOAuthDataProvider

saveAccessToken

protected void saveAccessToken(ServerAccessToken serverToken)

Specified by:

saveAccessToken in class AbstractOAuthDataProvider

saveRefreshToken

protected void saveRefreshToken(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

isStoreJwtTokenKeyOnly

public boolean isStoreJwtTokenKeyOnly()

setStoreJwtTokenKeyOnly

public void setStoreJwtTokenKeyOnly(boolean storeJwtTokenKeyOnly)

setJwtTokenConsumer

public void setJwtTokenConsumer(JoseJwtConsumer jwtTokenConsumer)