gov.nist.javax.sip.header
Class Contact

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
                  gov.nist.javax.sip.header.AddressParametersHeader
                      gov.nist.javax.sip.header.Contact

All Implemented Interfaces:

Cloneable, ContactHeader, Header, HeaderAddress, Parameters, Serializable, SIPHeaderNames

public final class Contact

extends AddressParametersHeader

implements ContactHeader

Contact Item.

Version:

JAIN-SIP-1.1

Author:

M. Ranganathan
This code is in the public domain. Bug reports contributed by Joao Paulo, Stephen Jones, John Zeng and Alstair Cole.

See Also:

ContactList, Serialized Form

Field Summary

static String	ACTION
static String	EXPIRES
static String	PROXY
static String	Q
static String	REDIRECT

Fields inherited from interface javax.sip.header.ContactHeader

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, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Contact()
Default constructor.

Method Summary

Address	getAddress() get the address field.
ContactList	getContactList() get the Contact list.
NameValueList	getContactParms() get the parameters List
int	getExpires() get Expires parameter.
float	getQValue() get the Q-value
boolean	getWildCardFlag() get the WildCardFlag field
void	setAddress(Address address) Set the address member
void	setContactList(ContactList cl) set the Contact List
void	setExpires(int expiryDeltaSeconds) Set the expiry time in seconds.
void	setParameter(String name, String value) Set a parameter.
void	setQValue(float qValue) set the Q-value parameter
void	setWildCardFlag(boolean w) Set the wildCardFlag member

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

getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameters, setQuotedParameter

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

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

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

clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString

Methods inherited from class gov.nist.core.GenericObject

getClassFromName, getMatcher, isMySubclass, match, setMatcher

Methods inherited from class java.lang.Object

getClass, hashCode, 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, toString

Field Detail

ACTION

public static final String ACTION

See Also:

Constant Field Values

PROXY

public static final String PROXY

See Also:

Constant Field Values

REDIRECT

public static final String REDIRECT

See Also:

Constant Field Values

EXPIRES

public static final String EXPIRES

See Also:

Constant Field Values

Q

public static final String Q

See Also:

Constant Field Values

Constructor Detail

Contact

public Contact()

Default constructor.

Method Detail

setParameter

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

Set a 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.

getContactList

public ContactList getContactList()

get the Contact list.

Returns:

ContactList

getWildCardFlag

public boolean getWildCardFlag()

get the WildCardFlag field

Returns:

boolean

getAddress

public Address getAddress()

get the address field.

Specified by:

getAddress in interface HeaderAddress

Overrides:

getAddress in class AddressParametersHeader

Returns:

Address

getContactParms

public NameValueList getContactParms()

get the parameters List

Returns:

NameValueList

getExpires

public int getExpires()

get Expires parameter.

Specified by:

getExpires in interface ContactHeader

Returns:

the Expires parameter.

setExpires

public void setExpires(int expiryDeltaSeconds)

Set the expiry time in seconds.

Specified by:

setExpires in interface ContactHeader

Parameters:

expiryDeltaSeconds - exipry time.

getQValue

public float getQValue()

get the Q-value

Specified by:

getQValue in interface ContactHeader

Returns:

float

setContactList

public void setContactList(ContactList cl)

set the Contact List

Parameters:

cl - ContactList to set

setWildCardFlag

public void setWildCardFlag(boolean w)

Set the wildCardFlag member

Parameters:

w - boolean to set

setAddress

public void setAddress(Address address)

Set the address member

Specified by:

setAddress in interface HeaderAddress

Overrides:

setAddress in class AddressParametersHeader

Parameters:

address - Address to set

setQValue

public void setQValue(float qValue)
               throws InvalidArgumentException

set the Q-value parameter

Specified by:

setQValue in interface ContactHeader

Parameters:

qValue - float to set

Throws:

InvalidArgumentException - if the q-value parameter value is not -1 or between 0 and 1.