|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.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
public final class Contact
Contact Item.
ContactList
,
Serialized FormField 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, 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 | |
---|---|
Contact()
Default constructor. |
Method Summary | |
---|---|
Object |
clone()
Clones this object. |
boolean |
equals(Object other)
An introspection based equality predicate for SIPObjects. |
Address |
getAddress()
get the address field. |
ContactList |
getContactList()
get the Contact list. |
gov.nist.core.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 |
---|
getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, 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 |
---|
getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher |
Methods inherited from class java.lang.Object |
---|
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 |
---|
public static final String ACTION
public static final String PROXY
public static final String REDIRECT
public static final String EXPIRES
public static final String Q
Constructor Detail |
---|
public Contact()
Method Detail |
---|
public void setParameter(String name, String value) throws ParseException
setParameter
in interface Parameters
setParameter
in class ParametersHeader
name
- - a String specifying the parameter namevalue
- - a String specifying the parameter value
ParseException
- which signals that an error has been reached
unexpectedly while parsing the parameter name or value.public ContactList getContactList()
public boolean getWildCardFlag()
public Address getAddress()
getAddress
in interface HeaderAddress
getAddress
in class AddressParametersHeader
public gov.nist.core.NameValueList getContactParms()
public int getExpires()
getExpires
in interface ContactHeader
public void setExpires(int expiryDeltaSeconds)
setExpires
in interface ContactHeader
expiryDeltaSeconds
- exipry time.public float getQValue()
getQValue
in interface ContactHeader
public void setContactList(ContactList cl)
cl
- ContactList to setpublic void setWildCardFlag(boolean w)
w
- boolean to setpublic void setAddress(Address address)
setAddress
in interface HeaderAddress
setAddress
in class AddressParametersHeader
address
- Address to setpublic void setQValue(float qValue) throws InvalidArgumentException
setQValue
in interface ContactHeader
qValue
- float to set
InvalidArgumentException
- if the q-value parameter value is not
-1
or between 0 and 1
.public Object clone()
gov.nist.core.GenericObject
clone
in interface Header
clone
in class AddressParametersHeader
public void setWildCard()
ContactHeader
setWildCard
in interface ContactHeader
public boolean isWildCard()
ContactHeader
isWildCard
in interface ContactHeader
public boolean equals(Object other)
SIPObject
equals
in interface Header
equals
in class AddressParametersHeader
other
- the other object to test against.
public void removeSipInstanceParam()
public String getSipInstanceParam()
public void setSipInstanceParam(String value)
public void removePubGruuParam()
public String getPubGruuParam()
public void setPubGruuParam(String value)
public void removeTempGruuParam()
public String getTempGruuParam()
public void setTempGruuParam(String value)
|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |