NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

javax.sip.header
Interface AuthenticationInfoHeader

All Superinterfaces:
Cloneable, Header, Parameters, Serializable
All Known Implementing Classes:
AuthenticationInfo

public interface AuthenticationInfoHeader
extends Parameters, Header

The Authentication-Info header field provides for mutual authentication with HTTP Digest. A UAS MAY include this header field in a 2xx response to a request that was successfully authenticated using digest based on the Authorization header field.

For Example:
Authentication-Info: nextnonce="47364c23432d2e131a5fb210812c"

Version:
1.2
Author:
BEA Systems, NIST

Field Summary
static String NAME
          Name of the AlertInfoHeader
 
Method Summary
 String getCNonce()
          Returns the CNonce value of this AuthenticationInfoHeader.
 String getNextNonce()
          Returns the nextNonce value of this AuthenticationInfoHeader.
 int getNonceCount()
          Returns the Nonce Count value of this AuthenticationInfoHeader.
 String getQop()
          Returns the messageQop value of this AuthenticationInfoHeader.
 String getResponse()
          Returns the Response value of this AuthenticationInfoHeader.
 void setCNonce(String cNonce)
          Sets the CNonce of the AuthenticationInfoHeader to the cNonce parameter value.
 void setNextNonce(String nextNonce)
          Sets the NextNonce of the AuthenticationInfoHeader to the nextNonce parameter value.
 void setNonceCount(int nonceCount)
          Sets the Nonce Count of the AuthenticationInfoHeader to the nonceCount parameter value.
 void setQop(String qop)
          Sets the Qop value of the AuthenticationInfoHeader to the new qop parameter value.
 void setResponse(String response)
          Sets the Response of the AuthenticationInfoHeader to the new response parameter value.
 
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

static final String NAME
Name of the AlertInfoHeader

See Also:
Constant Field Values
Method Detail

setNextNonce

void setNextNonce(String nextNonce)
                  throws ParseException
Sets the NextNonce of the AuthenticationInfoHeader to the nextNonce parameter value.

Parameters:
nextNonce - - the new nextNonce String of this AuthenticationInfoHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the nextNonce value.

getNextNonce

String getNextNonce()
Returns the nextNonce value of this AuthenticationInfoHeader.

Returns:
the String representing the nextNonce information, null if value is not set.

setQop

void setQop(String qop)
            throws ParseException
Sets the Qop value of the AuthenticationInfoHeader to the new qop parameter value.

Parameters:
qop - - the new Qop string of this AuthenticationInfoHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the Qop value.

getQop

String getQop()
Returns the messageQop value of this AuthenticationInfoHeader.

Returns:
the string representing the messageQop information, null if the value is not set.

setCNonce

void setCNonce(String cNonce)
               throws ParseException
Sets the CNonce of the AuthenticationInfoHeader to the cNonce parameter value.

Parameters:
cNonce - - the new cNonce String of this AuthenticationInfoHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the cNonce value.

getCNonce

String getCNonce()
Returns the CNonce value of this AuthenticationInfoHeader.

Returns:
the String representing the cNonce information, null if value is not set.

setNonceCount

void setNonceCount(int nonceCount)
                   throws ParseException
Sets the Nonce Count of the AuthenticationInfoHeader to the nonceCount parameter value.

Parameters:
nonceCount - - the new nonceCount integer of this AuthenticationInfoHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the nonceCount value.

getNonceCount

int getNonceCount()
Returns the Nonce Count value of this AuthenticationInfoHeader.

Returns:
the integer representing the nonceCount information, -1 if value is not set.

setResponse

void setResponse(String response)
                 throws ParseException
Sets the Response of the AuthenticationInfoHeader to the new response parameter value.

Parameters:
response - - the new response String of this AuthenticationInfoHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the Response.

getResponse

String getResponse()
Returns the Response value of this AuthenticationInfoHeader.

Returns:
the String representing the Response information.

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.