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

Class OAuthRequestFilter

java.lang.Object

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

org.apache.cxf.rs.security.oauth2.filters.OAuthRequestFilter

All Implemented Interfaces:

jakarta.ws.rs.container.ContainerRequestFilter

Direct Known Subclasses:

OAuthRequestInterceptor

@Provider
@PreMatching
@Priority(1000)
public class OAuthRequestFilter
extends AbstractAccessTokenValidator
implements jakarta.ws.rs.container.ContainerRequestFilter

JAX-RS OAuth2 filter which can be used to protect the end-user endpoints

Field Summary

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

realm, supportedSchemes

Constructor Summary

Constructors

Constructor	Description
OAuthRequestFilter()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkHttpVerb(jakarta.servlet.http.HttpServletRequest req, List<String> verbs)
protected boolean	checkRequestURI(jakarta.servlet.http.HttpServletRequest request, List<String> uris, Message m)
protected boolean	checkScopeProperty(String scope)
protected SecurityContext	createSecurityContext(jakarta.servlet.http.HttpServletRequest request, AccessTokenValidation accessTokenV)
void	filter(jakarta.ws.rs.container.ContainerRequestContext context)
String	getAudience()
protected String[]	getAuthorizationParts(Message m)
protected String	getTokenFromFormData(Message message)
boolean	isCompleteAudienceMatch()
protected boolean	isCorsRequest(Message m)
void	setAllPermissionsMatch(boolean allPermissionsMatch)
void	setAudience(String audience)
void	setAudienceIsEndpointAddress(boolean audienceIsEndpointAddress)
void	setBlockPublicClients(boolean blockPublicClients)
void	setCheckFormData(boolean checkFormData)
void	setCompleteAudienceMatch(boolean completeAudienceMatch)
void	setIssuer(String issuer)
void	setRequiredScopes(List<String> requiredScopes)
void	setTokenSubjectAuthenticationMethod(AuthenticationMethod method)
void	setUseUserSubject(boolean useUserSubject)
protected String	validateAudiences(List<String> audiences)
protected void	validateRequest(Message m)

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

findTokenValidator, getAccessTokenValidation, getJwtTokenConsumer, getMessageContext, isPersistJwtEncoding, removeAccessToken, setDataProvider, setJwtTokenConsumer, setMaxValidationDataCacheSize, setMessageContext, setPersistJwtEncoding, setRealm, setTokenValidator, setTokenValidators

Methods inherited from class java.lang.Object

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

Constructor Details

OAuthRequestFilter

public OAuthRequestFilter()

Method Details

filter

public void filter(jakarta.ws.rs.container.ContainerRequestContext context)

Specified by:

filter in interface jakarta.ws.rs.container.ContainerRequestFilter

validateRequest

protected void validateRequest(Message m)

checkHttpVerb

protected boolean checkHttpVerb(jakarta.servlet.http.HttpServletRequest req,
 List<String> verbs)

checkRequestURI

protected boolean checkRequestURI(jakarta.servlet.http.HttpServletRequest request,
 List<String> uris,
 Message m)

checkScopeProperty

protected boolean checkScopeProperty(String scope)

setUseUserSubject

public void setUseUserSubject(boolean useUserSubject)

createSecurityContext

protected SecurityContext createSecurityContext(jakarta.servlet.http.HttpServletRequest request,
 AccessTokenValidation accessTokenV)

isCorsRequest

protected boolean isCorsRequest(Message m)

validateAudiences

protected String validateAudiences(List<String> audiences)

setCheckFormData

public void setCheckFormData(boolean checkFormData)

getAuthorizationParts

protected String[] getAuthorizationParts(Message m)

getTokenFromFormData

protected String getTokenFromFormData(Message message)

setRequiredScopes

public void setRequiredScopes(List<String> requiredScopes)

setAllPermissionsMatch

public void setAllPermissionsMatch(boolean allPermissionsMatch)

setBlockPublicClients

public void setBlockPublicClients(boolean blockPublicClients)

setTokenSubjectAuthenticationMethod

public void setTokenSubjectAuthenticationMethod(AuthenticationMethod method)

getAudience

public String getAudience()

setAudience

public void setAudience(String audience)

isCompleteAudienceMatch

public boolean isCompleteAudienceMatch()

setCompleteAudienceMatch

public void setCompleteAudienceMatch(boolean completeAudienceMatch)

setAudienceIsEndpointAddress

public void setAudienceIsEndpointAddress(boolean audienceIsEndpointAddress)

setIssuer

public void setIssuer(String issuer)