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

Class DefaultEHCacheCodeDataProvider

java.lang.Object

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

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

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

All Implemented Interfaces:

AuthorizationCodeDataProvider, ClientRegistrationProvider, OAuthDataProvider

public class DefaultEHCacheCodeDataProvider
extends DefaultEHCacheOAuthDataProvider
implements AuthorizationCodeDataProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE_GRANT_CACHE_KEY

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

ACCESS_TOKEN_CACHE_KEY, cacheManager, CLIENT_CACHE_KEY, DEFAULT_CONFIG_URL, REFRESH_TOKEN_CACHE_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultEHCacheCodeDataProvider()
protected	DefaultEHCacheCodeDataProvider(String configFileURL, Bus bus)
protected	DefaultEHCacheCodeDataProvider(String configFileURL, Bus bus, String clientCacheKey, String codeCacheKey, String accessTokenKey, String refreshTokenKey)

Method Summary

Modifier and Type	Method and Description
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 ServerAuthorizationCodeGrant	doCreateCodeGrant(AuthorizationCodeRegistration reg)
protected void	doRemoveClient(Client c)
ServerAuthorizationCodeGrant	getCodeGrant(String code)
List<ServerAuthorizationCodeGrant>	getCodeGrants(Client c, UserSubject sub) Return the list of code grants associated with a given client
protected void	removeClientCodeGrants(Client c)
ServerAuthorizationCodeGrant	removeCodeGrant(String code) Returns the previously registered ServerAuthorizationCodeGrant
protected void	saveCodeGrant(ServerAuthorizationCodeGrant grant)
void	setCodeLifetime(long codeLifetime)

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

close, createCache, doGetClient, doRevokeAccessToken, doRevokeRefreshToken, getAccessToken, getAccessTokens, getCacheValue, getClients, getRefreshToken, getRefreshTokens, isStoreJwtTokenKeyOnly, putCacheValue, saveAccessToken, saveRefreshToken, setClient, setJwtTokenConsumer, setStoreJwtTokenKeyOnly

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

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

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

Field Detail

CODE_GRANT_CACHE_KEY

public static final String CODE_GRANT_CACHE_KEY

See Also:

Constant Field Values

Constructor Detail

DefaultEHCacheCodeDataProvider

protected DefaultEHCacheCodeDataProvider()

DefaultEHCacheCodeDataProvider

protected DefaultEHCacheCodeDataProvider(String configFileURL,
                                         Bus bus)

DefaultEHCacheCodeDataProvider

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

Method Detail

doRemoveClient

protected void doRemoveClient(Client c)

Overrides:

doRemoveClient in class DefaultEHCacheOAuthDataProvider

removeClientCodeGrants

protected void removeClientCodeGrants(Client c)

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

doCreateCodeGrant

protected ServerAuthorizationCodeGrant doCreateCodeGrant(AuthorizationCodeRegistration reg)
                                                  throws OAuthServiceException

Throws:

OAuthServiceException

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

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

getCodeGrant

public ServerAuthorizationCodeGrant getCodeGrant(String code)
                                          throws OAuthServiceException

Throws:

OAuthServiceException

saveCodeGrant

protected void saveCodeGrant(ServerAuthorizationCodeGrant grant)

setCodeLifetime

public void setCodeLifetime(long codeLifetime)