oracle.panama.messaging.push
Class Status

java.lang.Object
oracle.panama.messaging.push.Status

public class Status

extends java.lang.Object

Status class reports the delivery status of a message ID. Status helps client to track message status.
A status may have a failover status. Failover status is the status of the failover address. Statuses may be chained to reflect the statuses of a failover chain. Status may have following fields:
- status code: what status?
- status string: what status?
- time stamp: when did that status happen?
- recipient's address: who's status?
- message ID : who's status?
- transport: what is the delivery type?

Note:
Never access any public data fields inside this class directly, because they are for internal use in this release and will be changed in coming releases. Always use public methods of this class.

Field Summary

AddressData	address
static int	DELIVERY_TO_DEVICE_FAILURE
static int	DELIVERY_TO_DEVICE_SUCCESS
static int	DELIVERY_TO_SERVER_FAILURE
static int	DELIVERY_TO_SERVER_SUCCESS
int	failoverOrder
Status	failoverStatus
static int	INTERMEDIATE_NOTIFICATION
java.lang.String	mContent
java.lang.String	messageID
int	mType
java.lang.String	originalMessageID
static int	OVERALL_FAILURE Supported status ids.
static int	OVERALL_PENDING
static int	OVERALL_SUCCESS
static int	READ_ACKNOWLEDGEMENT_FAILURE
static int	READ_ACKNOWLEDGEMENT_SUCCESS
static int	TIMEOUT
long	timestamp
int	totalFailovers
java.lang.String	transport
static int	UNKNOWN_FAILURE
static int	UNKNOWN_STATUS_TYPE
static int	USER_REPLY_ACKNOWLEDGEMENT
static int	USER_REPLY_ACKNOWLEDGEMENT_FAILURE

Constructor Summary

Status()
Constructor

Method Summary

boolean	equals(java.lang.Object other)
AddressData	getAddress() get address of the status
java.lang.String	getContent() Get the status content.
int	getFailoverOrder() get failover order number of this recipient.
Status	getFailoverStatus() Status object may be chained if the recipient has failover address(es).
java.lang.String	getMessageID() get message ID of the status
java.lang.String	getOriginalMessageID() get original message ID, which is returned by Push.sendMsg() or PushLite.sendMsg()
long	getTimestamp() get time stamp of the status
int	getTotalFailovers() get total failovers of this recipeint.
java.lang.String	getTransport() get transport of the status
int	getType() Get the status type.
int	hashCode()
void	setAddress(AddressData addr) set address of the status
void	setContent(java.lang.String content) Set the status content.
void	setFailoverOrder(int number) set current failover order number of this recipient Failover order number is the order number of current failover channel appearing in the failover channel list.
void	setFailoverStatus(Status fStatus) Sets failover status of current status object
void	setMessageID(java.lang.String id) set message ID of the status
void	setOriginalMessageID(java.lang.String origMsgID) Set the original message ID.
void	setTimestamp(long timestamp) set time stamp of the status
void	setTotalFailovers(int total) set total failovers of this recipient
void	setTransport(java.lang.String trans) set transport of the status
void	setType(int type) Set the status type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

address

public AddressData address

DELIVERY_TO_DEVICE_FAILURE

public static final int DELIVERY_TO_DEVICE_FAILURE

See Also:

Constant Field Values

DELIVERY_TO_DEVICE_SUCCESS

public static final int DELIVERY_TO_DEVICE_SUCCESS

See Also:

Constant Field Values

DELIVERY_TO_SERVER_FAILURE

public static final int DELIVERY_TO_SERVER_FAILURE

See Also:

Constant Field Values

DELIVERY_TO_SERVER_SUCCESS

public static final int DELIVERY_TO_SERVER_SUCCESS

See Also:

Constant Field Values

failoverOrder

public int failoverOrder

failoverStatus

public Status failoverStatus

INTERMEDIATE_NOTIFICATION

public static final int INTERMEDIATE_NOTIFICATION

See Also:

Constant Field Values

mContent

public java.lang.String mContent

messageID

public java.lang.String messageID

mType

public int mType

originalMessageID

public java.lang.String originalMessageID

OVERALL_FAILURE

public static final int OVERALL_FAILURE

Supported status ids.

See Also:

Constant Field Values

OVERALL_PENDING

