Module org.refcodes.eventbus.ext.application

Package org.refcodes.eventbus.ext.application

Interface LifecycleBus

All Superinterfaces:

org.refcodes.component.Destroyable, DestroyBus, org.refcodes.eventbus.DispatchStrategyAccessor, org.refcodes.eventbus.EventBusObservable<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationEventMatcher,String>, org.refcodes.eventbus.EventBusPublisher<ApplicationBusEvent>, org.refcodes.observer.EventMatcher<ApplicationBusEvent>, org.refcodes.eventbus.GenericEventBus<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationEventMatcher,org.refcodes.mixin.EventMetaData,String>, org.refcodes.component.HandleLookup<String,org.refcodes.observer.Observer<ApplicationBusEvent>>, InitializeBus, org.refcodes.matcher.Matcher<ApplicationBusEvent>, PauseBus, org.refcodes.observer.Publisher<ApplicationBusEvent>, ResumeBus, StartBus, StopBus

All Known Subinterfaces:

ApplicationBus, MessagePropertiesBus

All Known Implementing Classes:

ApplicationBusImpl

public interface LifecycleBus
extends InitializeBus, StartBus, PauseBus, ResumeBus, StopBus, DestroyBus

The LifecycleBus extends the ApplicationBus with convenience functionality common to everyday application and service development regarding dispatching of LifecycleStatus signals such as InitializeBusEvent, StartBusEvent, PauseBusEvent, ResumeBusEvent, StopBusEvent or DestroyBusEvent instances. To ensure controlled LifecycleBusObserver bootstrapping (subscribed via onLifecycle(LifecycleBusObserver) and the like), the InitializeBusEvent instances fired upon calls to methods such as InitializeBus.publishInitialize(Properties) (and the like) are (if not stated otherwise) dispatched with the DispatchStrategy.CASCADE strategy. Same applies to service "shutdown" as of PauseBus.publishPause(), StopBus.publishStop() or DestroyBus.publishDestroy() (and the like) which are also dispatched by default with the DispatchStrategy.CASCADE strategy. This means that the observer methods LifecycleBusObserver.onInitialize(InitializeBusEvent), LifecycleBusObserver.onPause(PauseBusEvent), LifecycleBusObserver.onStop(StopBusEvent) and LifecycleBusObserver.onDestroy(DestroyBusEvent) must exit the invoking thread as soon as possible so not to block succeeding listener methods. As initialization is processed in a controlled manner (as mentioned above), starting or resuming the LifecycleBusObserver instances is done with the DispatchStrategy.PARALLEL as we enter normal operation. This means that the observer methods LifecycleBusObserver.onStart(StartBusEvent) and LifecycleBusObserver.onResume(ResumeBusEvent) do not need to exit the invoking thread as they cannot block succeeding listener methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

org.refcodes.component.Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.eventbus.DispatchStrategyAccessor

org.refcodes.eventbus.DispatchStrategyAccessor.DispatchStrategyMutator, org.refcodes.eventbus.DispatchStrategyAccessor.DispatchStrategyProperty

Method Summary

Modifier and Type	Method	Description
default String	onLifecycle(Class<?> aPublisherType, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(Enum<?> aAction, Class<?> aPublisherType, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(Enum<?> aAction, String aChannel, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(Enum<?> aAction, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(String aChannel, LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.
default String	onLifecycle(LifecycleBusObserver aObserver)	Subscribes a LifecycleBusObserver for LifecycleBusEvent instances to be passed to the according LifecycleBusObserver methods.

Methods inherited from interface org.refcodes.component.Destroyable

destroy

Methods inherited from interface org.refcodes.eventbus.ext.application.DestroyBus

onDestroy, onDestroy, onDestroy, onDestroy, onDestroy, onDestroy, onDestroy, onDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy, publishDestroy

Methods inherited from interface org.refcodes.eventbus.DispatchStrategyAccessor

getDispatchStrategy

Methods inherited from interface org.refcodes.eventbus.EventBusObservable

subscribe, subscribe, subscribe, unsubscribeAll

Methods inherited from interface org.refcodes.observer.EventMatcher

isMatching

Methods inherited from interface org.refcodes.eventbus.GenericEventBus

onAction, onAction, onActions, onActions, onAlias, onAlias, onCatchAll, onChannel, onChannel, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onGroup, onGroup, onType, onUniversalId, onUniversalId, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent

Methods inherited from interface org.refcodes.component.HandleLookup

hasHandle, lookupHandle, removeHandle

Methods inherited from interface org.refcodes.eventbus.ext.application.InitializeBus

onInitialize, onInitialize, onInitialize, onInitialize, onInitialize, onInitialize, onInitialize, onInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize, publishInitialize

Methods inherited from interface org.refcodes.eventbus.ext.application.PauseBus

onPause, onPause, onPause, onPause, onPause, onPause, onPause, onPause, publishPause, publishPause, publishPause, publishPause, publishPause, publishPause, publishPause, publishPause, publishPause, publishPause

Methods inherited from interface org.refcodes.eventbus.ext.application.ResumeBus

onResume, onResume, onResume, onResume, onResume, onResume, onResume, onResume, publishResume, publishResume, publishResume, publishResume, publishResume, publishResume, publishResume, publishResume, publishResume, publishResume

Methods inherited from interface org.refcodes.eventbus.ext.application.StartBus

onStart, onStart, onStart, onStart, onStart, onStart, onStart, onStart, publishStart, publishStart, publishStart, publishStart, publishStart, publishStart, publishStart, publishStart, publishStart, publishStart

Methods inherited from interface org.refcodes.eventbus.ext.application.StopBus

onStop, onStop, onStop, onStop, onStop, onStop, onStop, onStop, publishStop, publishStop, publishStop, publishStop, publishStop, publishStop, publishStop, publishStop, publishStop, publishStop

Method Detail

onLifecycle

default String onLifecycle(LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances to be passed to the according LifecycleBusObserver methods.

Parameters:

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(Class<?> aPublisherType,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(String aChannel,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aChannel - The channel name on which the event is receivable.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(String aAlias,
                           String aGroup,
                           String aChannel,
                           String aUid,
                           Class<?> aPublisherType,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aAlias - The alias property.

aGroup - The group property.

aChannel - The channel property.

aUid - The UID (Universal-TID) property.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(Enum<?> aAction,
                           Class<?> aPublisherType,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aAction - The action which this represents.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(Enum<?> aAction,
                           String aChannel,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aAction - The action which this represents.

aChannel - The channel name on which the event is receivable.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(Enum<?> aAction,
                           String aAlias,
                           String aGroup,
                           String aChannel,
                           String aUid,
                           Class<?> aPublisherType,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aAction - The action which this represents.

aAlias - The alias property.

aGroup - The group property.

aChannel - The channel property.

aUid - The UID (Universal-TID) property.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onLifecycle

default String onLifecycle(Enum<?> aAction,
                           LifecycleBusObserver aObserver)

Subscribes a LifecycleBusObserver for LifecycleBusEvent instances with the given attributes to be passed to the according LifecycleBusObserver methods.

Parameters:

aAction - The action which this represents.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.