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

Modifier	Constructor and Description
	OAuth2Request(JacksonRepresentationFactory jacksonRepresentationFactory, org.restlet.Request request) Constructs a new RestletOAuth2Request.
protected	OAuth2Request(OAuth2Request request) Copy the OAuth2 request.

Method Summary

Modifier and Type	Method and Description
static OAuth2Request	forRealm(String realm) Creates an OAuth2Request which holds the provided realm only.
Object	getAttribute(String name) Gets the value for an attribute from the request with the specified name.
JsonValue	getBody() Gets the body of the request.
ClientRegistration	getClientRegistration() Get the OAuth2 client registration of the request.
SignedJwt	getConsentResponseJwt()
Locale	getLocale() Get the request locale.
String	getOps() Gets the user's session public reference for this request.
<T> T	getParameter(String name) Gets the specified parameter from the request.
<T> T	getParameter(String name, boolean checkQueryParam) 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
String	getQueryParameter(String name) Gets the value for a query parameter from the request with the specified name.
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	setConsentResponseJwt(SignedJwt jwt)
void	setOps(String ops) Sets the user's session public reference for this request.
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

protected OAuth2Request(OAuth2Request request)

Copy the OAuth2 request.

Parameters:

request - the OAuth2 request

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.
Used to call the overloaded getParameter method with checkQueryParam set to true. The checkQueryParam enables us to prevent checking the query parameters from the request.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

Returns:

The parameter value or null if no parameter found.

getParameter

public <T> T getParameter(String name,
                          boolean checkQueryParam)

Gets the specified parameter from the request.

This method will first check the attributes then query string if checkQueryParam == true, then move onto check entity values if it is a post.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

checkQueryParam - boolean value indicating if the query parameter should be checked.

Returns:

The parameter value or null if no parameter found.

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

getAttribute

public Object getAttribute(String name)

Gets the value for an attribute from the request with the specified name.

Parameters:

name - The name.

Returns:

The attribute value, may be null

getQueryParameter

public String getQueryParameter(String name)

Gets the value for a query parameter from the request with the specified name.

Parameters:

name - The name.

Returns:

The query parameter value, may be null.

getBody

public 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.

setOps

public void setOps(String ops)

Sets the user's session public reference for this request.

Parameters:

ops - The user's session public reference.

getOps

public String getOps()

Gets the user's session public reference for this request.

Returns:

The user's session public reference.

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.

setConsentResponseJwt

public void setConsentResponseJwt(SignedJwt jwt)

Parameters:

jwt - A possibly null consent response to assign to this request.

getConsentResponseJwt

public SignedJwt getConsentResponseJwt()

Returns:

A possibly null SignedJwt if assigned.

setClientRegistration

public void setClientRegistration(ClientRegistration clientRegistration)

Set the OAuth2 client registration.

Parameters:

clientRegistration - The client registration.