Class Https


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

      • Https

        public Https()
    • Method Detail

      • gzip

        public static final byte[] gzip​(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        java.io.InputStream content1,
                                        byte[] content2)
                                 throws java.io.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:
        java.io.IOException
        Since:
        2.4.1
      • getCompleteServerName

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

        public static final java.lang.String getCompleteContext​(javax.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 java.lang.String getCookieValue​(javax.servlet.http.HttpServletRequest request,
                                                            java.lang.String name)
        Gets the value of the specified cookie, or null if not found.
        Parameters:
        name - the cookie's name
      • getServletURI

        public static final java.lang.String getServletURI​(javax.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 java.lang.String getThisContextPath​(javax.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 java.lang.String getThisServletPath​(javax.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 java.lang.String getThisRequestURI​(javax.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 java.lang.String getThisQueryString​(javax.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 java.lang.String getThisPathInfo​(javax.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 java.lang.String getOriginContextPath​(javax.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 java.lang.String getOriginServletPath​(javax.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 java.lang.String getOriginRequestURI​(javax.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 java.lang.String getOriginPathInfo​(javax.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 java.lang.String getOriginQueryString​(javax.servlet.ServletRequest request)
        Gets the query string regardless of being forwarded or not. Unlike getQueryString, it won't be affected by forwarding.
      • getOriginFullRequest

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

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

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

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

        public static void write​(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 Media media,
                                 boolean download,
                                 boolean repeatable)
                          throws java.io.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:
        java.io.IOException
        Since:
        3.5.0