org.zoolu.sip.header
Class AuthenticationHeader

java.lang.Object
  |
  +--org.zoolu.sip.header.Header
        |
        +--org.zoolu.sip.header.AuthenticationHeader

Direct Known Subclasses:

AuthenticationInfoHeader, AuthorizationHeader, WwwAuthenticateHeader

public abstract class AuthenticationHeader

extends Header

Abstract header for various authentication schemes

It is inherited by WwwAuthenticateHeader, AuthorizationHeader, etc.

Field Summary

static java.lang.String	LWS_SEPARATOR Lienar white space separator inserted bethween parameters.
static java.lang.String[]	QUOTED_PARAMETERS Array of parameters that are quoted.

Fields inherited from class org.zoolu.sip.header.Header

name, value

Constructor Summary

AuthenticationHeader(Header hd)
Creates a new AuthenticationHeader.

AuthenticationHeader(java.lang.String hname, java.lang.String hvalue)
Creates a new AuthenticationHeader.

AuthenticationHeader(java.lang.String hname, java.lang.String auth_scheme, java.util.Vector auth_params)
Creates a new AuthenticationHeader. specifing the auth_scheme and the vector of authentication parameters.

Method Summary

void	addAlgorithParam(java.lang.String algorithm) Adds the algorithm
void	addAutsParam(java.lang.String unquoted_auts) Adds the auts
void	addCnonceParam(java.lang.String unquoted_cnonce) Adds the cnonce
void	addNcParam(java.lang.String nc) Adds the nc
void	addNextnonceParam(java.lang.String unquoted_nextnonce) Adds the nextnonce
void	addNonceParam(java.lang.String unquoted_nonce) Adds the nonce
void	addOpaqueParam(java.lang.String unquoted_opaque) Adds the opaque
void	addParameter(java.lang.String param_name, java.lang.String param_value) Adds a parameter.
void	addQopOptionsParam(java.lang.String unquoted_qop_options) Adds the qop-options
void	addQopParam(java.lang.String qop) Adds the qop
void	addQuotedParameter(java.lang.String param_name, java.lang.String param_value) Adds a parameter with quotes.
void	addRealmParam(java.lang.String unquoted_realm) Adds the realm
void	addResponseParam(java.lang.String unquoted_response) Adds the response
void	addRspauthParam(java.lang.String unquoted_rspauth) Adds the rspauth
void	addUnquotedParameter(java.lang.String param_name, java.lang.String param_value) Adds a parameter without inserting quotes.
void	addUriParam(java.lang.String unquoted_uri) Adds the uri
void	addUsernameParam(java.lang.String unquoted_username) Adds the username
java.lang.String	getAlgorithParam() Returns the algorithm
java.lang.String	getAuthScheme() Gets the athentication scheme (i.e. the first token).
java.lang.String	getAutsParam() Returns the auts
java.lang.String	getCnonceParam() Returns the cnonce (unquoted)
java.lang.String	getNcParam() Returns the nc
java.lang.String	getNextnonceParam() Returns the nextnonce
java.lang.String	getNonceParam() Returns the nonce (unquoted)
java.lang.String	getOpaqueParam() Returns the opaque (unquoted)
java.lang.String	getParameter(java.lang.String param_name) Returns the parameter param_name, without quotes.
java.util.Vector	getParameters() Gets a String Vector of parameter names.
java.lang.String	getQopOptionsParam() Gets the qop-options
java.lang.String	getQopParam() Returns the qop
java.lang.String	getRealmParam() Returns the realm (unquoted)
java.lang.String	getResponseParam() Returns the response (unquoted)
java.lang.String	getRspauthParam() Returns the rspauth (unquoted)
java.lang.String	getUriParam() Returns the uri (unquoted)
java.lang.String	getUsernameParam() Returns the username (unquoted)
boolean	hasAlgorithmParam() Whether has algorithm
boolean	hasAutsParam() Whether has auts
boolean	hasCnonceParam() Whether has cnonce
boolean	hasNcParam() Whether has nc
boolean	hasNextnonceParam() Whether has nextnonce
boolean	hasNonceParam() Whether has nonce
boolean	hasOpaqueParam() Whether has opaque
boolean	hasParameter(java.lang.String param_name) Whether has parameter param_name
boolean	hasQopOptionsParam() Whether has qop-options
boolean	hasQopParam() Whether has qop
boolean	hasRealmParam() Whether has realm
boolean	hasResponseParam() Whether has response
boolean	hasRspauthParam() Whether has rspauth
boolean	hasUriParam() Whether has uri
boolean	hasUsernameParam() Whether has username

Methods inherited from class org.zoolu.sip.header.Header

clone, equals, getName, getValue, setValue, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LWS_SEPARATOR

public static java.lang.String LWS_SEPARATOR

Lienar white space separator inserted bethween parameters.

QUOTED_PARAMETERS

public static java.lang.String[] QUOTED_PARAMETERS

Array of parameters that are quoted.

Constructor Detail

AuthenticationHeader

public AuthenticationHeader(java.lang.String hname,
                            java.lang.String hvalue)

