|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WWWAuthenticateHeader
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
Parameters
Field Summary | |
---|---|
static java.lang.String |
NAME
Name of WWWAuthenticateHeader |
Method Summary | |
---|---|
java.lang.String |
getAlgorithm()
Returns the Algorithm value of this WWWAuthenicateHeader. |
java.lang.String |
getDomain()
Returns the Domain value of this WWWAuthenicateHeader. |
java.lang.String |
getNonce()
Returns the Nonce value of this WWWAuthenicateHeader. |
java.lang.String |
getOpaque()
Returns the Opaque value of this WWWAuthenicateHeader. |
java.lang.String |
getQop()
Returns the Qop value of this WWWAuthenicateHeader. |
java.lang.String |
getRealm()
Returns the Realm value of this WWWAuthenicateHeader. |
java.lang.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(java.lang.String algorithm)
Sets the Algorithm of the WWWAuthenicateHeader to the new algorithm parameter value. |
void |
setDomain(java.lang.String domain)
Sets the Domain of the WWWAuthenicateHeader to the domain parameter value. |
void |
setNonce(java.lang.String nonce)
Sets the Nonce of the WWWAuthenicateHeader to the nonce parameter value. |
void |
setOpaque(java.lang.String opaque)
Sets the Opaque value of the WWWAuthenicateHeader to the new opaque parameter value. |
void |
setQop(java.lang.String qop)
Sets the Qop value of the WWWAuthenicateHeader to the new qop parameter value. |
void |
setRealm(java.lang.String realm)
Sets the Realm of the WWWAuthenicateHeader to the realm parameter value. |
void |
setScheme(java.lang.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 |
---|
static final java.lang.String NAME
Method Detail |
---|
void setScheme(java.lang.String scheme)
scheme
- - the new string value that identifies the challenge
information scheme.java.lang.String getScheme()
void setRealm(java.lang.String realm) throws java.text.ParseException
realm
- the new Realm String of this WWWAuthenicateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the realm.java.lang.String getRealm()
void setNonce(java.lang.String nonce) throws java.text.ParseException
nonce
- - the new nonce String of this WWWAuthenicateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the nonce value.java.lang.String getNonce()
void setURI(URI uri)
uri
- - the new URI of this WWWAuthenicateHeader.URI getURI()
void setAlgorithm(java.lang.String algorithm) throws java.text.ParseException
algorithm
- - the new algorithm String of this WWWAuthenicateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the algorithm value.java.lang.String getAlgorithm()
void setQop(java.lang.String qop) throws java.text.ParseException
qop
- - the new Qop string of this WWWAuthenicateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the Qop value.java.lang.String getQop()
void setOpaque(java.lang.String opaque) throws java.text.ParseException
opaque
- - the new Opaque string of this WWWAuthenicateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the opaque value.java.lang.String getOpaque()
void setDomain(java.lang.String domain) throws java.text.ParseException
domain
- - the new Domain string of this WWWAuthenicateHeader.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the domain.java.lang.String getDomain()
void setStale(boolean stale)
stale
- - the new boolean value of the stale parameter.boolean isStale()
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |