oracle.wsc.android.messaging

Class MessagingPackage

java.lang.Object

oracle.wsc.android.session.Package

oracle.wsc.android.messaging.MessagingPackage

public class MessagingPackage
extends Package

Package handler that enables messaging applications. An object of the MessagingPackage class can be created by applications to send SIP based messages to any logged-in user. The object also dispatches received messages to registered observer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessagingPackage.Observer Listener for incoming messages and their acknowledgements.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PACKAGE_TYPE Default package type.

Fields inherited from class oracle.wsc.android.session.Package

PACKAGE_TYPE_STR

Constructor Summary

Constructors

Constructor and Description
MessagingPackage()

Method Summary

Modifier and Type	Method and Description
void	accept(MessagingMessage messagingMessage, Map extHeaders) Acknowledges that the message was received and accepted.
MessagingMessage	getMessage(String messageId) Fetches the messaging payload for a given id.
protected void	onMessage(Frame frame) Handles an inbound message that has no existing subsession.
void	reject(MessagingMessage messagingMessage, StatusCode statusCode, String reason, Map extHeaders) Rejects the incoming message and sends a NACK.
String	send(String content, String target, Map extHeaders) Sends SIP-based messages to a specific user.
void	setObserver(MessagingPackage.Observer observer) Sets the observer for messaging events.

Methods inherited from class oracle.wsc.android.session.Package

getPackageType, getSession, getSubSession, getSubSessions, putSubSession, removeSubSession

Methods inherited from class java.lang.Object

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

Field Detail

PACKAGE_TYPE

public static final String PACKAGE_TYPE

Default package type.

See Also:

Constant Field Values

Constructor Detail

MessagingPackage

public MessagingPackage()

Method Detail

send

public String send(String content,
                   String target,
                   Map extHeaders)

Sends SIP-based messages to a specific user.

Parameters:

content - content of the message

target - destination to whom the message is destined

extHeaders - extension headers. If provided, they are inserted into the JSON message

Returns:

message Id

accept

public void accept(MessagingMessage messagingMessage,
                   Map extHeaders)

Acknowledges that the message was received and accepted. This can be done once a new message is received via the onNewMessage callback on the Observer.

Parameters:

messagingMessage - the messaging payload that was received

extHeaders - extension headers; if provided, they are inserted into the JSON message

reject

public void reject(MessagingMessage messagingMessage,
                   StatusCode statusCode,
                   String reason,
                   Map extHeaders)

Rejects the incoming message and sends a NACK. This can be done once a new message is received via the onNewMessage callback on the Observer.

Parameters:

messagingMessage - the messaging payload that was received

statusCode - code with which to reject

reason - additional description

extHeaders - extension headers; if provided, they are inserted into the JSON message

getMessage

public MessagingMessage getMessage(String messageId)

Fetches the messaging payload for a given id.

Parameters:

messageId - message Id - obtained from send(...)

Returns:

messaging payload

setObserver

public void setObserver(MessagingPackage.Observer observer)

Sets the observer for messaging events.

Parameters:

observer - observer for this class

onMessage

protected void onMessage(Frame frame)

Description copied from class: Package

Handles an inbound message that has no existing subsession.

Specified by:

onMessage in class Package

Parameters:

frame - Message