JSIP API v1.2
November 2006

javax.sip.header
Interface AlertInfoHeader

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

public interface AlertInfoHeader
extends Parameters, Header

When present in an INVITE request, the Alert-Info header field specifies an alternative ring tone to the UAS. When present in a 180 (Ringing) response, the Alert-Info header field specifies an alternative ringback tone to the UAC. A typical usage is for a proxy to insert this header field to provide a distinctive ring feature.

The Alert-Info header field can introduce security risks, which are identical to the Call-Info header field risk, see section 20.9 of RFC3261. In addition, a user SHOULD be able to disable this feature selectively. This helps prevent disruptions that could result from the use of this header field by untrusted elements.

For Example:
Alert-Info:

Author:
BEA Systems, NIST

Field Summary
static java.lang.String NAME
          Name of the AlertInfoHeader
 
Method Summary
 URI getAlertInfo()
          Returns the AlertInfo value of this AlertInfoHeader.
 void setAlertInfo(URI alertInfo)
          Sets the AlertInfo of the AlertInfoHeader to the alertInfo parameter value.
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Field Detail

NAME

static final java.lang.String NAME
Name of the AlertInfoHeader

See Also:
Constant Field Values
Method Detail

setAlertInfo

void setAlertInfo(URI alertInfo)
Sets the AlertInfo of the AlertInfoHeader to the alertInfo parameter value.

Parameters:
alertInfo - the new Alert Info URI of this AlertInfoHeader.

getAlertInfo

URI getAlertInfo()
Returns the AlertInfo value of this AlertInfoHeader.

Returns:
the URI representing the AlertInfo.

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