Class Https

java.lang.Object
org.zkoss.web.servlet.Servlets
org.zkoss.web.servlet.http.Https

public class Https extends Servlets
The Servlet-related utilities.
Author:
tomyeh
  • Constructor Details

    • Https

      public Https()
  • Method Details

    • gzip

      public static final byte[] gzip(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, InputStream content1, byte[] content2) throws IOException
      Compresses the content into an byte array, or null if the browser doesn't support the compression (accept-encoding).
      Parameters:
      content1 - the first part of the content to compress; null to ignore. If you have multiple input streams, use java.io.SequenceInputStream to concatenate them
      content2 - the second part of the content to compress; null to ignore.
      Returns:
      the compressed result in an byte array, null if the browser doesn't support the compression.
      Throws:
      IOException
      Since:
      2.4.1
    • getCompleteServerName

      public static final String getCompleteServerName(jakarta.servlet.http.HttpServletRequest hreq)
      Gets the complete server name, including protocol, server, and ports. Example, http://mysite.com:8080
    • getCompleteContext

      public static final String getCompleteContext(jakarta.servlet.http.HttpServletRequest hreq)
      Gets the complete context path, including protocol, server, ports, and context. Example, http://mysite.com:8080/we
    • getCookieValue

      public static final String getCookieValue(jakarta.servlet.http.HttpServletRequest request, String name)
      Gets the value of the specified cookie, or null if not found.
      Parameters:
      name - the cookie's name
    • getServletURI

      public static final String getServletURI(jakarta.servlet.http.HttpServletRequest request)
      Returns the servlet uri of the request. A servlet uri is getServletPath() + getPathInfo(). In other words, a servlet uri is a request uri without the context path.

      However, HttpServletRequest.getRequestURI returns in encoded format, while this method returns in decode format (i.e., %nn is converted).

    • getThisContextPath

      public static final String getThisContextPath(jakarta.servlet.ServletRequest request)
      Gets the context path of this page. Unlike getContextPath, it detects whether the current page is included.
      Returns:
      "" if request is not a http request
    • getThisServletPath

      public static final String getThisServletPath(jakarta.servlet.ServletRequest request)
      Gets the servlet path of this page. Unlike getServletPath, it detects whether the current page is included.
      Returns:
      "/" if request is not a http request
    • getThisRequestURI

      public static final String getThisRequestURI(jakarta.servlet.ServletRequest request)
      Gets the request URI of this page. Unlike getRequestURI, it detects whether the current page is included.
      Returns:
      "/" if request is not a http request
    • getThisQueryString

      public static final String getThisQueryString(jakarta.servlet.ServletRequest request)
      Gets the query string of this page. Unlike getQueryString, it detects whether the current page is included.
      Returns:
      null if request is not a http request
    • getThisPathInfo

      public static final String getThisPathInfo(jakarta.servlet.ServletRequest request)
      Gets the path info of this page. Unlike getPathInfo, it detects whether the current page is included.
      Returns:
      null if request is not a http request
    • getOriginContextPath

      public static final String getOriginContextPath(jakarta.servlet.ServletRequest request)
      Gets the original context path regardless of being forwarded or not. Unlike getContextPath, it won't be affected by forwarding.
    • getOriginServletPath

      public static final String getOriginServletPath(jakarta.servlet.ServletRequest request)
      Gets the original servlet path regardless of being forwarded or not. Unlike getServletPath, it won't be affected by forwarding.
    • getOriginRequestURI

      public static final String getOriginRequestURI(jakarta.servlet.ServletRequest request)
      Gets the request URI regardless of being forwarded or not. Unlike HttpServletRequest.getRequestURI, it won't be affected by forwarding.
    • getOriginPathInfo

      public static final String getOriginPathInfo(jakarta.servlet.ServletRequest request)
      Gets the path info regardless of being forwarded or not. Unlike getPathInfo, it won't be affected by forwarding.
    • getOriginQueryString

      public static final String getOriginQueryString(jakarta.servlet.ServletRequest request)
      Gets the query string regardless of being forwarded or not. Unlike getQueryString, it won't be affected by forwarding.
    • getOriginFullServlet

      public static final String getOriginFullServlet(jakarta.servlet.ServletRequest request)
      Returns the servlet path + path info + query string. Because the path info is decoded, the return string can be considered as decoded. On the other hand getOriginFullRequest(jakarta.servlet.ServletRequest) is in the encoded form.
      See Also:
    • getOriginFullRequest

      public static final String getOriginFullRequest(jakarta.servlet.ServletRequest request)
      Returns the request uri + query string. Unlike getOriginFullServlet(jakarta.servlet.ServletRequest), this is in the encoded form (e.g., %nn still exists, if any). Note: request uri = context path + servlet path + path info.
    • sendRedirect

      public static final void sendRedirect(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String uri, Map params, int mode) throws IOException, jakarta.servlet.ServletException
      Redirects to another URL by prefixing the context path and encoding with encodeRedirectURL.

      It encodes the URI automatically (encodeRedirectURL). Parameters are encoded by Encodes.setToQueryString(StringBuffer,Map).

      Like Encodes.encodeURL(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse, java.lang.String), the servlet context is prefixed if uri starts with "/". In other words, to redirect other application, the complete URL must be used, e.g., http://host/other.

      Also, HttpServletResponse.encodeRedirectURL is called automatically.

      Parameters:
      request - the request; used only if params is not null
      response - the response
      uri - the redirect uri (not encoded; not including context-path), or null to denote getOriginFullServlet(jakarta.servlet.ServletRequest) It is OK to relevant (without leading '/'). If starts with "/", the context path of request is assumed. To reference to foreign context, use "~ctx/" where ctx is the context path of the foreign context (without leading '/').
      Notice that, since 3.6.3, uri could contain '*' (to denote locale and browser). Refer to Servlets.locate(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest, java.lang.String, org.zkoss.util.resource.Locator).
      params - the attributes that will be set when the redirection is back; null to ignore; format: (String, Object)
      mode - one of Servlets.OVERWRITE_URI, Servlets.IGNORE_PARAM, and Servlets.APPEND_PARAM. It defines how to handle if both uri and params contains the same parameter.
      Throws:
      IOException
      jakarta.servlet.ServletException
    • encodeRedirectURL

      public static final String encodeRedirectURL(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String uri, Map params, int mode)
      Encodes an URL such that it can be used with HttpServletResponse.sendRedirect.
    • toDate

      public static final Date toDate(String sdate) throws ParseException
      Converts a date string to a Date instance. The format of the giving date string must be complaint to HTTP protocol.
      Throws:
      ParseException - if the string is not valid
    • normalizePath

      public static String normalizePath(String path)
      Returns the normalized path, or null if it is invalid. It is invalid if it is null, or starts with "/" and contains "..".
      Since:
      10.0.0
    • isValidPath

      public static boolean isValidPath(String path)
      Returns whether the specified path is valid. It is valid if it is null, or starts with "/" and doesn't contain "..".
      Since:
      10.0.0
    • sanitizePath

      public static String sanitizePath(String path)
      Returns the path of the specified URI, or null if not found. It is the same as new URI(uri).getPath(), except that it returns null if the path is invalid.
      Since:
      10.0.0
      See Also:
    • toString

      public static final String toString(Date date)
      Converts a data to a string complaint to HTTP protocol.
    • write

      public static void write(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.zkoss.util.media.Media media, boolean download, boolean repeatable) throws IOException
      Write the specified media to HTTP response.
      Parameters:
      response - the HTTP response to write to
      media - the content to be written
      download - whether to cause the download to show at the client. If true, it sets the Content-Disposition header.
      repeatable - whether to use RepeatableInputStream or RepeatableReader to read the media. It is better to specify true if the media might be read repeatedly.
      Throws:
      IOException
      Since:
      3.5.0