com.solace.messaging.publisher

Class PersistentMessagePublisher.PublishReceipt

java.lang.Object

com.solace.messaging.publisher.PersistentMessagePublisher.PublishReceipt

All Implemented Interfaces:

Serializable

Enclosing interface:

PersistentMessagePublisher

@ProviderType
public static class PersistentMessagePublisher.PublishReceipt
extends Object
implements Serializable

A class that encapsulates broker acknowledgement or failed publishing attempts, used for message delivery notification processing such as timestamp, correlation token, original message, indicator if message was persisted on a broker.

Since:

1.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
PubSubPlusClientException	getException() Gets exception if any, indicating a failure to deliver or persist a message to the broker.
OutboundMessage	getMessage() Retrieves message associated with a Receipt.
long	getTimeStamp() Retrieves the timestamp, number of milliseconds from the Epoch time (time since 1970-01-01T00:00:00Z).
Object	getUserContext() Retrieves the context associated with an action if provided during publishing.
boolean	isPersisted() Gets information if message reached a broker and persistence confirmation was received back.
String	toString() Converts the Publish Receipt to a string representation does not include userContext.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getUserContext

public Object getUserContext()

Retrieves the context associated with an action if provided during publishing.

Returns:

context associated with broker delivery confirmation action or null if there is none

Since:

1.0

getTimeStamp

public long getTimeStamp()

Retrieves the timestamp, number of milliseconds from the Epoch time (time since 1970-01-01T00:00:00Z).

Returns:

a long value of representing the timestamp (in milliseconds)

Since:

1.0

getMessage

public OutboundMessage getMessage()

Retrieves message associated with a Receipt.

Returns:

a message associated with this instance of the Receipt

Since:

1.0

getException

public PubSubPlusClientException getException()

Gets exception if any, indicating a failure to deliver or persist a message to the broker.

Returns:

PubSubPlusClientException if the message was not delivered or persisted, otherwise null. For additional details, refer to the cause of the exception. Examples of possible causes include: publisher termination, broker delivery failure due to Publish ACL Denied, or delivery timeout.

Since:

1.0

isPersisted

public boolean isPersisted()

Gets information if message reached a broker and persistence confirmation was received back.

Returns:

true if the broker confirmed that a message was received and persisted, otherwise false

Since:

1.0

toString

public String toString()

Converts the Publish Receipt to a string representation does not include userContext.

Overrides:

toString in class Object

Returns:

a string of the instance without a content of userContext. userContext represented as: userContext.getClass().getName() + '@' + Integer.toHexString(hashCode()) or null when not present

Since:

1.0