AbstractAuthFilter (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.oauth.filters
Class AbstractAuthFilter

java.lang.Object
  org.apache.cxf.rs.security.oauth.filters.AbstractAuthFilter

Direct Known Subclasses:: OAuthRequestFilter, OAuthServletFilter

public class AbstractAuthFilter
extends Object
extends Object

Base OAuth filter which can be used to protect end-user endpoints

Constructor Summary
`protected`	`AbstractAuthFilter()`

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 OAuthContext`	`createOAuthContext(OAuthInfo info)`
`protected SecurityContext`	`createSecurityContext(javax.servlet.http.HttpServletRequest request, OAuthInfo info)`
`protected AuthorizationPolicy`	`getAuthorizationPolicy(String authorizationHeader)`
`protected OAuthInfo`	`handleOAuthRequest(javax.servlet.http.HttpServletRequest req)` Authenticates the third-party consumer and returns `OAuthInfo` bean capturing the information about the request.
`boolean`	`isUseUserSubject()`
`void`	`setDataProvider(OAuthDataProvider provider)` Sets `OAuthDataProvider` provider.
`void`	`setSupportUnknownParameters(boolean supportUnknownParameters)`
`void`	`setUseUserSubject(boolean useUserSubject)`
`void`	`setValidator(net.oauth.OAuthValidator validator)`

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

Constructor Detail

AbstractAuthFilter

protected AbstractAuthFilter()

Method Detail

setDataProvider

public void setDataProvider(OAuthDataProvider provider)

Sets OAuthDataProvider provider.

Parameters:: provider - the provider

setUseUserSubject

public void setUseUserSubject(boolean useUserSubject)

isUseUserSubject

public boolean isUseUserSubject()

handleOAuthRequest

protected OAuthInfo handleOAuthRequest(javax.servlet.http.HttpServletRequest req)
                                throws Exception,
                                       net.oauth.OAuthProblemException

Authenticates the third-party consumer and returns OAuthInfo bean capturing the information about the request.

Parameters:: req - http request
Returns:: OAuth info
Throws:: Exception; net.oauth.OAuthProblemException
See Also:: OAuthInfo

getAuthorizationPolicy

protected AuthorizationPolicy getAuthorizationPolicy(String authorizationHeader)

checkHttpVerb

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

checkRequestURI

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

createSecurityContext

protected SecurityContext createSecurityContext(javax.servlet.http.HttpServletRequest request,
                                                OAuthInfo info)

createOAuthContext

protected OAuthContext createOAuthContext(OAuthInfo info)

setValidator

public void setValidator(net.oauth.OAuthValidator validator)

setSupportUnknownParameters

public void setSupportUnknownParameters(boolean supportUnknownParameters)