org.keycloak.common.util.Encode クラス

org.keycloak.common.util.Encode 連携図

静的公開メンバ関数
static String	encodeQueryString (String value)
static String	encodePath (String value)
static String	encodePathSegment (String value)
static String	encodeFragment (String value)
static String	encodeMatrixParam (String value)
static String	encodeQueryParam (String value)
static String	decodePath (String path)
static String	encodeNonCodes (String string)
static boolean	savePathParams (String segment, StringBuilder newSegment, List< String > params)
static String	encodeValue (String segment, String[] encoding)
static String	encodePathAsIs (String segment)
static String	encodePathSaveEncodings (String segment)
static String	encodePathSegmentAsIs (String segment)
static String	encodePathSegmentSaveEncodings (String segment)
static String	encodeQueryParamAsIs (String nameOrValue)
static String	encodeQueryParamSaveEncodings (String segment)
static String	encodeFragmentAsIs (String nameOrValue)
static String	pathParamReplacement (String segment, List< String > params)
static MultivaluedHashMap< String, String >	decode (MultivaluedHashMap< String, String > map)
static MultivaluedHashMap< String, String >	decode (MultivaluedHashMap< String, String > map, String charset)
static MultivaluedHashMap< String, String >	encode (MultivaluedHashMap< String, String > map)
static String	decode (String string)

静的限定公開メンバ関数
static String	encodeFromArray (String segment, String[] encodingMap, boolean encodePercent)

静的関数
	[static initializer]

静的非公開メンバ関数
static String	decodeBytes (String enc, CharsetDecoder decoder)
static String	encode (int zhar, String[] encodingMap)

静的非公開変数類
static final String	UTF_8 = StandardCharsets.UTF_8.name()
static final Pattern	PARAM_REPLACEMENT = Pattern.compile("_resteasy_uri_parameter")
static final String []	pathEncoding = new String[128]
static final String []	pathSegmentEncoding = new String[128]
static final String []	matrixParameterEncoding = new String[128]
static final String []	queryNameValueEncoding = new String[128]
static final String []	queryStringEncoding = new String[128]
static final Pattern	nonCodes = Pattern.compile("%([^a-fA-F0-9]|[a-fA-F0-9]$|$|[a-fA-F0-9][^a-fA-F0-9])")
static final Pattern	encodedChars = Pattern.compile("%([a-fA-F0-9][a-fA-F0-9])")
static final Pattern	encodedCharsMulti = Pattern.compile("((%[a-fA-F0-9][a-fA-F0-9])+)")

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

org.keycloak.common.util.Encode.[static initializer] ( )

inlinestaticpackage

decode() [1/3]

static MultivaluedHashMap<String, String> org.keycloak.common.util.Encode.decode ( MultivaluedHashMap< String, String >  map )

inlinestatic

decode an encoded map

引数

map

戻り値

   {
       MultivaluedHashMap<String, String> decoded = new MultivaluedHashMap<String, String>();
      for (Map.Entry<String, List<String>> entry : map.entrySet())
      {
         List<String> values = entry.getValue();
         for (String value : values)
         {
            try
            {
               decoded.add(URLDecoder.decode(entry.getKey(), UTF_8), URLDecoder.decode(value, UTF_8));
            }
            catch (UnsupportedEncodingException e)
            {
               throw new RuntimeException(e);
            }
         }
      }
      return decoded;
   }

decode() [2/3]

static MultivaluedHashMap<String, String> org.keycloak.common.util.Encode.decode ( MultivaluedHashMap< String, String >  map, String  charset  )

inlinestatic

decode an encoded map

引数

map
charset

戻り値

   {
      if (charset == null)
      {
         charset = UTF_8;
      }
      MultivaluedHashMap<String, String> decoded = new MultivaluedHashMap<String, String>();
      for (Map.Entry<String, List<String>> entry : map.entrySet())
      {
         List<String> values = entry.getValue();
         for (String value : values)
         {
            try
            {
               decoded.add(URLDecoder.decode(entry.getKey(), charset), URLDecoder.decode(value, charset));
            }
            catch (UnsupportedEncodingException e)
            {
               throw new RuntimeException(e);
            }
         }
      }
      return decoded;
   }

decode() [3/3]

static String org.keycloak.common.util.Encode.decode ( String  string )

inlinestatic

   {
      try
      {
         return URLDecoder.decode(string, UTF_8);
      }
      catch (UnsupportedEncodingException e)
      {
         throw new RuntimeException(e);
      }
   }

decodeBytes()

static String org.keycloak.common.util.Encode.decodeBytes ( String  enc, CharsetDecoder  decoder  )

inlinestaticprivate

   {
      Matcher matcher = encodedChars.matcher(enc);
      ByteBuffer bytes = ByteBuffer.allocate(enc.length() / 3);
      while (matcher.find())
      {
         int b = Integer.parseInt(matcher.group(1), 16);
         bytes.put((byte) b);
      }
      bytes.flip();
      try
      {
         return decoder.decode(bytes).toString();
      }
      catch (CharacterCodingException e)
      {
         throw new RuntimeException(e);
      }
   }

decodePath()

static String org.keycloak.common.util.Encode.decodePath ( String  path )

inlinestatic

   {
      Matcher matcher = encodedCharsMulti.matcher(path);
      int start=0;
      StringBuilder builder = new StringBuilder();
      CharsetDecoder decoder = Charset.forName(UTF_8).newDecoder();
      while (matcher.find())
      {
         builder.append(path, start, matcher.start());
         decoder.reset();
         String decoded = decodeBytes(matcher.group(1), decoder);
         builder.append(decoded);
         start = matcher.end();
      }
      builder.append(path, start, path.length());
      return builder.toString();
   }

encode() [1/2]

static String org.keycloak.common.util.Encode.encode ( int  zhar, String []  encodingMap  )

inlinestaticprivate

引数

zhar	integer representation of character
encodingMap	encoding map

戻り値

URL encoded character

   {
      String encoded;
      if (zhar < encodingMap.length)
      {
         encoded = encodingMap[zhar];
      }
      else
      {
         try
         {
            encoded = URLEncoder.encode(Character.toString((char) zhar), UTF_8);
         }
         catch (UnsupportedEncodingException e)
         {
            throw new RuntimeException(e);
         }
      }
      return encoded;
   }

encode() [2/2]

static MultivaluedHashMap<String, String> org.keycloak.common.util.Encode.encode ( MultivaluedHashMap< String, String >  map )

inlinestatic

   {
       MultivaluedHashMap<String, String> decoded = new MultivaluedHashMap<String, String>();
      for (Map.Entry<String, List<String>> entry : map.entrySet())
      {
         List<String> values = entry.getValue();
         for (String value : values)
         {
            try
            {
               decoded.add(URLEncoder.encode(entry.getKey(), UTF_8), URLEncoder.encode(value, UTF_8));
            }
            catch (UnsupportedEncodingException e)
            {
               throw new RuntimeException(e);
            }
         }
      }
      return decoded;
   }

encodeFragment()

static String org.keycloak.common.util.Encode.encodeFragment ( String  value )

inlinestatic

Keep encoded values "%..." and template parameters intact.

   {
      return encodeValue(value, queryStringEncoding);
   }

encodeFragmentAsIs()

static String org.keycloak.common.util.Encode.encodeFragmentAsIs ( String  nameOrValue )

inlinestatic

   {
      return encodeFromArray(nameOrValue, queryNameValueEncoding, true);
   }

encodeFromArray()

static String org.keycloak.common.util.Encode.encodeFromArray ( String  segment, String []  encodingMap, boolean  encodePercent  )

inlinestaticprotected

   {
      StringBuilder result = new StringBuilder();
      for (int i = 0; i < segment.length(); i++)
      {
         char currentChar = segment.charAt(i);
         if (!encodePercent && currentChar == '%')
         {
            result.append(currentChar);
            continue;
         }
         String encoding = encode(currentChar, encodingMap);
         if (encoding == null)
         {
            result.append(currentChar);
         }
         else
         {
            result.append(encoding);
         }
      }
      return result.toString();
   }

encodeMatrixParam()

static String org.keycloak.common.util.Encode.encodeMatrixParam ( String  value )

inlinestatic

Keep encoded values "%..." and template parameters intact.

   {
      return encodeValue(value, matrixParameterEncoding);
   }

encodeNonCodes()

static String org.keycloak.common.util.Encode.encodeNonCodes ( String  string )

inlinestatic

Encode '' if it is not an encoding sequence

引数

string

戻り値

   {
      Matcher matcher = nonCodes.matcher(string);
      StringBuilder builder = new StringBuilder();


      // FYI: we do not use the no-arg matcher.find()
      //      coupled with matcher.appendReplacement()
      //      because the matched text may contain
      //      a second % and we must make sure we
      //      encode it (if necessary).
      int idx = 0;
      while (matcher.find(idx))
      {
         int start = matcher.start();
         builder.append(string.substring(idx, start));
         builder.append("%25");
         idx = start + 1;
      }
      builder.append(string.substring(idx));
      return builder.toString();
   }

encodePath()

static String org.keycloak.common.util.Encode.encodePath ( String  value )

inlinestatic

Keep encoded values "%...", matrix parameters, template parameters, and '/' characters intact.

   {
      return encodeValue(value, pathEncoding);
   }

encodePathAsIs()

static String org.keycloak.common.util.Encode.encodePathAsIs ( String  segment )

inlinestatic

Encode via RFC 3986. PCHAR is allowed allong with '/'

unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" pchar = unreserved / pct-encoded / sub-delims / ":" / "@"

   {
      return encodeFromArray(segment, pathEncoding, true);
   }

encodePathSaveEncodings()

static String org.keycloak.common.util.Encode.encodePathSaveEncodings ( String  segment )

inlinestatic

Keep any valid encodings from string i.e. keep "%2D" but don't keep "%p"

引数

segment

戻り値

   {
      String result = encodeFromArray(segment, pathEncoding, false);
      result = encodeNonCodes(result);
      return result;
   }

encodePathSegment()

static String org.keycloak.common.util.Encode.encodePathSegment ( String  value )

inlinestatic

Keep encoded values "%...", matrix parameters and template parameters intact.

   {
      return encodeValue(value, pathSegmentEncoding);
   }

encodePathSegmentAsIs()

static String org.keycloak.common.util.Encode.encodePathSegmentAsIs ( String  segment )

inlinestatic

Encode via RFC 3986. PCHAR is allowed allong with '/'

unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" pchar = unreserved / pct-encoded / sub-delims / ":" / "@"

   {
      return encodeFromArray(segment, pathSegmentEncoding, true);
   }

encodePathSegmentSaveEncodings()

static String org.keycloak.common.util.Encode.encodePathSegmentSaveEncodings ( String  segment )

inlinestatic

Keep any valid encodings from string i.e. keep "%2D" but don't keep "%p"

引数

segment

戻り値

   {
      String result = encodeFromArray(segment, pathSegmentEncoding, false);
      result = encodeNonCodes(result);
      return result;
   }

encodeQueryParam()

static String org.keycloak.common.util.Encode.encodeQueryParam ( String  value )

inlinestatic

Keep encoded values "%..." and template parameters intact.

   {
      return encodeValue(value, queryNameValueEncoding);
   }

encodeQueryParamAsIs()

static String org.keycloak.common.util.Encode.encodeQueryParamAsIs ( String  nameOrValue )

inlinestatic

Encodes everything of a query parameter name or value.

引数

nameOrValue

戻り値

   {
      return encodeFromArray(nameOrValue, queryNameValueEncoding, true);
   }

encodeQueryParamSaveEncodings()

static String org.keycloak.common.util.Encode.encodeQueryParamSaveEncodings ( String  segment )

inlinestatic

Keep any valid encodings from string i.e. keep "%2D" but don't keep "%p"

引数

segment

戻り値

   {
      String result = encodeFromArray(segment, queryNameValueEncoding, false);
      result = encodeNonCodes(result);
      return result;
   }

encodeQueryString()

static String org.keycloak.common.util.Encode.encodeQueryString ( String  value )

inlinestatic

Keep encoded values "%..." and template parameters intact.

   {
      return encodeValue(value, queryStringEncoding);
   }

encodeValue()

static String org.keycloak.common.util.Encode.encodeValue ( String  segment, String []  encoding  )

inlinestatic

Keep encoded values "%..." and template parameters intact i.e. "{x}"

引数

segment
encoding

戻り値

   {
      ArrayList<String> params = new ArrayList<String>();
      boolean foundParam = false;
      StringBuilder newSegment = new StringBuilder();
      if (savePathParams(segment, newSegment, params))
      {
         foundParam = true;
         segment = newSegment.toString();
      }
      String result = encodeFromArray(segment, encoding, false);
      result = encodeNonCodes(result);
      segment = result;
      if (foundParam)
      {
         segment = pathParamReplacement(segment, params);
      }
      return segment;
   }

pathParamReplacement()

static String org.keycloak.common.util.Encode.pathParamReplacement ( String  segment, List< String >  params  )

inlinestatic

   {
      StringBuilder newSegment = new StringBuilder();
      Matcher matcher = PARAM_REPLACEMENT.matcher(segment);
      int i = 0;
      int start = 0;
      while (matcher.find())
      {
         newSegment.append(segment, start, matcher.start());
         String replacement = params.get(i++);
         newSegment.append(replacement);
                 start = matcher.end();
      }
          newSegment.append(segment, start, segment.length());
      segment = newSegment.toString();
      return segment;
   }

savePathParams()

static boolean org.keycloak.common.util.Encode.savePathParams ( String  segment, StringBuilder  newSegment, List< String >  params  )

inlinestatic

   {
      boolean foundParam = false;
      // Regular expressions can have '{' and '}' characters.  Replace them to do match
      segment = PathHelper.replaceEnclosedCurlyBraces(segment);
      Matcher matcher = PathHelper.URI_TEMPLATE_PATTERN.matcher(segment);
      int start = 0;
      while (matcher.find())
      {
         newSegment.append(segment, start, matcher.start());
         foundParam = true;
         String group = matcher.group();
         // Regular expressions can have '{' and '}' characters.  Recover earlier replacement
         params.add(PathHelper.recoverEnclosedCurlyBraces(group));
         newSegment.append("_resteasy_uri_parameter");
         start = matcher.end();
      }
      newSegment.append(segment, start, segment.length());
      return foundParam;
   }

メンバ詳解

encodedChars

final Pattern org.keycloak.common.util.Encode.encodedChars = Pattern.compile("%([a-fA-F0-9][a-fA-F0-9])")

staticprivate

encodedCharsMulti

final Pattern org.keycloak.common.util.Encode.encodedCharsMulti = Pattern.compile("((%[a-fA-F0-9][a-fA-F0-9])+)")

staticprivate

matrixParameterEncoding

final String [] org.keycloak.common.util.Encode.matrixParameterEncoding = new String[128]

staticprivate

nonCodes

final Pattern org.keycloak.common.util.Encode.nonCodes = Pattern.compile("%([^a-fA-F0-9]|[a-fA-F0-9]$|$|[a-fA-F0-9][^a-fA-F0-9])")

staticprivate

PARAM_REPLACEMENT

final Pattern org.keycloak.common.util.Encode.PARAM_REPLACEMENT = Pattern.compile("_resteasy_uri_parameter")

staticprivate

pathEncoding

final String [] org.keycloak.common.util.Encode.pathEncoding = new String[128]

staticprivate

pathSegmentEncoding

final String [] org.keycloak.common.util.Encode.pathSegmentEncoding = new String[128]

staticprivate

queryNameValueEncoding

final String [] org.keycloak.common.util.Encode.queryNameValueEncoding = new String[128]

staticprivate

queryStringEncoding

final String [] org.keycloak.common.util.Encode.queryStringEncoding = new String[128]

staticprivate

UTF_8

final String org.keycloak.common.util.Encode.UTF_8 = StandardCharsets.UTF_8.name()

staticprivate

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/common/util/Encode.java