JSIP API v1.2
November 2006

javax.sip.header
Interface InReplyToHeader

All Superinterfaces:
java.lang.Cloneable, Header, java.io.Serializable

public interface InReplyToHeader
extends Header

The In-Reply-To header field enumerates the Call-IDs that this call references or returns. These Call-IDs may have been cached by the client then included in this header field in a return call.

This allows automatic call distribution systems to route return calls to the originator of the first call. This also allows callees to filter calls, so that only return calls for calls they originated will be accepted. This field is not a substitute for request authentication.

For Example:
In-Reply-To: 70710@saturn.jcp.org, 17320@saturn.jcp.org

Author:
BEA Systems, NIST

Field Summary
static java.lang.String NAME
          Name of InReplyToHeader
 
Method Summary
 java.lang.String getCallId()
          Returns the Call-Id of InReplyToHeader.
 void setCallId(java.lang.String callId)
          Sets the Call-Id of the InReplyToHeader.
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Field Detail

NAME

static final java.lang.String NAME
Name of InReplyToHeader

See Also:
Constant Field Values
Method Detail

setCallId

void setCallId(java.lang.String callId)
               throws java.text.ParseException
Sets the Call-Id of the InReplyToHeader. The CallId parameter uniquely identifies a serious of messages within a dialogue.

Parameters:
callId - - the string value of the Call-Id of this InReplyToHeader.
Throws:
java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the callId value.

getCallId

java.lang.String getCallId()
Returns the Call-Id of InReplyToHeader. The CallId parameter uniquely identifies a series of messages within a dialogue.

Returns:
the String value of the Call-Id of this InReplyToHeader

JSIP API v1.2
November 2006

If you have any comments, please mail them to JAIN-SIP-INTEREST@java.sun.com after subscribing at http://archives.java.sun.com
Copyright - 2006 BEA Systems and Sun Microsystems