OAuthRequestInterceptor (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 OAuthRequestInterceptor

java.lang.Object
  org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator
      org.apache.cxf.rs.security.oauth2.filters.OAuthRequestFilter
          org.apache.cxf.rs.security.oauth2.filters.OAuthRequestInterceptor

All Implemented Interfaces:: javax.ws.rs.container.ContainerRequestFilter, Interceptor<Message>, PhaseInterceptor<Message>

public class OAuthRequestInterceptor
extends OAuthRequestFilter
implements PhaseInterceptor<Message>
extends OAuthRequestFilter
implements PhaseInterceptor<Message>

Field Summary

Fields inherited from class org.apache.cxf.rs.security.oauth2.services.AbstractAccessTokenValidator
`realm, supportedSchemes`

Constructor Summary
`OAuthRequestInterceptor()`

Method Summary
`Collection<PhaseInterceptor<? extends Message>>`	`getAdditionalInterceptors()` Returns a collection of Interceptors that should be added to the chain whenever this interceptor is added.
`Set<String>`	`getAfter()` Returns a set containing the IDs of the interceptors that should be executed before this interceptor.
`protected String[]`	`getAuthorizationParts(Message message)`
`Set<String>`	`getBefore()` Returns a set containing the IDs of the interceptors that should be executed after this interceptor.
`String`	`getId()` Returns the ID of this interceptor.
`String`	`getPhase()` Returns the phase in which this interceptor is excecuted.
`void`	`handleFault(Message message)` Called for all interceptors (in reverse order) on which handleMessage had been successfully invoked, when normal execution of the chain was aborted for some reason.
`void`	`handleMessage(Message message)` Intercepts a message.

Methods inherited from class org.apache.cxf.rs.security.oauth2.filters.OAuthRequestFilter
`checkHttpVerb, checkRequestURI, createSecurityContext, filter, getTokenFromFormData, isCorsRequest, setAudienceIsEndpointAddress, setCheckFormData, setUseUserSubject, validateAudience, validateRequest`

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

OAuthRequestInterceptor

public OAuthRequestInterceptor()

Method Detail

handleMessage

public void handleMessage(Message message)
                   throws Fault

Description copied from interface: Interceptor

Intercepts a message. Interceptors should NOT invoke handleMessage or handleFault on the next interceptor - the interceptor chain will take care of this.

Specified by:: handleMessage in interface Interceptor<Message>

Throws:: Fault

getAuthorizationParts

protected String[] getAuthorizationParts(Message message)

Overrides:: getAuthorizationParts in class OAuthRequestFilter