Creates a new AuthenticationHeader.

AuthenticationHeader

public AuthenticationHeader(Header hd)

Creates a new AuthenticationHeader.

AuthenticationHeader

public AuthenticationHeader(java.lang.String hname,
                            java.lang.String auth_scheme,
                            java.util.Vector auth_params)

Creates a new AuthenticationHeader. specifing the auth_scheme and the vector of authentication parameters.

auth_params is a vector of String of the form parm_name "=" parm_value

Method Detail

addParameter

public void addParameter(java.lang.String param_name,
                         java.lang.String param_value)

Adds a parameter. If param_name belongs to QUOTED_PARAMETERS, param_value is quoted (if already not).

addUnquotedParameter

public void addUnquotedParameter(java.lang.String param_name,
                                 java.lang.String param_value)

Adds a parameter without inserting quotes.

addQuotedParameter

public void addQuotedParameter(java.lang.String param_name,
                               java.lang.String param_value)

Adds a parameter with quotes.

hasParameter

public boolean hasParameter(java.lang.String param_name)

Whether has parameter param_name

getParameter

public java.lang.String getParameter(java.lang.String param_name)

Returns the parameter param_name, without quotes.

getParameters

public java.util.Vector getParameters()

Gets a String Vector of parameter names.

getAuthScheme

public java.lang.String getAuthScheme()

Gets the athentication scheme (i.e. the first token).

hasRealmParam

public boolean hasRealmParam()

Whether has realm

getRealmParam

public java.lang.String getRealmParam()

Returns the realm (unquoted)

addRealmParam

public void addRealmParam(java.lang.String unquoted_realm)

Adds the realm

hasNonceParam

public boolean hasNonceParam()

Whether has nonce

getNonceParam

public java.lang.String getNonceParam()

Returns the nonce (unquoted)

addNonceParam

public void addNonceParam(java.lang.String unquoted_nonce)

Adds the nonce

hasOpaqueParam

public boolean hasOpaqueParam()

Whether has opaque

getOpaqueParam

public java.lang.String getOpaqueParam()

Returns the opaque (unquoted)

addOpaqueParam

public void addOpaqueParam(java.lang.String unquoted_opaque)

Adds the opaque

hasUsernameParam

public boolean hasUsernameParam()

Whether has username

getUsernameParam

public java.lang.String getUsernameParam()

Returns the username (unquoted)

addUsernameParam

public void addUsernameParam(java.lang.String unquoted_username)

Adds the username

hasUriParam

public boolean hasUriParam()

Whether has uri

getUriParam

public java.lang.String getUriParam()

Returns the uri (unquoted)

addUriParam

public void addUriParam(java.lang.String unquoted_uri)

Adds the uri

hasResponseParam

public boolean hasResponseParam()

Whether has response

getResponseParam

public java.lang.String getResponseParam()

Returns the response (unquoted)

addResponseParam

public void addResponseParam(java.lang.String unquoted_response)

Adds the response

hasCnonceParam

public boolean hasCnonceParam()

Whether has cnonce

getCnonceParam

public java.lang.String getCnonceParam()

Returns the cnonce (unquoted)

addCnonceParam

public void addCnonceParam(java.lang.String unquoted_cnonce)

Adds the cnonce

hasRspauthParam

public boolean hasRspauthParam()

Whether has rspauth

getRspauthParam

public java.lang.String getRspauthParam()

Returns the rspauth (unquoted)

addRspauthParam

public void addRspauthParam(java.lang.String unquoted_rspauth)

Adds the rspauth

hasAutsParam

public boolean hasAutsParam()

Whether has auts

getAutsParam

public java.lang.String getAutsParam()

Returns the auts

addAutsParam

public void addAutsParam(java.lang.String unquoted_auts)

Adds the auts

hasNextnonceParam

public boolean hasNextnonceParam()

Whether has nextnonce

getNextnonceParam

public java.lang.String getNextnonceParam()

Returns the nextnonce

addNextnonceParam

public void addNextnonceParam(java.lang.String unquoted_nextnonce)

Adds the nextnonce

hasQopOptionsParam

public boolean hasQopOptionsParam()

Whether has qop-options

getQopOptionsParam

public java.lang.String getQopOptionsParam()

Gets the qop-options

addQopOptionsParam

public void addQopOptionsParam(java.lang.String unquoted_qop_options)

Adds the qop-options

hasQopParam

public boolean hasQopParam()

Whether has qop

getQopParam

public java.lang.String getQopParam()

Returns the qop

addQopParam

public void addQopParam(java.lang.String qop)

Adds the qop

hasNcParam

public boolean hasNcParam()

Whether has nc

getNcParam

public java.lang.String getNcParam()

Returns the nc

addNcParam

public void addNcParam(java.lang.String nc)

Adds the nc

hasAlgorithmParam

public boolean hasAlgorithmParam()

Whether has algorithm

getAlgorithParam

public java.lang.String getAlgorithParam()

Returns the algorithm

addAlgorithParam

public void addAlgorithParam(java.lang.String algorithm)

Adds the algorithm