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

Class AbstractCodeDataProvider

java.lang.Object

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

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

All Implemented Interfaces:

AuthorizationCodeDataProvider, ClientRegistrationProvider, OAuthDataProvider

public abstract class AbstractCodeDataProvider
extends AbstractOAuthDataProvider
implements AuthorizationCodeDataProvider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCodeDataProvider()

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)
static ServerAuthorizationCodeGrant	initCodeGrant(AuthorizationCodeRegistration reg, long lifetime)
static boolean	isCodeMatched(ServerAuthorizationCodeGrant grant, Client c, UserSubject sub)
protected void	removeClientCodeGrants(Client c)
protected abstract void	saveCodeGrant(ServerAuthorizationCodeGrant grant)
void	setCodeLifetime(long codeLifetime)

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

authenticateUnregisteredClient, checkRequestedScopes, close, convertScopeToPermissions, convertSingleScopeToPermission, convertToJWTAccessToken, createAccessToken, createClientCredentialsClient, createJwtAccessToken, createNewAccessToken, createNewRefreshToken, doCreateAccessToken, doCreateAccessToken, doCreateNewRefreshToken, doGetClient, doRefreshAccessToken, doRemoveClient, doRevokeAccessToken, doRevokeRefreshToken, getClient, getCurrentClientSecret, getCurrentRequestedGrantType, getCurrentTokenRequestParams, getDefaultScopes, getInvisibleToClientScopes, getIssuer, getJwtAccessTokenClaimMap, getJwtAccessTokenProducer, getMessageContext, getPermissionMap, getPreauthorizedToken, getRefreshToken, getRequiredScopes, handleLinkedRefreshToken, init, isClientMatched, isPersistJwtEncoding, isRecycleRefreshTokens, isRefreshTokenSupported, isSupportPreauthorizedTokens, isTokenMatched, isUseJwtFormatForAccessTokens, linkAccessTokenToRefreshToken, linkRefreshTokenToAccessToken, processJwtAccessToken, refreshAccessToken, removeClient, removeClientTokens, revokeAccessToken, revokeAccessTokens, revokeRefreshToken, revokeToken, saveAccessToken, saveRefreshToken, 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.grants.code.AuthorizationCodeDataProvider

getCodeGrants, removeCodeGrant

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

getClients, setClient

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

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

Constructor Details

AbstractCodeDataProvider

protected AbstractCodeDataProvider()

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

setCodeLifetime

public void setCodeLifetime(long codeLifetime)

removeClientCodeGrants

protected void removeClientCodeGrants(Client c)

initCodeGrant

public static ServerAuthorizationCodeGrant initCodeGrant(AuthorizationCodeRegistration reg,
 long lifetime)

saveCodeGrant

protected abstract void saveCodeGrant(ServerAuthorizationCodeGrant grant)

isCodeMatched

public static boolean isCodeMatched(ServerAuthorizationCodeGrant grant,
 Client c,
 UserSubject sub)