org.pfsw.net.http

Class AuthorizationHeader

java.lang.Object

org.pfsw.net.http.AuthorizationHeader

public class AuthorizationHeader
extends java.lang.Object

An instance of this class represents the parsed request header "Authorization". So it is quite easy to determine what type (auth-scheme) of authorization is provided and what credentials are sent within.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_SCHEME_BASIC
static java.lang.String	AUTH_SCHEME_BEARER
static java.lang.String	AUTH_SCHEME_DIGEST

Constructor Summary

Constructors

Constructor and Description
AuthorizationHeader()
AuthorizationHeader(java.lang.String authScheme, java.lang.String authData)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asHeaderString() Returns the full request header name and value.
java.lang.String	asString() Returns the auth-scheme together with the auth-data separated by a space.
java.lang.String	getAuthData() Returns the authentication data that was provided with the authentication scheme.
java.lang.String	getAuthScheme()
boolean	isAuthScheme(java.lang.String name) Returns true if the underlying authentication scheme equals (case-insensitive) the given name.
boolean	isBasicAuthScheme()
boolean	isBearerAuthScheme()
boolean	isDigestAuthScheme()
void	setAuthData(java.lang.String authData)
void	setAuthScheme(java.lang.String authScheme)

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_SCHEME_BASIC

public static final java.lang.String AUTH_SCHEME_BASIC

See Also:

Constant Field Values

AUTH_SCHEME_DIGEST

public static final java.lang.String AUTH_SCHEME_DIGEST

See Also:

Constant Field Values

AUTH_SCHEME_BEARER

public static final java.lang.String AUTH_SCHEME_BEARER

See Also:

Constant Field Values

Constructor Detail

AuthorizationHeader

public AuthorizationHeader()

AuthorizationHeader

public AuthorizationHeader(java.lang.String authScheme,
                           java.lang.String authData)

Method Detail

getAuthScheme

public java.lang.String getAuthScheme()

getAuthData

public java.lang.String getAuthData()

Returns the authentication data that was provided with the authentication scheme. This data is not yet decoded or decrypted in any way.

setAuthScheme

public void setAuthScheme(java.lang.String authScheme)

setAuthData

public void setAuthData(java.lang.String authData)

isBasicAuthScheme

public boolean isBasicAuthScheme()

isDigestAuthScheme

public boolean isDigestAuthScheme()

isBearerAuthScheme

public boolean isBearerAuthScheme()

isAuthScheme

public boolean isAuthScheme(java.lang.String name)

Returns true if the underlying authentication scheme equals (case-insensitive) the given name.

Parameters:

name - The (auth scheme) name to check against.

asString

public java.lang.String asString()

Returns the auth-scheme together with the auth-data separated by a space.

Example: "Basic emda8ghk823fvdcs99sJSst="

asHeaderString

public java.lang.String asHeaderString()

Returns the full request header name and value.

Example: "Authorization: Bearer e8785jAp9dnSNo/Twqpds8a7w4j="