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 : AlertInfoHeader.java
15: * Author : Phelim O'Doherty
16: *
17: * HISTORY
18: * Version Date Author Comments
19: * 1.1 08/10/2002 Phelim O'Doherty
20: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21: */package javax.sip.header;
22:
23: import javax.sip.address.URI;
24:
25: /**
26: * When present in an INVITE request, the Alert-Info header field
27: * specifies an alternative ring tone to the UAS. When present in a 180
28: * (Ringing) response, the Alert-Info header field specifies an
29: * alternative ringback tone to the UAC. A typical usage is for a proxy
30: * to insert this header field to provide a distinctive ring feature.
31: * <p>
32: * The Alert-Info header field can introduce security risks, which are
33: * identical to the Call-Info header field risk, see section 20.9 of
34: * <a href = "http://www.ietf.org/rfc/rfc3261.txt">RFC3261</a>.
35: * In addition, a user SHOULD be able to disable this feature selectively.
36: * This helps prevent disruptions that could result from the use of this
37: * header field by untrusted elements.
38: * <p>
39: * For Example:<br>
40: * <code>Alert-Info: <http://jcp.org/yeeha.wav></code>
41: *
42: * @author BEA Systems, NIST
43: * @version 1.2
44: */
45:
46: public interface AlertInfoHeader extends Parameters, Header {
47:
48: /**
49: * Sets the AlertInfo of the AlertInfoHeader to the <var>alertInfo</var>
50: * parameter value.
51: *
52: * @param alertInfo the new Alert Info URI of this AlertInfoHeader.
53: */
54: public void setAlertInfo(URI alertInfo);
55:
56: /**
57: * Returns the AlertInfo value of this AlertInfoHeader.
58: *
59: * @return the URI representing the AlertInfo.
60: */
61: public URI getAlertInfo();
62:
63: /**
64: * Name of the AlertInfoHeader
65: */
66: public final static String NAME = "Alert-Info";
67:
68: }
|