gov.nist.javax.sip.header.extensions

Class Join

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.extensions.Join

All Implemented Interfaces:

JoinHeader, HeaderExt, ParametersExt, SIPHeaderNames, Serializable, Cloneable, ExtensionHeader, Header, Parameters

public class Join
extends ParametersHeader
implements ExtensionHeader, JoinHeader

Join SIPHeader.

Version:

JAIN-SIP-1.2

Author:

jean.deruelle@gmail.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	callId
CallIdentifier	callIdentifier callIdentifier field
static String	NAME

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

Constructors

Constructor and Description
Join() Default constructor
Join(String callId) Constructor given the call Identifier.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder retval) Encode the body part of this header (i.e.
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, 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, 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

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

NAME

public static final String NAME

See Also:

Constant Field Values

callIdentifier

public CallIdentifier callIdentifier

callIdentifier field

callId

public String callId

Constructor Detail

Join

public Join()

Default constructor

Join

public Join(String callId)
     throws IllegalArgumentException

Constructor given the call Identifier.

Parameters:

callId - string call identifier (should be localid@host)

Throws:

IllegalArgumentException - if call identifier is bad.

Method Detail

encodeBody

public StringBuilder encodeBody(StringBuilder retval)

Encode the body part of this header (i.e. leave out the hdrName).

Specified by:

encodeBody in class ParametersHeader

Returns:

String encoded body part of the header.

getCallId

public String getCallId()

get the CallId field. This does the same thing as encodeBody

Specified by:

getCallId in interface JoinHeader

Returns:

String the encoded body part of the

getCallIdentifer

public CallIdentifier getCallIdentifer()

get the call Identifer member.

Returns:

CallIdentifier

setCallId

public void setCallId(String cid)

set the CallId field

Specified by:

setCallId in interface JoinHeader

Parameters:

cid - String to set. This is the body part of the Call-Id header. It must have the form localId@host or localId.

Throws:

IllegalArgumentException - if cid is null, not a token, or is not a token@token.

setCallIdentifier

public void setCallIdentifier(CallIdentifier cid)

Set the callIdentifier member.

Parameters:

cid - CallIdentifier to set (localId@host).

getToTag

public String getToTag()

Get the to-tag parameter from the address parm list.

Specified by:

getToTag in interface JoinHeader

Returns:

tag field

setToTag

public void setToTag(String t)
              throws ParseException

Set the to-tag member

Specified by:

setToTag in interface JoinHeader

Parameters:

t - tag to set. From tags are mandatory.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the Tag value.

hasToTag

public boolean hasToTag()

Boolean function

Returns:

true if the Tag exist

removeToTag

public void removeToTag()

remove Tag member

getFromTag

public String getFromTag()

Get the from-tag parameter from the address parm list.

Specified by:

getFromTag in interface JoinHeader

Returns:

tag field

setFromTag

public void setFromTag(String t)
                throws ParseException

Set the to-tag member

Specified by:

setFromTag in interface JoinHeader

Parameters:

t - tag to set. From tags are mandatory.

Throws:

ParseException

hasFromTag

public boolean hasFromTag()

Boolean function

Returns:

true if the Tag exist

removeFromTag

public void removeFromTag()

remove Tag member

setValue

public void setValue(String value)
              throws ParseException

Description copied from interface: ExtensionHeader

Sets the value parameter of the ExtensionHeader.

Specified by:

setValue in interface ExtensionHeader

Parameters:

value - - the new value of the ExtensionHeader

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the value parameter.