oracle.sdp.messaging

Class ListenerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.sdp.messaging.ListenerException

All Implemented Interfaces:

Serializable

public class ListenerException
extends Exception

ListenerException is used in the signature of the Listener callback API. If an onMessage or onStatus callback cannot be completed successfully, the implementer of the Listener may throw a ListenerException. If the ListenerException.isRetriable is true, then delivery of the message or status may be retried. Otherwise delivery of the message or status will be aborted and a failure status will be generated where appropriate.

Since:

Monaco

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListenerException() Construct a ListenerException.
ListenerException(String message) Construct a ListenerException with a message.
ListenerException(String message, boolean retriable) Construct a ListenerException with a message and a flag indicating whether delivery of the message or status should be retried or not.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isRetriable() Return an indicator of whether the operation that led to the exception should be retried or not.
void	setRetriable(boolean retriable) Set the retriable flag for this exception after construction.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ListenerException

public ListenerException()

Construct a ListenerException. This method generates a retriable exception. If the reason for generating this ListenerException is permanent, use ListenerException(String, boolean) to indicate that delivery should not be retried.

ListenerException

public ListenerException(String message)

Construct a ListenerException with a message. The message may be reported as a status update for delivery of the message where appropriate. This method generates a retriable exception. If the reason for generating this ListenerException is permanent, use ListenerException(String, boolean) to indicate that delivery should not be retried.

Parameters:

message -

ListenerException

public ListenerException(String message,
                 boolean retriable)

Construct a ListenerException with a message and a flag indicating whether delivery of the message or status should be retried or not.

Parameters:

message -

retriable -

Method Detail

isRetriable

public boolean isRetriable()

Return an indicator of whether the operation that led to the exception should be retried or not.

Returns:

true if retriable

setRetriable

public void setRetriable(boolean retriable)

Set the retriable flag for this exception after construction.

Parameters:

retriable -