play.mvc

Class Http.Response

java.lang.Object

play.mvc.Http.Response

All Implemented Interfaces:

Http.HeaderNames

Enclosing class:

Http

public static class Http.Response
extends java.lang.Object
implements Http.HeaderNames

The HTTP response.

Field Summary

Fields inherited from interface play.mvc.Http.HeaderNames

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE, X_FORWARDED_FOR, X_FORWARDED_HOST, X_FORWARDED_PORT, X_FORWARDED_PROTO, X_REQUESTED_WITH

Constructor Summary

Constructors

Constructor and Description
Response()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Http.Cookie>	cookie(java.lang.String name)
java.util.Collection<Http.Cookie>	cookies()
void	discardCookie(java.lang.String name) Discard a cookie on the default path ("/") with no domain and that's not secure.
void	discardCookie(java.lang.String name, java.lang.String path) Discard a cookie on the given path with no domain and not that's secure.
void	discardCookie(java.lang.String name, java.lang.String path, java.lang.String domain) Discard a cookie on the given path and domain that's not secure.
void	discardCookie(java.lang.String name, java.lang.String path, java.lang.String domain, boolean secure) Discard a cookie in this result
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Gets the current response headers.
void	setContentType(java.lang.String contentType) Deprecated. noop. Use Result.as(String) instead.
void	setCookie(Http.Cookie cookie) Set a new cookie.
void	setCookie(java.lang.String name, java.lang.String value, java.lang.Integer maxAge, java.lang.String path, java.lang.String domain, boolean secure, boolean httpOnly, Http.Cookie.SameSite sameSite) Deprecated. Use setCookie(Http.Cookie) instead.
void	setHeader(java.lang.String name, java.lang.String value) Adds a new header to the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response()

Method Detail

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Adds a new header to the response.

Parameters:

name - The name of the header, must not be null

value - The value of the header, must not be null

getHeaders

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

Gets the current response headers.

Returns:

the current response headers.

setContentType

@Deprecated
public void setContentType(java.lang.String contentType)

Deprecated. noop. Use Result.as(String) instead.

Parameters:

contentType - Deprecated

setCookie

@Deprecated
public void setCookie(java.lang.String name,
                                  java.lang.String value,
                                  java.lang.Integer maxAge,
                                  java.lang.String path,
                                  java.lang.String domain,
                                  boolean secure,
                                  boolean httpOnly,
                                  Http.Cookie.SameSite sameSite)

Deprecated. Use setCookie(Http.Cookie) instead.

Set a new cookie.

Parameters:

name - Cookie name, must not be null

value - Cookie value

maxAge - Cookie duration in seconds (null for a transient cookie, 0 or less for one that expires now)

path - Cookie path

domain - Cookie domain

secure - Whether the cookie is secured (for HTTPS requests)

httpOnly - Whether the cookie is HTTP only (i.e. not accessible from client-side JavaScript code)

sameSite - The SameSite value (Strict or Lax)

setCookie

public void setCookie(Http.Cookie cookie)

Set a new cookie.

Parameters:

cookie - to set

discardCookie

public void discardCookie(java.lang.String name)

Discard a cookie on the default path ("/") with no domain and that's not secure.

Parameters:

name - The name of the cookie to discard, must not be null

discardCookie

public void discardCookie(java.lang.String name,
                          java.lang.String path)

Discard a cookie on the given path with no domain and not that's secure.

Parameters:

name - The name of the cookie to discard, must not be null

path - The path of the cookie te discard, may be null

discardCookie

public void discardCookie(java.lang.String name,
                          java.lang.String path,
                          java.lang.String domain)

Discard a cookie on the given path and domain that's not secure.

Parameters:

name - The name of the cookie to discard, must not be null

path - The path of the cookie te discard, may be null

domain - The domain of the cookie to discard, may be null

discardCookie

public void discardCookie(java.lang.String name,
                          java.lang.String path,
                          java.lang.String domain,
                          boolean secure)

Discard a cookie in this result

Parameters:

name - The name of the cookie to discard, must not be null

path - The path of the cookie te discard, may be null

domain - The domain of the cookie to discard, may be null

secure - Whether the cookie to discard is secure

cookies

public java.util.Collection<Http.Cookie> cookies()

cookie

public java.util.Optional<Http.Cookie> cookie(java.lang.String name)