javax.sip.header

Interface ContentDispositionHeader

All Superinterfaces:

Cloneable, Header, Parameters, Serializable

All Known Implementing Classes:

ContentDisposition

public interface ContentDispositionHeader
extends Parameters, Header

The Content-Disposition header field describes how the message body or, for multipart messages, a message body part is to be interpreted by the UAC or UAS. This SIP header field extends the MIME Content-Type. Several new "disposition-types" of the Content-Disposition header are defined by SIP, namely:-

• session - indicates that the body part describes a session, for either calls or early (pre-call) media.
• render - indicates that the body part should be displayed or otherwise rendered to the user.
• icon - indicates that the body part contains an image suitable as an iconic representation of the caller or callee that could be rendered informationally by a user agent when a message has been received, or persistently while a dialog takes place.
• alert - indicates that the body part contains information, such as an audio clip, that should be rendered by the user agent in an attempt to alert the user to the receipt of a request, generally a request that initiates a dialog.

For backward-compatibility, if the Content-Disposition header field is missing, the server SHOULD assume bodies of Content-Type application/sdp are the disposition "session", while other content types are "render".

If this header field is missing, the MIME type determines the default content disposition. If there is none, "render" is assumed.

For Example:
Content-Disposition: session

Version:

1.2

Author:

BEA Systems, NIST

See Also:

ContentTypeHeader, ContentLengthHeader, ContentEncodingHeader, ContentLanguageHeader

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALERT Alert Disposition Type Constant
static String	ICON Icon Disposition Type Constant
static String	NAME Name of ContentDispositionHeader
static String	RENDER Render Disposition Type Constant
static String	SESSION Session Disposition Type Constant

Method Summary

Methods

Modifier and Type	Method and Description
String	getDispositionType() Gets the interpretation of the message body or message body part of this ContentDispositionHeader.
String	getHandling() Gets the handling information of the unknown content disposition of the ContentDispositionHeader.
void	setDispositionType(String dispositionType) Sets the interpretation value of the message body or message body part for this ContentDispositionHeader.
void	setHandling(String handling) The handling parameter describes how the UAS should react if it receives a message body whose content type or disposition type it does not understand.

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 String NAME

Name of ContentDispositionHeader

See Also:

Constant Field Values

SESSION

static final String SESSION

Session Disposition Type Constant

See Also:

Constant Field Values

RENDER

static final String RENDER

Render Disposition Type Constant

See Also:

Constant Field Values

ICON

static final String ICON

Icon Disposition Type Constant

See Also:

Constant Field Values

ALERT

static final String ALERT

Alert Disposition Type Constant

See Also:

Constant Field Values

Method Detail

setDispositionType

void setDispositionType(String dispositionType)
                        throws ParseException

Sets the interpretation value of the message body or message body part for this ContentDispositionHeader.

Parameters:

dispositionType - the new String value of the disposition type.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the dispositionType parameter.

getDispositionType

String getDispositionType()

Gets the interpretation of the message body or message body part of this ContentDispositionHeader.

Returns:

interpretation of the message body or message body part

setHandling

void setHandling(String handling)
                 throws ParseException

The handling parameter describes how the UAS should react if it receives a message body whose content type or disposition type it does not understand. The parameter has defined values of "optional" and "required". If the handling parameter is missing, the value "required" SHOULD be assumed.

Parameters:

handling - the new String value either "optional" or "required".

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the handling parameter.

getHandling

String getHandling()

Gets the handling information of the unknown content disposition of the ContentDispositionHeader.

Returns:

handling information for unknown content dispositions.