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

Class AbstractTokenService

java.lang.Object

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

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

Direct Known Subclasses:

AccessTokenService, TokenRevocationService

public class AbstractTokenService
extends AbstractOAuthService

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
AbstractTokenService()

Method Summary

Modifier and Type	Method	Description
protected Client	authenticateClientIfNeeded(jakarta.ws.rs.core.MultivaluedMap<String,String> params)	Make sure the client is authenticated
protected void	checkCertificateBinding(Client client, TLSSessionInfo tlsSessionInfo)
protected void	compareTlsCertificates(TLSSessionInfo tlsInfo, List<String> base64EncodedCerts)
protected jakarta.ws.rs.core.Response	createErrorResponse(jakarta.ws.rs.core.MultivaluedMap<String,String> params, String error)
protected jakarta.ws.rs.core.Response	createErrorResponseFromBean(OAuthError errorBean)
protected jakarta.ws.rs.core.Response	createErrorResponseFromErrorCode(String error)
protected Client	getAndValidateClientFromIdAndSecret(String clientId, String providedClientSecret, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected Client	getClient(String clientId, jakarta.ws.rs.core.MultivaluedMap<String,String> params)	Get the Client reference
protected Client	getClient(String clientId, String clientSecret, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected Client	getClientFromBasicAuthScheme(jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected Client	getClientFromTLSCertificates(jakarta.ws.rs.core.SecurityContext sc, TLSSessionInfo tlsSessionInfo, jakarta.ws.rs.core.MultivaluedMap<String,String> params)
protected jakarta.ws.rs.core.Response	handleException(OAuthServiceException ex, String error)
boolean	isCanSupportPublicClients()
protected boolean	isConfidenatialClientSecretValid(Client client, String providedClientSecret)
protected boolean	isValidPublicClient(Client client, String clientId)
protected void	reportInvalidClient()
protected void	reportInvalidClient(OAuthError error)
protected String	retrieveClientId(jakarta.ws.rs.core.MultivaluedMap<String,String> params)
void	setCanSupportPublicClients(boolean support)
void	setClientIdProvider(ClientIdProvider clientIdProvider)
void	setClientSecretVerifier(ClientSecretVerifier clientSecretVerifier)
void	setWriteCustomErrors(boolean writeCustomErrors)
protected void	validateClientAuthenticationMethod(Client c, String authMethod)

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

AbstractTokenService

public AbstractTokenService()

Method Details

authenticateClientIfNeeded

protected Client authenticateClientIfNeeded(jakarta.ws.rs.core.MultivaluedMap<String,String> params)

Make sure the client is authenticated

validateClientAuthenticationMethod

protected void validateClientAuthenticationMethod(Client c,
 String authMethod)

retrieveClientId

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

getAndValidateClientFromIdAndSecret

protected Client getAndValidateClientFromIdAndSecret(String clientId,
 String providedClientSecret,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

isConfidenatialClientSecretValid

protected boolean isConfidenatialClientSecretValid(Client client,
 String providedClientSecret)

isValidPublicClient

protected boolean isValidPublicClient(Client client,
 String clientId)

getClientFromBasicAuthScheme

protected Client getClientFromBasicAuthScheme(jakarta.ws.rs.core.MultivaluedMap<String,String> params)

checkCertificateBinding

protected void checkCertificateBinding(Client client,
 TLSSessionInfo tlsSessionInfo)

getClientFromTLSCertificates

protected Client getClientFromTLSCertificates(jakarta.ws.rs.core.SecurityContext sc,
 TLSSessionInfo tlsSessionInfo,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

compareTlsCertificates

protected void compareTlsCertificates(TLSSessionInfo tlsInfo,
 List<String> base64EncodedCerts)

handleException

protected jakarta.ws.rs.core.Response handleException(OAuthServiceException ex,
 String error)

createErrorResponse

protected jakarta.ws.rs.core.Response createErrorResponse(jakarta.ws.rs.core.MultivaluedMap<String,String> params,
 String error)

createErrorResponseFromErrorCode

protected jakarta.ws.rs.core.Response createErrorResponseFromErrorCode(String error)

createErrorResponseFromBean

protected jakarta.ws.rs.core.Response createErrorResponseFromBean(OAuthError errorBean)

getClient

protected Client getClient(String clientId,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

Get the Client reference

Parameters:

clientId - the provided client id

Returns:

Client the client reference

getClient

protected Client getClient(String clientId,
 String clientSecret,
 jakarta.ws.rs.core.MultivaluedMap<String,String> params)

reportInvalidClient

protected void reportInvalidClient()

reportInvalidClient

protected void reportInvalidClient(OAuthError error)

setCanSupportPublicClients

public void setCanSupportPublicClients(boolean support)

isCanSupportPublicClients

public boolean isCanSupportPublicClients()

setWriteCustomErrors

public void setWriteCustomErrors(boolean writeCustomErrors)

setClientIdProvider

public void setClientIdProvider(ClientIdProvider clientIdProvider)

setClientSecretVerifier

public void setClientSecretVerifier(ClientSecretVerifier clientSecretVerifier)