com.neeve.aep.event

Class AepSendExceptionEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.event.alert.AlertEvent

com.neeve.aep.event.AepSendExceptionEvent

All Implemented Interfaces:

IAlertEvent, IEvent, UtlPool.Item<Event>, UtlReferenceTracker.HasReferenceTracker

public final class AepSendExceptionEvent
extends AlertEvent

Event notifying an AEP application that a send encountered an exception.

This event is dispatched to an application to notify it that the AEP engine has encountered a send exception and was configured to log and exception and continue for such a scenario.

AepSendExceptionEvents are emitted only for sends that fail during background commit. This event is not emitted in cases where the exception is thrown to the appplication.

Threading:

This class is safe for concurrent access by multiple threads.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Modifier and Type	Method and Description
static AepSendExceptionEvent	create(MessageBusBinding binding, MessageChannel channel, MessageView view, Exception failure) Create a new (initialized) send exception event.
static Event	create(Properties props) Create a new (uninitialized) send exception event.
Exception	getException() Get the send exception.
MessageChannel	getMessageChannel() Get the channel associated with the failed send.
MessageView	getMessageView() Get the the message for which send failed.
MessageView	getTriggeringMessage() Returns the triggering message as specified by IAlertEvent.getTriggeringMessage()..
void	setTriggeringMessage(MessageView triggeringMessage) Set the triggering message for the send exception event.
String	toString() Get a string representation of the object

Methods inherited from class com.neeve.event.alert.AlertEvent

getBackingMessage, getEventTime, setBackingMessage

Methods inherited from class com.neeve.event.Event

acquire, dispose, getAcknowledger, getAttachment, getDelay, getDispatchTime, getInstanceNumber, getOfferTs, getPollTs, getPool, getRemainingTime, getScheduledTime, getSource, getType, init, isEndOfBatch, isHandled, owners, referenceTracker, setAcknowledger, setAttachment, setDelay, setDispatchTime, setEndOfBatch, setHandled, setPool, setScheduledTime, setSource

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neeve.event.IEvent

acquire, dispose, getAcknowledger, getAttachment, getDelay, getDispatchTime, getInstanceNumber, getRemainingTime, getScheduledTime, getSource, getType, isEndOfBatch, isHandled, owners, setAcknowledger, setAttachment, setDelay, setEndOfBatch, setHandled, setSource

Methods inherited from interface com.neeve.util.UtlReferenceTracker.HasReferenceTracker

referenceTracker

Method Detail

create

public static Event create(Properties props)

Create a new (uninitialized) send exception event.

This method instantiates a new send exception event object. The method is for use by the event factory to instantiate new send exception events. The method should not be used directly by the user since the method bypasses any event pooling i.e. it creates a new send exception event object even if there are eligible event objects available in the event type's pool.

create

public static AepSendExceptionEvent create(MessageBusBinding binding,
                                           MessageChannel channel,
                                           MessageView view,
                                           Exception failure)

Create a new (initialized) send exception event.

Parameters:

binding - The binding from where this event originated

channel - The channel through which the stabilized message was sent.

view - The stabilized message view.

failure - The message stabilization status.

This method instantiates and initializes a send exception event. The method uses the event factory to instantiate a new send exception event (the factory recycles objects through the event type's object pool is configured for the type) and then initializes it with the supplied parameters.

getMessageChannel

public final MessageChannel getMessageChannel()

Get the channel associated with the failed send.

Threading:

This method is safe for concurrent access by multiple threads.

getMessageView

public final MessageView getMessageView()

Get the the message for which send failed.

Threading:

This method is safe for concurrent access by multiple threads.

This method returns the message view supplied to the channel send method that this event corresponds to.

getException

public final Exception getException()

Get the send exception.

Returns:

Returns the exception returned by the failed send.

Threading:

This method is safe for concurrent access by multiple threads.

setTriggeringMessage

public final void setTriggeringMessage(MessageView triggeringMessage)

Set the triggering message for the send exception event.

For a solicited send the triggering message is set to the inbound message that triggered the send. For an unsolicited send the triggering message is set to null.

See Also:

IAlertEvent.getTriggeringMessage()

getTriggeringMessage

public final MessageView getTriggeringMessage()

Returns the triggering message as specified by IAlertEvent.getTriggeringMessage()..

This implementation returns the message that caused the send exception.

Specified by:

getTriggeringMessage in interface IAlertEvent

Overrides:

getTriggeringMessage in class AlertEvent

Returns:

The message that caused the send exception.

See Also:

IAlertEvent.getTriggeringMessage()

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class AlertEvent