Class URLUtils


  • public class URLUtils
    extends java.lang.Object
    URL-encoding utility for each URL part according to the RFC specs
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.BitSet ALPHA
      alpha = lowalpha | upalpha
      static java.util.BitSet ALPHANUM
      alphanum = alpha | digit
      static java.util.BitSet DIGIT
      digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
      static java.util.BitSet FRAGMENT
      fragment = pchar / "/" / "?"
      static java.util.BitSet GEN_DELIMS
      gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
      static java.util.BitSet LOW_ALPHA
      lowalpha = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z"
      static java.util.BitSet PATH_PARAM_NAME
      path_param_name = pchar ";" | "="
      static java.util.BitSet PATH_PARAM_VALUE
      path_param_value = pchar ";"
      static java.util.BitSet PATH_SEGMENT
      path_segment = pchar ";"
      static java.util.BitSet PCHAR
      pchar = unreserved | escaped | sub-delims | ":" | "@"
      static java.util.BitSet QUERY
      query = pchar / "/" / "?"
      static java.util.BitSet RESERVED
      reserved = gen-delims | sub-delims
      static java.util.BitSet SUB_DELIMS
      sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
      static java.util.BitSet UNRESERVED
      unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
      static java.util.BitSet UP_ALPHA
      upalpha = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z"
    • Constructor Summary

      Constructors 
      Constructor Description
      URLUtils()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String encodePart​(java.lang.String part, java.lang.String charset, java.util.BitSet allowed)
      Encodes a string to be a valid URI part, with the given characters allowed.
      static java.lang.String encodePathParamName​(java.lang.String pathParamName)
      Encodes a string to be a valid path parameter name, which means it can contain PCHAR* without "=" or ";".
      static java.lang.String encodePathParamValue​(java.lang.String pathParamValue)
      Encodes a string to be a valid path parameter value, which means it can contain PCHAR* without ";".
      static java.lang.String encodePathSegment​(java.lang.String pathSegment)
      Encodes a string to be a valid path segment, which means it can contain PCHAR* only (do not put path parameters or they will be escaped.
      static java.lang.String encodeQueryNameOrValue​(java.lang.String queryNameOrValue)
      Encodes a string to be a valid query, which means it can contain PCHAR* | "?" | "/" without "=" | "&" | "+".
      static java.lang.String encodeQueryNameOrValueNoParen​(java.lang.String queryNameOrValueNoParen)
      Encodes a string to be a valid query with no parenthesis, which means it can contain PCHAR* | "?" | "/" without "=" | "&" | "+" | "(" | ")".
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • GEN_DELIMS

        public static final java.util.BitSet GEN_DELIMS
        gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
      • SUB_DELIMS

        public static final java.util.BitSet SUB_DELIMS
        sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
      • RESERVED

        public static final java.util.BitSet RESERVED
        reserved = gen-delims | sub-delims
      • LOW_ALPHA

        public static final java.util.BitSet LOW_ALPHA
        lowalpha = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z"
      • UP_ALPHA

        public static final java.util.BitSet UP_ALPHA
        upalpha = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z"
      • ALPHA

        public static final java.util.BitSet ALPHA
        alpha = lowalpha | upalpha
      • DIGIT

        public static final java.util.BitSet DIGIT
        digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
      • ALPHANUM

        public static final java.util.BitSet ALPHANUM
        alphanum = alpha | digit
      • UNRESERVED

        public static final java.util.BitSet UNRESERVED
        unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
      • PCHAR

        public static final java.util.BitSet PCHAR
        pchar = unreserved | escaped | sub-delims | ":" | "@"

        Note: we don't allow escaped here since we will escape it ourselves, so we don't want to allow them in the unescaped sequences

      • PATH_SEGMENT

        public static final java.util.BitSet PATH_SEGMENT
        path_segment = pchar ";"
      • PATH_PARAM_NAME

        public static final java.util.BitSet PATH_PARAM_NAME
        path_param_name = pchar ";" | "="
      • PATH_PARAM_VALUE

        public static final java.util.BitSet PATH_PARAM_VALUE
        path_param_value = pchar ";"
      • QUERY

        public static final java.util.BitSet QUERY
        query = pchar / "/" / "?"
      • FRAGMENT

        public static final java.util.BitSet FRAGMENT
        fragment = pchar / "/" / "?"
    • Constructor Detail

      • URLUtils

        public URLUtils()
    • Method Detail

      • encodePathParamName

        public static java.lang.String encodePathParamName​(java.lang.String pathParamName)
        Encodes a string to be a valid path parameter name, which means it can contain PCHAR* without "=" or ";". Uses UTF-8.
      • encodePathParamValue

        public static java.lang.String encodePathParamValue​(java.lang.String pathParamValue)
        Encodes a string to be a valid path parameter value, which means it can contain PCHAR* without ";". Uses UTF-8.
      • encodeQueryNameOrValue

        public static java.lang.String encodeQueryNameOrValue​(java.lang.String queryNameOrValue)
        Encodes a string to be a valid query, which means it can contain PCHAR* | "?" | "/" without "=" | "&" | "+". Uses UTF-8.
      • encodeQueryNameOrValueNoParen

        public static java.lang.String encodeQueryNameOrValueNoParen​(java.lang.String queryNameOrValueNoParen)
        Encodes a string to be a valid query with no parenthesis, which means it can contain PCHAR* | "?" | "/" without "=" | "&" | "+" | "(" | ")". It strips parenthesis. Uses UTF-8.
      • encodePathSegment

        public static java.lang.String encodePathSegment​(java.lang.String pathSegment)
        Encodes a string to be a valid path segment, which means it can contain PCHAR* only (do not put path parameters or they will be escaped. Uses UTF-8.
      • encodePart

        public static java.lang.String encodePart​(java.lang.String part,
                                                  java.lang.String charset,
                                                  java.util.BitSet allowed)
                                           throws java.io.UnsupportedEncodingException
        Encodes a string to be a valid URI part, with the given characters allowed. The rest will be encoded.
        Throws:
        java.io.UnsupportedEncodingException