Apache CXF API

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

java.lang.Object
  extended by org.apache.cxf.rs.security.oauth2.services.AbstractOAuthService
Direct Known Subclasses:
AccessTokenService, RedirectionBasedGrantService

public abstract class AbstractOAuthService
extends Object

Abstract OAuth service


Constructor Summary
AbstractOAuthService()
           
 
Method Summary
protected  void checkTransportSecurity()
          HTTPS is the default transport for OAuth 2.0 services.
protected  Client getClient(javax.ws.rs.core.MultivaluedMap<String,String> params)
           
protected  Client getClient(String clientId)
          Get the Client reference
 OAuthDataProvider getDataProvider()
           
 MessageContext getMessageContext()
           
protected  javax.ws.rs.core.MultivaluedMap<String,String> getQueryParameters()
           
protected  void reportInvalidRequestError(String errorDescription)
           
 void setBlockUnsecureRequests(boolean blockUnsecureRequests)
          HTTPS is the default transport for OAuth 2.0 services, this property can be used to block all the requests issued over HTTP
 void setDataProvider(OAuthDataProvider dataProvider)
           
 void setMessageContext(MessageContext context)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractOAuthService

public AbstractOAuthService()
Method Detail

setMessageContext

@Context
public void setMessageContext(MessageContext context)

getMessageContext

public MessageContext getMessageContext()

setDataProvider

public void setDataProvider(OAuthDataProvider dataProvider)

getDataProvider

public OAuthDataProvider getDataProvider()

getQueryParameters

protected javax.ws.rs.core.MultivaluedMap<String,String> getQueryParameters()

getClient

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

getClient

protected Client getClient(String clientId)
Get the Client reference

Parameters:
clientId - the provided client id
Returns:
Client the client reference
Throws:
javax.ws.rs.WebApplicationException - if no matching Client is found, the error is returned directly to the end user without following the redirect URI if any

checkTransportSecurity

protected void checkTransportSecurity()
HTTPS is the default transport for OAuth 2.0 services. By default this method will issue a warning for open endpoints


reportInvalidRequestError

protected void reportInvalidRequestError(String errorDescription)

setBlockUnsecureRequests

public void setBlockUnsecureRequests(boolean blockUnsecureRequests)
HTTPS is the default transport for OAuth 2.0 services, this property can be used to block all the requests issued over HTTP

Parameters:
blockUnsecureRequests - if set to true then HTTP requests will be blocked

Apache CXF API

Apache CXF