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

Class JPACodeDataProvider

java.lang.Object

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

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

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

All Implemented Interfaces:

AuthorizationCodeDataProvider, ClientRegistrationProvider, OAuthDataProvider

Direct Known Subclasses:

JPACMTCodeDataProvider

public class JPACodeDataProvider
extends JPAOAuthDataProvider
implements AuthorizationCodeDataProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.rs.security.oauth2.provider.JPAOAuthDataProvider

JPAOAuthDataProvider.EntityManagerOperation<T>

Constructor Summary

Constructors

Constructor	Description
JPACodeDataProvider()

Method Summary

Modifier and Type	Method	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)
List<ServerAuthorizationCodeGrant>	getCodeGrants(Client c, UserSubject subject)	Return the list of code grants associated with a given client
protected jakarta.persistence.TypedQuery<ServerAuthorizationCodeGrant>	getCodesQuery(Client c, UserSubject resourceOwnerSubject, jakarta.persistence.EntityManager em)
protected void	removeClientCodeGrants(Client c)
protected void	removeClientCodeGrants(Client c, jakarta.persistence.EntityManager em)
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.JPAOAuthDataProvider

beginIfNeeded, closeIfNeeded, commitIfNeeded, doCreateAccessToken, doGetClient, doRevokeAccessToken, doRevokeRefreshToken, execute, executeInTransaction, flushIfNeeded, getAccessToken, getAccessTokens, getClients, getClientsQuery, getEntityManager, getRefreshToken, getRefreshTokens, getRefreshTokensQuery, getTokensQuery, linkRefreshTokenToAccessToken, persistEntity, removeEntity, saveAccessToken, saveRefreshToken, setClient, setEntityManagerFactory

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

authenticateUnregisteredClient, checkRequestedScopes, close, convertScopeToPermissions, convertSingleScopeToPermission, convertToJWTAccessToken, createAccessToken, createClientCredentialsClient, createJwtAccessToken, createNewAccessToken, createNewRefreshToken, 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

Constructor Details

JPACodeDataProvider

public JPACodeDataProvider()

Method Details

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

saveCodeGrant

protected void saveCodeGrant(ServerAuthorizationCodeGrant grant)

doRemoveClient

protected void doRemoveClient(Client c)

Overrides:

doRemoveClient in class JPAOAuthDataProvider

removeClientCodeGrants

protected void removeClientCodeGrants(Client c)

removeClientCodeGrants

protected void removeClientCodeGrants(Client c,
 jakarta.persistence.EntityManager em)

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

getCodeGrants

public List<ServerAuthorizationCodeGrant> getCodeGrants(Client c,
 UserSubject subject)
                                                 throws OAuthServiceException

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

subject - the user subject, can be null

Returns:

the list of grants

Throws:

OAuthServiceException

See Also:

• ServerAuthorizationCodeGrant

setCodeLifetime

public void setCodeLifetime(long codeLifetime)

getCodesQuery

protected jakarta.persistence.TypedQuery<ServerAuthorizationCodeGrant> getCodesQuery(Client c,
 UserSubject resourceOwnerSubject,
 jakarta.persistence.EntityManager em)