JSIP API v1.2
November 2006

javax.sip.header
Interface ContentDispositionHeader

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

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:-

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

Author:
BEA Systems, NIST
See Also:
ContentTypeHeader, ContentLengthHeader, ContentEncodingHeader, ContentLanguageHeader

Field Summary
static java.lang.String ALERT
          Alert Disposition Type Constant
static java.lang.String ICON
          Icon Disposition Type Constant
static java.lang.String NAME
          Name of ContentDispositionHeader
static java.lang.String RENDER
          Render Disposition Type Constant
static java.lang.String SESSION
          Session Disposition Type Constant
 
Method Summary
 java.lang.String getDispositionType()
          Gets the interpretation of the message body or message body part of this ContentDispositionHeader.
 java.lang.String getHandling()
          Gets the handling information of the unknown content disposition of the ContentDispositionHeader.
 void setDispositionType(java.lang.String dispositionType)
          Sets the interpretation value of the message body or message body part for this ContentDispositionHeader.
 void setHandling(java.lang.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 java.lang.String NAME
Name of ContentDispositionHeader

See Also:
Constant Field Values

SESSION

static final java.lang.String SESSION
Session Disposition Type Constant

See Also:
Constant Field Values

RENDER

static final java.lang.String RENDER
Render Disposition Type Constant

See Also:
Constant Field Values

ICON

static final java.lang.String ICON
Icon Disposition Type Constant

See Also:
Constant Field Values

ALERT

static final java.lang.String ALERT
Alert Disposition Type Constant

See Also:
Constant Field Values
Method Detail

setDispositionType

void setDispositionType(java.lang.String dispositionType)
                        throws java.text.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:
java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the dispositionType parameter.

getDispositionType

java.lang.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(java.lang.String handling)
                 throws java.text.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:
java.text.ParseException - which signals that an error has been reached unexpectedly while parsing the handling parameter.

getHandling

java.lang.String getHandling()
Gets the handling information of the unknown content disposition of the ContentDispositionHeader.

Returns:
handling information for unknown content dispositions.

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