Package com.vaadin.flow.server

Class VaadinServletResponse

java.lang.Object
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
com.vaadin.flow.server.VaadinServletResponse
All Implemented Interfaces:
VaadinResponse, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
public class VaadinServletResponse extends jakarta.servlet.http.HttpServletResponseWrapper implements VaadinResponse
Wrapper for HttpServletResponse.
Since:
1.0.
Author:
Vaadin Ltd
See Also:

  • Field Summary

    Fields inherited from interface jakarta.servlet.http.HttpServletResponse

    SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

  • Constructor Summary

    Constructors
    Constructor
    Description
    VaadinServletResponse(jakarta.servlet.http.HttpServletResponse response, VaadinServletService vaadinService)
    Wraps a http servlet response and an associated vaadin service.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VaadinServletResponse
    getCurrent()
    Gets the currently processed Vaadin servlet response.
    jakarta.servlet.http.HttpServletResponse
    getHttpServletResponse()
    Gets the original unwrapped HttpServletResponse.
    VaadinServletService
    getService()
    Gets the vaadin service for the context of this response.
    void
    setCacheTime(long milliseconds)
    Sets cache time in milliseconds, -1 means no cache at all.

    Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

    addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setTrailerFields

    Methods inherited from class jakarta.servlet.ServletResponseWrapper

    flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jakarta.servlet.ServletResponse

    flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

    Methods inherited from interface com.vaadin.flow.server.VaadinResponse

    addCookie, getOutputStream, getWriter, sendError, setContentLength, setContentType, setDateHeader, setHeader, setNoCacheHeaders, setStatus

  • Constructor Details

    • VaadinServletResponse

      public VaadinServletResponse(jakarta.servlet.http.HttpServletResponse response, VaadinServletService vaadinService)
      Wraps a http servlet response and an associated vaadin service.
      Parameters:
      response - the http servlet response to wrap
      vaadinService - the associated vaadin service

  • Method Details

    • getHttpServletResponse

      public jakarta.servlet.http.HttpServletResponse getHttpServletResponse()
      Gets the original unwrapped HttpServletResponse.
      Returns:
      the unwrapped response

    • setCacheTime

      public void setCacheTime(long milliseconds)
      Description copied from interface: VaadinResponse
      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.
      Specified by:
      setCacheTime in interface VaadinResponse
      Parameters:
      milliseconds - Cache time in milliseconds

    • getService

      public VaadinServletService getService()
      Description copied from interface: VaadinResponse
      Gets the vaadin service for the context of this response.
      Specified by:
      getService in interface VaadinResponse
      Returns:
      the vaadin service
      See Also:

    • getCurrent

      public static VaadinServletResponse getCurrent()
      Gets the currently processed Vaadin servlet 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 servlet response instance if available, otherwise null