javax.sip.header
Interface WWWAuthenticateHeader

All Superinterfaces:

Cloneable, Header, Parameters, Serializable

All Known Subinterfaces:

ProxyAuthenticateHeader, WWWAuthenticateHeaderIms

All Known Implementing Classes:

ProxyAuthenticate, WWWAuthenticate

public interface WWWAuthenticateHeader

extends Parameters, Header

This interface represents the WWW-Authenticate response-header. A WWW-Authenticate header field value contains an authentication challenge. When a UAS receives a request from a UAC, the UAS MAY authenticate the originator before the request is processed. If no credentials (in the Authorization header field) are provided in the request, the UAS can challenge the originator to provide credentials by rejecting the request with a 401 (Unauthorized) status code. The WWW-Authenticate response-header field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the realm.

For Example:
WWW-Authenticate: Digest realm="atlanta.com", domain="sip:boxesbybob.com", qop="auth", nonce="f84f1cec41e6cbe5aea9c8e88d359", opaque="", stale=FALSE, algorithm=MD5

Version:

1.2

Author:

BEA Systems, NIST

See Also:

Parameters

Field Summary

static String

NAME Name of WWWAuthenticateHeader

Method Summary

String	getAlgorithm() Returns the Algorithm value of this WWWAuthenicateHeader.
String	getDomain() Returns the Domain value of this WWWAuthenicateHeader.
String	getNonce() Returns the Nonce value of this WWWAuthenicateHeader.
String	getOpaque() Returns the Opaque value of this WWWAuthenicateHeader.
String	getQop() Returns the Qop value of this WWWAuthenicateHeader.
String	getRealm() Returns the Realm value of this WWWAuthenicateHeader.
String	getScheme() Returns the scheme of the challenge information for this WWWAuthenticateHeader.
URI	getURI() Deprecated. Since v1.2. URI is not a supported parameter for this header. This method should return null.
boolean	isStale() Returns the boolean value of the state paramater of this WWWAuthenicateHeader.
void	setAlgorithm(String algorithm) Sets the Algorithm of the WWWAuthenicateHeader to the new algorithm parameter value.
void	setDomain(String domain) Sets the Domain of the WWWAuthenicateHeader to the domain parameter value.
void	setNonce(String nonce) Sets the Nonce of the WWWAuthenicateHeader to the nonce parameter value.
void	setOpaque(String opaque) Sets the Opaque value of the WWWAuthenicateHeader to the new opaque parameter value.
void	setQop(String qop) Sets the Qop value of the WWWAuthenicateHeader to the new qop parameter value.
void	setRealm(String realm) Sets the Realm of the WWWAuthenicateHeader to the realm parameter value.
void	setScheme(String scheme) Sets the scheme of the challenge information for this WWWAuthenticateHeader.
void	setStale(boolean stale) Sets the value of the stale parameter of the WWWAuthenicateHeader to the stale parameter value.
void	setURI(URI uri) Deprecated. Since v1.2. URI is not a supported parameter for this header.

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

public static final String NAME

Name of WWWAuthenticateHeader

See Also:

Constant Field Values

Method Detail

setScheme

public void setScheme(String scheme)

Sets the scheme of the challenge information for this WWWAuthenticateHeader. For example, Digest.

Parameters:

scheme - - the new string value that identifies the challenge information scheme.

getScheme

public String getScheme()

Returns the scheme of the challenge information for this WWWAuthenticateHeader.

Returns:

the string value of the challenge information.

setRealm

public void setRealm(String realm)
              throws ParseException

Sets the Realm of the WWWAuthenicateHeader to the realm parameter value. Realm strings MUST be globally unique. It is RECOMMENDED that a realm string contain a hostname or domain name. Realm strings SHOULD present a human-readable identifier that can be rendered to a user.

Parameters:

realm - the new Realm String of this WWWAuthenicateHeader.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the realm.

getRealm

public String getRealm()

Returns the Realm value of this WWWAuthenicateHeader. This convenience method returns only the realm of the complete Challenge.

Returns:

the String representing the Realm information, null if value is not set.

setNonce

public void setNonce(String nonce)
              throws ParseException

Sets the Nonce of the WWWAuthenicateHeader to the nonce parameter value.

Parameters:

nonce - - the new nonce String of this WWWAuthenicateHeader.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the nonce value.

getNonce

public String getNonce()

Returns the Nonce value of this WWWAuthenicateHeader.

Returns:

the String representing the nonce information, null if value is not set.

setURI

public void setURI(URI uri)

Deprecated. Since v1.2. URI is not a supported parameter for this header.

Sets the URI of the WWWAuthenicateHeader to the URI parameter value.

Parameters:

uri - - the new URI of this WWWAuthenicateHeader.

getURI

public URI getURI()

Deprecated. Since v1.2. URI is not a supported parameter for this header. This method should return null.

Returns the URI value of this WWWAuthenicateHeader, for example DigestURI.

Returns:

the URI representing the URI information, null if value is not set.

setAlgorithm

public void setAlgorithm(String algorithm)
                  throws ParseException

Sets the Algorithm of the WWWAuthenicateHeader to the new algorithm parameter value.

Parameters:

algorithm - - the new algorithm String of this WWWAuthenicateHeader.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the algorithm value.

getAlgorithm

public String getAlgorithm()

Returns the Algorithm value of this WWWAuthenicateHeader.

Returns:

the String representing the Algorithm information, null if the value is not set.

setQop

public void setQop(String qop)
            throws ParseException

Sets the Qop value of the WWWAuthenicateHeader to the new qop parameter value.

Parameters:

qop - - the new Qop string of this WWWAuthenicateHeader.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the Qop value.

getQop

public String getQop()

Returns the Qop value of this WWWAuthenicateHeader.

Returns:

the string representing the Qop information, null if the value is not set.

setOpaque

public void setOpaque(String opaque)
               throws ParseException

Sets the Opaque value of the WWWAuthenicateHeader to the new opaque parameter value.

Parameters:

opaque - - the new Opaque string of this WWWAuthenicateHeader.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the opaque value.

getOpaque

public String getOpaque()

Returns the Opaque value of this WWWAuthenicateHeader.

Returns:

the String representing the Opaque information, null if the value is not set.

setDomain

public void setDomain(String domain)
               throws ParseException

Sets the Domain of the WWWAuthenicateHeader to the domain parameter value.

Parameters:

domain - - the new Domain string of this WWWAuthenicateHeader.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the domain.

getDomain

public String getDomain()

Returns the Domain value of this WWWAuthenicateHeader.

Returns:

the String representing the Domain information, null if value is not set.

setStale

public void setStale(boolean stale)

Sets the value of the stale parameter of the WWWAuthenicateHeader to the stale parameter value.

Parameters:

stale - - the new boolean value of the stale parameter.

isStale

public boolean isStale()

Returns the boolean value of the state paramater of this WWWAuthenicateHeader.

Returns:

the boolean representing if the challenge is stale.