Skip navigation links

com.oracle.sft.api
Interface CommonPresenceInstantMessage

All Superinterfaces:

Message, TextMessage

public interface CommonPresenceInstantMessage

extends TextMessage

Represents the Common Presence and Instant Messaging (CPIM) message in an IMConversation or IMConference. CommonPresenceInstantMessage extends TextMessage to support store and forward status reporting and message disposition. Instant Message Disposition Notification (IMDN) is used to request and forward dispositions of all exchanged messages. IMDN is defined in RFC 5438. IMDN is constructed using the CPIM message format defined in RFC 3862.

IMConversation is created by SFT internally for the incoming MESSAGE request/response with Common Presence and Instant Messaging format

Upon receiving an incoming Common Presence and Instant Messaging message, the CommunicationEvent.Type.MESSAGEARRIVED event is invoked on the CommunicationBean.

Upon receiving an incoming 2xx response to a disposition request, CommunicationEvent.Type.DISPOSITION_REQUEST_SUCCESS_RESPONDED event is invoked on the CommunicationBean.

Upon receiving an incoming 4xx,5xx or 6xx response to a disposition request, the CommunicationEvent.Type.DISPOSITION_REQUEST_FAILURE_RESPONDED event is invoked on the CommunicationBean.

CommunicationBean can get a CommonPresenceInstantMessage via CommunicationContext.getMessage()

See Also:

IMConversation, IMConference

Nested Class Summary

static class

CommonPresenceInstantMessage.Headers Common CPIM Headers

Method Summary

DispositionContext	buildDispositionContext() To build the context for disposition service
DispositionContext	buildDispositionContext(CommonPresenceInstantMessage msg, DispositionNotification.Type type, DispositionNotification.Status status) To build disposition notification for a disposition request Instant Message
DispositionContext	buildDispositionContext(String content, String contentType) To Generate Disposition Request
DispositionContext	getDispositionContext() To get IMDN disposition info
String	getMessageContent() Returns CPIM MIME message content
String	getMessageContentHeader(String name) Returns CPIM MIME-encapsulated content header
String	getMessageContentType() Returns CPIM MIME-encapsulated content type
Date	getMessageDate() Returns CPIM-MIME message date
String	getMessageHeader(String name) Returns CPIM message-metadata header
void	setDispositionContext(DispositionContext dispositionCxt) Set DispositionContext
void	setMessageContent(String content, String contentType) Sets CPIM MIME message content and contentType
void	setMessageContentHeader(String key, String value) Sets CPIM MIME-encapsulated content header content headers includes ( but not limit to )"Content-Type", "Content-Disposition", "Content-ID", "Content-Length"
void	setMessageContentType(String contentType) Sets CPIM MIME-encapsulated content type
void	setMessageHeader(String key, String value) Sets CPIM message-metadata header

Methods inherited from interface com.oracle.sft.api.TextMessage

addRecipient, getRecipients, getText, sendAnonymous, sendAnonymous, setText

Methods inherited from interface com.oracle.sft.api.Message

consume, getContent, getContentType, reject, send, send, send

Method Detail

getMessageHeader

String getMessageHeader(String name)

Returns CPIM message-metadata header

Parameters:

name - Header name

Returns:

Header value

setMessageHeader

void setMessageHeader(String key,
                      String value)

Sets CPIM message-metadata header

Parameters:

key - : header name

value - : header value

getMessageContentHeader

String getMessageContentHeader(String name)

Returns CPIM MIME-encapsulated content header

Parameters:

name - Header name

Returns:

Header value

setMessageContentHeader

void setMessageContentHeader(String key,
                             String value)

Sets CPIM MIME-encapsulated content header content headers includes ( but not limit to )"Content-Type", "Content-Disposition", "Content-ID", "Content-Length"

Parameters:

key - Content Header name

value - : Content Header value

getMessageDate

Date getMessageDate()
                    throws ParseException

Returns CPIM-MIME message date

Returns:

Date

Throws:

ParseException

getMessageContentType

String getMessageContentType()

Returns CPIM MIME-encapsulated content type

Returns:

Content type

setMessageContentType

void setMessageContentType(String contentType)

Sets CPIM MIME-encapsulated content type

Parameters:

contentType -

getMessageContent

String getMessageContent()

Returns CPIM MIME message content

Returns:

Content

setMessageContent

void setMessageContent(String content,
                       String contentType)

Sets CPIM MIME message content and contentType

Parameters:

content -

contentType -

setDispositionContext

void setDispositionContext(DispositionContext dispositionCxt)

Set DispositionContext

Parameters:

dispositionCxt -

getDispositionContext

DispositionContext getDispositionContext()

To get IMDN disposition info

Returns:

DispositionContext

buildDispositionContext

DispositionContext buildDispositionContext()

To build the context for disposition service

Returns:

DispositionContext

buildDispositionContext

DispositionContext buildDispositionContext(CommonPresenceInstantMessage msg,
                                           DispositionNotification.Type type,
                                           DispositionNotification.Status status)

To build disposition notification for a disposition request Instant Message

Parameters:

msg -

type -

status -

Returns:

DispositionContext

buildDispositionContext

DispositionContext buildDispositionContext(String content,
                                           String contentType)

To Generate Disposition Request

Parameters:

content -

contentType -

Returns:

DispositionContext

Skip navigation links