Http.Response (playframework)

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_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, 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

Constructor Summary

Constructors
Constructor and Description

Http.Response()

Constructors
Constructor and Description
`Http.Response()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Iterable<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 give 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
`void`	`discardCookies(java.lang.String... names)` Deprecated. Use the discardCookie methods instead
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` Gets the current response headers.
`void`	`setContentType(java.lang.String contentType)` Sets the content-type of the response.
`void`	`setCookie(java.lang.String name, java.lang.String value)` Set a new transient cookie with path “/” For example:
`void`	`setCookie(java.lang.String name, java.lang.String value, java.lang.Integer maxAge)` Set a new cookie with path “/”
`void`	`setCookie(java.lang.String name, java.lang.String value, java.lang.Integer maxAge, java.lang.String path)` 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)` 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)` Set a new cookie
`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
  - Http.Response
```
public Http.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.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Sets the content-type of the response.
    
    Parameters:
    contentType - The content type. Must not be null.
  - setCookie
```
public void setCookie(java.lang.String name,
             java.lang.String value)
```
    Set a new transient cookie with path “/”
    For example:
```
 response().setCookie("theme", "blue");
 
```
    Parameters:
    name - Cookie name. Must not be null.
    value - Cookie value.
  - setCookie
```
public void setCookie(java.lang.String name,
             java.lang.String value,
             java.lang.Integer maxAge)
```
    Set a new cookie with path “/”
    
    Parameters:
    name - Cookie name. Must not be null.
    value - Cookie value.
    maxAge - Cookie duration (null for a transient cookie and 0 or less for a cookie that expires now).
  - setCookie
```
public void setCookie(java.lang.String name,
             java.lang.String value,
             java.lang.Integer maxAge,
             java.lang.String path)
```
    Set a new cookie
    
    Parameters:
    name - Cookie name. Must not be null.
    value - Cookie value
    maxAge - Cookie duration (null for a transient cookie and 0 or less for a cookie that expires now)
    path - Cookie path
  - setCookie
```
public void setCookie(java.lang.String name,
             java.lang.String value,
             java.lang.Integer maxAge,
             java.lang.String path,
             java.lang.String domain)
```
    Set a new cookie
    
    Parameters:
    name - Cookie name. Must not be null.
    value - Cookie value
    maxAge - Cookie duration (null for a transient cookie and 0 or less for a cookie that expires now)
    path - Cookie path
    domain - Cookie domain
  - setCookie
```
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)
```
    Set a new cookie
    
    Parameters:
    name - Cookie name. Must not be null.
    value - Cookie value
    maxAge - Cookie duration (null for a transient cookie and 0 or less for a cookie 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)
  - discardCookies
```
@Deprecated
public void discardCookies(java.lang.String... names)
```
    Deprecated. Use the discardCookie methods instead
    Discard cookies along this result
    For example:
```
 response().discardCookies("theme");
 
```
    This only discards cookies on the default path ("/") with no domain and that didn't have secure set. To discard other cookies, use the discardCookie method.
    Parameters:
    names - Names of the cookies to discard. Must not be null.
  - 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 give 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.lang.Iterable<Http.Cookie> cookies()
```

Class Http.Response

Field Summary

Fields inherited from interface play.mvc.Http.HeaderNames

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Http.Response

Method Detail

setHeader

getHeaders

setContentType

setCookie

setCookie

setCookie

setCookie

setCookie

discardCookies

discardCookie

discardCookie

discardCookie

discardCookie

cookies