com.wedeploy.api.sdk

Class RequestWrapper

java.lang.Object

com.wedeploy.api.sdk.RequestWrapper

All Implemented Interfaces:

Request

public class RequestWrapper
extends java.lang.Object
implements Request

Request wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
protected Request	request

Constructor Summary

Constructors

Constructor and Description
RequestWrapper(Request request)

Method Summary

Modifier and Type	Method and Description
Auth	auth() Returns the auth.
java.lang.String	baseUrl() Returns the base URL corresponding to the the HTTP request.
java.lang.String	body() Returns the body content as a string.
Request	body(byte[] body) Sets the raw body content.
Request	body(java.lang.Object body) Sets the body content, assuming JSON content type.
Request	body(java.lang.String body) Sets the body content by passing the string value.
Request	body(java.lang.String body, ContentType contentType) Sets the raw body content and the content-type.
byte[]	bodyBytes() Returns the raw body content.
<T> java.util.List<T>	bodyList(java.lang.Class<T> componentType) Returns parsed body content as a List.
<K,V> java.util.Map<K,V>	bodyMap(java.lang.Class<K> keyType, java.lang.Class<V> valueType) Returns parsed body content.
<V> java.util.Map<java.lang.String,V>	bodyMap(java.lang.Class<V> valueType) REturns parsed body content.
<T> T	bodyValue() Parses the body depending on content-type.
<T> T	bodyValue(java.lang.Class<T> type) Parses the body depending on content-type into the target type.
java.lang.String	contentType() Gets the content type header.
Request	contentType(ContentType contentType) Sets the content type header.
Context	context() Returns the context that this request belongs to.
Request	cookie(Cookie cookie) Adds a cookie to the response.
Cookie	cookie(java.lang.String name) Gets cookie value by name.
java.util.Map<java.lang.String,Cookie>	cookies()
FileUpload[]	fileUploads() Returns array of uploaded files.
java.lang.Object	form(java.lang.String name) Returns the form parameter.
Request	form(java.lang.String name, java.lang.Object value) Sets the form parameter.
MultiMap<java.lang.Object>	forms() Returns form parameters.
java.lang.String	header(java.lang.String name) Gets header value by name.
Request	header(java.lang.String name, java.lang.String value) Sets the first header name with the specified value.
MultiMap<java.lang.String>	headers() Returns headers.
boolean	isContentType(ContentType contentType) Checks if the request contains a content type header with the specified value.
java.lang.String	method() Returns HTTP method, in uppercase.
Request	method(java.lang.String method) Sets method.
void	next() Delegates this request to the next handler.
void	next(OnResponseEndCallback onResponseEnd) Delegates this request to the next handler and executes the runnable on the response end.
java.lang.String	param(java.lang.String name) Gets parameter value by name.
Request	param(java.lang.String name, java.lang.String value) Sets parameter value.
MultiMap<java.lang.String>	params() Returns map of string request parameters.
java.lang.String	path() Returns action path of the URI.
java.lang.String	query() Returns the query string of the URL.
Response	response() Returns associated response of this request.
void	response(Response response) Associates response to this request.
Session	session() Returns current session.
java.lang.String	url() Returns the absolute URL corresponding to the the HTTP request.
MultiMap<java.lang.Object>	values() Merges all the inputs in best possible way.
<T> T	values(java.lang.Class<T> type) Returns merged values to a certain type.

Methods inherited from class java.lang.Object

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

Field Detail

request

protected final Request request

Constructor Detail

RequestWrapper

public RequestWrapper(Request request)

Method Detail

auth

public Auth auth()

Description copied from interface: Request

Returns the auth.

Specified by:

auth in interface Request

baseUrl

public java.lang.String baseUrl()

Description copied from interface: Request

Returns the base URL corresponding to the the HTTP request. If null the request represents a 'local' call, with only a Request.path() existing.

Specified by:

baseUrl in interface Request

body

public java.lang.String body()

Description copied from interface: Request

Returns the body content as a string.

Specified by:

body in interface Request

body

public Request body(byte[] body)

Description copied from interface: Request

Sets the raw body content.

Specified by:

body in interface Request

body

public Request body(java.lang.Object body)

Description copied from interface: Request

Sets the body content, assuming JSON content type.

Specified by:

body in interface Request

body

public Request body(java.lang.String body)

Description copied from interface: Request

Sets the body content by passing the string value.

Specified by:

body in interface Request

body

public Request body(java.lang.String body,
                    ContentType contentType)

Description copied from interface: Request

Sets the raw body content and the content-type. This is just a shortcut method.

Specified by:

body in interface Request

bodyBytes

public byte[] bodyBytes()

Description copied from interface: Request

Returns the raw body content.

Specified by:

bodyBytes in interface Request

bodyList

public <T> java.util.List<T> bodyList(java.lang.Class<T> componentType)

Description copied from interface: Request

Returns parsed body content as a List.

Specified by:

bodyList in interface Request

bodyMap

public <K,V> java.util.Map<K,V> bodyMap(java.lang.Class<K> keyType,
                                        java.lang.Class<V> valueType)

Description copied from interface: Request

Returns parsed body content. If body is not set, returns null.

Specified by:

bodyMap in interface Request

bodyMap

