gov.nist.javax.sip.header

Class ParametersHeader

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.ParametersHeader

All Implemented Interfaces:

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

Direct Known Subclasses:

Accept, AcceptEncoding, AcceptLanguage, AddressParametersHeader, AlertInfo, AuthenticationHeader, AuthenticationInfo, CallInfo, ContentDisposition, ContentType, ErrorInfo, Event, Join, MinSE, PAccessNetworkInfo, PChargingFunctionAddresses, PChargingVector, PUserDatabase, PVisitedNetworkID, Reason, References, Replaces, RetryAfter, SecurityAgree, SessionExpires, SubscriptionState, Via

public abstract class ParametersHeader
extends SIPHeader
implements Parameters, ParametersExt, Serializable

Parameters header. Suitable for extension by headers that have parameters.

Version:

1.2 $Revision: 1.17 $ $Date: 2010-07-28 08:39:26 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DuplicateNameValueList	duplicates
protected NameValueList	parameters

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

headerName

Fields inherited from class 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 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

Modifier	Constructor and Description
protected	ParametersHeader()
protected	ParametersHeader(String hdrName)
protected	ParametersHeader(String hdrName, boolean sync)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this object.
protected abstract StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
protected boolean	equalParameters(Parameters other)
String	getMultiParameter(String name) Returns the parameter name
Iterator<String>	getMultiParameterNames() Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.
DuplicateNameValueList	getMultiParameters()
Object	getMultiParameterValue(String name) Return the parameter as an object (dont convert to string).
NameValue	getNameValue(String parameterName) This is for the benifit of the TCK.
String	getParameter(String name) Returns the value of the named parameter, or null if it is not set.
String	getParameter(String name, boolean stripQuotes) Returns the value of the named parameter, or null if it is not set.
protected boolean	getParameterAsBoolean(String parameterName) Get the parameter value as a boolean.
protected float	getParameterAsFloat(String parameterName) Get the parameter as a float value.
protected int	getParameterAsHexInt(String parameterName) Get the parameter as an integer when it is entered as a hex.
protected int	getParameterAsInt(String parameterName) Get the parameter as an integer value.
protected long	getParameterAsLong(String parameterName) Get the parameter as a long value.
protected GenericURI	getParameterAsURI(String parameterName) Get the parameter value as a URI.
Iterator<String>	getParameterNames() Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.
NameValueList	getParameters() get the parameter list.
Object	getParameterValue(String name) Return the parameter as an object (dont convert to string).
boolean	hasMultiParameter(String parameterName) Return true if has a parameter.
boolean	hasMultiParameters() Return true if you have a parameter and false otherwise.
boolean	hasParameter(String parameterName) Return true if has a parameter.
boolean	hasParameters() Return true if you have a parameter and false otherwise.
void	removeMultiParameter(String name) Removes the specified parameter from Parameters of this ParametersHeader.
void	removeMultiParameters() Remove all parameters.
void	removeParameter(String name) Removes the specified parameter from Parameters of this ParametersHeader.
void	removeParameters() Remove all parameters.
void	setMultiParameter(NameValue nameValue) Set the parameter given a name and value.
void	setMultiParameter(String name, String value) Introduced specifically for the P-Charging-Function-Addresses Header and all other headers that may have multiple header parameters of the same name, but with multiple possible values.
void	setParameter(NameValue nameValue) Set the parameter given a name and value.
protected void	setParameter(String name, boolean value) Sets the value of the specified parameter.
protected void	setParameter(String name, float value) Sets the value of the specified parameter.
protected void	setParameter(String name, int value) Sets the value of the specified parameter.
protected void	setParameter(String name, Object value) Sets the value of the specified parameter.
void	setParameter(String name, String value) Sets the value of the specified parameter.
void	setParameters(NameValueList parameters) Set the parameter list.
void	setQuotedParameter(String name, String value) Sets the value of the specified parameter.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sip.header.Header

equals

Field Detail

parameters

protected NameValueList parameters

duplicates

protected DuplicateNameValueList duplicates

Constructor Detail

ParametersHeader

protected ParametersHeader()

ParametersHeader

protected ParametersHeader(String hdrName)

ParametersHeader

protected ParametersHeader(String hdrName,
                boolean sync)

Method Detail

getParameter

public String getParameter(String name)

Description copied from interface: Parameters

Returns the value of the named parameter, or null if it is not set. A zero-length String indicates flag parameter.

Specified by:

getParameter in interface Parameters

Parameters:

name - name of parameter to retrieve

Returns:

the value of specified parameter

getParameter

public String getParameter(String name,
                  boolean stripQuotes)

Description copied from interface: ParametersExt

Returns the value of the named parameter, or null if it is not set. A zero-length String indicates flag parameter. The stack remove the undeeded quotes that are imposed by SIP encoding rules to ensure unambiguous parsing.
The stripQuotes parameter can be used to get the original value as it has been received by the stack ie with the quotes

Specified by:

getParameter in interface ParametersExt

Parameters:

name - name of parameter to retrieve

stripQuotes - will return the value of the parameter as it has been received when the message came into the stack

Returns:

the value of specified parameter

getParameterValue

public Object getParameterValue(String name)

Return the parameter as an object (dont convert to string).

Parameters:

name - is the name of the parameter to get.

Returns:

the object associated with the name.

getParameterNames

public Iterator<String> getParameterNames()

Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.

Specified by:

getParameterNames in interface Parameters

Returns:

an Iterator over all the parameter names

hasParameters

public boolean hasParameters()

