org.apache.mina.proxy.utils

Class StringUtilities

java.lang.Object

org.apache.mina.proxy.utils.StringUtilities

public class StringUtilities
extends java.lang.Object

StringUtilities.java - Various methods to handle strings.

Since:

MINA 2.0.0-M3

Constructor Summary

Constructors

Constructor and Description
StringUtilities()

Method Summary

Modifier and Type	Method and 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 java.lang.String	copyDirective(java.util.HashMap<java.lang.String,java.lang.String> src, java.util.HashMap<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 void	copyDirective(java.util.HashMap<java.lang.String,java.lang.String> directives, java.lang.StringBuilder sb, java.lang.String directive) Copy the directive to the StringBuilder if not null.
private static void	extractDirective(java.util.HashMap<java.lang.String,java.lang.String> map, java.lang.String key, java.lang.String value) Processes directive/value pairs from the digest-challenge and fill out the provided map.
static java.lang.String	getDirectiveValue(java.util.HashMap<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.HashMap<java.lang.String,java.lang.String>	parseDirectives(byte[] buf) Parses digest-challenge string, extracting each token and value(s).
private static int	skipLws(byte[] buf, int start) Skip all linear white spaces
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

Constructor Detail

StringUtilities

public StringUtilities()

Method Detail

getDirectiveValue

public static java.lang.String getDirectiveValue(java.util.HashMap<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.HashMap<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.HashMap<java.lang.String,java.lang.String> src,
                                             java.util.HashMap<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.HashMap<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.

Throws:

java.io.UnsupportedEncodingException

javax.security.sasl.SaslException - if the String cannot be parsed according to RFC 2831

extractDirective

private static void extractDirective(java.util.HashMap<java.lang.String,java.lang.String> map,
                                     java.lang.String key,
                                     java.lang.String value)
                              throws javax.security.sasl.SaslException

Processes directive/value pairs from the digest-challenge and fill out the provided map.

Parameters:

key - A non-null String challenge token name.

value - A non-null String token value.

Throws:

javax.security.sasl.SaslException - if either the key or the value is null or if the key already has a value.

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

skipLws

private static int skipLws(byte[] buf,
                           int start)

Skip all linear white spaces

Parameters:

buf - the buf which is being scanned for lws

start - the offset to start at

Returns:

the next position in buf which isn't a lws character

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:

javax.security.sasl.AuthenticationException

java.io.UnsupportedEncodingException

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.