play.mvc
Class Http.Response

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

Enclosing class:

Http

public static class Http.Response
extends Object

An HTTP response

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

current

public static ThreadLocal<Http.Response> current

Bind to thread

Http.Response

public Http.Response()

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

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)

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,
                      Integer maxAge)

setCookie

public void setCookie(String name,
                      String value,
                      String domain,
                      String path,
                      String duration)

setCookie

public void setCookie(String name,
                      String value,
                      String domain,
                      String path,
                      Integer maxAge)

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()