NIST SIP Parser and Stack (v1.2) API

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.

Version:
JAIN-SIP-1.1 This code is in the public domain.
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, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, 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
 String encodeBody()
          Encode the body part of this header (i.e. leave out the hdrName).
 boolean equals(Object other)
          Compare two call ids for equality.
 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, isHeaderList, setHeaderName
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
clone, dbgPrint, debugDump, debugDump, match, merge, replace, replace, replace, replace, toString
 
Methods inherited from class gov.nist.core.GenericObject
getClassFromName, getMatcher, isMySubclass, setMatcher
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Header
clone, getName, 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)
Compare two call ids for equality.

Specified by:
equals in interface Header
Overrides:
equals in class SIPObject
Parameters:
other - Object to set
Returns:
true if the two call ids are equals, false otherwise

encodeBody

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

Overrides:
encodeBody in class SIPHeader
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).

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.