public class HttpResponse
extends java.lang.Object
Constructor and Description |
---|
HttpResponse()
Creates an empty
HttpResponse . |
Modifier and Type | Method and Description |
---|---|
void |
addCookie(Cookie cookie)
Adds cookie to the response.
|
void |
addCookie(java.lang.String name,
java.lang.String value)
Deprecated.
Please use
addCookie(Cookie) and Cookie.builder() instead of this method. |
void |
addCookie(java.lang.String name,
java.lang.String value,
int maxAge)
Deprecated.
Please use
addCookie(Cookie) and Cookie.builder() instead of this method. |
void |
addCookie(java.lang.String name,
java.lang.String value,
int maxAge,
boolean secured,
boolean httpOnly)
Deprecated.
Please use
addCookie(Cookie) and Cookie.builder() instead of this method. |
void |
addCookie(java.lang.String name,
java.lang.String value,
java.lang.String domain,
java.lang.String path,
int maxAge,
boolean secured,
boolean httpOnly)
Deprecated.
Please use
addCookie(Cookie) and Cookie.builder() instead of this method. |
void |
addCookie(java.lang.String name,
java.lang.String value,
java.lang.String domain,
java.lang.String path,
int maxAge,
java.util.Date expires,
boolean secured,
boolean httpOnly)
Deprecated.
Please use
addCookie(Cookie) and Cookie.builder() instead of this method. |
void |
addCookie(java.lang.String name,
java.lang.String value,
java.lang.String domain,
java.lang.String path,
int maxAge,
java.util.Date expires,
boolean secured,
boolean httpOnly,
Cookie.SameSite sameSite)
Deprecated.
Please use
addCookie(Cookie) and Cookie.builder() instead of this method. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Adds a response header field.
|
void |
addHeaders(java.util.Map<java.lang.String,java.lang.String> map)
Adds a map of header fields.
|
java.lang.String |
getHeader(java.lang.String key)
Returns the header field value associated to the given header field
key . |
protected long |
getLength()
Returns the length (in bytes) of the response data or
-1 if the length is unknown. |
java.lang.String |
getMimeType()
Returns the MIME-TYPE of the response.
|
java.lang.String |
getStatus()
Returns the response status.
|
Cookie |
removeCookie(java.lang.String name)
Remove the cookie mapped by name.
|
void |
setData(byte[] data)
Set the data contained by this response.
|
void |
setData(java.io.InputStream dataStream)
Sets the
InputStream from which the response data can be read. |
void |
setData(java.io.InputStream dataStream,
long length)
Sets the
InputStream from which the response data can be read. |
void |
setData(java.lang.String data)
Set the data contained by this response.
|
void |
setData(java.lang.String data,
java.lang.String encoding)
|
void |
setMimeType(java.lang.String mimeType)
Set the response MIME-TYPE.
|
void |
setStatus(java.lang.String status)
Set the response status.
|
public HttpResponse()
HttpResponse
.public void addHeader(java.lang.String name, java.lang.String value)
addCookie(String, String, String, String, int, boolean, boolean)
name
- name of the header field to set.value
- value of the header filed.public void addHeaders(java.util.Map<java.lang.String,java.lang.String> map)
addCookie(String, String, String, String, int, boolean, boolean)
map
- map of headers to add@Nullable public java.lang.String getHeader(@Nullable java.lang.String key)
key
.key
- a header field name (if null
, null
is returned).null
if the header field is not found.protected long getLength()
-1
if the length is unknown.@Nullable public java.lang.String getMimeType()
public java.lang.String getStatus()
public void setData(@Nullable java.lang.String data)
data
- the response data as a byte array (set to empty if null
is given)public void setData(@Nullable java.lang.String data, java.lang.String encoding) throws java.io.UnsupportedEncodingException
data
- the String
to be used as response body.encoding
- the encoding used to transform the String
data
to bytes. The following encodings
can be used:
ISO-8859-1
ISO-8859-1 encoding, always supported by the platform
UTF-8
UTF-8 encoding, only supported if the "Embed UTF-8 encoding" option is enabled
in the Run Configurations. If this option is not set, an UnsupportedEncodingException
is
thrown.
US-ASCII
US-ASCII encoding
java.io.UnsupportedEncodingException
- when the specified encoding is not supported.public void setData(@Nullable byte[] data)
data
- the response data as a byte array (set to empty if null
is given)public void setData(java.io.InputStream dataStream)
InputStream
from which the response data can be read.
This method should be used only if response data length is not known in advance. If the length is known by
advance the setData(InputStream, long)
should be used instead of this one. When response data is
specified with this method, the response must be sent using the chunked transfer-coding which increase the
response message size.
dataStream
- the InputStream
from which the response data can be read, the stream will be closed
automatically when the response is sent.public void setData(java.io.InputStream dataStream, long length)
InputStream
from which the response data can be read.
This method should be used when response data length is known in advance. It allows to transfer response body without using the chunked transfer-coding. This reduces response message size.
dataStream
- the InputStream
from which the response data can be read, the stream will be closed
automatically when the response is sent.length
- the number of byte to be read from the InputStream
.public final void setMimeType(java.lang.String mimeType)
mimeType
- the response MIME-TYPE to set.public final void setStatus(java.lang.String status)
status
- the response status to set. Should be one of the HTTP_STATUS_*
constants defined in
HttpConstants
public void addCookie(Cookie cookie)
cookie
- the cookie to add.@Deprecated public void addCookie(java.lang.String name, java.lang.String value)
addCookie(Cookie)
and Cookie.builder()
instead of this method.name
- name of the cookievalue
- value of the cookie@Deprecated public void addCookie(java.lang.String name, java.lang.String value, int maxAge)
addCookie(Cookie)
and Cookie.builder()
instead of this method.name
- name of the cookievalue
- value of the cookiemaxAge
- max age of the cookie in seconds (negative for the not persistent cookie, zero - deletes the cookie)@Deprecated public void addCookie(java.lang.String name, java.lang.String value, int maxAge, boolean secured, boolean httpOnly)
addCookie(Cookie)
and Cookie.builder()
instead of this method.name
- name of the cookievalue
- value of the cookiemaxAge
- max age of the cookie in seconds (negative for the not persistent cookie, zero - deletes the cookie)secured
- if true : cookie will be securedhttpOnly
- if true: cookie will be marked as http only@Deprecated public void addCookie(java.lang.String name, java.lang.String value, @Nullable java.lang.String domain, @Nullable java.lang.String path, int maxAge, boolean secured, boolean httpOnly)
addCookie(Cookie)
and Cookie.builder()
instead of this method.name
- name of the cookievalue
- value of the cookiedomain
- domain of the cookiepath
- path of the cookiemaxAge
- max age of the cookie in seconds (negative for the not persistent cookie, zero - deletes the cookie)secured
- if true : cookie will be securedhttpOnly
- if true: cookie will be marked as http only@Deprecated public void addCookie(java.lang.String name, java.lang.String value, @Nullable java.lang.String domain, @Nullable java.lang.String path, int maxAge, @Nullable java.util.Date expires, boolean secured, boolean httpOnly)
addCookie(Cookie)
and Cookie.builder()
instead of this method.name
- name of the cookievalue
- value of the cookiedomain
- domain of the cookiepath
- path of the cookiemaxAge
- max age of the cookie in seconds (negative for the not persistent cookie, zero - deletes the cookie)expires
- The maximum lifetime of the cookie as an HTTP-date timestamp.secured
- if true : cookie will be securedhttpOnly
- if true: cookie will be marked as http only@Deprecated public void addCookie(java.lang.String name, java.lang.String value, @Nullable java.lang.String domain, @Nullable java.lang.String path, int maxAge, @Nullable java.util.Date expires, boolean secured, boolean httpOnly, @Nullable Cookie.SameSite sameSite)
addCookie(Cookie)
and Cookie.builder()
instead of this method.name
- name of the cookievalue
- value of the cookiedomain
- domain of the cookiepath
- path of the cookiemaxAge
- max age of the cookie in seconds (negative for the not persistent cookie, zero - deletes the cookie)expires
- The maximum lifetime of the cookie as an HTTP-date timestamp.secured
- if true : cookie will be securedhttpOnly
- if true: cookie will be marked as http onlysameSite
- same site value of the cookie Cookie.SameSite
@Nullable public Cookie removeCookie(java.lang.String name)
name
- of the cookie