gov.nist.javax.sip.message
Interface MessageExt

All Superinterfaces:

Cloneable, Message, Serializable

All Known Subinterfaces:

RequestExt, ResponseExt

All Known Implementing Classes:

SIPMessage, SIPRequest, SIPResponse

public interface MessageExt
extends Message

Author:

[email protected]

Method Summary

Object	getApplicationData() Returns the application data associated with the transaction.This specification does not define the format of this application specific data.
CallIdHeader	getCallIdHeader() Get the callId header or null if none present.
ContentLengthHeader	getContentLengthHeader() Get the content length header or null if none present.
ContentTypeHeader	getContentTypeHeader() Get the content type header or null if none present.
CSeqHeader	getCSeqHeader() Get the CSeq header or null if none present.
String	getFirstLine() Get the first line of the request or response.
FromHeader	getFromHeader() Get the From header or null if none present.
MultipartMimeContent	getMultipartMimeContent() Get the multipart mime content from a message.
ToHeader	getToHeader() Get the To header or null if none present.
ViaHeader	getTopmostViaHeader() Get the topmost Via header.
void	setApplicationData(Object applicationData) This method allows applications to associate application context with the message.

Methods inherited from interface javax.sip.message.Message

addFirst, addHeader, addLast, clone, equals, getContent, getContentDisposition, getContentEncoding, getContentLanguage, getContentLength, getExpires, getHeader, getHeaderNames, getHeaders, getRawContent, getSIPVersion, getUnrecognizedHeaders, hashCode, removeContent, removeFirst, removeHeader, removeLast, setContent, setContentDisposition, setContentEncoding, setContentLanguage, setContentLength, setExpires, setHeader, setSIPVersion, toString

Method Detail

setApplicationData

void setApplicationData(Object applicationData)

This method allows applications to associate application context with the message. This specification does not define the format of this data, this the responsibility of the application and is dependent on the application. this application data is un-interpreted by the stack. Beware : when you clone a message, the deepcopy does not apply to the application data (instead, we would just make a copy of the pointer).

Parameters:

applicationData - - un-interpreted application data.

Since:

v2.0

getApplicationData

Object getApplicationData()

Returns the application data associated with the transaction.This specification does not define the format of this application specific data. This is the responsibility of the application.

Returns:

application data associated with the message by the application.

Since:

v2.0

getMultipartMimeContent

MultipartMimeContent getMultipartMimeContent()
                                             throws ParseException

Get the multipart mime content from a message. Builds a wrapper around the content and breaks it into multiple sections. Returns these sections as a multipart mime content list. If the content type is not multipart mime then the list will have a single element in it.

Parameters:

Message - message

Throws:

ParseException - if the content type is multipart mime but the content is not properly encoded.

Since:

v2.0

getTopmostViaHeader

ViaHeader getTopmostViaHeader()

Get the topmost Via header.

Since:

v2.0

getFromHeader

FromHeader getFromHeader()

Get the From header or null if none present.

Since:

v2.0

getToHeader

ToHeader getToHeader()

Get the To header or null if none present.

Since:

v2.0

getCallIdHeader

CallIdHeader getCallIdHeader()

Get the callId header or null if none present.

Since:

v2.0

getCSeqHeader

CSeqHeader getCSeqHeader()

Get the CSeq header or null if none present.

Since:

v2.0

getContentTypeHeader

ContentTypeHeader getContentTypeHeader()

Get the content type header or null if none present.

Since:

v2.0

getContentLengthHeader

ContentLengthHeader getContentLengthHeader()

Get the content length header or null if none present.

Since:

v2.0

getFirstLine

String getFirstLine()

Get the first line of the request or response.

Since:

v2.0