gov.nist.javax.sip.header

Interface ParametersExt

All Superinterfaces:

Parameters

All Known Implementing Classes:

Accept, AcceptEncoding, AcceptLanguage, AddressParametersHeader, AlertInfo, AuthenticationHeader, AuthenticationInfo, Authorization, CallInfo, Contact, ContentDisposition, ContentType, ErrorInfo, Event, From, Join, MinSE, PAccessNetworkInfo, ParametersHeader, PAssertedIdentity, PAssociatedURI, Path, PCalledPartyID, PChargingFunctionAddresses, PChargingVector, PPreferredIdentity, PProfileKey, ProxyAuthenticate, ProxyAuthorization, PServedUser, PUserDatabase, PVisitedNetworkID, Reason, RecordRoute, References, ReferredBy, ReferTo, Replaces, ReplyTo, RetryAfter, Route, SecurityAgree, SecurityClient, SecurityServer, SecurityVerify, ServiceRoute, SessionExpires, SubscriptionState, To, Via, WWWAuthenticate

public interface ParametersExt
extends Parameters

Extensions to the Parameters interface supported by the implementation and will be included in the next spec release.

Author:

jean.deruelle@gmail.com

Method Summary

Methods

Modifier and Type	Method and Description
String	getParameter(String name, boolean stripQuotes) Returns the value of the named parameter, or null if it is not set.
void	setQuotedParameter(String name, String value) Sets the value of the specified parameter.

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Method Detail

getParameter

String getParameter(String name,
                  boolean stripQuotes)

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

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

Since:

2.0

setQuotedParameter

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.