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

gov.nist.javax.sip.header
Class AuthenticationInfo

java.lang.Object
  extended by gov.nist.core.GenericObject
      extended by gov.nist.javax.sip.header.SIPObject
          extended by gov.nist.javax.sip.header.SIPHeader
              extended by gov.nist.javax.sip.header.ParametersHeader
                  extended by gov.nist.javax.sip.header.AuthenticationInfo
All Implemented Interfaces:
HeaderExt, SIPHeaderNames, Serializable, Cloneable, AuthenticationInfoHeader, Header, Parameters

public final class AuthenticationInfo
extends ParametersHeader
implements AuthenticationInfoHeader

Authentication info SIP Header.

Since:
1.1
Version:
1.2 $Revision: 1.9 $ $Date: 2009/07/17 18:57:27 $
Author:
M. Ranganathan NIST/ITL/ANTD
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.AuthenticationInfoHeader
NAME
 
Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames
ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE
 
Constructor Summary
AuthenticationInfo()
          Default contstructor.
 
Method Summary
 void add(gov.nist.core.NameValue nv)
           
 String getAuthenticationInfo()
          Returns the AuthenticationInfo value of this AuthenticationInfoHeader.
 gov.nist.core.NameValue getAuthInfo(String name)
          Get the name value pair for a given authentication info parameter.
 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 setParameter(String name, String value)
          Sets the value of the specified parameter.
 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 class gov.nist.javax.sip.header.ParametersHeader
clone, getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameters, setQuotedParameter
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
dbgPrint, debugDump, debugDump, equals, match
 
Methods inherited from class gov.nist.core.GenericObject
getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Constructor Detail

AuthenticationInfo

public AuthenticationInfo()
Default contstructor.

Method Detail

add

public void add(gov.nist.core.NameValue nv)

getAuthInfo

public gov.nist.core.NameValue getAuthInfo(String name)
Get the name value pair for a given authentication info parameter.

Parameters:
name - is the name for which we want to retrieve the name value list.

getAuthenticationInfo

public String getAuthenticationInfo()
Returns the AuthenticationInfo value of this AuthenticationInfoHeader.

Returns:
the String representing the AuthenticationInfo

getCNonce

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

Specified by:
getCNonce in interface AuthenticationInfoHeader
Returns:
the String representing the cNonce information, null if value is not set.
Since:
v1.1

getNextNonce

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

Specified by:
getNextNonce in interface AuthenticationInfoHeader
Returns:
the String representing the nextNonce information, null if value is not set.
Since:
v1.1

getNonceCount

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

Specified by:
getNonceCount in interface AuthenticationInfoHeader
Returns:
the integer representing the nonceCount information, -1 if value is not set.
Since:
v1.1

getQop

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

Specified by:
getQop in interface AuthenticationInfoHeader
Returns:
the string representing the messageQop information, null if the value is not set.
Since:
v1.1

getResponse

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

Specified by:
getResponse in interface AuthenticationInfoHeader
Returns:
the String representing the Response information.
Since:
v1.1

setCNonce

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

Specified by:
setCNonce in interface AuthenticationInfoHeader
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.
Since:
v1.1

setNextNonce

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

Specified by:
setNextNonce in interface AuthenticationInfoHeader
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.
Since:
v1.1

setNonceCount

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

Specified by:
setNonceCount in interface AuthenticationInfoHeader
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.
Since:
v1.1

setQop

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

Specified by:
setQop in interface AuthenticationInfoHeader
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.
Since:
v1.1

setResponse

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

Specified by:
setResponse in interface AuthenticationInfoHeader
Parameters:
response - - the new response String of this AuthenticationInfoHeader.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the Response.
Since:
v1.1

setParameter

public void setParameter(String name,
                         String value)
                  throws ParseException
Description copied from class: ParametersHeader
Sets the value of the specified parameter. If the parameter already had a value it will be overwritten. A zero-length String indicates flag parameter.

Specified by:
setParameter in interface Parameters
Overrides:
setParameter in class ParametersHeader
Parameters:
name - - a String specifying the parameter name
value - - a String specifying the parameter value
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the parameter name or value.

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.