org.restlet.ext.oauth

Class AccessTokenClientResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ClientResource

org.restlet.ext.oauth.AccessTokenClientResource

All Implemented Interfaces:

OAuthResourceDefs

Direct Known Subclasses:

FacebookAccessTokenClientResource

Deprecated.

Will be removed in next minor release.

@Deprecated
public class AccessTokenClientResource
extends ClientResource
implements OAuthResourceDefs

Client resource used to acquire an OAuth token. Implements OAuth 2.0 (RFC6749).
Use or override the requestToken(OAuthParameters) method to retrieve the token.

Author:

Shotaro Uchida

Field Summary

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
AccessTokenClientResource(Reference tokenUri) Deprecated.

Method Summary

Modifier and Type	Method and Description
Representation	handleInbound(Response response) Deprecated. Handles the inbound call.
org.restlet.ext.oauth.internal.Token	requestToken(OAuthParameters parameters) Deprecated. Returns the OAuth token by requesting the remote authorization server.
void	setAuthenticationMethod(ChallengeScheme scheme) Deprecated.
void	setClientCredentials(java.lang.String clientId, java.lang.String clientSecret) Deprecated.
protected void	setupBodyClientCredentials(OAuthParameters parameters) Deprecated. By default adds the clientId and clientSecret (if any) values to the set of Oauth parameters. Called from requestToken(OAuthParameters) method.

Methods inherited from class org.restlet.resource.ClientResource

accept, accept, addQueryParameter, addQueryParameter, addQueryParameters, addSegment, create, create, create, createNext, createRequest, createResponse, delete, delete, delete, doError, doError, doError, doRelease, finalize, get, get, get, getAttribute, getChild, getChild, getChild, getChild, getMaxRedirects, getNext, getOnResponse, getOnSent, getParent, getParent, getRetryAttempts, getRetryDelay, handle, handle, handle, handle, handle, handle, handle, handle, handle, handleOutbound, hasNext, head, head, isFollowingRedirects, isRequestEntityBuffering, isResponseEntityBuffering, isRetryOnError, options, options, options, patch, patch, patch, patch, post, post, post, post, put, put, put, put, redirect, retry, setAttribute, setChallengeResponse, setChallengeResponse, setClientInfo, setConditions, setCookies, setEntityBuffering, setFollowingRedirects, setHostRef, setHostRef, setLoggable, setMaxRedirects, setMethod, setNext, setOnResponse, setOnSent, setOriginalRef, setProtocol, setProxyChallengeResponse, setProxyChallengeResponse, setRanges, setReference, setReference, setReferrerRef, setReferrerRef, setRequestEntityBuffering, setResponseEntityBuffering, setRetryAttempts, setRetryDelay, setRetryOnError, wrap, wrap

Methods inherited from class org.restlet.resource.Resource

doCatch, doError, doInit, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AccessTokenClientResource

public AccessTokenClientResource(Reference tokenUri)

Deprecated.

Method Detail

handleInbound

public Representation handleInbound(Response response)

Deprecated.

Handles the inbound call. Note that only synchronous calls are processed.
Overrides the ClientResource.handleInbound(Response) method in order to return the OAuth error entity. That is to say in case of OAuth error response, no ResourceException is thrown, whereas the initial behaviour of ClientResource is to throw such exception.

Overrides:

handleInbound in class ClientResource

Parameters:

response -

Returns:

The response's entity, if any.

requestToken

public org.restlet.ext.oauth.internal.Token requestToken(OAuthParameters parameters)
                                                  throws OAuthException,
                                                         java.io.IOException,
                                                         org.json.JSONException

Deprecated.

Returns the OAuth token by requesting the remote authorization server.

Parameters:

parameters - The credentials, in case of they are sent via the entity of the request.

Returns:

The OAuth token.

Throws:

OAuthException

java.io.IOException

org.json.JSONException

setAuthenticationMethod

public void setAuthenticationMethod(ChallengeScheme scheme)

Deprecated.

setClientCredentials

public void setClientCredentials(java.lang.String clientId,
                                 java.lang.String clientSecret)

Deprecated.

setupBodyClientCredentials

protected void setupBodyClientCredentials(OAuthParameters parameters)

Deprecated.

By default adds the clientId and clientSecret (if any) values to the set of Oauth parameters.
Called from requestToken(OAuthParameters) method.

Parameters:

parameters - The set of Oauth parameters to complete.