|
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.extensions.Join
public class Join
Join SIPHeader.
Field Summary | |
---|---|
String |
callId
|
CallIdentifier |
callIdentifier
callIdentifier field |
static String |
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, 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 | |
---|---|
Join()
Default constructor |
|
Join(String callId)
Constructor given the call Identifier. |
Method Summary | |
---|---|
String |
encodeBody()
Encode the body part of this header (i.e. leave out the hdrName). |
String |
getCallId()
get the CallId field. |
CallIdentifier |
getCallIdentifer()
get the call Identifer member. |
String |
getFromTag()
Get the from-tag parameter from the address parm list. |
String |
getToTag()
Get the to-tag parameter from the address parm list. |
boolean |
hasFromTag()
Boolean function |
boolean |
hasToTag()
Boolean function |
void |
removeFromTag()
remove Tag member |
void |
removeToTag()
remove Tag member |
void |
setCallId(String cid)
set the CallId field |
void |
setCallIdentifier(CallIdentifier cid)
Set the callIdentifier member. |
void |
setFromTag(String t)
Set the to-tag member |
void |
setToTag(String t)
Set the to-tag member |
void |
setValue(String value)
Sets the value parameter of the ExtensionHeader. |
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader |
---|
clone, getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, 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, equals, match |
Methods inherited from class gov.nist.core.GenericObject |
---|
getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher |
Methods inherited from class java.lang.Object |
---|
equals, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.sip.header.ExtensionHeader |
---|
getValue |
Methods inherited from interface javax.sip.header.Parameters |
---|
getParameter, getParameterNames, removeParameter, setParameter |
Methods inherited from interface javax.sip.header.Header |
---|
clone, equals, getName, hashCode, toString |
Field Detail |
---|
public static final String NAME
public CallIdentifier callIdentifier
public String callId
Constructor Detail |
---|
public Join()
public Join(String callId) throws IllegalArgumentException
callId
- string call identifier (should be localid@host)
IllegalArgumentException
- if call identifier is bad.Method Detail |
---|
public String encodeBody()
public String getCallId()
getCallId
in interface JoinHeader
public CallIdentifier getCallIdentifer()
public void setCallId(String cid)
setCallId
in interface JoinHeader
cid
- String to set. This is the body part of the Call-Id
header. It must have the form localId@host or localId.
IllegalArgumentException
- if cid is null, not a token, or is
not a token@token.public void setCallIdentifier(CallIdentifier cid)
cid
- CallIdentifier to set (localId@host).public String getToTag()
getToTag
in interface JoinHeader
public void setToTag(String t) throws ParseException
setToTag
in interface JoinHeader
t
- tag to set. From tags are mandatory.
ParseException
- which signals that an error has been reached
unexpectedly while parsing the Tag value.public boolean hasToTag()
public void removeToTag()
public String getFromTag()
getFromTag
in interface JoinHeader
public void setFromTag(String t) throws ParseException
setFromTag
in interface JoinHeader
t
- tag to set. From tags are mandatory.
ParseException
public boolean hasFromTag()
public void removeFromTag()
public void setValue(String value) throws ParseException
ExtensionHeader
setValue
in interface ExtensionHeader
value
- - the new value of the ExtensionHeader
ParseException
- which signals that an error has been reached
unexpectedly while parsing the value parameter.
|
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 |