Package com.inductiveautomation.ignition.gateway.resourcecollection

Class ResourceCollectionLifecycleFactory<T extends ResourceCollectionLifecycle>

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.ignition.gateway.resourcecollection.ResourceCollectionLifecycleFactory<T>

All Implemented Interfaces:

Lifecycle

Direct Known Subclasses:

EventStreamProjectLifecycleFactory

public abstract class ResourceCollectionLifecycleFactory<T extends ResourceCollectionLifecycle>
extends AbstractLifecycle

A factory for creating and managing ResourceCollectionLifecycles. Subclasses define some filtering logic to determine which collections and which resources are relevant, and then a factory method to instantiate the resource collection lifecycle objects. This class will then take care of listening for changes to the relevant collections, and starting and stopping the lifecycle objects as necessary as collections are added, removed, or changed to match or mismatch the getResourceCollectionFilter() predicate.

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<RuntimeResourceCollection>	IS_RUNNABLE	A Predicate that returns true if a ResourceCollection is runnable.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourceCollectionLifecycleFactory(ResourceCollectionManager manager)

Method Summary

Modifier and Type	Method	Description
abstract T	createLifecycle(RuntimeResourceCollection collection)	Create an instance of ResourceCollectionLifecycle that can manage runtime and lifecycle for collection.
Optional<T>	getLifecycle(String name)	Get the ResourceCollectionLifecycle for name, if it exists.
final com.google.common.collect.ImmutableList<T>	getLifecycles()	Get an immutable copy of the current ResourceCollectionLifecycles.
Predicate<RuntimeResourceCollection>	getResourceCollectionFilter()	Return a Predicate that indicates whether a collection should have a ResourceCollectionLifecycle created for it.
protected abstract ResourceFilter	getResourceFilter()	Get the ResourceFilter to apply when getting matching resources this lifecycle is interested in.
protected final void	onShutdown()
protected final void	onStartup()
void	restartAll()	We may need to restart all lifecycles of a type (such as scripting) if a module is installed, restarted or uninstalled.

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Field Details

IS_RUNNABLE

public static final Predicate<RuntimeResourceCollection> IS_RUNNABLE

A Predicate that returns true if a ResourceCollection is runnable.

Constructor Details

ResourceCollectionLifecycleFactory

protected ResourceCollectionLifecycleFactory(ResourceCollectionManager manager)

Method Details

onStartup

protected final void onStartup()

Specified by:

onStartup in class AbstractLifecycle

onShutdown

protected final void onShutdown()

Specified by:

onShutdown in class AbstractLifecycle

getLifecycle

public Optional<T> getLifecycle(String name)

Get the ResourceCollectionLifecycle for name, if it exists.

Parameters:

name - the resource collection name the lifecycle belongs to.

Returns:

the ResourceCollectionLifecycle for name, if it exists.

getLifecycles

public final com.google.common.collect.ImmutableList<T> getLifecycles()

Get an immutable copy of the current ResourceCollectionLifecycles.

Returns:

an immutable copy of the current ResourceCollectionLifecycles.

createLifecycle

public abstract T createLifecycle(RuntimeResourceCollection collection)

Create an instance of ResourceCollectionLifecycle that can manage runtime and lifecycle for collection.

Parameters:

collection - the RuntimeResourceCollection that will be run.

Returns:

a ResourceCollectionLifecycle that can manage runtime and lifecycle for collection.

restartAll

public void restartAll()

We may need to restart all lifecycles of a type (such as scripting) if a module is installed, restarted or uninstalled. Most LifecycleFactories will not override this.

getResourceFilter

protected abstract ResourceFilter getResourceFilter()

Get the ResourceFilter to apply when getting matching resources this lifecycle is interested in.

Returns:

the ResourceFilter to apply when matching resources this lifecycle is interested in.

getResourceCollectionFilter

public Predicate<RuntimeResourceCollection> getResourceCollectionFilter()

Return a Predicate that indicates whether a collection should have a ResourceCollectionLifecycle created for it.

For example, if the collection doesn't contain any resources of a certain type then this predicate could return false to avoid creating a lifecycle that doesn't actually have any resources to run.

Should resources of an interesting type later get added the machinery of ResourceCollectionLifecycleFactory ensures a lifecycle will have a chance to be created at that time.

The default implementation is RuntimeResourceCollection::isRunnable

Returns:

a Predicate that indicates whether a resource collection should have a ResourceCollectionLifecycle created for it.