com.bea.wcp.sip.util
Class ContentIndirectionUtil

java.lang.Object
  com.bea.wcp.sip.util.ContentIndirectionUtil

public final class ContentIndirectionUtil
extends java.lang.Object

A SIP message consists of a start line, various headers, and then the body of the message. Content Indirection (CI) allows the body to be located outside the message itself, allowing later retrieval. This second location is provided in a header, and consists of an URL, typically using HTTP. Additional headers provide secondary information about the body, such as its size, and the lifetime of the URL.

Content Indirection is described in RFC 4438.

This static class presents three utility methods which make it easier to use Content Indirection.

Use the bodyIsIndirect(javax.servlet.sip.SipServletMessage) method to check whether a SIP message is using content indirection. If it is, then call parseIndirectContentData(javax.servlet.sip.SipServletMessage)to get an ICParsedData object, through which can be accessed the various attributes and headers relevant to Content Indirection messages.

Attributes that are long-form dates can be decoded using the date format produced by getDateFormat(). Check the content indirection example for example code.

Method Summary

static boolean	bodyIsIndirect(SipServletMessage msg) Is msg using Indirect Content?
static java.text.SimpleDateFormat	getDateFormat() Return a SimpleDateFormat for the RFC1123 date format, restricted to GMT.
static ICParsedData	parseIndirectContentData(SipServletMessage msg) Return an object that can provide the attributes and body headers from a message that is using content indirection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDateFormat

public static java.text.SimpleDateFormat getDateFormat()

Return a SimpleDateFormat for the RFC1123 date format, restricted to GMT. This is particularly convenient for decoding expiration attributes in content indirection messages.

parseIndirectContentData

public static ICParsedData parseIndirectContentData(SipServletMessage msg)
                                             throws ContentIndirectionException

Return an object that can provide the attributes and body headers from a message that is using content indirection. See above ICParsedData for more information.

Throws:

ContentIndirectionException

bodyIsIndirect

public static boolean bodyIsIndirect(SipServletMessage msg)

Is msg using Indirect Content?