org.glassfish.jersey.message.internal
Class Requests

java.lang.Object
  org.glassfish.jersey.message.internal.Requests

public final class Requests
extends java.lang.Object

Internal Jersey request factory & utility class. Provides various request factory and utility methods.

Author:

Marek Potociar (marek.potociar at oracle.com)

Method Summary

static java.net.URI	baseUri(Request request) Get the base URI of the request.
static Request.RequestBuilder	from(Request request) Create a new request instance as a copy of an existing request instance.
static Request.RequestBuilder	from(java.lang.String requestUri, java.lang.String method) Create new request builder without any base URI.
static Request.RequestBuilder	from(java.lang.String baseUri, java.lang.String requestUri, java.lang.String method) Create new request builder with a base URI.
static Request.RequestBuilder	from(java.net.URI requestUri, java.lang.String method) Create new request builder without any base URI.
static Request.RequestBuilder	from(java.net.URI baseUri, java.net.URI requestUri, java.lang.String method) Create new request builder with a base URI.
static Request.RequestBuilder	from(java.net.URI baseUri, java.net.URI requestUri, java.lang.String method, java.io.InputStream externalInputStream) Create new request builder with a base URI.
static MessageBodyWorkers	getMessageWorkers(Request request) Get the MessageBodyWorkers from the request.
static HttpHeaders	httpHeaders(Request request) Get HttpHeaders instance representing the headers of the request.
static java.lang.String	relativePath(Request request) Get the path of the request relative to the base request URI as a string.
static java.lang.String	relativePath(Request request, boolean decode) Get the path of the request relative to the base request URI as a string.
static void	setMessageWorkers(Request.RequestBuilder requestBuilder, MessageBodyWorkers workers) Set the MessageBodyWorkers to the request builder.
static Request.RequestBuilder	toBuilder(Request request) Request builder initialized from the request.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static Request.RequestBuilder from(java.net.URI baseUri,
                                          java.net.URI requestUri,
                                          java.lang.String method)

Create new request builder with a base URI.

Parameters:

baseUri - base request URI; on the server side represented by the application root URI.

requestUri - absolute request URI.

method - request method.

Returns:

new request builder.

from

public static Request.RequestBuilder from(java.net.URI baseUri,
                                          java.net.URI requestUri,
                                          java.lang.String method,
                                          java.io.InputStream externalInputStream)

Create new request builder with a base URI.

Parameters:

baseUri - base request URI; on the server side represented by the application root URI.

requestUri - absolute request URI.

method - request method.

externalInputStream - sets the external raw input stream. This input stream is the stream "from wire" and is not intercepted yet.

Returns:

new request builder.

from

public static Request.RequestBuilder from(java.net.URI requestUri,
                                          java.lang.String method)

Create new request builder without any base URI.

Parameters:

requestUri - absolute request URI.

method - request method.

Returns:

new request builder.

from

public static Request.RequestBuilder from(java.lang.String baseUri,
                                          java.lang.String requestUri,
                                          java.lang.String method)

Create new request builder with a base URI.

Parameters:

baseUri - base request URI; on the server side represented by the application root URI.

requestUri - absolute request URI.

method - request method.

Returns:

new request builder.

from

public static Request.RequestBuilder from(java.lang.String requestUri,
                                          java.lang.String method)

Create new request builder without any base URI.

Parameters:

requestUri - absolute request URI.

method - request method.

Returns:

new request builder.

from

public static Request.RequestBuilder from(Request request)

Create a new request instance as a copy of an existing request instance.

Parameters:

request - original JAX-RS request to be copied. It is assumed that the instance is represented by an internal Jersey request type.

Returns:

copy of an existing request instance.

toBuilder

public static Request.RequestBuilder toBuilder(Request request)

Request builder initialized from the request.

Parameters:

request - JAX-RS request. It is assumed that the instance is represented by an internal Jersey request type.

Returns:

request builder initialized from the request.

relativePath

public static java.lang.String relativePath(Request request)

Get the path of the request relative to the base request URI as a string. All sequences of escaped octets are decoded, equivalent to Requests.relativePath(request, true).

Parameters:

request - JAX-RS request. It is assumed that the instance is represented by an internal Jersey request type.

Returns:

decoded relative request path.

relativePath

public static java.lang.String relativePath(Request request,
                                            boolean decode)

Get the path of the request relative to the base request URI as a string.

Parameters:

request - JAX-RS request. It is assumed that the instance is represented by an internal Jersey request type.

decode - controls whether sequences of escaped octets are decoded (true) or not (false).

Returns:

relative request path.

baseUri

public static java.net.URI baseUri(Request request)

Get the base URI of the request.

On the server side base request URI is the URI of the application. URIs of root resource classes are all relative to this base URI.

Parameters:

request - JAX-RS request. It is assumed that the instance is represented by an internal Jersey request type.

Returns:

base URI of the request.

httpHeaders

public static HttpHeaders httpHeaders(Request request)

Get HttpHeaders instance representing the headers of the request.

Parameters:

request - JAX-RS request. It is assumed that the instance is represented by an internal Jersey request type.

Returns:

HttpHeaders instance for the headers of the request.

setMessageWorkers

public static void setMessageWorkers(Request.RequestBuilder requestBuilder,
                                     MessageBodyWorkers workers)

Set the MessageBodyWorkers to the request builder.

Parameters:

requestBuilder - JAX-RS request builder. It is assumed that the instance is represented by an internal Jersey request builder type.

workers - message body readers and writers lookup factory.

getMessageWorkers

public static MessageBodyWorkers getMessageWorkers(Request request)

Get the MessageBodyWorkers from the request.

Parameters:

request - JAX-RS request. It is assumed that the instance is represented by an internal Jersey request builder type.

Returns:

message body readers and writers lookup factory.