Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

play.mvc
Class Http.Response

java.lang.Object
  extended by play.mvc.Http.Response
Enclosing class:
Http
public static class Http.Response
extends java.lang.Object

An HTTP response

Field Summary
 java.lang.String contentType
          Response content type
 java.util.Map<java.lang.String,Http.Cookie> cookies
          Response cookies
static java.lang.ThreadLocal<Http.Response> current
          Bind to thread
 java.io.File direct
          Send this file directly
 java.util.Map<java.lang.String,Http.Header> headers
          Response headers
 java.io.ByteArrayOutputStream out
          Response body stream
 java.lang.Integer status
          Response status code
 
Constructor Summary
Http.Response()
           
 
Method Summary
 void cacheFor(java.lang.String duration)
          Add a cache-control header
 void cacheFor(java.lang.String etag, java.lang.String duration, long lastModified)
          Add cache-control headers
static Http.Response current()
          Retrieve the current response
 java.lang.String getHeader(java.lang.String name)
          Get a response header
 void print(java.lang.Object o)
           
 void reset()
           
 void setCookie(java.lang.String name, java.lang.String value)
          Set a new cookie
 void setCookie(java.lang.String name, java.lang.String value, java.lang.Integer maxAge)
           
 void setCookie(java.lang.String name, java.lang.String value, java.lang.String duration)
          Set a new cookie that will expire in (current) + duration
 void setCookie(java.lang.String name, java.lang.String value, java.lang.String domain, java.lang.String path, java.lang.Integer maxAge)
           
 void setCookie(java.lang.String name, java.lang.String value, java.lang.String domain, java.lang.String path, java.lang.String duration)
           
 void setHeader(java.lang.String name, java.lang.String value)
          Set a response header
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

status

public java.lang.Integer status
Response status code

contentType

public java.lang.String contentType
Response content type

headers

public java.util.Map<java.lang.String,Http.Header> headers
Response headers

cookies

public java.util.Map<java.lang.String,Http.Cookie> cookies
Response cookies

out

public java.io.ByteArrayOutputStream out
Response body stream

direct

public java.io.File direct
Send this file directly

current

public static java.lang.ThreadLocal<Http.Response> current
Bind to thread

Constructor Detail

Http.Response

public Http.Response()
Method Detail

current

public static Http.Response current()
Retrieve the current response

Returns:
the current response

getHeader

public java.lang.String getHeader(java.lang.String name)
Get a response header

Parameters:
name - Header name
Returns:
the header value as a String

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
Set a response header

Parameters:
name - Header name
value - Header value

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value)
Set a new cookie

Parameters:
name - Cookie name
value - Cookie value

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.lang.String duration)
Set a new cookie that will expire in (current) + duration

Parameters:
name -
value -
duration - Ex: 3d

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.lang.Integer maxAge)

setCookie

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

setCookie

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

cacheFor

public void cacheFor(java.lang.String duration)
Add a cache-control header

Parameters:
duration - Ex: 3h

cacheFor

public void cacheFor(java.lang.String etag,
                     java.lang.String duration,
                     long lastModified)
Add cache-control headers

Parameters:
duration - Ex: 3h

print

public void print(java.lang.Object o)

reset

public void reset()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Guillaume Bort & zenexity - Distributed under Apache 2 licence, without any warrantly