org.glassfish.jersey.message.internal
Class Responses

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

public final class Responses
extends java.lang.Object

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

Author:

Paul Sandoz, Marek Potociar (marek.potociar at oracle.com), Jakub Podlesak (jakub.podlesak at oracle.com)

Method Summary

static Response.ResponseBuilder	clientError(Request request) Create a response builder for the request & status code set to Response.Status.BAD_REQUEST.
static Response.ResponseBuilder	conflict(Request request) Create a response builder for the request & status code set to Response.Status.CONFLICT.
static Response.ResponseBuilder	empty() Create a response builder with no response entity & status code set to Response.Status.NO_CONTENT.
static void	fillHeaders(Response.ResponseBuilder responseBuilder, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Add headers to the response builder.
static Response.ResponseBuilder	from(int statusCode, Request request) Create a response builder for the request with a given status code.
static Response.ResponseBuilder	from(int statusCode, Request request, java.io.InputStream externalInputStream) Create a response builder for the request with a given status code.
static Response.ResponseBuilder	from(Response.StatusType status, Request request) Create a response builder for the request with a given status code.
static MessageBodyWorkers	getMessageWorkers(Response response) Get the MessageBodyWorkers from the response.
static Response.ResponseBuilder	methodNotAllowed(Request request) Create a response builder for the request & status code set to Response.Status.METHOD_NOT_ALLOWED.
static Response.ResponseBuilder	noContent(Request request) Create a response builder for the request & status code set to Response.Status.NO_CONTENT.
static Response.ResponseBuilder	notAcceptable(Request request) Create a response builder for the request & status code set to Response.Status.NOT_ACCEPTABLE.
static Response.ResponseBuilder	notFound(Request request) Create a response builder for the request & status code set to Response.Status.NOT_FOUND.
static Response.ResponseBuilder	notModified(EntityTag eTag, Request request) Create a response builder for the request & status code set to Response.Status.NOT_MODIFIED.
static Response.ResponseBuilder	notModified(Request request) Create a response builder for the request & status code set to Response.Status.NOT_MODIFIED.
static Response.ResponseBuilder	preconditionFailed(Request request) Create a response builder for the request & status code set to Response.Status.PRECONDITION_FAILED.
static void	setMessageWorkers(Response.ResponseBuilder responseBuilder, MessageBodyWorkers workers) Set the MessageBodyWorkers to the response builder.
static Response.ResponseBuilder	toBuilder(Response response) Transforms a response to a response builder.
static Response.ResponseBuilder	unsupportedMediaType(Request request) Create a response builder for the request & status code set to Response.Status.UNSUPPORTED_MEDIA_TYPE.

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static Response.ResponseBuilder empty()

Create a response builder with no response entity & status code set to Response.Status.NO_CONTENT.

Returns:

response builder instance.

from

public static Response.ResponseBuilder from(Response.StatusType status,
                                            Request request)

Create a response builder for the request with a given status code.

Parameters:

status - response status code.

request - request for which the response is created.

Returns:

response builder instance.

from

public static Response.ResponseBuilder from(int statusCode,
                                            Request request,
                                            java.io.InputStream externalInputStream)

Create a response builder for the request with a given status code.

Parameters:

statusCode - response status code.

request - request for which the response is created.

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

Returns:

response builder instance.

from

public static Response.ResponseBuilder from(int statusCode,
                                            Request request)

Create a response builder for the request with a given status code.

Parameters:

statusCode - response status code.

request - request for which the response is created.

Returns:

response builder instance.

toBuilder

public static Response.ResponseBuilder toBuilder(Response response)

Transforms a response to a response builder.

Parameters:

response - response instance to be transformed into a response builder.

Returns:

response builder instance.

fillHeaders

public static void fillHeaders(Response.ResponseBuilder responseBuilder,
                               java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Add headers to the response builder.

Parameters:

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

headers - map of headers. Each header name may be associated with multiple values stored as a list.

notModified

public static Response.ResponseBuilder notModified(EntityTag eTag,
                                                   Request request)

Create a response builder for the request & status code set to Response.Status.NOT_MODIFIED.

Parameters:

eTag - entity tag header value to be set on the response.

request - request for which the response is created.

Returns:

response builder instance.

notModified

public static Response.ResponseBuilder notModified(Request request)

Create a response builder for the request & status code set to Response.Status.NOT_MODIFIED.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

noContent

public static Response.ResponseBuilder noContent(Request request)

Create a response builder for the request & status code set to Response.Status.NO_CONTENT.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

clientError

public static Response.ResponseBuilder clientError(Request request)

Create a response builder for the request & status code set to Response.Status.BAD_REQUEST.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

notFound

public static Response.ResponseBuilder notFound(Request request)

Create a response builder for the request & status code set to Response.Status.NOT_FOUND.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

methodNotAllowed

public static Response.ResponseBuilder methodNotAllowed(Request request)

Create a response builder for the request & status code set to Response.Status.METHOD_NOT_ALLOWED.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

notAcceptable

public static Response.ResponseBuilder notAcceptable(Request request)

Create a response builder for the request & status code set to Response.Status.NOT_ACCEPTABLE.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

preconditionFailed

public static Response.ResponseBuilder preconditionFailed(Request request)

Create a response builder for the request & status code set to Response.Status.PRECONDITION_FAILED.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

conflict

public static Response.ResponseBuilder conflict(Request request)

Create a response builder for the request & status code set to Response.Status.CONFLICT.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

unsupportedMediaType

public static Response.ResponseBuilder unsupportedMediaType(Request request)

Create a response builder for the request & status code set to Response.Status.UNSUPPORTED_MEDIA_TYPE.

Parameters:

request - request for which the response is created.

Returns:

response builder instance.

setMessageWorkers

public static void setMessageWorkers(Response.ResponseBuilder responseBuilder,
                                     MessageBodyWorkers workers)

Set the MessageBodyWorkers to the response builder.

Parameters:

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

workers - message body readers and writers lookup factory.

getMessageWorkers

public static MessageBodyWorkers getMessageWorkers(Response response)

Get the MessageBodyWorkers from the response.

Parameters:

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

Returns:

message body readers and writers lookup factory.