public <V> java.util.Map<java.lang.String,V> bodyMap(java.lang.Class<V> valueType)

Description copied from interface: Request

REturns parsed body content. If body is not set, returns null.

Specified by:

bodyMap in interface Request

bodyValue

public <T> T bodyValue()

Description copied from interface: Request

Parses the body depending on content-type. If content-type is NOT set, it will use assume the "plain/text" content type. Returns parsed body content. If body is not set, returns null. If body can not be parsed, throws an Exception.

Specified by:

bodyValue in interface Request

bodyValue

public <T> T bodyValue(java.lang.Class<T> type)

Description copied from interface: Request

Parses the body depending on content-type into the target type.

Specified by:

bodyValue in interface Request

See Also:

Request.bodyValue()

contentType

public java.lang.String contentType()

Description copied from interface: Request

Gets the content type header.

Specified by:

contentType in interface Request

contentType

public Request contentType(ContentType contentType)

Description copied from interface: Request

Sets the content type header.

Specified by:

contentType in interface Request

context

public Context context()

Description copied from interface: Request

Returns the context that this request belongs to.

Specified by:

context in interface Request

cookie

public Request cookie(Cookie cookie)

Description copied from interface: Request

Adds a cookie to the response.

Specified by:

cookie in interface Request

cookie

public Cookie cookie(java.lang.String name)

Description copied from interface: Request

Gets cookie value by name.

Specified by:

cookie in interface Request

cookies

public java.util.Map<java.lang.String,Cookie> cookies()

Specified by:

cookies in interface Request

Returns:

A map of all the cookies.

fileUploads

public FileUpload[] fileUploads()

Description copied from interface: Request

Returns array of uploaded files. Returns null if nothing was uploaded.

Specified by:

fileUploads in interface Request

form

public java.lang.Object form(java.lang.String name)

Description copied from interface: Request

Returns the form parameter.

Specified by:

form in interface Request

form

public Request form(java.lang.String name,
                    java.lang.Object value)

Description copied from interface: Request

Sets the form parameter.

Specified by:

form in interface Request

forms

public MultiMap<java.lang.Object> forms()

Description copied from interface: Request

Returns form parameters.

Specified by:

forms in interface Request

header

public java.lang.String header(java.lang.String name)

Description copied from interface: Request

Gets header value by name.

Specified by:

header in interface Request

header

public Request header(java.lang.String name,
                      java.lang.String value)

Description copied from interface: Request

Sets the first header name with the specified value.

Specified by:

header in interface Request

headers

public MultiMap<java.lang.String> headers()

Description copied from interface: Request

Returns headers.

Specified by:

headers in interface Request

isContentType

public boolean isContentType(ContentType contentType)

Description copied from interface: Request

Checks if the request contains a content type header with the specified value.

Specified by:

isContentType in interface Request

method

public java.lang.String method()

Description copied from interface: Request

Returns HTTP method, in uppercase.

Specified by:

method in interface Request

method

public Request method(java.lang.String method)

Description copied from interface: Request

Sets method.

Specified by:

method in interface Request

next

public void next()

Description copied from interface: Request

Delegates this request to the next handler.

Specified by:

next in interface Request

next

public void next(OnResponseEndCallback onResponseEnd)

Description copied from interface: Request

Delegates this request to the next handler and executes the runnable on the response end.

Specified by:

next in interface Request

param

public java.lang.String param(java.lang.String name)

Description copied from interface: Request

Gets parameter value by name.

Specified by:

param in interface Request

param

public Request param(java.lang.String name,
                     java.lang.String value)

Description copied from interface: Request

Sets parameter value.

Specified by:

param in interface Request

params

public MultiMap<java.lang.String> params()

Description copied from interface: Request

Returns map of string request parameters. They consist of:

1. query parameters
2. form parameters
3. parameters from api.json (serialized to string)
4. path parameters

Parameters are accumulated in given order.

Specified by:

params in interface Request

path

public java.lang.String path()

Description copied from interface: Request

Returns action path of the URI. Returned path does not contain the query part. Returns "/" for the root.

Specified by:

path in interface Request

query

public java.lang.String query()

Description copied from interface: Request

Returns the query string of the URL.

Specified by:

query in interface Request

response

public Response response()

Description copied from interface: Request

Returns associated response of this request.

Specified by:

response in interface Request

response

public void response(Response response)

Description copied from interface: Request

Associates response to this request.

Specified by:

response in interface Request

session

public Session session()

Description copied from interface: Request

Returns current session.

Specified by:

session in interface Request

url

public java.lang.String url()

Description copied from interface: Request

Returns the absolute URL corresponding to the the HTTP request.

Specified by:

url in interface Request

values

public MultiMap<java.lang.Object> values()

Description copied from interface: Request

Merges all the inputs in best possible way. The following is merged in given order:

1. parameters - parsed to a JSON, if possible
2. Request.bodyValue() parsed body}

Values with the same names and different sources are accumulated in multi map. Always returns an object, never a null. When content type is one of the form content types, body is ignored.

Specified by:

values in interface Request

values

public <T> T values(java.lang.Class<T> type)

Description copied from interface: Request

Returns merged values to a certain type.

Specified by:

values in interface Request

See Also:

Request.values()