OAuthRequestFilter (Apache CXF JavaDoc 3.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Apache CXF API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: javax.ws.rs.container.ContainerRequestFilter

Direct Known Subclasses:: OAuthRequestInterceptor

@Provider @PreMatching public class OAuthRequestFilter
extends AbstractAccessTokenValidator
implements javax.ws.rs.container.ContainerRequestFilter
extends AbstractAccessTokenValidator
implements javax.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
`OAuthRequestFilter()`

Method Summary
`protected boolean`	`checkHttpVerb(javax.servlet.http.HttpServletRequest req, List<String> verbs)`
`protected boolean`	`checkRequestURI(javax.servlet.http.HttpServletRequest request, List<String> uris)`
`protected SecurityContext`	`createSecurityContext(javax.servlet.http.HttpServletRequest request, AccessTokenValidation accessTokenV)`
`void`	`filter(javax.ws.rs.container.ContainerRequestContext context)`
`protected String[]`	`getAuthorizationParts(Message m)`
`protected String`	`getTokenFromFormData(Message message)`
`protected boolean`	`isCorsRequest(Message m)`
`void`	`setAudienceIsEndpointAddress(boolean audienceIsEndpointAddress)`
`void`	`setCheckFormData(boolean checkFormData)`
`void`	`setUseUserSubject(boolean useUserSubject)`
`protected boolean`	`validateAudience(String audience)`
`protected void`	`validateRequest(Message m)`

Methods inherited from class org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator
`findTokenValidator, getAccessTokenValidation, getAudiences, getMessageContext, setAudiences, setDataProvider, setMessageContext, setRealm, setTokenValidator, setTokenValidators`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

OAuthRequestFilter

public OAuthRequestFilter()

Method Detail

filter

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

Specified by:: filter in interface javax.ws.rs.container.ContainerRequestFilter

validateRequest

protected void validateRequest(Message m)

checkHttpVerb

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

checkRequestURI

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

setUseUserSubject

public void setUseUserSubject(boolean useUserSubject)

createSecurityContext

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

isCorsRequest

protected boolean isCorsRequest(Message m)

validateAudience

protected boolean validateAudience(String audience)

Overrides:: validateAudience in class AbstractAccessTokenValidator

setAudienceIsEndpointAddress

public void setAudienceIsEndpointAddress(boolean audienceIsEndpointAddress)

setCheckFormData

public void setCheckFormData(boolean checkFormData)

getAuthorizationParts

protected String[] getAuthorizationParts(Message m)

getTokenFromFormData

protected String getTokenFromFormData(Message message)