gov.nist.javax.sip.header

Class CallID

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.CallID

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, CallIdHeader, Header

public class CallID
extends SIPHeader
implements CallIdHeader

Call ID SIPHeader.

Since:

1.1

Version:

1.2 $Revision: 1.8 $ $Date: 2010-05-06 14:07:54 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CallIdentifier	callIdentifier callIdentifier field
static String	NAME_LOWER

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

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

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this object.
String	encodeBody() Encode the body part of this header (i.e.
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.
String	getCallId() get the CallId field.
CallIdentifier	getCallIdentifer() get the call Identifer member.
void	setCallId(String cid) set the CallId field
void	setCallIdentifier(CallIdentifier cid) Set the callIdentifier member.

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

getName, hashCode, toString

Field Detail

NAME_LOWER

public static final String NAME_LOWER

callIdentifier

protected CallIdentifier callIdentifier

callIdentifier field

Constructor Detail

CallID

public CallID()

Default constructor

CallID

public CallID(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

equals

public boolean equals(Object other)

Description copied from class: SIPObject

An introspection based equality predicate for SIPObjects.

Specified by:

equals in interface CallIdHeader

Specified by:

equals in interface Header

Overrides:

equals in class SIPObject

Parameters:

other - the other object to test against.

Returns:

true if the objects are euqal and false otherwise

encodeBody

public String encodeBody()

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

Returns:

String encoded body part of the header.

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 SIPHeader

getCallId

public String getCallId()

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

Specified by:

getCallId in interface CallIdHeader

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)
               throws ParseException

set the CallId field

Specified by:

setCallId in interface CallIdHeader

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.

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

setCallIdentifier

public void setCallIdentifier(CallIdentifier cid)

Set the callIdentifier member.

Parameters:

cid - CallIdentifier to set (localId@host).

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Specified by:

clone in interface Header

Overrides:

clone in class GenericObject

Returns:

a deep copy of Header