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:

CallIdHeader, Cloneable, Header, Serializable, SIPHeaderNames

public class CallID

extends SIPHeader

implements CallIdHeader

Call ID SIPHeader.

Since:

1.1

Version:

1.2 $Revision: 1.5 $ $Date: 2006/07/13 09:01:47 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

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

CallID()
Default constructor

CallID(String callId)
Constructor given the call Identifier.

Method Summary

Object	clone() Creates and returns a deep copy of the Header.
String	encodeBody() Encode the body part of this header (i.e. leave out the hdrName).
boolean	equals(Object other) Compare this CallIdHeader for equality with another.
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, 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.Header

getName, hashCode, toString

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 interface: CallIdHeader

Compare this CallIdHeader for equality with another. This method overrides the equals method in javax.sip.Header. This method specifies object equality as outlined by RFC3261. Call-IDs are case-sensitive and are simply compared byte-by-byte.

Specified by:

equals in interface CallIdHeader

Overrides:

equals in class SIPObject

Parameters:

other - the other object to test against.

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.

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 interface: Header

Creates and returns a deep copy of the Header. This methods must ensure a deep copy of the Header, so that when a message is cloned the Header can be modified without effecting the original Header in the message. This provides useful functionality for proxying Requests and Responses, for example:

• Recieve a message.
• Create a deep clone of the message and headers.
• Modify necessary headers.
• Proxy the message using the send methods on the SipProvider.

This method overrides the clone method in java.lang.Object.

Specified by:

clone in interface Header