com.neeve.aep.event

Class AepMessagingStartFailedEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.event.lifecycle.LifecycleEvent

com.neeve.aep.event.AepMessagingStartFailedEvent

All Implemented Interfaces:

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

public final class AepMessagingStartFailedEvent
extends LifecycleEvent
implements IAlertEvent

Event notifying an AEP application that its messaging start failed.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched to an application to notify it that the AEP engine failed to start its messaging machinery. This event is dispatched after the engine has attempted to establish the application's message bus bindings and join any configured channels. For bindings that were successfully established, the application would have received the coresponding binding and channel up events before this event is dispatched.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Methods

Modifier and Type	Method and Description
static AepMessagingStartFailedEvent	create(Exception cause) Create a new (initialized) messaging start failure event.
static Event	create(Properties props) Create a new (uninitialized) messaging start failure event.
Exception	getCause() Get messaging start failure cause.
MessageView	getTriggeringMessage() Implementation of IAlertEvent.getTriggeringMessage()
void	setCause(Exception cause) Set messaging start failure cause
String	toString() Get a string representation of the object

Methods inherited from class com.neeve.event.lifecycle.LifecycleEvent

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.alert.IAlertEvent

getBackingMessage, getEventTime, setBackingMessage

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) messaging start failure event.

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

create

public static AepMessagingStartFailedEvent create(Exception cause)

Create a new (initialized) messaging start failure event.

Parameters:

cause - Contains the cause of failure.

This method instantiates and initializes a messaging start failure event. The method uses the event factory to instantiate a new messaging start failure 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.

setCause

public final void setCause(Exception cause)

Set messaging start failure cause

Parameters:

cause - The failure cause

Threading:

This method is safe for concurrent access by multiple threads.

getCause

public final Exception getCause()

Get messaging start failure cause.

Returns:

Returns the cause of failure. How a messaging start operation is deemed a success or failure is determined by the engine's messaging start fail policy. Therefore, the policy also determines how to interpret this value. For the NeverFail policy, it indicates that all binding attempts returned with a permanent exception. In such as case, this parameter contains the permanent exception returned by the last binding attempt. For FailIfOneBindingFails, it indicates that at least one binding attempt failed. In such a case, this parameter contains the exception returned by the failed binding attempt. Finally, for FailIfAllBindingsFail, this parameter indicates that all binding attempts failed (not necessarily permanent). In such a case, this parameter contains the exception returned by the last failed attempt.

Threading:

This method is safe for concurrent access by multiple threads.

getTriggeringMessage

public final MessageView getTriggeringMessage()

Implementation of IAlertEvent.getTriggeringMessage()

Specified by:

getTriggeringMessage in interface IAlertEvent

Returns:

A value of null indicates that the alert was not triggered by any inbound or outbound message.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class LifecycleEvent