org.restlet.ext.oauth

Class OAuthServerResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.oauth.OAuthServerResource

All Implemented Interfaces:

OAuthResourceDefs

Direct Known Subclasses:

AccessTokenServerResource, AuthorizationBaseServerResource, TokenAuthServerResource

Deprecated.

Will be removed in next minor release.

@Deprecated
public abstract class OAuthServerResource
extends ServerResource
implements OAuthResourceDefs

Base class for common resources used by the OAuth server side. Implements OAuth 2.0 (RFC6749)

Author:

Shotaro Uchida , Kristoffer Gronowski

Field Summary

Fields

Modifier and Type	Field and Description
protected org.restlet.ext.oauth.internal.ClientManager	clients Deprecated.
static java.lang.String	PARAMETER_DEFAULT_SCOPE Deprecated.
protected org.restlet.ext.oauth.internal.TokenManager	tokens Deprecated.

Fields inherited from interface org.restlet.ext.oauth.OAuthResourceDefs

ACCESS_TOKEN, CLIENT_ID, CLIENT_SECRET, CODE, ERROR, ERROR_DESC, ERROR_URI, EXPIRES_IN, GRANT_TYPE, PASSWORD, REDIR_URI, REFRESH_TOKEN, RESPONSE_TYPE, SCOPE, STATE, TOKEN_TYPE, TOKEN_TYPE_BEARER, TOKEN_TYPE_MAC, USERNAME

Constructor Summary

Constructors

Constructor and Description
OAuthServerResource() Deprecated. Default constructor.

Method Summary

Modifier and Type	Method and Description
static void	addCacheDirective(Response response, CacheDirective cacheDirective) Deprecated. Adds a cache directive to the response.
protected void	doInit() Deprecated.
protected org.restlet.ext.oauth.internal.Client	getClient(Form parameters) Deprecated. Get request parameter "client_id".
protected java.lang.String[]	getScope(Form parameters) Deprecated. Get request parameter "scope".
protected java.lang.String	getState(Form parameters) Deprecated. Get request parameter "state".
static Representation	responseErrorRepresentation(OAuthException ex) Deprecated. Returns the representation of the given error.

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doHandle, doNegotiatedHandle, get, get, getAnnotation, getAnnotation, getAnnotations, getAttribute, getDescription, getInfo, getInfo, getName, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDescription, setDimensions, setExisting, setLocationRef, setLocationRef, setName, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_DEFAULT_SCOPE

public static final java.lang.String PARAMETER_DEFAULT_SCOPE

Deprecated.

See Also:

Constant Field Values

clients

protected volatile org.restlet.ext.oauth.internal.ClientManager clients

Deprecated.

tokens

protected volatile org.restlet.ext.oauth.internal.TokenManager tokens

Deprecated.

Constructor Detail

OAuthServerResource

public OAuthServerResource()

Deprecated.

Default constructor.

Method Detail

addCacheDirective

public static void addCacheDirective(Response response,
                                     CacheDirective cacheDirective)

Deprecated.

Adds a cache directive to the response.

Parameters:

response - The current response.

cacheDirective - The cache directive to add.

responseErrorRepresentation

public static Representation responseErrorRepresentation(OAuthException ex)

Deprecated.

Returns the representation of the given error. The format of the JSON document is according to 5.2. Error Response.

Parameters:

ex - Any OAuthException with error

Returns:

The representation of the given error.

doInit

protected void doInit()
               throws ResourceException

Deprecated.

Overrides:

doInit in class Resource

Throws:

ResourceException

getClient

protected org.restlet.ext.oauth.internal.Client getClient(Form parameters)
                                                   throws OAuthException

Deprecated.

Get request parameter "client_id".

Parameters:

parameters -

Returns:

Throws:

OAuthException

getScope

protected java.lang.String[] getScope(Form parameters)
                               throws OAuthException

Deprecated.

Get request parameter "scope".

Parameters:

parameters -

Returns:

Throws:

OAuthException

getState

protected java.lang.String getState(Form parameters)

Deprecated.

Get request parameter "state".

Parameters:

parameters -

Returns:

Throws:

OAuthException