oracle.sdp.messaging.driver
Interface Status

All Superinterfaces:

MessagingObject, Serializable, Status

public interface Status
extends Status

Status allows a driver to report the delivery status of a sent message. It is reported to the system by a remote gateway or service center. This information could be a delivery notification, a failure notification, or a state update. Status may have following fields:
- type: the status type.
- content: the status details.
- date: the date when the status/event occurred.
- address: the recipient's address associated with this status.
- message id: the message id associated with this status.
- gateway id: the message id sent by the remote gateway or service center. A driver should use the StatusFactory to create a new Status object. It should minimally set the type, address, message id (if the result of a send() operation) and gateway id before sending it to the status listener callback. The date is automatically set to the creation time of this Status object, but can be overriden by the driver, if necessary.

Since:

11.0.0

Field Summary

Fields inherited from interface oracle.sdp.messaging.MessagingObject

METADATA_APPLICATION_NAME, NAMESPACE_NOTIFICATION_PREFERENCES, NAMESPACE_SDPM, NAMESPACE_UMS

Method Summary

int	getChunkCount() Get the total chunks the message is split into.
java.lang.String[]	getChunkIds() Get the chunk ids for all chunks.
Status[]	getChunkStatuses() Get the sending statuses for all chunks.
void	setAddress(Address address) Set the recipient address associated with this status.
void	setChunkCount(int count) Set the total chunks the message is split into.
void	setChunkIds(java.lang.String[] ids) Set the ids for all chunks.
void	setChunkStatuses(Status[] stses) Set the sending statuses for all chunks.
void	setContent(java.lang.String content) Set the status content.
void	setDate(Calendar date) Set the date and time this status was generated.
void	setDriver(java.lang.String driver) Set the name of the reporting driver.
void	setGatewayMessageId(java.lang.String gatewayMessageId) Set the message id assigned by the gateway/driver.
void	setMessageId(java.lang.String messageId) Set the message id of the corresponding message for which this status report is for.
void	setType(StatusType type) Set the status type. For a list of supported types see StatusType.

Methods inherited from interface oracle.sdp.messaging.Status

getAddress, getContent, getDate, getDriver, getFailoverOrder, getFailoverStatus, getGatewayMessageId, getMessageId, getRecipient, getTotalFailovers, getType

Methods inherited from interface oracle.sdp.messaging.MessagingObject

getAllNamespaces, getMetaData, getMetaDataNames, setMetaData

Method Detail

setAddress

void setAddress(Address address)

Set the recipient address associated with this status.

Parameters:

address - the recipient address

setContent

void setContent(java.lang.String content)

Set the status content.

Parameters:

content - the status content.

setDate

void setDate(Calendar date)

Set the date and time this status was generated.

Parameters:

date - the date and time this status was generated.

setMessageId

void setMessageId(java.lang.String messageId)

Set the message id of the corresponding message for which this status report is for.

Parameters:

messageId - the SDP Messaging assigned message id of the corresponding message.

setGatewayMessageId

void setGatewayMessageId(java.lang.String gatewayMessageId)

Set the message id assigned by the gateway/driver. The message id should be unique per pair of message and recipient address. This means you need to assign a unique id to the message for each recipient. The uniqueness of the id is not enforced. But it is strongly recommended. The uniqueness makes it possible to find out which message a sending status reported by the driver later on is actually for.

Parameters:

gatewayMessageId - the message id assigned by the gateway/driver.

setType

void setType(StatusType type)

Set the status type.
For a list of supported types see StatusType.

Parameters:

type - the status type.

setDriver

void setDriver(java.lang.String driver)

Set the name of the reporting driver.

Parameters:

driver - the name of the reporting driver.

getChunkCount

int getChunkCount()

Get the total chunks the message is split into.

Returns:

the total chunks.

getChunkIds

java.lang.String[] getChunkIds()

Get the chunk ids for all chunks.

Returns:

the chunk ids for all chunks.

getChunkStatuses

Status[] getChunkStatuses()

Get the sending statuses for all chunks.

Returns:

the sending statuses for all chunks.

setChunkCount

void setChunkCount(int count)

Set the total chunks the message is split into.

Parameters:

count - the total chunks.

setChunkIds

void setChunkIds(java.lang.String[] ids)

Set the ids for all chunks.

Parameters:

ids - the ids for all chunks.

setChunkStatuses

void setChunkStatuses(Status[] stses)

Set the sending statuses for all chunks.

Parameters:

stses - the statuses for all chunks.