org.forgerock.oauth2.core

Class OAuth2Request

java.lang.Object

org.forgerock.oauth2.core.OAuth2Request

public class OAuth2Request
extends Object

An abstraction of the actual request so as to allow the core of the OAuth2 provider to be agnostic of the library used to translate the HTTP request.

Since:

12.0.0

Constructor Summary

Constructors

Constructor and Description
OAuth2Request(JacksonRepresentationFactory jacksonRepresentationFactory, org.restlet.Request request) Constructs a new RestletOAuth2Request.

Method Summary

Modifier and Type	Method and Description
static OAuth2Request	forRealm(String realm) Creates an OAuth2Request which holds the provided realm only.
org.forgerock.json.JsonValue	getBody() Gets the body of the request.
ClientRegistration	getClientRegistration() Get the OAuth2 client registration of the request.
OAuth2Constants.EndpointType	getEndpointType() Get EndpointType.
Locale	getLocale() Get the request locale.
<T> T	getParameter(String name) Gets the specified parameter from the request.
int	getParameterCount(String name) Gets the count of the parameter present in the request with the given name
Set<String>	getParameterNames() Gets the name of the parameters in the current request
org.restlet.Request	getRequest() Gets the actual underlying request.
String	getSession() Gets the user's session for this request.
<T extends Token> T	getToken(Class<T> tokenClass) Get a Token that is in play for this request.
Collection<Token>	getTokens() Get all the tokens that have been used in this request.
void	setClientRegistration(ClientRegistration clientRegistration) Set the OAuth2 client registration.
void	setSession(String sessionId) Sets the user's session for this request.
<T extends Token> void	setToken(Class<T> tokenClass, T token) Set a Token that is in play for this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Request

@Inject
public OAuth2Request(JacksonRepresentationFactory jacksonRepresentationFactory,
                             org.restlet.Request request)

Constructs a new RestletOAuth2Request.

Parameters:

jacksonRepresentationFactory - The factory class for JacksonRepresentation.

request - The Restlet request.

Method Detail

getRequest

public org.restlet.Request getRequest()

Gets the actual underlying request.

Returns:

The underlying request.

getParameter

public <T> T getParameter(String name)

Gets the specified parameter from the request.
It is up to the implementation to determine how and where it gets the parameter from on the request, i.e. query parameters, request attributes, etc.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

Returns:

The parameter value.

getParameterCount

public int getParameterCount(String name)

Gets the count of the parameter present in the request with the given name

Parameters:

name - The name of the parameter

Returns:

The count of the the parameter with the given name

getParameterNames

public Set<String> getParameterNames()

Gets the name of the parameters in the current request

Returns:

The parameter names in the request

getBody

public org.forgerock.json.JsonValue getBody()

Gets the body of the request.
Note: reading of the body maybe a one time only operation, so the implementation needs to cache the content of the body so multiple calls to this method do not behave differently.
This method should only ever be called for access and refresh token request and requests to the userinfo and tokeninfo endpoints.

Returns:

The body of the request.

setToken

public <T extends Token> void setToken(Class<T> tokenClass,
                                       T token)

Set a Token that is in play for this request.

Type Parameters:

T - The type of token.

Parameters:

tokenClass - The token type.

token - The token instance.

getToken

public <T extends Token> T getToken(Class<T> tokenClass)

Get a Token that is in play for this request.

Type Parameters:

T - The type of token.

Parameters:

tokenClass - The token type.

Returns:

The token instance.

getTokens

public Collection<Token> getTokens()

Get all the tokens that have been used in this request.

Returns:

The token instances.

setSession

public void setSession(String sessionId)

Sets the user's session for this request.

Parameters:

sessionId - The user's session.

getSession

public String getSession()

Gets the user's session for this request.

Returns:

The user's session.

getLocale

public Locale getLocale()

Get the request locale.

Returns:

The Locale object.

getClientRegistration

public ClientRegistration getClientRegistration()

Get the OAuth2 client registration of the request.

Returns:

The client registration.

forRealm

public static OAuth2Request forRealm(String realm)

Creates an OAuth2Request which holds the provided realm only.

Parameters:

realm - The request realm.

Returns:

An OAuth2Request.

setClientRegistration

public void setClientRegistration(ClientRegistration clientRegistration)

Set the OAuth2 client registration.

Parameters:

clientRegistration - The client registration.

getEndpointType

public OAuth2Constants.EndpointType getEndpointType()

Get EndpointType.

Returns:

EndpointType