public interface MessageInfo extends Externalizable
Modifier and Type | Method and Description |
---|---|
Calendar |
getAcceptedDate()
Get the date and time when this message was accepted.
|
String |
getApplicationInstanceName()
Get the application instance name.
|
String |
getApplicationName()
Get the application name.
|
String |
getCarrier()
Get the carrier name for the message.
|
int |
getChunkSize()
Get the message chunk size of the sending request.
|
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.
|
String |
getDriver()
Get driver instance name.
|
int |
getExpiration()
Get the expiration of the message.
|
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.
|
int |
getMaxResend()
Get the max number of resends in case of failed delivery.
|
MessagePriorityType |
getPriority()
Get the priority of the message.
|
String |
getProfileId() |
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(String instanceName)
Set the application instance name.
|
void |
setApplicationName(String applicationName)
Set the application name.
|
void |
setCarrier(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(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(String driver)
For internal use.
|
void |
setExpiration(int expiration)
Set the expiration of the message.
|
void |
setGatewayMessageId(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 |
setMaxResend(int maxResend)
Set the max number of resends in case of failed delivery.
|
void |
setPriority(MessagePriorityType priority)
Set the priority of the message.
|
void |
setProfileId(String profileId) |
void |
setProtocol(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.
|
readExternal, writeExternal
int getDelay()
void setDelay(int delay)
delay
- the delay in seconds.int getExpiration()
void setExpiration(int expiration)
expiration
- the expiration in seconds.MessagePriorityType getPriority()
void setPriority(MessagePriorityType priority)
The default priority, if not set, is NORMAL.
priority
- the priority.int getSpeedLevel()
void setSpeedLevel(int speed)
The default level, if not set, is 0.
speed
- the desired sending speed level.int getCostLevel()
void setCostLevel(int cost)
The default level, if not set, is 0.
cost
- the desired sending cost level.MessageReliabilityType getReliability()
void setReliability(MessageReliabilityType reliability)
The default, if not set, is RELIABLE.
reliability
- the desired reliability type.MessageTrackingType getTracking()
void setTracking(MessageTrackingType tracking)
The default, if not set, is TIGHT_NOTIFICATION.
tracking
- the desired tracking type.MessageSessionType getSession()
void setSession(MessageSessionType sessionType)
The default, if not set, is NO_SESSION.
sessionType
- the desired session type.Calendar getAcceptedDate()
void setAcceptedDate(Calendar date)
date
- the date and time.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.
void setCorrelationId(String id)
id
- the message correlation id.String getCarrier()
void setCarrier(String carrier)
carrier
- the carrier name.String getProtocol()
void setProtocol(String protocol)
protocol
- the protocol nameString getDriver()
void setDriver(String driver)
driver
- the driver instance name.String getGatewayMessageId()
void setGatewayMessageId(String gatewayMessageId)
gatewayMessageId
- the gateway message id for this message.int getChunkSize()
void setChunkSize(int size)
size
- the message chunk size of the sending request.int getMaxChunks()
void setMaxChunks(int count)
count
- the maximum message chunks of the sending request.StatusType getHighestStatusLevel()
void setHighestStatusLevel(StatusType statusType)
statusType
- the highest status level requested.String getApplicationName()
void setApplicationName(String applicationName)
applicationName
- the application name.String getApplicationInstanceName()
void setApplicationInstanceName(String instanceName)
instanceName
- the application instance name.int getMaxResend()
void setMaxResend(int maxResend)
maxResend
- the max number of resends.String getProfileId()
void setProfileId(String profileId)
profileId
- the application partitioning profile id to set.Copyright © 2006, 2017 Oracle and/or its affiliates. All rights reserved.