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

Class JCacheOAuthDataProvider

java.lang.Object

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

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

All Implemented Interfaces:

ClientRegistrationProvider, OAuthDataProvider

Direct Known Subclasses:

JCacheCodeDataProvider

public class JCacheOAuthDataProvider
extends AbstractOAuthDataProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_TOKEN_CACHE_KEY
protected CacheManager	cacheManager
static String	CLIENT_CACHE_KEY
static String	DEFAULT_CONFIG_URL
static String	REFRESH_TOKEN_CACHE_KEY

Constructor Summary

Constructors

Constructor and Description
JCacheOAuthDataProvider()
JCacheOAuthDataProvider(boolean storeJwtTokenKeyOnly)
JCacheOAuthDataProvider(String configFileURL, Bus bus)
JCacheOAuthDataProvider(String configFileURL, Bus bus, boolean storeJwtTokenKeyOnly)
JCacheOAuthDataProvider(String configFileURL, Bus bus, String clientCacheKey, String accessTokenCacheKey, String refreshTokenCacheKey)
JCacheOAuthDataProvider(String configFileURL, Bus bus, String clientCacheKey, String accessTokenCacheKey, String refreshTokenCacheKey, boolean storeJwtTokenKeyOnly)

Method Summary

Modifier and Type	Method and Description
void	close()
protected static <K,V> <any>	createCache(CacheManager cacheManager, String cacheKey, Class<K> keyType, Class<V> valueType)
protected static CacheManager	createCacheManager(String configFile, Bus bus)
Client	doGetClient(String clientId)
protected void	doRemoveClient(Client c)
protected void	doRevokeAccessToken(ServerAccessToken at)
protected void	doRevokeRefreshToken(RefreshToken rt)
ServerAccessToken	getAccessToken(String accessTokenKey) Get access token
List<ServerAccessToken>	getAccessTokens(Client c, UserSubject sub) Return all access tokens associated with a given client
List<Client>	getClients(UserSubject resourceOwner) Get a list of clients registered by a resource owner.
protected ServerAccessToken	getJwtAccessToken(String key)
protected List<ServerAccessToken>	getJwtAccessTokens(Client client, UserSubject sub)
protected RefreshToken	getRefreshToken(String refreshTokenKey)
List<RefreshToken>	getRefreshTokens(Client c, UserSubject sub) Return all refresh tokens associated with a given client
protected static <V extends ServerAccessToken> V	getToken(<any> cache, String key)
protected static <K,V extends ServerAccessToken> List<V>	getTokens(<any> cache, Client client, UserSubject sub)
protected static boolean	isExpired(ServerAccessToken token)
boolean	isStoreJwtTokenKeyOnly()
protected void	saveAccessToken(ServerAccessToken serverToken)
protected void	saveRefreshToken(RefreshToken refreshToken)
void	setClient(Client client) Set a Client
void	setJwtTokenConsumer(JoseJwtConsumer jwtTokenConsumer)

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 final CacheManager cacheManager

Constructor Detail

JCacheOAuthDataProvider

public JCacheOAuthDataProvider()
                        throws Exception

Throws:

Exception

JCacheOAuthDataProvider

public JCacheOAuthDataProvider(boolean storeJwtTokenKeyOnly)
                        throws Exception

Throws:

Exception

JCacheOAuthDataProvider

public JCacheOAuthDataProvider(String configFileURL,
                               Bus bus)
                        throws Exception

Throws:

Exception

JCacheOAuthDataProvider

public JCacheOAuthDataProvider(String configFileURL,
                               Bus bus,
                               boolean storeJwtTokenKeyOnly)
                        throws Exception

Throws:

Exception

JCacheOAuthDataProvider

public JCacheOAuthDataProvider(String configFileURL,
                               Bus bus,
                               String clientCacheKey,
                               String accessTokenCacheKey,
                               String refreshTokenCacheKey)
                        throws Exception

Throws:

Exception

JCacheOAuthDataProvider

public JCacheOAuthDataProvider(String configFileURL,
                               Bus bus,
                               String clientCacheKey,
                               String accessTokenCacheKey,
                               String refreshTokenCacheKey,
                               boolean storeJwtTokenKeyOnly)
                        throws Exception

Throws:

Exception

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 accessTokenKey)
                                 throws OAuthServiceException

Description copied from interface: OAuthDataProvider

Get access token

Parameters:

accessTokenKey - 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

close

public void close()

Overrides:

close in class AbstractOAuthDataProvider

getToken

protected static <V extends ServerAccessToken> V getToken(<any> cache,
                                                          String key)

getJwtAccessToken

protected ServerAccessToken getJwtAccessToken(String key)

getTokens

protected static <K,V extends ServerAccessToken> List<V> getTokens(<any> cache,
                                                                   Client client,
                                                                   UserSubject sub)

getJwtAccessTokens

protected List<ServerAccessToken> getJwtAccessTokens(Client client,
                                                     UserSubject sub)

isExpired

protected static boolean isExpired(ServerAccessToken token)

createCacheManager

protected static CacheManager createCacheManager(String configFile,
                                                 Bus bus)
                                          throws Exception

Throws:

Exception

createCache

protected static <K,V> <any> createCache(CacheManager cacheManager,
                                         String cacheKey,
                                         Class<K> keyType,
                                         Class<V> valueType)

isStoreJwtTokenKeyOnly

public boolean isStoreJwtTokenKeyOnly()

setJwtTokenConsumer

public void setJwtTokenConsumer(JoseJwtConsumer jwtTokenConsumer)