public static class Http.RequestBuilder
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected play.api.mvc.Request<Http.RequestBody> |
req |
Constructor and Description |
---|
RequestBuilder()
Returns a simple request builder.
|
RequestBuilder(Http.RequestBuilder copy)
Returns a request builder as copy of the passed request builder.
|
RequestBuilder(play.api.mvc.request.RequestFactory requestFactory)
Returns a simple request builder.
|
Modifier and Type | Method and Description |
---|---|
<T> Http.RequestBuilder |
attr(TypedKey<T> key,
T value)
Add an attribute to the request.
|
TypedMap |
attrs() |
Http.RequestBuilder |
attrs(TypedMap newAttrs)
Update the request attributes.
|
Http.RequestBody |
body() |
protected Http.RequestBuilder |
body(Http.RequestBody body)
Set the body of the request.
|
protected Http.RequestBuilder |
body(Http.RequestBody body,
java.lang.String contentType)
Set the body of the request.
|
Http.RequestBuilder |
bodyForm(java.util.Map<java.lang.String,java.lang.String> data)
Set a Form url encoded body to this request.
|
Http.RequestBuilder |
bodyFormArrayValues(java.util.Map<java.lang.String,java.lang.String[]> data)
Set a Form url encoded body to this request.
|
Http.RequestBuilder |
bodyJson(com.fasterxml.jackson.databind.JsonNode node)
Set a Json Body to this request.
|
Http.RequestBuilder |
bodyJson(play.api.libs.json.JsValue json)
Set a Json Body to this request.
|
Http.RequestBuilder |
bodyMultipart(java.util.List<Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>> data,
Files.TemporaryFileCreator temporaryFileCreator,
akka.stream.Materializer mat)
Deprecated.
Deprecated as of 2.7.0. Renamed to
bodyRaw(List,
Files.TemporaryFileCreator, Materializer) . |
Http.RequestBuilder |
bodyMultipart(java.util.Map<java.lang.String,java.lang.String[]> formData,
java.util.List<Http.MultipartFormData.FilePart> files)
Set a Multipart Form url encoded body to this request.
|
Http.RequestBuilder |
bodyRaw(byte[] data)
Set a Binary Data to this request using a singleton temporary file creator.
|
Http.RequestBuilder |
bodyRaw(byte[] data,
Files.TemporaryFileCreator tempFileCreator)
Set a Binary Data to this request.
|
Http.RequestBuilder |
bodyRaw(akka.util.ByteString data)
Set a Binary Data to this request using a singleton temp file creator The
Content-Type header of the request is set to application/octet-stream . |
Http.RequestBuilder |
bodyRaw(akka.util.ByteString data,
Files.TemporaryFileCreator tempFileCreator)
Set a Binary Data to this request.
|
Http.RequestBuilder |
bodyRaw(java.util.List<Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>> data,
Files.TemporaryFileCreator temporaryFileCreator,
akka.stream.Materializer mat)
Set a Multipart Form url encoded body to this request saving it as a raw body.
|
Http.RequestBuilder |
bodyText(java.lang.String text)
Set a Text to this request.
|
Http.RequestBuilder |
bodyText(java.lang.String text,
java.nio.charset.Charset charset)
Set a Text to this request.
|
Http.RequestBuilder |
bodyXml(org.w3c.dom.Document xml)
Set a XML to this request.
|
Http.RequestBuilder |
bodyXml(org.xml.sax.InputSource xml)
Set a XML to this request.
|
Http.RequestImpl |
build()
Builds the request.
|
java.util.Optional<java.util.List<java.security.cert.X509Certificate>> |
clientCertificateChain() |
Http.RequestBuilder |
clientCertificateChain(java.util.List<java.security.cert.X509Certificate> clientCertificateChain) |
Http.RequestBuilder |
cookie(Http.Cookie cookie)
Sets one cookie.
|
Http.Cookies |
cookies() |
java.util.Map<java.lang.String,java.lang.String> |
flash() |
Http.RequestBuilder |
flash(java.util.Map<java.lang.String,java.lang.String> data)
Sets cookies in a request.
|
Http.RequestBuilder |
flash(java.lang.String key,
java.lang.String value)
Sets a cookie in the request.
|
Http.Headers |
getHeaders() |
Http.RequestBuilder |
header(java.lang.String key,
java.util.List<java.lang.String> values) |
Http.RequestBuilder |
header(java.lang.String key,
java.lang.String value) |
Http.RequestBuilder |
headers(Http.Headers headers)
Set the headers to be used by the request builder.
|
java.lang.String |
host() |
Http.RequestBuilder |
host(java.lang.String host) |
java.lang.Long |
id() |
Http.RequestBuilder |
id(java.lang.Long id) |
Http.RequestBuilder |
langCookie(Lang lang,
MessagesApi messagesApi)
Sets given lang in a cookie.
|
Http.RequestBuilder |
langCookie(java.util.Locale locale,
MessagesApi messagesApi)
Sets given lang in a cookie.
|
java.lang.String |
method() |
Http.RequestBuilder |
method(java.lang.String method) |
java.lang.String |
path() |
Http.RequestBuilder |
path(java.lang.String path)
This method sets the path of the uri.
|
java.lang.String |
remoteAddress() |
Http.RequestBuilder |
remoteAddress(java.lang.String remoteAddress) |
boolean |
secure() |
Http.RequestBuilder |
secure(boolean secure) |
java.util.Map<java.lang.String,java.lang.String> |
session() |
Http.RequestBuilder |
session(java.util.Map<java.lang.String,java.lang.String> data)
Sets all parameters for the session.
|
Http.RequestBuilder |
session(java.lang.String key,
java.lang.String value)
Sets a session.
|
Http.RequestBuilder |
transientLang(Lang lang)
Sets the transient language.
|
Http.RequestBuilder |
transientLang(java.util.Locale locale)
Sets the transient language.
|
Http.RequestBuilder |
transientLang(java.lang.String code)
Deprecated.
Deprecated as of 2.8.0 Use
transientLang(Lang) instead. |
java.lang.String |
uri() |
Http.RequestBuilder |
uri(java.lang.String str)
Sets the uri.
|
Http.RequestBuilder |
uri(java.net.URI uri) |
java.lang.String |
version() |
Http.RequestBuilder |
version(java.lang.String version) |
Http.RequestBuilder |
withoutTransientLang()
Removes the transient language.
|
protected play.api.mvc.Request<Http.RequestBody> req
public RequestBuilder()
public RequestBuilder(Http.RequestBuilder copy)
public RequestBuilder(play.api.mvc.request.RequestFactory requestFactory)
requestFactory
- the incoming request factorypublic Http.RequestBody body()
protected Http.RequestBuilder body(Http.RequestBody body, java.lang.String contentType)
body
- the bodycontentType
- Content-Type header valueprotected Http.RequestBuilder body(Http.RequestBody body)
body
- The body.public Http.RequestBuilder bodyRaw(akka.util.ByteString data)
Content-Type
header of the request is set to application/octet-stream
.data
- the Binary Datapublic Http.RequestBuilder bodyRaw(akka.util.ByteString data, Files.TemporaryFileCreator tempFileCreator)
Content-Type
header of the request is set to
application/octet-stream
.data
- the Binary DatatempFileCreator
- the temporary file creator for binary data.public Http.RequestBuilder bodyRaw(byte[] data)
Content-Type
header of the request is set to application/octet-stream
.data
- the Binary Datapublic Http.RequestBuilder bodyRaw(byte[] data, Files.TemporaryFileCreator tempFileCreator)
Content-Type
header of the request is set to
application/octet-stream
.data
- the Binary DatatempFileCreator
- the temporary file creator for binary data.public Http.RequestBuilder bodyFormArrayValues(java.util.Map<java.lang.String,java.lang.String[]> data)
data
- the x-www-form-urlencoded parameterspublic Http.RequestBuilder bodyForm(java.util.Map<java.lang.String,java.lang.String> data)
data
- the x-www-form-urlencoded parameters@Deprecated public Http.RequestBuilder bodyMultipart(java.util.List<Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>> data, Files.TemporaryFileCreator temporaryFileCreator, akka.stream.Materializer mat)
bodyRaw(List,
Files.TemporaryFileCreator, Materializer)
.data
- the multipart-form parameterstemporaryFileCreator
- the temporary file creator.mat
- a Akka Streams Materializerpublic Http.RequestBuilder bodyRaw(java.util.List<Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>> data, Files.TemporaryFileCreator temporaryFileCreator, akka.stream.Materializer mat)
data
- the multipart-form parameterstemporaryFileCreator
- the temporary file creator.mat
- a Akka Streams Materializerpublic Http.RequestBuilder bodyMultipart(java.util.Map<java.lang.String,java.lang.String[]> formData, java.util.List<Http.MultipartFormData.FilePart> files)
formData
- the URL form-encoded data partfiles
- the files partpublic Http.RequestBuilder bodyJson(com.fasterxml.jackson.databind.JsonNode node)
Content-Type
header of the request is set to
application/json
.node
- the Json Nodepublic Http.RequestBuilder bodyJson(play.api.libs.json.JsValue json)
Content-Type
header of the request is set to
application/json
.json
- the JsValuepublic Http.RequestBuilder bodyXml(org.xml.sax.InputSource xml)
Content-Type
header of the request is set to application/xml
.xml
- the XMLpublic Http.RequestBuilder bodyXml(org.w3c.dom.Document xml)
The Content-Type
header of the request is set to application/xml
.
xml
- the XMLpublic Http.RequestBuilder bodyText(java.lang.String text)
Content-Type
header of the request is set to text/plain
.text
- the text, assumed to be encoded in US_ASCII format, per
https://tools.ietf.org/html/rfc6657#section-4public Http.RequestBuilder bodyText(java.lang.String text, java.nio.charset.Charset charset)
Content-Type
header of the request is set to text/plain; charset=$charset
.text
- the text, which is assumed to be already encoded in the format defined by
charset.charset
- the character set that the request is encoded in.public Http.RequestImpl build()
public java.lang.Long id()
public Http.RequestBuilder id(java.lang.Long id)
id
- the id to be usedpublic <T> Http.RequestBuilder attr(TypedKey<T> key, T value)
T
- The type of the attribute to add.key
- The key of the attribute to add.value
- The value of the attribute to add.public Http.RequestBuilder attrs(TypedMap newAttrs)
newAttrs
- The attribute entries to add.public TypedMap attrs()
public java.lang.String method()
public Http.RequestBuilder method(java.lang.String method)
method
- sets the methodpublic java.lang.String uri()
public Http.RequestBuilder uri(java.net.URI uri)
public Http.RequestBuilder uri(java.lang.String str)
str
- the uripublic Http.RequestBuilder secure(boolean secure)
secure
- true if the request is securepublic boolean secure()
public java.lang.String host()
public Http.RequestBuilder host(java.lang.String host)
host
- sets the host in the headerpublic java.lang.String path()
public Http.RequestBuilder path(java.lang.String path)
path
- the path after the port and for the query in a uripublic java.lang.String version()
public Http.RequestBuilder version(java.lang.String version)
version
- the versionpublic Http.Headers getHeaders()
public Http.RequestBuilder headers(Http.Headers headers)
headers
- the headers to be replacedpublic Http.RequestBuilder header(java.lang.String key, java.util.List<java.lang.String> values)
key
- the key for in the headervalues
- the values associated with the keypublic Http.RequestBuilder header(java.lang.String key, java.lang.String value)
key
- the key for in the headervalue
- the value (one) associated with the keypublic Http.Cookies cookies()
public Http.RequestBuilder cookie(Http.Cookie cookie)
cookie
- the cookie to be setpublic java.util.Map<java.lang.String,java.lang.String> flash()
public Http.RequestBuilder flash(java.lang.String key, java.lang.String value)
key
- the key for the cookievalue
- the value for the cookiepublic Http.RequestBuilder flash(java.util.Map<java.lang.String,java.lang.String> data)
data
- a key value mapping of cookiespublic java.util.Map<java.lang.String,java.lang.String> session()
public Http.RequestBuilder session(java.lang.String key, java.lang.String value)
key
- the key for the sessionvalue
- the value associated with the key for the sessionpublic Http.RequestBuilder session(java.util.Map<java.lang.String,java.lang.String> data)
data
- a key value mapping of the session datapublic java.lang.String remoteAddress()
public Http.RequestBuilder remoteAddress(java.lang.String remoteAddress)
remoteAddress
- sets the remote addresspublic java.util.Optional<java.util.List<java.security.cert.X509Certificate>> clientCertificateChain()
public Http.RequestBuilder clientCertificateChain(java.util.List<java.security.cert.X509Certificate> clientCertificateChain)
clientCertificateChain
- sets the X509Certificates to usepublic Http.RequestBuilder langCookie(Lang lang, MessagesApi messagesApi)
lang
- The language to use.public Http.RequestBuilder langCookie(java.util.Locale locale, MessagesApi messagesApi)
locale
- The language to use.public Http.RequestBuilder transientLang(Lang lang)
lang
- The language to use.@Deprecated public Http.RequestBuilder transientLang(java.lang.String code)
transientLang(Lang)
instead.code
- The language to use.public Http.RequestBuilder transientLang(java.util.Locale locale)
locale
- The language to use.public Http.RequestBuilder withoutTransientLang()