Package org.zkoss.zkmax.au.websocket

Class ResponseWrapper

java.lang.Object
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
org.zkoss.zkmax.au.websocket.ResponseWrapper
All Implemented Interfaces:
jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse
public class ResponseWrapper extends jakarta.servlet.http.HttpServletResponseWrapper
A facade response for WebSocket wrapping the WebSocket handshake response.
Since:
8.5.0
Author:
wenninghsu

  • 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
    ResponseWrapper(jakarta.servlet.http.HttpServletResponse response)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCookie(jakarta.servlet.http.Cookie cookie)
     
    void
    addDateHeader(String name, long date)
     
    void
    addHeader(String name, String value)
     
    void
    addIntHeader(String name, int value)
     
    boolean
    containsHeader(String name)
     
    String
    encodeRedirectURL(String url)
     
    String
    encodeURL(String url)
     
    String
    getCharacterEncoding()
     
    String
    getContentType()
     
    protected Map<String,Object>
    getExtraHeaders()
     
    Map<String,Object>
    getGeneral()
     
    String
    getHeader(String name)
     
    Collection<String>
    getHeaderNames()
     
    Collection<String>
    getHeaders(String name)
     
    Locale
    getLocale()
     
    void
    setCharacterEncoding(String charset)
     
    void
    setContentType(String type)
     
    void
    setDateHeader(String name, long date)
     
    void
    setHeader(String name, String value)
     
    void
    setIntHeader(String name, int value)
     
    void
    setLocale(Locale loc)
     
    void
    setStatus(int sc)
     

    Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

    encodeRedirectUrl, encodeUrl, getStatus, sendError, sendError, sendRedirect, setStatus

    Methods inherited from class jakarta.servlet.ServletResponseWrapper

    flushBuffer, getBufferSize, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setContentLength, setContentLengthLong, 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, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentLengthLong

  • Constructor Details

    • ResponseWrapper

      public ResponseWrapper(jakarta.servlet.http.HttpServletResponse response)

  • Method Details

    • encodeURL

      public String encodeURL(String url)
      Specified by:
      encodeURL in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      encodeURL in class jakarta.servlet.http.HttpServletResponseWrapper

    • encodeRedirectURL

      public String encodeRedirectURL(String url)
      Specified by:
      encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      encodeRedirectURL in class jakarta.servlet.http.HttpServletResponseWrapper

    • addCookie

      public void addCookie(jakarta.servlet.http.Cookie cookie)
      Specified by:
      addCookie in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      addCookie in class jakarta.servlet.http.HttpServletResponseWrapper

    • setHeader

      public void setHeader(String name, String value)
      Specified by:
      setHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      setHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • setIntHeader

      public void setIntHeader(String name, int value)
      Specified by:
      setIntHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      setIntHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • setDateHeader

      public void setDateHeader(String name, long date)
      Specified by:
      setDateHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      setDateHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • addHeader

      public void addHeader(String name, String value)
      Specified by:
      addHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      addHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • addDateHeader

      public void addDateHeader(String name, long date)
      Specified by:
      addDateHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      addDateHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • addIntHeader

      public void addIntHeader(String name, int value)
      Specified by:
      addIntHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      addIntHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • containsHeader

      public boolean containsHeader(String name)
      Specified by:
      containsHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      containsHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • getExtraHeaders

      protected Map<String,Object> getExtraHeaders()

    • getHeader

      public String getHeader(String name)
      Specified by:
      getHeader in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      getHeader in class jakarta.servlet.http.HttpServletResponseWrapper

    • getHeaders

      public Collection<String> getHeaders(String name)
      Specified by:
      getHeaders in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      getHeaders in class jakarta.servlet.http.HttpServletResponseWrapper

    • getHeaderNames

      public Collection<String> getHeaderNames()
      Specified by:
      getHeaderNames in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      getHeaderNames in class jakarta.servlet.http.HttpServletResponseWrapper

    • setStatus

      public void setStatus(int sc)
      Specified by:
      setStatus in interface jakarta.servlet.http.HttpServletResponse
      Overrides:
      setStatus in class jakarta.servlet.http.HttpServletResponseWrapper

    • getGeneral

      public Map<String,Object> getGeneral()

    • setLocale

      public void setLocale(Locale loc)
      Specified by:
      setLocale in interface jakarta.servlet.ServletResponse
      Overrides:
      setLocale in class jakarta.servlet.ServletResponseWrapper

    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface jakarta.servlet.ServletResponse
      Overrides:
      getLocale in class jakarta.servlet.ServletResponseWrapper

    • setCharacterEncoding

      public void setCharacterEncoding(String charset)
      Specified by:
      setCharacterEncoding in interface jakarta.servlet.ServletResponse
      Overrides:
      setCharacterEncoding in class jakarta.servlet.ServletResponseWrapper

    • getCharacterEncoding

      public String getCharacterEncoding()
      Specified by:
      getCharacterEncoding in interface jakarta.servlet.ServletResponse
      Overrides:
      getCharacterEncoding in class jakarta.servlet.ServletResponseWrapper

    • setContentType

      public void setContentType(String type)
      Specified by:
      setContentType in interface jakarta.servlet.ServletResponse
      Overrides:
      setContentType in class jakarta.servlet.ServletResponseWrapper

    • getContentType

      public String getContentType()
      Specified by:
      getContentType in interface jakarta.servlet.ServletResponse
      Overrides:
      getContentType in class jakarta.servlet.ServletResponseWrapper