org.restlet.ext.oauth

Class AuthorizationBaseServerResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.oauth.OAuthServerResource

org.restlet.ext.oauth.AuthorizationBaseServerResource

All Implemented Interfaces:

OAuthResourceDefs

Direct Known Subclasses:

AuthorizationServerResource, AuthPageServerResource

Deprecated.

Will be removed in next minor release.

@Deprecated
public class AuthorizationBaseServerResource
extends OAuthServerResource

Base Restlet resource class for Authorization service resource.
Handle errors according to OAuth2.0 specification, and manage AuthSession. Authorization Enddpoint, Authorization pages, and Login pages should extend this class.

Author:

Shotaro Uchida

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

Method Summary

Modifier and Type	Method and Description
protected void	doCatch(java.lang.Throwable t) Deprecated.
protected org.restlet.ext.oauth.internal.AuthSession	getAuthSession() Deprecated. Returns the current authorization session.
protected Representation	getErrorPage(java.lang.String errPage, OAuthException ex) Deprecated. Helper method to format error responses according to OAuth2 spec.
protected void	resetAuthSession() Deprecated. Reset the current authorization session.
protected void	sendError(java.lang.String redirectionUri, OAuthException ex, java.lang.String state, boolean fragment) Deprecated. Helper method to format error responses according to OAuth2 spec.
protected org.restlet.ext.oauth.internal.AuthSession	setupAuthSession(org.restlet.ext.oauth.internal.RedirectionURI redirectionUri) Deprecated. Sets up a new authorization session.
protected void	ungetAuthSession() Deprecated. Use resetAuthSession() instead.

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

addCacheDirective, doInit, getClient, 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

AuthorizationBaseServerResource

public AuthorizationBaseServerResource()

Deprecated.

Method Detail

doCatch

protected void doCatch(java.lang.Throwable t)

Deprecated.

Overrides:

doCatch in class ServerResource

getAuthSession

protected org.restlet.ext.oauth.internal.AuthSession getAuthSession()
                                                             throws OAuthException

Deprecated.

Returns the current authorization session.

Returns:

The current AuthSession instance.

Throws:

OAuthException - In case the session has timed out.

getErrorPage

protected Representation getErrorPage(java.lang.String errPage,
                                      OAuthException ex)

Deprecated.

Helper method to format error responses according to OAuth2 spec. (Non Redirect)

Parameters:

errPage - errorPage template name

ex - Any OAuthException with error

sendError

protected void sendError(java.lang.String redirectionUri,
                         OAuthException ex,
                         java.lang.String state,
                         boolean fragment)

Deprecated.

Helper method to format error responses according to OAuth2 spec. (Redirect)

Parameters:

redirectionUri - redirection URI to send error.

ex - Any OAuthException with error.

state - state parameter as presented in the initial authorize request.

fragment - true if use URL Fragment.

setupAuthSession

protected org.restlet.ext.oauth.internal.AuthSession setupAuthSession(org.restlet.ext.oauth.internal.RedirectionURI redirectionUri)

Deprecated.

Sets up a new authorization session.

Parameters:

redirectionUri - The redirection URI.

Returns:

A new autorization session.

ungetAuthSession

protected void ungetAuthSession()

Deprecated. Use resetAuthSession() instead.

Unget current authorization session.

resetAuthSession

protected void resetAuthSession()

Deprecated.

Reset the current authorization session.