org.restlet.ext.oauth

Class AccessTokenServerResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.oauth.OAuthServerResource

org.restlet.ext.oauth.AccessTokenServerResource

All Implemented Interfaces:

OAuthResourceDefs

Deprecated.

Will be removed in next minor release.

@Deprecated
public class AccessTokenServerResource
extends OAuthServerResource

Server resource used to acquire an OAuth token. A code, or refresh token can be exchanged for a working token. Implements OAuth 2.0 (RFC6749) Example. Attach an AccessTokenServerResource

 {
      @code
      public Restlet createInboundRoot() {
              ...
              root.attach("/token", AccessTokenServerResource.class);
              ...
      }
 }
 

Author:

Shotaro Uchida , Kristoffer Gronowski

See Also:

OAuth 2.0 (3.2. Token Endpoint)

Field Summary

Fields inherited from class org.restlet.ext.oauth.OAuthServerResource

clients, PARAMETER_DEFAULT_SCOPE, tokens

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
AccessTokenServerResource() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	doCatch(java.lang.Throwable t) Deprecated. Handles errors as described in 5.2 Error Response.
protected void	ensureGrantTypeAllowed(org.restlet.ext.oauth.internal.Client client, GrantType grantType) Deprecated.
protected org.restlet.ext.oauth.internal.Client	getAuthenticatedClient() Deprecated.
protected org.restlet.ext.oauth.internal.Client	getClient(Form params) Deprecated. Get request parameter "client_id".
protected java.lang.String	getCode(Form parameters) Deprecated. Returns the value of the request parameter "code".
protected GrantType	getGrantType(Form parameters) Deprecated. Returns the value of the request parameter "grant_type".
protected java.lang.String	getPassword(Form parameters) Deprecated. Returns the value of the request parameter "password".
protected java.lang.String	getRedirectURI(Form parameters) Deprecated. Returns the value of the request parameter "redirect_uri".
protected java.lang.String	getRefreshToken(Form parameters) Deprecated. Returns the value of the request parameter "refresh_token".
protected java.lang.String	getUsername(Form parameters) Deprecated. Returns the value of the request parameter "username".
Representation	requestToken(Representation input) Deprecated. Handles the Post request.
protected Representation	responseTokenRepresentation(org.restlet.ext.oauth.internal.Token token, java.lang.String[] requestedScope) Deprecated. Generates a JSON document with valid token.

Methods inherited from class org.restlet.ext.oauth.OAuthServerResource

addCacheDirective, doInit, getScope, getState, responseErrorRepresentation

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, 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

Constructor Detail

AccessTokenServerResource

public AccessTokenServerResource()

Deprecated.

Method Detail

doCatch

protected void doCatch(java.lang.Throwable t)

Deprecated.

Handles errors as described in 5.2 Error Response.

Overrides:

doCatch in class ServerResource

ensureGrantTypeAllowed

protected void ensureGrantTypeAllowed(org.restlet.ext.oauth.internal.Client client,
                                      GrantType grantType)
                               throws OAuthException

Deprecated.

Throws:

OAuthException

getAuthenticatedClient

protected org.restlet.ext.oauth.internal.Client getAuthenticatedClient()
                                                                throws OAuthException

Deprecated.

Throws:

OAuthException

getClient

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

Deprecated.

Description copied from class: OAuthServerResource

Get request parameter "client_id".

Overrides:

getClient in class OAuthServerResource

Returns:

Throws:

OAuthException

getCode

protected java.lang.String getCode(Form parameters)
                            throws OAuthException

Deprecated.

Returns the value of the request parameter "code".

Parameters:

parameters -

Returns:

The value of the request parameter "code".

Throws:

OAuthException - In case the parameter is not set.

getGrantType

protected GrantType getGrantType(Form parameters)
                          throws OAuthException

Deprecated.

Returns the value of the request parameter "grant_type".

Parameters:

parameters -

Returns:

The value of the request parameter "grant_type".

Throws:

OAuthException - In case the parameter is not set or is an invalid value.

getPassword

protected java.lang.String getPassword(Form parameters)
                                throws OAuthException

Deprecated.

Returns the value of the request parameter "password".

Parameters:

parameters -

Returns:

The value of the request parameter "password".

Throws:

OAuthException - In case the parameter is not set.

getRedirectURI

protected java.lang.String getRedirectURI(Form parameters)
                                   throws OAuthException

Deprecated.

Returns the value of the request parameter "redirect_uri".

Parameters:

parameters -

Returns:

The value of the request parameter "redirect_uri".

Throws:

OAuthException - In case the parameter is not set.

getRefreshToken

protected java.lang.String getRefreshToken(Form parameters)
                                    throws OAuthException

Deprecated.

Returns the value of the request parameter "refresh_token".

Parameters:

parameters -

Returns:

The value of the request parameter "refresh_token".

Throws:

OAuthException - In case the parameter is not set.

getUsername

protected java.lang.String getUsername(Form parameters)
                                throws OAuthException

Deprecated.

Returns the value of the request parameter "username".

Parameters:

parameters -

Returns:

The value of the request parameter "username".

Throws:

OAuthException - In case the parameter is not set.

requestToken

@Post(value="form:json")
public Representation requestToken(Representation input)
                                                     throws OAuthException,
                                                            org.json.JSONException

Deprecated.

Handles the Post request. The client MUST use the HTTP "POST" method when making access token requests. (3.2. Token Endpoint)

Parameters:

input - HTML form formated token request per oauth-v2 spec.

Returns:

JSON response with token or error.

Throws:

OAuthException

org.json.JSONException

responseTokenRepresentation

protected Representation responseTokenRepresentation(org.restlet.ext.oauth.internal.Token token,
                                                     java.lang.String[] requestedScope)
                                              throws org.json.JSONException

Deprecated.

Generates a JSON document with valid token. The format of the JSON document is according to 5.1. Successful Response.

Parameters:

token - The token generated by the client.

requestedScope - The scope originally requested by the client.

Returns:

The token representation as described in RFC6749 5.1.

Throws:

org.json.JSONException