Package org.apache.cxf.rs.security.oauth2.grants.code

Class JCacheCodeDataProvider

java.lang.Object

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

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

org.apache.cxf.rs.security.oauth2.grants.code.JCacheCodeDataProvider

All Implemented Interfaces:

AuthorizationCodeDataProvider, ClientRegistrationProvider, OAuthDataProvider

public class JCacheCodeDataProvider
extends JCacheOAuthDataProvider
implements AuthorizationCodeDataProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE_GRANT_CACHE_KEY

Fields inherited from class org.apache.cxf.rs.security.oauth2.provider.JCacheOAuthDataProvider

ACCESS_TOKEN_CACHE_KEY, cacheManager, CLIENT_CACHE_KEY, DEFAULT_CONFIG_URL, REFRESH_TOKEN_CACHE_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JCacheCodeDataProvider()
protected	JCacheCodeDataProvider(String configFileURL, Bus bus)
protected	JCacheCodeDataProvider(String configFileURL, Bus bus, String clientCacheKey, String codeCacheKey, String accessTokenKey, String refreshTokenKey)
protected	JCacheCodeDataProvider(String configFileURL, Bus bus, String clientCacheKey, String codeCacheKey, String accessTokenKey, String refreshTokenKey, boolean storeJwtTokenKeyOnly)

Method Summary

Modifier and Type	Method	Description
void	close()
ServerAuthorizationCodeGrant	createCodeGrant(AuthorizationCodeRegistration reg)	Creates a temporarily code grant which will capture the information about the Client requesting the access to the resource owner's resources
protected void	doRemoveClient(Client c)
protected ServerAuthorizationCodeGrant	getCodeGrant(String code)
List<ServerAuthorizationCodeGrant>	getCodeGrants(Client c, UserSubject sub)	Return the list of code grants associated with a given client
protected static boolean	isExpired(ServerAuthorizationCodeGrant grant)
ServerAuthorizationCodeGrant	removeCodeGrant(String code)	Returns the previously registered ServerAuthorizationCodeGrant
void	setCodeLifetime(long codeLifetime)

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

createCache, createCacheManager, doGetClient, doRevokeAccessToken, doRevokeRefreshToken, getAccessToken, getAccessTokens, getClients, getJwtAccessToken, getJwtAccessTokens, getRefreshToken, getRefreshTokens, getToken, getTokens, isExpired, isStoreJwtTokenKeyOnly, linkRefreshTokenToAccessToken, saveAccessToken, saveRefreshToken, setClient, setJwtTokenConsumer

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

authenticateUnregisteredClient, checkRequestedScopes, convertScopeToPermissions, convertSingleScopeToPermission, convertToJWTAccessToken, createAccessToken, createClientCredentialsClient, createJwtAccessToken, createNewAccessToken, createNewRefreshToken, doCreateAccessToken, doCreateAccessToken, doCreateNewRefreshToken, doRefreshAccessToken, getClient, getCurrentClientSecret, getCurrentRequestedGrantType, getCurrentTokenRequestParams, getDefaultScopes, getInvisibleToClientScopes, getIssuer, getJwtAccessTokenClaimMap, getJwtAccessTokenProducer, getMessageContext, getPermissionMap, getPreauthorizedToken, getRequiredScopes, handleLinkedRefreshToken, init, isClientMatched, isPersistJwtEncoding, isRecycleRefreshTokens, isRefreshTokenSupported, isSupportPreauthorizedTokens, isTokenMatched, isUseJwtFormatForAccessTokens, linkAccessTokenToRefreshToken, processJwtAccessToken, refreshAccessToken, removeClient, removeClientTokens, revokeAccessToken, revokeAccessTokens, revokeRefreshToken, revokeToken, setAccessTokenLifetime, setAuthenticationStrategy, setClients, setDefaultScopes, setInvisibleToClientScopes, setIssuer, setJwtAccessTokenClaimMap, setJwtAccessTokenProducer, setMessageContext, setPermissionMap, setPersistJwtEncoding, 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

Methods inherited from interface org.apache.cxf.rs.security.oauth2.provider.OAuthDataProvider

convertScopeToPermissions, createAccessToken, getAccessToken, getAccessTokens, getClient, getPreauthorizedToken, getRefreshTokens, refreshAccessToken, revokeToken

Field Details

CODE_GRANT_CACHE_KEY

public static final String CODE_GRANT_CACHE_KEY

See Also:

• Constant Field Values

Constructor Details

JCacheCodeDataProvider

protected JCacheCodeDataProvider()

JCacheCodeDataProvider

protected JCacheCodeDataProvider(String configFileURL,
 Bus bus)

JCacheCodeDataProvider

protected JCacheCodeDataProvider(String configFileURL,
 Bus bus,
 String clientCacheKey,
 String codeCacheKey,
 String accessTokenKey,
 String refreshTokenKey)

JCacheCodeDataProvider

protected JCacheCodeDataProvider(String configFileURL,
 Bus bus,
 String clientCacheKey,
 String codeCacheKey,
 String accessTokenKey,
 String refreshTokenKey,
 boolean storeJwtTokenKeyOnly)

Method Details

doRemoveClient

protected void doRemoveClient(Client c)

Overrides:

doRemoveClient in class JCacheOAuthDataProvider

createCodeGrant

public ServerAuthorizationCodeGrant createCodeGrant(AuthorizationCodeRegistration reg)
                                             throws OAuthServiceException

Description copied from interface: AuthorizationCodeDataProvider

Creates a temporarily code grant which will capture the information about the Client requesting the access to the resource owner's resources

Specified by:

createCodeGrant in interface AuthorizationCodeDataProvider

Parameters:

reg - information about the client code grant request

Returns:

new code grant

Throws:

OAuthServiceException

See Also:

• AuthorizationCodeRegistration
• ServerAuthorizationCodeGrant

getCodeGrants

public List<ServerAuthorizationCodeGrant> getCodeGrants(Client c,
 UserSubject sub)

Description copied from interface: AuthorizationCodeDataProvider

Return the list of code grants associated with a given client

Specified by:

getCodeGrants in interface AuthorizationCodeDataProvider

Parameters:

c - the client

sub - the user subject, can be null

Returns:

the list of grants

See Also:

• ServerAuthorizationCodeGrant

removeCodeGrant

public ServerAuthorizationCodeGrant removeCodeGrant(String code)
                                             throws OAuthServiceException

Description copied from interface: AuthorizationCodeDataProvider

Returns the previously registered ServerAuthorizationCodeGrant

Specified by:

removeCodeGrant in interface AuthorizationCodeDataProvider

Parameters:

code - the code grant

Returns:

the grant

Throws:

OAuthServiceException - if no grant with this code is available

See Also:

• ServerAuthorizationCodeGrant

setCodeLifetime

public void setCodeLifetime(long codeLifetime)

getCodeGrant

protected ServerAuthorizationCodeGrant getCodeGrant(String code)
                                             throws OAuthServiceException

Throws:

OAuthServiceException

isExpired

protected static boolean isExpired(ServerAuthorizationCodeGrant grant)

close

public void close()

Overrides:

close in class JCacheOAuthDataProvider