org.eclipse.milo.opcua.sdk.server

Class LifecycleManager

java.lang.Object

org.eclipse.milo.opcua.sdk.server.AbstractLifecycle

org.eclipse.milo.opcua.sdk.server.LifecycleManager

All Implemented Interfaces:

Lifecycle

public final class LifecycleManager
extends AbstractLifecycle

A Lifecycle instance that manages the startup and shutdown of a collection of sub-Lifecycles.

Registered Lifecycles are started when this LifecycleManager is started and shutdown when this LifecycleManager is shutdown.

The order that sub-Lifecycles are shutdown can be controlled with the optional LifecycleManager.ShutdownOrder parameter provided in LifecycleManager(ShutdownOrder).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LifecycleManager.ShutdownOrder Modes that control the order in which registered Lifecycles are shutdown.

Constructor Summary

Constructors

Constructor and Description
LifecycleManager() Create a LifecycleManager that shuts down sub-Lifecycles in LifecycleManager.ShutdownOrder.LINEAR order.
LifecycleManager(LifecycleManager.ShutdownOrder shutdownOrder) Create a LifecycleManager that shuts down sub-Lifecycles in the specified LifecycleManager.ShutdownOrder.

Method Summary

Modifier and Type	Method and Description
void	addLifecycle(Lifecycle lifecycle) Add a Lifecycle to be managed.
Lifecycle	addShutdownTask(Runnable shutdownTask) Add logic to run at shutdown.
Lifecycle	addStartupTask(Runnable startupTask) Add logic to run at startup.
protected void	onShutdown() Execute shutdown logic, if there is any.
protected void	onStartup() Execute startup logic, if there is any.
void	removeLifecycle(Lifecycle lifecycle) Remove a previously added Lifecycle.

Methods inherited from class org.eclipse.milo.opcua.sdk.server.AbstractLifecycle

isNotRunning, isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleManager

public LifecycleManager()

Create a LifecycleManager that shuts down sub-Lifecycles in LifecycleManager.ShutdownOrder.LINEAR order.

LifecycleManager

public LifecycleManager(LifecycleManager.ShutdownOrder shutdownOrder)

Create a LifecycleManager that shuts down sub-Lifecycles in the specified LifecycleManager.ShutdownOrder.

Parameters:

shutdownOrder - the LifecycleManager.ShutdownOrder to shutdown sub-Lifecycles in.

Method Detail

onStartup

protected void onStartup()

Description copied from class: AbstractLifecycle

Execute startup logic, if there is any.

Specified by:

onStartup in class AbstractLifecycle

onShutdown

protected void onShutdown()

Description copied from class: AbstractLifecycle

Execute shutdown logic, if there is any.

Specified by:

onShutdown in class AbstractLifecycle

addLifecycle

public void addLifecycle(Lifecycle lifecycle)

Add a Lifecycle to be managed.

This Lifecycle will have Lifecycle.startup() called when this manager is started and Lifecycle.shutdown() called when this manager is shutdown.

Parameters:

lifecycle - the Lifecycle to add.

removeLifecycle

public void removeLifecycle(Lifecycle lifecycle)

Remove a previously added Lifecycle.

Parameters:

lifecycle - the Lifecycle to remove.

addStartupTask

public Lifecycle addStartupTask(Runnable startupTask)

Add logic to run at startup.

This is a convenience method for addLifecycle(Lifecycle) where Lifecycle.shutdown() is implied to be a no-op.

Parameters:

startupTask - logic to run at startup.

Returns:

a Lifecycle instance that can be used with removeLifecycle(Lifecycle) if needed.

addShutdownTask

public Lifecycle addShutdownTask(Runnable shutdownTask)

Add logic to run at shutdown.

This is a convenience method for addLifecycle(Lifecycle) where Lifecycle.startup() is implied to be a no-op.

Parameters:

shutdownTask - logic to run at shutdown.

Returns:

a Lifecycle instance that can be used with removeLifecycle(Lifecycle) if needed.