Package org.eclipse.jetty.server

Class ServletResponseHttpWrapper

java.lang.Object
javax.servlet.ServletResponseWrapper
org.eclipse.jetty.server.ServletResponseHttpWrapper
All Implemented Interfaces:
HttpServletResponse, ServletResponse
@Deprecated(since="2021-05-27") public class ServletResponseHttpWrapper extends ServletResponseWrapper implements HttpServletResponse
Deprecated.
The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
ServletResponseHttpWrapper Wrapper to tunnel a ServletResponse via an HttpServletResponse

  • Constructor Details

    • ServletResponseHttpWrapper

      public ServletResponseHttpWrapper(ServletResponse response)
      Deprecated.

  • Method Details

    • addCookie

      public void addCookie(Cookie cookie)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
      Specified by:
      addCookie in interface HttpServletResponse
      Parameters:
      cookie - the Cookie to return to the client

    • containsHeader

      public boolean containsHeader(String name)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Returns a boolean indicating whether the named response header has already been set.
      Specified by:
      containsHeader in interface HttpServletResponse
      Parameters:
      name - the header name
      Returns:
      true if the named response header has already been set; false otherwise

    • encodeURL

      public String encodeURL(String url)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

      For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

      Specified by:
      encodeURL in interface HttpServletResponse
      Parameters:
      url - the url to be encoded.
      Returns:
      the encoded URL if encoding is needed; the unchanged URL otherwise.

    • encodeRedirectURL

      public String encodeRedirectURL(String url)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from the encodeURL method.

      All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

      Specified by:
      encodeRedirectURL in interface HttpServletResponse
      Parameters:
      url - the url to be encoded.
      Returns:
      the encoded URL if encoding is needed; the unchanged URL otherwise.
      See Also:

    • encodeUrl

      public String encodeUrl(String url)
      Deprecated.
      Specified by:
      encodeUrl in interface HttpServletResponse
      Parameters:
      url - the url to be encoded.
      Returns:
      the encoded URL if encoding is needed; the unchanged URL otherwise.

    • encodeRedirectUrl

      public String encodeRedirectUrl(String url)
      Deprecated.
      Specified by:
      encodeRedirectUrl in interface HttpServletResponse
      Parameters:
      url - the url to be encoded.
      Returns:
      the encoded URL if encoding is needed; the unchanged URL otherwise.

    • sendError

      public void sendError(int sc, String msg) throws IOException
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sends an error response to the client using the specified status code and clears the output buffer. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter.

      If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

      Specified by:
      sendError in interface HttpServletResponse
      Parameters:
      sc - the error status code
      msg - the descriptive message
      Throws:
      IOException - If an input or output exception occurs

    • sendError

      public void sendError(int sc) throws IOException
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sends an error response to the client using the specified status code and clears the buffer. This is equivalent to calling HttpServletResponse.sendError(int, String) with the same status code and null for the message.
      Specified by:
      sendError in interface HttpServletResponse
      Parameters:
      sc - the error status code
      Throws:
      IOException - If an input or output exception occurs

    • sendRedirect

      public void sendRedirect(String location) throws IOException
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.

      If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

      Specified by:
      sendRedirect in interface HttpServletResponse
      Parameters:
      location - the redirect location URL
      Throws:
      IOException - If an input or output exception occurs

    • setDateHeader

      public void setDateHeader(String name, long date)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
      Specified by:
      setDateHeader in interface HttpServletResponse
      Parameters:
      name - the name of the header to set
      date - the assigned date value
      See Also:

    • addDateHeader

      public void addDateHeader(String name, long date)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.
      Specified by:
      addDateHeader in interface HttpServletResponse
      Parameters:
      name - the name of the header to set
      date - the additional date value
      See Also:

    • setHeader

      public void setHeader(String name, String value)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
      Specified by:
      setHeader in interface HttpServletResponse
      Parameters:
      name - the name of the header
      value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
      See Also:

    • addHeader

      public void addHeader(String name, String value)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Adds a response header with the given name and value. This method allows response headers to have multiple values.
      Specified by:
      addHeader in interface HttpServletResponse
      Parameters:
      name - the name of the header
      value - the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
      See Also:

    • setIntHeader

      public void setIntHeader(String name, int value)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
      Specified by:
      setIntHeader in interface HttpServletResponse
      Parameters:
      name - the name of the header
      value - the assigned integer value
      See Also:

    • addIntHeader

      public void addIntHeader(String name, int value)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Adds a response header with the given name and integer value. This method allows response headers to have multiple values.
      Specified by:
      addIntHeader in interface HttpServletResponse
      Parameters:
      name - the name of the header
      value - the assigned integer value
      See Also:

    • setStatus

      public void setStatus(int sc)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.

      The container clears the buffer and sets the Location header, preserving cookies and other headers.

      Specified by:
      setStatus in interface HttpServletResponse
      Parameters:
      sc - the status code
      See Also:

    • setStatus

      public void setStatus(int sc, String sm)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Sets the status code and message for this response.
      Specified by:
      setStatus in interface HttpServletResponse
      Parameters:
      sc - the status code
      sm - the status message

    • getHeader

      public String getHeader(String name)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Return the value for the specified header, or null if this header has not been set. If more than one value was added for this name, only the first is returned; use HttpServletResponse.getHeaders(String) to retrieve all of them.
      Specified by:
      getHeader in interface HttpServletResponse
      Parameters:
      name - Header name to look up
      Returns:
      The first value for the specified header. This is the raw value so if multiple values are specified in the first header then they will be returned as a single header value .
      See Also:

    • getHeaderNames

      public Collection<String> getHeaderNames()
      Deprecated.
      Description copied from interface: HttpServletResponse
      Get the header names set for this HTTP response.
      Specified by:
      getHeaderNames in interface HttpServletResponse
      Returns:
      The header names set for this HTTP response.
      See Also:

    • getHeaders

      public Collection<String> getHeaders(String name)
      Deprecated.
      Description copied from interface: HttpServletResponse
      Return a Collection of all the header values associated with the specified header name.
      Specified by:
      getHeaders in interface HttpServletResponse
      Parameters:
      name - Header name to look up
      Returns:
      The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.
      See Also:

    • getStatus

      public int getStatus()
      Deprecated.
      Description copied from interface: HttpServletResponse
      Get the HTTP status code for this Response.
      Specified by:
      getStatus in interface HttpServletResponse
      Returns:
      The HTTP status code for this Response
      See Also: