Package org.apache.mina.proxy.utils

Class StringUtilities

  • public class StringUtilities
extends java.lang.Object
    StringUtilities.java - Various methods to handle strings.
    Since:
    MINA 2.0.0-M3
    Author:
    Apache MINA Project

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addValueToHeader​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers, java.lang.String key, java.lang.String value, boolean singleValued)
      Adds an header to the provided map of headers.
      static void copyDirective​(java.util.Map<java.lang.String,​java.lang.String> directives, java.lang.StringBuilder sb, java.lang.String directive)
      Copy the directive to the StringBuilder if not null.
      static java.lang.String copyDirective​(java.util.Map<java.lang.String,​java.lang.String> src, java.util.Map<java.lang.String,​java.lang.String> dst, java.lang.String directive)
      Copy the directive from the source map to the destination map, if it's value isn't null.
      static java.lang.String getDirectiveValue​(java.util.Map<java.lang.String,​java.lang.String> directivesMap, java.lang.String directive, boolean mandatory)
      A directive is a parameter of the digest authentication process.
      static java.lang.String getSingleValuedHeader​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers, java.lang.String key)
      Returns the value of the named header.
      static boolean isLws​(byte b)
      Is character a linear white space ? LWS = [CRLF] 1*( SP | HT ) Note that we're checking individual bytes instead of CRLF
      static java.util.Map<java.lang.String,​java.lang.String> parseDirectives​(byte[] buf)
      Parses digest-challenge string, extracting each token and value(s).
      static java.lang.String stringTo8859_1​(java.lang.String str)
      Used to convert username-value, passwd or realm to 8859_1 encoding if all chars in string are within the 8859_1 (Latin 1) encoding range.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getDirectiveValue

        public static java.lang.String getDirectiveValue​(java.util.Map<java.lang.String,​java.lang.String> directivesMap,
                                                 java.lang.String directive,
                                                 boolean mandatory)
                                          throws javax.security.sasl.AuthenticationException
        A directive is a parameter of the digest authentication process. Returns the value of a directive from the map. If mandatory is true and the value is null, then it throws an AuthenticationException.
        Parameters:
        directivesMap - the directive's map
        directive - the name of the directive we want to retrieve
        mandatory - is the directive mandatory
        Returns:
        the mandatory value as a String
        Throws:
        javax.security.sasl.AuthenticationException - if mandatory is true and if directivesMap.get(directive) == null

      • copyDirective

        public static void copyDirective​(java.util.Map<java.lang.String,​java.lang.String> directives,
                                 java.lang.StringBuilder sb,
                                 java.lang.String directive)
        Copy the directive to the StringBuilder if not null. (A directive is a parameter of the digest authentication process.)
        Parameters:
        directives - the directives map
        sb - the output buffer
        directive - the directive name to look for

      • copyDirective

        public static java.lang.String copyDirective​(java.util.Map<java.lang.String,​java.lang.String> src,
                                             java.util.Map<java.lang.String,​java.lang.String> dst,
                                             java.lang.String directive)
        Copy the directive from the source map to the destination map, if it's value isn't null. (A directive is a parameter of the digest authentication process.)
        Parameters:
        src - the source map
        dst - the destination map
        directive - the directive name
        Returns:
        the value of the copied directive

      • parseDirectives

        public static java.util.Map<java.lang.String,​java.lang.String> parseDirectives​(byte[] buf)
                                                                              throws javax.security.sasl.SaslException
        Parses digest-challenge string, extracting each token and value(s). Each token is a directive.
        Parameters:
        buf - A non-null digest-challenge string.
        Returns:
        A Map containing the aprsed directives
        Throws:
        javax.security.sasl.SaslException - if the String cannot be parsed according to RFC 2831

      • isLws

        public static boolean isLws​(byte b)
        Is character a linear white space ? LWS = [CRLF] 1*( SP | HT ) Note that we're checking individual bytes instead of CRLF
        Parameters:
        b - the byte to check
        Returns:
        true if it's a linear white space

      • stringTo8859_1

        public static java.lang.String stringTo8859_1​(java.lang.String str)
                                       throws java.io.UnsupportedEncodingException
        Used to convert username-value, passwd or realm to 8859_1 encoding if all chars in string are within the 8859_1 (Latin 1) encoding range.
        Parameters:
        str - a non-null String
        Returns:
        a non-null String containing the 8859_1 encoded string
        Throws:
        java.io.UnsupportedEncodingException - if we weren't able to decode using the ISO 8859_1 encoding

      • getSingleValuedHeader

        public static java.lang.String getSingleValuedHeader​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers,
                                                     java.lang.String key)
        Returns the value of the named header. If it has multiple values then an IllegalArgumentException is thrown
        Parameters:
        headers - the http headers map
        key - the key of the header
        Returns:
        the value of the http header

      • addValueToHeader

        public static void addValueToHeader​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers,
                                    java.lang.String key,
                                    java.lang.String value,
                                    boolean singleValued)
        Adds an header to the provided map of headers.
        Parameters:
        headers - the http headers map
        key - the name of the new header to add
        value - the value of the added header
        singleValued - if true and the map already contains one value then it is replaced by the new value. Otherwise it simply adds a new value to this multi-valued header.