Return true if you have a parameter and false otherwise.

Returns:

true if the parameters list is non-empty.

removeParameter

public void removeParameter(String name)

Removes the specified parameter from Parameters of this ParametersHeader. This method returns silently if the parameter is not part of the ParametersHeader.

Specified by:

removeParameter in interface Parameters

Parameters:

name - - a String specifying the parameter name

setParameter

public void setParameter(String name,
                String value)
                  throws ParseException

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

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.

setQuotedParameter

public void setQuotedParameter(String name,
                      String value)
                        throws ParseException

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.

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.

setParameter

protected void setParameter(String name,
                int value)

Sets the value of the specified parameter. If the parameter already had a value it will be overwritten.

Parameters:

name - - a String specifying the parameter name

value - - an int specifying the parameter value

Throws:

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

setParameter

protected void setParameter(String name,
                boolean value)

Sets the value of the specified parameter. If the parameter already had a value it will be overwritten.

Parameters:

name - - a String specifying the parameter name

value - - a boolean specifying the parameter value

Throws:

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

setParameter

protected void setParameter(String name,
                float value)

Sets the value of the specified parameter. If the parameter already had a value it will be overwritten.

Parameters:

name - - a String specifying the parameter name

value - - a boolean specifying the parameter value

Throws:

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

setParameter

protected void setParameter(String name,
                Object value)

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.

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.

hasParameter

public boolean hasParameter(String parameterName)

Return true if has a parameter.

Parameters:

parameterName - is the name of the parameter.

Returns:

true if the parameter exists and false if not.

removeParameters

public void removeParameters()

Remove all parameters.

getParameters

public NameValueList getParameters()

get the parameter list.

Returns:

parameter list

setParameter

public void setParameter(NameValue nameValue)

Set the parameter given a name and value.

Parameters:

nameValue - - the name value of the parameter to set.

setParameters

public void setParameters(NameValueList parameters)

Set the parameter list.

Parameters:

parameters - The name value list to set as the parameter list.

getParameterAsInt

protected int getParameterAsInt(String parameterName)

Get the parameter as an integer value.

Parameters:

parameterName - -- the parameter name to fetch.

Returns:

-1 if the parameter is not defined in the header.

getParameterAsHexInt

protected int getParameterAsHexInt(String parameterName)

Get the parameter as an integer when it is entered as a hex.

Parameters:

parameterName - -- The parameter name to fetch.

Returns:

-1 if the parameter is not defined in the header.

getParameterAsFloat

protected float getParameterAsFloat(String parameterName)

Get the parameter as a float value.

Parameters:

parameterName - -- the parameter name to fetch

Returns:

-1 if the parameter is not defined or the parameter as a float.

getParameterAsLong

protected long getParameterAsLong(String parameterName)

Get the parameter as a long value.

Parameters:

parameterName - -- the parameter name to fetch.

Returns:

-1 if the parameter is not defined or the parameter as a long.

getParameterAsURI

protected GenericURI getParameterAsURI(String parameterName)

Get the parameter value as a URI.

Parameters:

parameterName - -- the parameter name

Returns:

value of the parameter as a URI or null if the parameter not present.

getParameterAsBoolean

protected boolean getParameterAsBoolean(String parameterName)

Get the parameter value as a boolean.

Parameters:

parameterName - -- the parameter name

Returns:

boolean value of the parameter.

getNameValue

public NameValue getNameValue(String parameterName)

This is for the benifit of the TCK.

Returns:

the name value pair for the given parameter name.

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Specified by:

clone in interface Header

Overrides:

clone in class GenericObject

Returns:

a deep copy of Header

setMultiParameter

public void setMultiParameter(String name,
                     String value)

Introduced specifically for the P-Charging-Function-Addresses Header and all other headers that may have multiple header parameters of the same name, but with multiple possible values. Example: P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22]; ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd]

Parameters:

name - of the parameter

value - of the parameter

setMultiParameter

public void setMultiParameter(NameValue nameValue)

Set the parameter given a name and value.

Parameters:

nameValue - - the name value of the parameter to set.

getMultiParameter

public String getMultiParameter(String name)

Returns the parameter name

Parameters:

name -

Returns:

getMultiParameters

public DuplicateNameValueList getMultiParameters()

getMultiParameterValue

public Object getMultiParameterValue(String name)

Return the parameter as an object (dont convert to string).

Parameters:

name - is the name of the parameter to get.

Returns:

the object associated with the name.

getMultiParameterNames

public Iterator<String> getMultiParameterNames()

Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.

Returns:

an Iterator over all the parameter names

hasMultiParameters

public boolean hasMultiParameters()

Return true if you have a parameter and false otherwise.

Returns:

true if the parameters list is non-empty.

removeMultiParameter

public void removeMultiParameter(String name)

Removes the specified parameter from Parameters of this ParametersHeader. This method returns silently if the parameter is not part of the ParametersHeader.

Parameters:

name - - a String specifying the parameter name

hasMultiParameter

public boolean hasMultiParameter(String parameterName)

Return true if has a parameter.

Parameters:

parameterName - is the name of the parameter.

Returns:

true if the parameter exists and false if not.

removeMultiParameters

public void removeMultiParameters()

Remove all parameters.

equalParameters

protected final boolean equalParameters(Parameters other)

encodeBody

protected abstract StringBuilder encodeBody(StringBuilder buffer)

Description copied from class: SIPHeader

Encode the body of this header (the stuff that follows headerName). A.K.A headerValue.

Specified by:

encodeBody in class SIPHeader