Package com.vaadin.flow.server

Interface VaadinResponse

  • All Known Implementing Classes:
    VaadinServletResponse
    public interface VaadinResponse
    A generic response from the server, wrapping a more specific response type, e.g. HttpServletResponse.
    Since:
    1.0
    Author:
    Vaadin Ltd

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void addCookie​(javax.servlet.http.Cookie cookie)
      Adds the specified cookie to the response.
      static VaadinResponse getCurrent()
      Gets the currently processed Vaadin response.
      OutputStream getOutputStream()
      Returns a OutputStream for writing binary data in the response.
      VaadinService getService()
      Gets the vaadin service for the context of this response.
      PrintWriter getWriter()
      Returns a PrintWriter object that can send character text to the client.
      void sendError​(int errorCode, String message)
      Sends an error response to the client using the specified status code and clears the buffer.
      void setCacheTime​(long milliseconds)
      Sets cache time in milliseconds, -1 means no cache at all.
      void setContentLength​(int len)
      Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
      void setContentType​(String contentType)
      Sets the content type of this response.
      void setDateHeader​(String name, long timestamp)
      Properly formats a timestamp as a date header.
      void setHeader​(String name, String value)
      Sets the value of a generic response header.
      default void setNoCacheHeaders()
      Sets all conceivable headers that might prevent a response from being stored in any caches.
      void setStatus​(int statusCode)
      Sets the (http) status code for the response.

    • Method Detail

      • setStatus

        void setStatus​(int statusCode)
        Sets the (http) status code for the response. If you want to include an error message along the status code, use sendError(int, String) instead.
        Parameters:
        statusCode - the status code to set
        See Also:
        HttpServletResponse.setStatus(int)

      • setContentType

        void setContentType​(String contentType)
        Sets the content type of this response. If the content type including a charset is set before getWriter() is invoked, the returned PrintWriter will automatically use the defined charset.
        Parameters:
        contentType - a string specifying the MIME type of the content
        See Also:
        ServletResponse.setContentType(String)

      • setHeader

        void setHeader​(String name,
               String value)
        Sets the value of a generic response header. If the header had already been set, the new value overwrites the previous one.
        Parameters:
        name - the name of the header
        value - the header value.
        See Also:
        HttpServletResponse.setHeader(String, String)

      • setDateHeader

        void setDateHeader​(String name,
                   long timestamp)
        Properly formats a timestamp as a date header. If the header had already been set, the new value overwrites the previous one.
        Parameters:
        name - the name of the header
        timestamp - the number of milliseconds since epoch
        See Also:
        HttpServletResponse.setDateHeader(String, long)

      • getOutputStream

        OutputStream getOutputStream()
                      throws IOException
        Returns a OutputStream for writing binary data in the response.

        Either this method or getWriter() may be called to write the response, not both.

        Returns:
        a OutputStream for writing binary data
        Throws:
        IOException - if an input or output exception occurred
        See Also:
        getWriter(), ServletResponse.getOutputStream()

      • getWriter

        PrintWriter getWriter()
               throws IOException
        Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding defined using setContentType.

        Either this method or getOutputStream() may be called to write the response, not both.

        Returns:
        a PrintWriter for writing character text
        Throws:
        IOException - if an input or output exception occurred
        See Also:
        getOutputStream(), ServletResponse.getWriter()

      • setCacheTime

        void setCacheTime​(long milliseconds)
        Sets cache time in milliseconds, -1 means no cache at all. All required headers related to caching in the response are set based on the time.
        Parameters:
        milliseconds - Cache time in milliseconds

      • sendError

        void sendError​(int errorCode,
               String message)
        throws IOException
        Sends an error response to the client using the specified status code and clears the buffer. In some configurations, this can cause a predefined error page to be displayed.
        Parameters:
        errorCode - the HTTP status code
        message - a message to accompany the error
        Throws:
        IOException - if an input or output exception occurs
        See Also:
        HttpServletResponse.sendError(int, String)

      • getService

        VaadinService getService()
        Gets the vaadin service for the context of this response.
        Returns:
        the vaadin service
        See Also:
        VaadinService

      • addCookie

        void addCookie​(javax.servlet.http.Cookie cookie)
        Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
        Parameters:
        cookie - the Cookie to return to the client
        See Also:
        HttpServletResponse.addCookie(Cookie)

      • setContentLength

        void setContentLength​(int len)
        Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
        Parameters:
        len - an integer specifying the length of the content being returned to the client

      • setNoCacheHeaders

        default void setNoCacheHeaders()
        Sets all conceivable headers that might prevent a response from being stored in any caches.

      • getCurrent

        static VaadinResponse getCurrent()
        Gets the currently processed Vaadin response. The current response is automatically defined when the request is started. The current response can not be used in e.g. background threads because of the way server implementations reuse response instances.
        Returns:
        the current Vaadin response instance if available, otherwise null