info.magnolia.ui.api.app

Class SubAppLifecycleEvent

java.lang.Object

info.magnolia.ui.api.app.SubAppLifecycleEvent

All Implemented Interfaces:

info.magnolia.event.Event<SubAppLifecycleEventHandler>

public class SubAppLifecycleEvent
extends Object
implements info.magnolia.event.Event<SubAppLifecycleEventHandler>

SubAppLifecycleEvent is fired on initiation, termination and activation/de-activation of a sub-app (the exact list of supported lifecycle phases is provided by SubAppLifecycleEvent.Type).

Such events are fired in the sub-app scope, hence, handlers in some sub-app are notified of only those lifecycle events that happen in that particular sub-app.

Subscription to the SubAppLifecycleEvent allows the developer for managing the sub-app resources in a more fine-grained fashion, e.g. warming-up some caches once sub-app is starting/activating and cleaning them up on termination/de-activation.

Please note that this event normally should not be fired in a custom app code - the app framework is responsible for that.

See Also:

SubAppEventBus, SubAppLifecycleEvent.Type

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubAppLifecycleEvent.Type List of supported sub-app lifecycle phases.

Constructor Summary

Constructors

Constructor and Description
SubAppLifecycleEvent(SubAppDescriptor app, SubAppLifecycleEvent.Type eventType)

Method Summary

Modifier and Type	Method and Description
void	dispatch(SubAppLifecycleEventHandler handler)
SubAppDescriptor	getSubAppDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubAppLifecycleEvent

public SubAppLifecycleEvent(SubAppDescriptor app,
                            SubAppLifecycleEvent.Type eventType)

Method Detail

getSubAppDescriptor

public SubAppDescriptor getSubAppDescriptor()

dispatch

public void dispatch(SubAppLifecycleEventHandler handler)

Specified by:

dispatch in interface info.magnolia.event.Event<SubAppLifecycleEventHandler>