public static final int OVERALL_PENDING

See Also:

Constant Field Values

OVERALL_SUCCESS

public static final int OVERALL_SUCCESS

See Also:

Constant Field Values

READ_ACKNOWLEDGEMENT_FAILURE

public static final int READ_ACKNOWLEDGEMENT_FAILURE

See Also:

Constant Field Values

READ_ACKNOWLEDGEMENT_SUCCESS

public static final int READ_ACKNOWLEDGEMENT_SUCCESS

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

See Also:

Constant Field Values

timestamp

public long timestamp

totalFailovers

public int totalFailovers

transport

public java.lang.String transport

UNKNOWN_FAILURE

public static final int UNKNOWN_FAILURE

See Also:

Constant Field Values

UNKNOWN_STATUS_TYPE

public static final int UNKNOWN_STATUS_TYPE

See Also:

Constant Field Values

USER_REPLY_ACKNOWLEDGEMENT

public static final int USER_REPLY_ACKNOWLEDGEMENT

See Also:

Constant Field Values

USER_REPLY_ACKNOWLEDGEMENT_FAILURE

public static final int USER_REPLY_ACKNOWLEDGEMENT_FAILURE

See Also:

Constant Field Values

Constructor Detail

Status

public Status()

Constructor

Method Detail

equals

public boolean equals(java.lang.Object other)

getAddress

public AddressData getAddress()

get address of the status

getContent

public java.lang.String getContent()

Get the status content.

Returns:

the status content.

getFailoverOrder

public int getFailoverOrder()

get failover order number of this recipient.

Returns:

0: current failover number is unknown or not available >0: current status is the status of nth failover channel.

getFailoverStatus

public Status getFailoverStatus()

Status object may be chained if the recipient has failover address(es).
Failover status is useful when push client uses Push.getStatus() or PushLite.getStatus() to retrieve all failover statuses of a recipient by the message ID (or WorkOrder) returned from Push.sendMsg() or PushLite.sendMsg().
Failover status is NOT AVAILABLE for realtime callback status, because the next failover has not been tried.
For example: a recipient has failover addresses in following order: 1-222-333333 (SMS), 1-333-444444 (Fax), 1-444-5551234 (voice) and foo@bar.com (Email) Suppose first two attempts fail and msg gets delivered to 3rd address. Status chain may have 3 nodes.

Returns:

getFailoverStatus( ) returns the next status node (status of failover attempt) in the chain.
null if current node doesn't have failover status (yet).

getMessageID

public java.lang.String getMessageID()

get message ID of the status

getOriginalMessageID

public java.lang.String getOriginalMessageID()

get original message ID, which is returned by Push.sendMsg() or PushLite.sendMsg()

getTimestamp

public long getTimestamp()

get time stamp of the status

getTotalFailovers

public int getTotalFailovers()

get total failovers of this recipeint.

Returns:

0: total number of failover channels of this recipient is unknown or not available >0: total number of failover channels of this recipient

getTransport

public java.lang.String getTransport()

get transport of the status

getType

public int getType()

Get the status type.

Returns:

the status type.

hashCode

public int hashCode()

setAddress

public void setAddress(AddressData addr)

set address of the status

setContent

public void setContent(java.lang.String content)

Set the status content.

Parameters:

content - the status content.

setFailoverOrder

public void setFailoverOrder(int number)

set current failover order number of this recipient Failover order number is the order number of current failover channel appearing in the failover channel list. It starts from 1.

setFailoverStatus

public void setFailoverStatus(Status fStatus)

Sets failover status of current status object

setMessageID

public void setMessageID(java.lang.String id)

set message ID of the status

setOriginalMessageID

public void setOriginalMessageID(java.lang.String origMsgID)

Set the original message ID. Original message ID is the message ID returned from Push.sendMsg() or PushLite.sendMsg() calls, which is the message ID of first failover channel of a recipient. Second and later failover channels will have new message IDs when they have been tried.

setTimestamp

public void setTimestamp(long timestamp)

set time stamp of the status

setTotalFailovers

public void setTotalFailovers(int total)

set total failovers of this recipient

setTransport

public void setTransport(java.lang.String trans)

set transport of the status

setType

public void setType(int type)

Set the status type.

Parameters:

type - the status type.

toString

public java.lang.String toString()