im.toss.http.parser

Class HttpAuthCredentials

java.lang.Object

im.toss.http.parser.HttpAuthCredentials

public class HttpAuthCredentials
extends java.lang.Object

An HTTP authentication credentials.

See Also:

Hypertext Transfer Protocol (HTTP/1.1): Authentication

Constructor Summary

Constructors

Constructor and Description
HttpAuthCredentials(java.lang.String scheme, java.lang.String token)
HttpAuthCredentials(java.lang.String scheme, java.lang.String token, java.util.Map<java.lang.String,java.util.List<java.lang.String>> params)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static HttpAuthCredentials	fromSingleValueParams(java.lang.String scheme, java.lang.String token, java.util.Map<java.lang.String,java.lang.String> params) Obtains an instance of HttpAuthCredentials from scheme, token and single value params.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParams() Returns the parameters.
java.lang.String	getScheme()
java.util.Map<java.lang.String,java.lang.String>	getSingleValueParams() Returns the parameters in single value representation.
java.lang.String	getToken()
int	hashCode()
static HttpAuthCredentials	none() Returns empty HttpAuthCredentials.
static HttpAuthCredentials	parse(java.lang.String credentials)
static HttpAuthCredentials	parse(java.lang.String credentials, boolean strict) Obtains an instance of HttpAuthCredentials from credentials such as Custom k1=v1, k2=v2.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpAuthCredentials

public HttpAuthCredentials(java.lang.String scheme,
                           java.lang.String token)

HttpAuthCredentials

public HttpAuthCredentials(java.lang.String scheme,
                           java.lang.String token,
                           java.util.Map<java.lang.String,java.util.List<java.lang.String>> params)

Method Detail

fromSingleValueParams

public static HttpAuthCredentials fromSingleValueParams(java.lang.String scheme,
                                                        java.lang.String token,
                                                        java.util.Map<java.lang.String,java.lang.String> params)

Obtains an instance of HttpAuthCredentials from scheme, token and single value params.

Parameters:

scheme - the auth scheme, not null

token - the token68, not null

params - the auth params, not null

Returns:

HttpAuthCredentials, not null

Throws:

java.lang.NullPointerException - if any argument is null

parse

public static HttpAuthCredentials parse(java.lang.String credentials)

parse

public static HttpAuthCredentials parse(java.lang.String credentials,
                                        boolean strict)

Obtains an instance of HttpAuthCredentials from credentials such as Custom k1=v1, k2=v2.

Parameters:

credentials - the credentials to parse such as "Custom k1=v1, k2=v2", not null

strict - For every parsing error, an exception is thrown if true, a warning message is logged if false

Returns:

HttpAuthCredentials, not null

Throws:

HttpAuthCredentialParseException - for every parsing error if strict is true

none

public static HttpAuthCredentials none()

Returns empty HttpAuthCredentials.

Returns:

empty HttpAuthCredentials which scheme is "", token is "" and values are empty map.

getScheme

public java.lang.String getScheme()

getToken

public java.lang.String getToken()

getParams

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParams()

Returns the parameters.

Returns:

the parameters as an unmodifiable map that contains the mapping from keys to the values.

getSingleValueParams

public java.util.Map<java.lang.String,java.lang.String> getSingleValueParams()

Returns the parameters in single value representation.

Returns:

the parameters as an unmodifiable map that contains the mapping from keys to the first values.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object