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:

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

public final class Contact
extends AddressParametersHeader
implements ContactHeader

Contact Item.

Since:

1.1

Version:

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

Author:

M. Ranganathan

See Also:

ContactList, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION
static String	EXPIRES
static String	PROXY
static String	Q
static String	REDIRECT
protected boolean	wildCardFlag wildCardFlag field.

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

address

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

duplicates, 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 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, 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
Contact() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this object.
protected String	encodeBody() Encode body of the header into a cannonical String.
protected StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
boolean	equals(Object other) An introspection based equality predicate for SIPObjects.
Address	getAddress() get the address field.
ContactList	getContactList() get the Contact list.
NameValueList	getContactParms() get the parameters List
int	getExpires() get Expires parameter.
String	getPubGruuParam()
float	getQValue() get the Q-value
String	getSipInstanceParam()
String	getTempGruuParam()
boolean	getWildCardFlag() get the WildCardFlag field
boolean	isWildCard() Returns a boolean value that indicates if the contact header has the format of Contact: *.
void	removePubGruuParam() remove the pub-gruu value from the parameter list if it exists.
void	removeSipInstanceParam()
void	removeTempGruuParam() remove the pub-gruu value from the parameter list if it exists.
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	setPubGruuParam(String value)
void	setQValue(float qValue) set the Q-value parameter
void	setSipInstanceParam(String value)
void	setTempGruuParam(String value)
void	setWildCard() Sets a wildcard on this contact address that is "*" is assigned to the contact header so that the header will have the format of Contact: *.
void	setWildCardFlag(boolean w) Set the wildCardFlag member

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

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 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, 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

finalize, 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

getName, hashCode, 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

wildCardFlag

protected boolean wildCardFlag

wildCardFlag field.

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.

encodeBody

protected String encodeBody()

Encode body of the header into a cannonical String.

Returns:

string encoding of the header value.

encodeBody

protected 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 ParametersHeader

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.

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Specified by:

clone in interface Header

Overrides:

clone in class AddressParametersHeader

Returns:

a deep copy of Header

setWildCard

public void setWildCard()

Description copied from interface: ContactHeader

Sets a wildcard on this contact address that is "*" is assigned to the contact header so that the header will have the format of Contact: *.

Specified by:

setWildCard in interface ContactHeader

isWildCard

public boolean isWildCard()

Description copied from interface: ContactHeader

Returns a boolean value that indicates if the contact header has the format of Contact: *.

Specified by:

isWildCard in interface ContactHeader

Returns:

true if this is a wildcard address, false otherwise.

equals

public boolean equals(Object other)

Description copied from class: SIPObject

An introspection based equality predicate for SIPObjects.

Specified by:

equals in interface Header

Overrides:

equals in class AddressParametersHeader

Parameters:

other - the other object to test against.

Returns:

true if the objects are euqal and false otherwise

removeSipInstanceParam

public void removeSipInstanceParam()

getSipInstanceParam

public String getSipInstanceParam()

setSipInstanceParam

public void setSipInstanceParam(String value)

removePubGruuParam

public void removePubGruuParam()

remove the pub-gruu value from the parameter list if it exists.

getPubGruuParam

public String getPubGruuParam()

setPubGruuParam

public void setPubGruuParam(String value)

removeTempGruuParam

public void removeTempGruuParam()

remove the pub-gruu value from the parameter list if it exists.

getTempGruuParam

public String getTempGruuParam()

setTempGruuParam

public void setTempGruuParam(String value)