|
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 MessageInfo
This interface defines all delivery related properties about the message. All of these properties are optional with default values set by the constructor.
Method Summary | |
---|---|
Calendar |
getAcceptedDate()
Get the date and time when this message was accepted. |
java.lang.String |
getApplicationInstanceName()
Get the application instance name. |
java.lang.String |
getApplicationName()
Get the application name. |
java.lang.String |
getCarrier()
Get the carrier name for the message. |
int |
getChunkSize()
Get the message chunk size of the sending request. |
java.lang.String |
getCorrelationId()
Get the message correlation id. |
int |
getCostLevel()
Get the desired cost level of the message. |
int |
getDelay()
Get the delay to send the message. |
java.lang.String |
getDriver()
Get driver instance name. |
int |
getExpiration()
Get the expiration of the message. |
java.lang.String |
getGatewayMessageId()
Get the gateway (or driver) assigned id for this message. |
StatusType |
getHighestStatusLevel()
Get the highest status level requested for this message. |
int |
getMaxChunks()
Get the maximum message chunks of the sending request. |
MessagePriorityType |
getPriority()
Get the priority of the message. |
java.lang.String |
getProtocol()
Get the protocol for the desired driver that can deliver this message. |
MessageReliabilityType |
getReliability()
Get the reliability type of the message. |
MessageSessionType |
getSession()
Get the session type. |
int |
getSpeedLevel()
Get the desired speed level of the message. |
MessageTrackingType |
getTracking()
Get the tracking type desired in sending the message. |
void |
setAcceptedDate(Calendar date)
Set the date and time when this message was accepted. |
void |
setApplicationInstanceName(java.lang.String instanceName)
Set the application instance name. |
void |
setApplicationName(java.lang.String applicationName)
Set the application name. |
void |
setCarrier(java.lang.String carrier)
Set the carrier name for the desired driver that can deliver this message. |
void |
setChunkSize(int size)
Set the message chunk size of the sending request. |
void |
setCorrelationId(java.lang.String id)
Set the message correlation id. |
void |
setCostLevel(int cost)
Set the desired sending cost level of the message. |
void |
setDelay(int delay)
Set the delay to send the message. |
void |
setDriver(java.lang.String driver)
For a sending message, set the desired name of the driver that should deliver the message. |
void |
setExpiration(int expiration)
Set the expiration of the message. |
void |
setGatewayMessageId(java.lang.String gatewayMessageId)
Set the gateway (or driver) assigned id for this message. |
void |
setHighestStatusLevel(StatusType statusType)
Set the highest status level requested for this message. |
void |
setMaxChunks(int count)
Set the maximum message chunks of the sending request. |
void |
setPriority(MessagePriorityType priority)
Set the priority of the message. |
void |
setProtocol(java.lang.String protocol)
Set the protocol name for the desired driver that can deliver this message. |
void |
setReliability(MessageReliabilityType reliability)
Set the desired reliability type of the message. |
void |
setSession(MessageSessionType sessionType)
Sets the desired session type. |
void |
setSpeedLevel(int speed)
Set the desired sending speed level of the message. |
void |
setTracking(MessageTrackingType tracking)
Set the desired tracking type in sending the message. |
Methods inherited from interface java.io.Externalizable |
---|
readExternal, writeExternal |
Method Detail |
---|
Calendar getAcceptedDate()
java.lang.String getApplicationInstanceName()
java.lang.String getApplicationName()
java.lang.String getCarrier()
int getChunkSize()
java.lang.String getCorrelationId()
For a received message, if the message is in a session, the correlation id of the message just sent to the from-device is used as the correlation id of this received message. If that message just sent to the from-device doesn't have a correlation id, then its message id is used. If the message is not in a session, the correlation id won't be set.
For a message to be sent, the correlation id should be set by the application. If it is not set, then there is no correlation id. The correlation id can be used to link many sending/received messages together so that it is easy to find out how messages are exchanged in one transaction.
When a message is passed to a driver, the correlation id should be ignored by the driver. Actually, when a message is passed to a driver, the correlation id is re-set to some unique message store id that can be used by the driver to generate unique driver/gateway message id if necessary.
int getCostLevel()
int getDelay()
java.lang.String getDriver()
int getExpiration()
java.lang.String getGatewayMessageId()
StatusType getHighestStatusLevel()
int getMaxChunks()
MessagePriorityType getPriority()
java.lang.String getProtocol()
MessageReliabilityType getReliability()
MessageSessionType getSession()
int getSpeedLevel()
MessageTrackingType getTracking()
void setAcceptedDate(Calendar date)
the
- date and time.void setApplicationInstanceName(java.lang.String instanceName)
instanceName
- the application instance name.void setApplicationName(java.lang.String applicationName)
applicationName
- the application name.void setCarrier(java.lang.String carrier)
carrier
- the carrier name.void setChunkSize(int size)
size
- the message chunk size of the sending request.void setCorrelationId(java.lang.String id)
id
- the message correlation id.void setCostLevel(int cost)
The default level, if not set, is 0.
cost
- the desired sending cost level.void setDelay(int delay)
delay
- the delay in seconds.void setDriver(java.lang.String driver)
driver
- the driver instance name.void setExpiration(int expiration)
expiration
- the expiration in seconds.void setGatewayMessageId(java.lang.String gatewayMessageId)
gatewayMessageId
- the gateway message id for this message.void setHighestStatusLevel(StatusType statusType)
statusType
- the highest status level requested.void setMaxChunks(int count)
count
- the maximum message chunks of the sending request.void setPriority(MessagePriorityType priority)
The default priority, if not set, is NORMAL.
priority
- the priority.void setProtocol(java.lang.String protocol)
protocol
- the protocol namevoid setReliability(MessageReliabilityType reliability)
The default, if not set, is RELIABLE.
reliability
- the desired reliability type.void setSession(MessageSessionType sessionType)
The default, if not set, is NO_SESSION.
sessionType
- the desired session type.void setSpeedLevel(int speed)
The default level, if not set, is 0.
speed
- the desired sending speed level.void setTracking(MessageTrackingType tracking)
The default, if not set, is TIGHT_NOTIFICATION.
tracking
- the desired tracking 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 |