Http.Response (Play! API)

java.lang.Object
- play.mvc.Http.Response

Enclosing class:: Http

public static class Http.Response
extends Object

An HTTP response

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`chunked`
`String`	`contentType` Response content type
`Map<String,Http.Cookie>`	`cookies` Response cookies
`static ThreadLocal<Http.Response>`	`current` Bind to thread
`Object`	`direct` Send this file directly
`String`	`encoding` The encoding used when writing response to client
`Map<String,Http.Header>`	`headers` Response headers
`ByteArrayOutputStream`	`out` Response body stream
`Integer`	`status` Response status code

Constructor Summary

Constructors
Constructor and Description

Response()

Constructors
Constructor and Description
`Response()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accessControl(String allowOrigin)` Add headers to allow cross-domain requests.
`void`	`accessControl(String allowOrigin, boolean allowCredentials)` Add headers to allow cross-domain requests.
`void`	`accessControl(String allowOrigin, String allowMethods, boolean allowCredentials)` Add headers to allow cross-domain requests.
`void`	`cacheFor(String duration)` Add a cache-control header
`void`	`cacheFor(String etag, String duration, long lastModified)` Add cache-control headers
`static Http.Response`	`current()` Retrieve the current response
`String`	`getHeader(String name)` Get a response header
`void`	`onWriteChunk(F.Action<Object> handler)`
`void`	`print(Object o)`
`void`	`removeCookie(String name)` Removes the specified cookie with path /
`void`	`removeCookie(String name, String path)` Removes the cookie
`void`	`reset()`
`void`	`setContentTypeIfNotSet(String contentType)`
`void`	`setCookie(String name, String value)` Set a new cookie
`void`	`setCookie(String name, String value, String duration)` Set a new cookie that will expire in (current) + duration
`void`	`setCookie(String name, String value, String domain, String path, Integer maxAge, boolean secure)`
`void`	`setCookie(String name, String value, String domain, String path, Integer maxAge, boolean secure, boolean httpOnly)`
`void`	`setHeader(String name, String value)` Set a response header
`void`	`writeChunk(Object o)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - status
```
public Integer status
```
    Response status code
  - contentType
```
public String contentType
```
    Response content type
  - headers
```
public Map<String,Http.Header> headers
```
    Response headers
  - cookies
```
public Map<String,Http.Cookie> cookies
```
    Response cookies
  - out
```
public ByteArrayOutputStream out
```
    Response body stream
  - direct
```
public Object direct
```
    Send this file directly
  - encoding
```
public String encoding
```
    The encoding used when writing response to client
  - current
```
public static final ThreadLocal<Http.Response> current
```
    Bind to thread
  - chunked
```
public boolean chunked
```
- Constructor Detail
  - Response
```
public Response()
```
- Method Detail
  - current
```
public static Http.Response current()
```
    Retrieve the current response
    
    Returns:
    
    the current response
  - getHeader
```
public String getHeader(String name)
```
    Get a response header
    
    Parameters:
    
    name - Header name case-insensitive
    
    Returns:
    
    the header value as a String
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Set a response header
    
    Parameters:
    
    name - Header name
    
    value - Header value
  - setContentTypeIfNotSet
```
public void setContentTypeIfNotSet(String contentType)
```
  - setCookie
```
public void setCookie(String name,
                      String value)
```
    Set a new cookie
    
    Parameters:
    
    name - Cookie name
    
    value - Cookie value
  - removeCookie
```
public void removeCookie(String name)
```
    Removes the specified cookie with path /
    
    Parameters:
    
    name - cookie name
  - removeCookie
```
public void removeCookie(String name,
                         String path)
```
    Removes the cookie
    
    Parameters:
    
    name - cookie name
    
    path - cookie path
  - setCookie
```
public void setCookie(String name,
                      String value,
                      String duration)
```
    Set a new cookie that will expire in (current) + duration
    
    Parameters:
    
    name -
    
    value -
    
    duration - Ex: 3d
  - setCookie
```
public void setCookie(String name,
                      String value,
                      String domain,
                      String path,
                      Integer maxAge,
                      boolean secure)
```
  - setCookie
```
public void setCookie(String name,
                      String value,
                      String domain,
                      String path,
                      Integer maxAge,
                      boolean secure,
                      boolean httpOnly)
```
  - cacheFor
```
public void cacheFor(String duration)
```
    Add a cache-control header
    
    Parameters:
    
    duration - Ex: 3h
  - cacheFor
```
public void cacheFor(String etag,
                     String duration,
                     long lastModified)
```
    Add cache-control headers
    
    Parameters:
    
    duration - Ex: 3h
  - accessControl
```
public void accessControl(String allowOrigin)
```
    Add headers to allow cross-domain requests. Be careful, a lot of browsers don't support these features and will ignore the headers. Refer to the browsers' documentation to know what versions support them.
    
    Parameters:
    
    allowOrigin - a comma separated list of domains allowed to perform the x-domain call, or "*" for all.
  - accessControl
```
public void accessControl(String allowOrigin,
                          boolean allowCredentials)
```
    Add headers to allow cross-domain requests. Be careful, a lot of browsers don't support these features and will ignore the headers. Refer to the browsers' documentation to know what versions support them.
    
    Parameters:
    
    allowOrigin - a comma separated list of domains allowed to perform the x-domain call, or "*" for all.
    
    allowCredentials - Let the browser send the cookies when doing a x-domain request. Only respected by the browser if allowOrigin != "*"
  - accessControl
```
public void accessControl(String allowOrigin,
                          String allowMethods,
                          boolean allowCredentials)
```
    Add headers to allow cross-domain requests. Be careful, a lot of browsers don't support these features and will ignore the headers. Refer to the browsers' documentation to know what versions support them.
    
    Parameters:
    
    allowOrigin - a comma separated list of domains allowed to perform the x-domain call, or "*" for all.
    
    allowMethods - a comma separated list of HTTP methods allowed, or null for all.
    
    allowCredentials - Let the browser send the cookies when doing a x-domain request. Only respected by the browser if allowOrigin != "*"
  - print
```
public void print(Object o)
```
  - reset
```
public void reset()
```
  - writeChunk
```
public void writeChunk(Object o)
```
  - onWriteChunk
```
public void onWriteChunk(F.Action<Object> handler)
```

Class Http.Response

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

status

contentType

headers

cookies

out

direct

encoding

current

chunked

Constructor Detail

Response

Method Detail

current

getHeader

setHeader

setContentTypeIfNotSet

setCookie

removeCookie

removeCookie

setCookie

setCookie

setCookie

cacheFor

cacheFor

accessControl

accessControl

accessControl

print

reset

writeChunk

onWriteChunk