01: /**
02: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
03: * Unpublished - rights reserved under the Copyright Laws of the United States.
04: * Copyright © 2003 Sun Microsystems, Inc. All rights reserved.
05: * Copyright © 2005 BEA Systems, Inc. All rights reserved.
06: *
07: * Use is subject to license terms.
08: *
09: * This distribution may include materials developed by third parties.
10: *
11: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12: *
13: * Module Name : JSIP Specification
14: * File Name : InReplyToHeader.java
15: * Author : Phelim O'Doherty
16: *
17: * HISTORY
18: * Version Date Author Comments
19: * 1.1 08/10/2002 Phelim O'Doherty Initial version
20: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21: */package javax.sip.header;
22:
23: import java.text.ParseException;
24:
25: /**
26: * The In-Reply-To header field enumerates the Call-IDs that this call
27: * references or returns. These Call-IDs may have been cached by the client
28: * then included in this header field in a return call.
29: * <p>
30: * This allows automatic call distribution systems to route return calls to the
31: * originator of the first call. This also allows callees to filter calls, so
32: * that only return calls for calls they originated will be accepted. This
33: * field is not a substitute for request authentication.
34: * <p>
35: * For Example:<br>
36: * <code>In-Reply-To: 70710@saturn.jcp.org, 17320@saturn.jcp.org</code>
37: *
38: * @author BEA Systems, NIST
39: * @version 1.2
40: */
41: public interface InReplyToHeader extends Header {
42:
43: /**
44: * Sets the Call-Id of the InReplyToHeader. The CallId parameter uniquely
45: * identifies a serious of messages within a dialogue.
46: *
47: * @param callId - the string value of the Call-Id of this InReplyToHeader.
48: * @throws ParseException which signals that an error has been reached
49: * unexpectedly while parsing the callId value.
50: */
51: public void setCallId(String callId) throws ParseException;
52:
53: /**
54: * Returns the Call-Id of InReplyToHeader. The CallId parameter uniquely
55: * identifies a series of messages within a dialogue.
56: *
57: * @return the String value of the Call-Id of this InReplyToHeader
58: */
59: public String getCallId();
60:
61: /**
62: * Name of InReplyToHeader
63: */
64: public final static String NAME = "In-Reply-To";
65:
66: }
|