|
Oracle Fusion Middleware User Messaging Service 11.1.1.3.0 Java API Reference E14011-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface 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.
Field Summary |
---|
Fields inherited from interface oracle.sdp.messaging.MessagingObject |
---|
NAMESPACE_NOTIFICATION_PREFERENCES, NAMESPACE_SDPM |
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 |
---|
int getChunkCount()
java.lang.String[] getChunkIds()
Status[] getChunkStatuses()
void setAddress(Address address)
address
- the recipient addressvoid setChunkCount(int count)
count
- the total chunks.void setChunkIds(java.lang.String[] ids)
ids
- the ids for all chunks.void setChunkStatuses(Status[] stses)
stses
- the statuses for all chunks.void setContent(java.lang.String content)
content
- the status content.void setDate(Calendar date)
date
- the date and time this status was generated.void setDriver(java.lang.String driver)
driver
- the name of the reporting driver.void setGatewayMessageId(java.lang.String gatewayMessageId)
gatewayMessageId
- the message id assigned by the gateway/driver.void setMessageId(java.lang.String messageId)
messageId
- the SDP Messaging assigned message id of the corresponding message.void setType(StatusType type)
StatusType
.
type
- the status type.
|
Oracle Fusion Middleware User Messaging Service 11.1.1.3.0 Java API Reference E14011-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |