Package play.mvc

Class Http.Response

  • Enclosing class:
    Http
    public static class Http.Response
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Response()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void accessControl​(java.lang.String allowOrigin)
      Add headers to allow cross-domain requests.
      void accessControl​(java.lang.String allowOrigin, boolean allowCredentials)
      Add headers to allow cross-domain requests.
      void accessControl​(java.lang.String allowOrigin, java.lang.String allowMethods, boolean allowCredentials)
      Add headers to allow cross-domain requests.
      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()
      Deprecated.
      java.lang.String getHeader​(java.lang.String name)
      Get a response header
      void onWriteChunk​(java.util.function.Consumer<java.lang.Object> handler)  
      void print​(java.lang.String text)  
      void removeCookie​(java.lang.String name)  
      void removeCookie​(java.lang.String name, java.lang.String path)  
      static void removeCurrent()  
      void setContentTypeIfNotSet​(java.lang.String contentType)  
      void setCookie​(java.lang.String name, java.lang.String value)  
      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, boolean secure)  
      void setCookie​(java.lang.String name, java.lang.String value, java.lang.String domain, java.lang.String path, java.lang.Integer maxAge, boolean secure, boolean httpOnly)  
      static void setCurrent​(Http.Response response)
      Deprecated.
      void setHeader​(java.lang.String name, java.lang.String value)  
      void writeChunk​(java.lang.Object o)  

      • 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

      • contentType

        public java.lang.String contentType

      • headers

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

      • cookies

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

      • out

        public java.io.ByteArrayOutputStream out

      • direct

        public java.lang.Object direct

      • encoding

        public java.nio.charset.Charset encoding

      • chunked

        public boolean chunked

    • Constructor Detail

      • Response

        public Response()

    • Method Detail

      • current

        @Deprecated
public static Http.Response current()
        Deprecated.

      • setCurrent

        @Deprecated
public static void setCurrent​(Http.Response response)
        Deprecated.

      • removeCurrent

        public static void removeCurrent()

      • getHeader

        @Nullable
public java.lang.String getHeader​(@Nonnull
                                  java.lang.String name)
        Get a response header
        Parameters:
        name - Header name case-insensitive
        Returns:
        the header value as a String

      • setHeader

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

      • setContentTypeIfNotSet

        public void setContentTypeIfNotSet​(java.lang.String contentType)

      • setCookie

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

      • removeCookie

        public void removeCookie​(java.lang.String name)

      • removeCookie

        public void removeCookie​(java.lang.String name,
                         java.lang.String path)

      • 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:
        duration - the cookie duration (Ex: "3d")

      • setCookie

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

      • setCookie

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

      • 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:
        etag - the Etag value
        duration - the cache duration (Ex: 3h)
        lastModified - The last modified date

      • accessControl

        public void accessControl​(java.lang.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​(java.lang.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​(java.lang.String allowOrigin,
                          java.lang.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​(java.lang.String text)

      • writeChunk

        public void writeChunk​(java.lang.Object o)

      • onWriteChunk

        public void onWriteChunk​(java.util.function.Consumer<java.lang.Object> handler)