Package org.apache.cxf.rs.security.oauth2.services

Class AuthorizationCodeGrantService

java.lang.Object

org.apache.cxf.rs.security.oauth2.services.AbstractOAuthService

org.apache.cxf.rs.security.oauth2.services.RedirectionBasedGrantService

org.apache.cxf.rs.security.oauth2.services.AuthorizationCodeGrantService

Direct Known Subclasses:

OidcAuthorizationCodeService

@Path("/authorize")
public class AuthorizationCodeGrantService
extends RedirectionBasedGrantService

This resource handles the End User authorizing or denying the Client to access its resources. If End User approves the access this resource will redirect End User back to the Client, supplying the authorization code.

Field Summary

Fields inherited from class org.apache.cxf.rs.security.oauth2.services.AbstractOAuthService

LOG

Constructor Summary

Constructors

Constructor	Description
AuthorizationCodeGrantService()

Method Summary

Modifier and Type	Method	Description
protected boolean	canRedirectUriBeEmpty(Client c)
protected boolean	canSupportPublicClient(Client c)
protected AuthorizationCodeRegistration	createCodeRegistration(OAuthRedirectionState state, Client client, List<String> requestedScope, List<String> approvedScope, UserSubject userSubject, ServerAccessToken preauthorizedToken)
protected jakarta.ws.rs.core.Response	createErrorResponse(String state, String redirectUri, String error)
protected jakarta.ws.rs.core.Response	createGrant(OAuthRedirectionState state, Client client, List<String> requestedScope, List<String> approvedScope, UserSubject userSubject, ServerAccessToken preauthorizedToken)
protected jakarta.ws.rs.core.Response	deliverOOBResponse(OOBAuthorizationResponse response)
ServerAuthorizationCodeGrant	getGrantRepresentation(OAuthRedirectionState state, Client client, List<String> requestedScope, List<String> approvedScope, UserSubject userSubject, ServerAccessToken preauthorizedToken)
protected jakarta.ws.rs.core.UriBuilder	getRedirectUriBuilder(String state, String redirectUri)
protected String	processCodeGrant(Client client, String code, UserSubject endUser)
protected OAuthRedirectionState	recreateRedirectionStateFromParams(jakarta.ws.rs.core.MultivaluedMap<String,String> params)
void	setCanSupportEmptyRedirectForPrivateClients(boolean canSupportEmptyRedirectForPrivateClients)
void	setCanSupportPublicClients(boolean support)
void	setCodeResponseFilter(AuthorizationCodeResponseFilter filter)

Methods inherited from class org.apache.cxf.rs.security.oauth2.services.RedirectionBasedGrantService

authorize, authorizeDecision, authorizeDecisionForm, authorizePost, canAccessTokenBeReturned, canAuthorizationBeSkipped, completeAuthorization, createAuthorizationData, createErrorResponse, createHtmlResponse, createUserSubject, getAndValidateSecurityContext, getApprovedScope, getClient, getSupportedGrantType, getSupportedResponseTypes, isFormResponse, isRevokePreauthorizedTokenOnApproval, noConsentForRequestedScopes, personalizeData, recreateRedirectionStateFromSession, setAuthorizationFilter, setHidePreauthorizedScopesInForm, setMatchRedirectUriWithApplicationUri, setMaxDefaultSessionInterval, setPartialMatchScopeValidation, setResourceOwnerNameProvider, setRevokePreauthorizedTokenOnApproval, setScopesRequiringNoConsent, setSessionAuthenticityTokenProvider, setSubjectCreator, setSupportSinglePageApplications, setUseAllClientScopes, setUseRegisteredRedirectUriIfPossible, startAuthorization, startAuthorization, validateRedirectUri

Methods inherited from class org.apache.cxf.rs.security.oauth2.services.AbstractOAuthService

checkTransportSecurity, getDataProvider, getMessageContext, getQueryParameters, getValidClient, getValidClient, injectContextIntoOAuthProviders, isWriteOptionalParameters, reportInvalidRequestError, reportInvalidRequestError, reportInvalidRequestError, reportInvalidRequestError, setBlockUnsecureRequests, setDataProvider, setMessageContext, setWriteOptionalParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthorizationCodeGrantService

public AuthorizationCodeGrantService()

Method Details

recreateRedirectionStateFromParams

protected OAuthRedirectionState recreateRedirectionStateFromParams(jakarta.ws.rs.core.MultivaluedMap<String,String> params)

Overrides:

recreateRedirectionStateFromParams in class RedirectionBasedGrantService

createGrant

protected jakarta.ws.rs.core.Response createGrant(OAuthRedirectionState state,
 Client client,
 List<String> requestedScope,
 List<String> approvedScope,
 UserSubject userSubject,
 ServerAccessToken preauthorizedToken)

Specified by:

createGrant in class RedirectionBasedGrantService

getGrantRepresentation

public ServerAuthorizationCodeGrant getGrantRepresentation(OAuthRedirectionState state,
 Client client,
 List<String> requestedScope,
 List<String> approvedScope,
 UserSubject userSubject,
 ServerAccessToken preauthorizedToken)

createCodeRegistration

protected AuthorizationCodeRegistration createCodeRegistration(OAuthRedirectionState state,
 Client client,
 List<String> requestedScope,
 List<String> approvedScope,
 UserSubject userSubject,
 ServerAccessToken preauthorizedToken)

processCodeGrant

protected String processCodeGrant(Client client,
 String code,
 UserSubject endUser)

deliverOOBResponse

protected jakarta.ws.rs.core.Response deliverOOBResponse(OOBAuthorizationResponse response)

createErrorResponse

protected jakarta.ws.rs.core.Response createErrorResponse(String state,
 String redirectUri,
 String error)

Specified by:

createErrorResponse in class RedirectionBasedGrantService

getRedirectUriBuilder

protected jakarta.ws.rs.core.UriBuilder getRedirectUriBuilder(String state,
 String redirectUri)

canSupportPublicClient

protected boolean canSupportPublicClient(Client c)

Specified by:

canSupportPublicClient in class RedirectionBasedGrantService

canRedirectUriBeEmpty

protected boolean canRedirectUriBeEmpty(Client c)

Specified by:

canRedirectUriBeEmpty in class RedirectionBasedGrantService

setCanSupportPublicClients

public void setCanSupportPublicClients(boolean support)

setCodeResponseFilter

public void setCodeResponseFilter(AuthorizationCodeResponseFilter filter)

setCanSupportEmptyRedirectForPrivateClients

public void setCanSupportEmptyRedirectForPrivateClients(boolean canSupportEmptyRedirectForPrivateClients)