android.gov.nist.javax.sip.header

Class AuthenticationInfo

java.lang.Object

android.gov.nist.core.GenericObject

android.gov.nist.javax.sip.header.SIPObject

android.gov.nist.javax.sip.header.SIPHeader

android.gov.nist.javax.sip.header.ParametersHeader

android.gov.nist.javax.sip.header.AuthenticationInfo

All Implemented Interfaces:

HeaderExt, ParametersExt, SIPHeaderNames, AuthenticationInfoHeader, Header, Parameters, Serializable, Cloneable

public final class AuthenticationInfo
extends ParametersHeader
implements AuthenticationInfoHeader

Authentication info SIP Header.

Since:

1.1

Version:

1.2 $Revision: 1.10 $ $Date: 2010-05-06 14:07:50 $

Author:

M. Ranganathan NIST/ITL/ANTD

See Also:

Serialized Form

Field Summary

Fields inherited from class android.gov.nist.javax.sip.header.ParametersHeader

duplicates, parameters

Fields inherited from class android.gov.nist.javax.sip.header.SIPHeader

headerName

Fields inherited from class android.gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Fields inherited from interface android.javax.sip.header.AuthenticationInfoHeader

NAME

Fields inherited from interface android.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

Constructors

Constructor and Description
AuthenticationInfo() Default contstructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(NameValue nv)
protected StringBuilder	encodeBody(StringBuilder buffer) Value of header encoded in canonical form.
String	getAuthenticationInfo() Returns the AuthenticationInfo value of this AuthenticationInfoHeader.
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.
String	getScheme() Returns the authentication scheme of this AuthenticationInfoHeader.
String	getSNum() Returns the "snum" value of this AuthenticationInfoHeader.
String	getSRand() Returns the "srand" value of this AuthenticationInfoHeader.
String	getTargetName() Returns the "targetname" 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.
void	setScheme(String scheme) Sets authentication scheme name of the AuthenticationInfoHeader to the scheme parameter value.
void	setSNum(String sNum) Sets the SNum of the AuthenticationInfoHeader to the sNum parameter value.
void	setSRand(String sRand) Sets the SRand of the AuthenticationInfoHeader to the sRand parameter value.
void	setTargetName(String targetName) Sets the TargetName of the AuthenticationInfoHeader to the targetName parameter value.

Methods inherited from class android.gov.nist.javax.sip.header.ParametersHeader

clone, equalParameters, getMultiParameter, getMultiParameterNames, getMultiParameters, getMultiParameterValue, getNameValue, getParameter, getParameter, getParameterAsBoolean, getParameterAsFloat, getParameterAsHexInt, getParameterAsInt, getParameterAsLong, getParameterAsURI, getParameterNames, getParameters, getParameterValue, hasMultiParameter, hasMultiParameters, hasParameter, hasParameters, removeMultiParameter, removeMultiParameters, removeParameter, removeParameters, setMultiParameter, setMultiParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameters, setQuotedParameter

Methods inherited from class android.gov.nist.javax.sip.header.SIPHeader

encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString

Methods inherited from class android.gov.nist.javax.sip.header.SIPObject

dbgPrint, debugDump, debugDump, equals, match

Methods inherited from class android.gov.nist.core.GenericObject

dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter

Methods inherited from interface android.javax.sip.header.Header

clone, equals, getName, hashCode, toString

Constructor Detail

AuthenticationInfo

public AuthenticationInfo()

Default contstructor.

Method Detail

add

public void add(NameValue nv)

encodeBody

protected StringBuilder encodeBody(StringBuilder buffer)

Value of header encoded in canonical form.

Specified by:

encodeBody in class ParametersHeader

getAuthInfo

public 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

getSNum

public String getSNum()

Returns the "snum" value of this AuthenticationInfoHeader.

Returns:

the String representing the snum information.

getSRand

public String getSRand()

Returns the "srand" value of this AuthenticationInfoHeader.

Returns:

the String representing the srand information.

getTargetName

public String getTargetName()

Returns the "targetname" value of this AuthenticationInfoHeader.

Returns:

the String representing the targetname information.

getScheme

public String getScheme()

Returns the authentication scheme of this AuthenticationInfoHeader.

Returns:

the String representing the scheme information or null if scheme wasn't set explicitly.

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

setSNum

public void setSNum(String sNum)
             throws ParseException

Sets the SNum of the AuthenticationInfoHeader to the sNum parameter value.

Parameters:

sNum - - the new sNum String of this AuthenticationInfoHeader.

Throws:

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

setSRand

public void setSRand(String sRand)
              throws ParseException

Sets the SRand of the AuthenticationInfoHeader to the sRand parameter value.

Parameters:

sRand - - the new sRand String of this AuthenticationInfoHeader.

Throws:

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

setTargetName

public void setTargetName(String targetName)
                   throws ParseException

Sets the TargetName of the AuthenticationInfoHeader to the targetName parameter value.

Parameters:

targetName - - the new targetName String of this AuthenticationInfoHeader.

Throws:

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

setScheme

public void setScheme(String scheme)
               throws ParseException

Sets authentication scheme name of the AuthenticationInfoHeader to the scheme parameter value.

Parameters:

scheme - - the new scheme String of this AuthenticationInfoHeader.

Throws:

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

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.