Package com.inductiveautomation.ignition.gateway.project

Class ProjectLifecycle

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.ignition.gateway.project.ProjectLifecycle

public abstract class ProjectLifecycle
extends AbstractLifecycle

Constructor Summary

Constructors

Constructor	Description
ProjectLifecycle(RuntimeProject project)

Method Summary

Modifier and Type	Method	Description
final RuntimeProject	getProject()
protected void	onAfterChanges()	Called after a series of calls to the resource modification methods is complete.
protected void	onBeforeChanges()	Called before a series of calls to the resource modification methods begins.
protected void	onManifestChanged(ProjectManifest manifest)	The ProjectManifest for the Project managed by this lifecycle has changed.
protected abstract void	onResourcesCreated(List<ProjectResource> resources)	Resources matching the interests of this lifecycle were created.
protected abstract void	onResourcesDeleted(List<ProjectResourceId> resourceIds)	Resources matching the interests of this lifecycle were deleted.
protected abstract void	onResourcesModified(List<ProjectResource> resources)	Resources matching the interests of this lifecycle were modified.
protected final void	onShutdown()
protected abstract void	onShutdown(List<ProjectResourceId> resourceIds)	Shut down this ProjectLifecycle.
protected final void	onStartup()
protected abstract void	onStartup(List<ProjectResource> resources)	Start this ProjectLifecycle.

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

Constructor Details

ProjectLifecycle

public ProjectLifecycle(RuntimeProject project)

Method Details

onStartup

protected final void onStartup()

Specified by:

onStartup in class AbstractLifecycle

onShutdown

protected final void onShutdown()

Specified by:

onShutdown in class AbstractLifecycle

getProject

public final RuntimeProject getProject()

onStartup

protected abstract void onStartup(List<ProjectResource> resources)

Start this ProjectLifecycle.

Parameters:

resources - initial list of resources that match the scope and type interests of this lifecycle.

onShutdown

protected abstract void onShutdown(List<ProjectResourceId> resourceIds)

Shut down this ProjectLifecycle.

Parameters:

resourceIds - list of ProjectResourceIds that match the scope and type interests of this lifecycle.

onBeforeChanges

protected void onBeforeChanges()

Called before a series of calls to the resource modification methods begins.

onAfterChanges

protected void onAfterChanges()

Called after a series of calls to the resource modification methods is complete.

onManifestChanged

protected void onManifestChanged(ProjectManifest manifest)

The ProjectManifest for the Project managed by this lifecycle has changed.

Parameters:

manifest - the updated ProjectManifest.

onResourcesCreated

protected abstract void onResourcesCreated(List<ProjectResource> resources)

Resources matching the interests of this lifecycle were created.

This is a chance for subclasses to do something of interest with these new resources, e.g. "run" them.

Parameters:

resources - ProjectResources matching the interests of this lifecycle.

onResourcesModified

protected abstract void onResourcesModified(List<ProjectResource> resources)

Resources matching the interests of this lifecycle were modified.

This is a chance for subclasses to do something of interest with these modified resources, e.g. stop "running" something based on the old resource and start "running" something based on the newly modified resource.

Parameters:

resources - ProjectResources matching the interests of this lifecycle.

onResourcesDeleted

protected abstract void onResourcesDeleted(List<ProjectResourceId> resourceIds)

Resources matching the interests of this lifecycle were deleted.

This is a chance for subclasses to do something of interest with these deleted resources, e.g. stop "running" something based on the resource.

Parameters:

resourceIds - ProjectResourceIds matching the interests of this lifecycle.