Package com.inductiveautomation.ignition.gateway.project

Interface ProjectManagerBase

All Known Subinterfaces:

ProjectManager

public interface ProjectManagerBase

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME_PATTERN

Method Summary

Modifier and Type	Method	Description
void	addProjectListener(ProjectListener listener)	Add a ProjectListener.
default String	copyProject(String projectName, String newProjectName)	Create a copy of the RuntimeProject named projectName, using newProjectName as the new project name, if possible.
void	createOrReplaceProject(String projectName, ProjectManifest manifest, List<ProjectResource> resources)	Create a new RuntimeProject with the provided manifests and resources, or replace an existing project by projectName if it already exists.
void	createProject(String projectName, ProjectManifest manifest, List<ProjectResource> resources)	Create a new RuntimeProject with the provided manifest and resources.
default String	createProjectSafe(String projectName, ProjectManifest manifest, List<ProjectResource> resources)	Create a new RuntimeProject with the provided manifests and resources.
default String	createProjectSafe(String projectName, ProjectManifest manifest, List<ProjectResource> resources, String namePattern)	Create a new RuntimeProject with the provided manifests and resources.
void	deleteProject(String projectName)	Delete the project named projectName, if it exists.
void	exportProject(String projectName, OutputStream destination)	Export a copy of project projectName by writing the contents to the destination OutputStream.
default Optional<RuntimeProject>	getProject(String projectName)	Get a the RuntimeProject for the given name with all project resources in all scopes, if it exists.
default Optional<RuntimeProject>	getProject(String projectName, int applicationScope)	Returns a RuntimeProject for the given name loaded with all project resources that meet the given application scope, if it exists.
Optional<RuntimeProject>	getProject(String projectName, ResourceFilter resourceFilter)	Get a RuntimeProject by the given projectName containing only resources that pass the provided ResourceFilter, if it exists.
Map<String,ProjectManifest>	getProjectManifests()	Get a Map of ProjectManifests for all current Projects.
List<String>	getProjectNames()	Get a List of all current project names.
List<ProjectDiff.AbsoluteDiff>	pull(List<ProjectSnapshot> snapshots)	Pull any changes for the given snapshots.
List<ProjectDiff.AbsoluteDiff>	pull(List<ProjectSnapshot> snapshots, ResourceFilter filter)	Pull any changes for the given snapshots, but only changes for resources that match the filter.
void	push(List<ChangeOperation> changeOperations)	Attempt to push a list of ChangeOperations.
void	removeProjectListener(ProjectListener listener)	Remove a previously-registered ProjectListener.
CompletableFuture<Void>	requestScan()	Requests that a scan for Project Resources on the filesystem be performed immediately.

Field Details

DEFAULT_NAME_PATTERN

static final String DEFAULT_NAME_PATTERN

See Also:

• Constant Field Values

Method Details

addProjectListener

void addProjectListener(ProjectListener listener)

Add a ProjectListener.

Parameters:

listener - the ProjectListener.

removeProjectListener

void removeProjectListener(ProjectListener listener)

Remove a previously-registered ProjectListener.

Parameters:

listener - the ProjectListener.

createProject

void createProject(String projectName,
 ProjectManifest manifest,
 List<ProjectResource> resources)
            throws IllegalArgumentException,
IOException,
NameInUseException

Create a new RuntimeProject with the provided manifest and resources.

Parameters:

projectName - the name of the project to create.

manifest - the ProjectManifest.

resources - the resources, if any, to assign to the project.

Throws:

IllegalArgumentException - if any of the resources indicate they belong to a project other than projectName.

IOException - if the project files could not be created.

NameInUseException - if a project by projectName already exists.

createProjectSafe

default String createProjectSafe(String projectName,
 ProjectManifest manifest,
 List<ProjectResource> resources)
                          throws IllegalArgumentException,
IOException

Create a new RuntimeProject with the provided manifests and resources.

If a project by projectName already exists, the suffix "_N", where N increases monotonically from 1, is appended to projectName until a name that isn't already used is found.

Parameters:

projectName - the name of the project to create.

manifest - the ProjectManifest.

resources - the resources, if any, to assign to the project.

Returns:

the name of the new project.

Throws:

IllegalArgumentException - if any of the resources indicate they belong to a project other than projectName.

IOException - if the project files could not be created.

createProjectSafe

default String createProjectSafe(String projectName,
 ProjectManifest manifest,
 List<ProjectResource> resources,
 String namePattern)
                          throws IllegalArgumentException,
IOException

Create a new RuntimeProject with the provided manifests and resources.

If a project by projectName already exists the namePattern is applied to the name via String.format(String, Object...), with a monotonically increasing integer value supplied, until a suitable name is found.

Parameters:

projectName - the name of the project to create.

manifest - the ProjectManifest.

resources - the resources, if any, to assign to the project.

namePattern - the name pattern to apply if projectName already exists.

Returns:

the name of the new project.

Throws:

IllegalArgumentException - if any of the resources indicate they belong to a project other than projectName.

IOException - if the project files could not be created.

createOrReplaceProject

void createOrReplaceProject(String projectName,
 ProjectManifest manifest,
 List<ProjectResource> resources)
                     throws IllegalArgumentException,
IOException

Create a new RuntimeProject with the provided manifests and resources, or replace an existing project by projectName if it already exists.

Replacing an existing project is modeled as a push of create, modify, and delete ChangeOperations, as opposed to deleting the existing project and creating a new one.

Parameters:

projectName - the name of the project to create or replace.

manifest - the ProjectManifest.

resources - the resources, if any, to assign to the project.

Throws:

IllegalArgumentException - if any of the resources indicate they belong to a project other than projectName.

IOException - if the project files could not be created.

copyProject

default String copyProject(String projectName,
 String newProjectName)
                    throws IOException,
ProjectNotFoundException,
ProjectInvalidException

Create a copy of the RuntimeProject named projectName, using newProjectName as the new project name, if possible.

If newProjectName already exists a suitable name will be chosen automatically via createProjectSafe(String, ProjectManifest, List).

Parameters:

projectName - the name of the existing project to copy.

newProjectName - the name for the new project.

Returns:

the actual name used for the new project.

Throws:

IOException - if the project files could not be created.

ProjectNotFoundException - if a project by projectName does not exist.

ProjectInvalidException - if the project by projectName exists but its configuration is not valid.

deleteProject

void deleteProject(String projectName)
            throws IOException,
ProjectNotFoundException

Delete the project named projectName, if it exists.

Parameters:

projectName - the name of the project to delete

Throws:

IOException - if the project files could not be deleted.

ProjectNotFoundException - if a project by projectName does not exist.

getProject

default Optional<RuntimeProject> getProject(String projectName)

Get a the RuntimeProject for the given name with all project resources in all scopes, if it exists.

The project returned will not have been validated. See RuntimeProject.validateOrThrow().

Parameters:

projectName - the name of the project to get.

Returns:

the RuntimeProject for the given name with all project resources in all scopes.

getProject

default Optional<RuntimeProject> getProject(@Nonnull
 String projectName,
 int applicationScope)

Returns a RuntimeProject for the given name loaded with all project resources that meet the given application scope, if it exists.

The project returned will not have been validated. See RuntimeProject.validateOrThrow().

Parameters:

projectName - the name of the project to get.

applicationScope - the ApplicationScope resources must belong to.

Returns:

a RuntimeProject for the given name loaded with all project resources that meet the given application scope.

getProject

Optional<RuntimeProject> getProject(@Nonnull
 String projectName,
 ResourceFilter resourceFilter)

Get a RuntimeProject by the given projectName containing only resources that pass the provided ResourceFilter, if it exists.

The project returned will not have been validated. See RuntimeProject.validateOrThrow().

Parameters:

projectName - the name of the project to get.

resourceFilter - the ResourceFilter.

Returns:

a RuntimeProject by the given projectName containing only resources that pass the provided ResourceFilter.

exportProject

void exportProject(String projectName,
 OutputStream destination)
            throws IOException,
ProjectNotFoundException

Export a copy of project projectName by writing the contents to the destination OutputStream.

The bytes written are composed of a zip formatted project folder that could be uncompressed and placed directly in the projects directory resulting in a functional project.

Parameters:

projectName - the name of the project to export.

destination - an OutputStream to write the export to.

Throws:

IOException

ProjectNotFoundException

getProjectManifests

Map<String,ProjectManifest> getProjectManifests()

Get a Map of ProjectManifests for all current Projects.

Returns:

a Map of ProjectManifests, keyed by project name.

getProjectNames

List<String> getProjectNames()

Get a List of all current project names.

Returns:

a List of all current project names.

push

void push(List<ChangeOperation> changeOperations)
   throws ProjectPushException

Attempt to push a list of ChangeOperations.

If any changes conflict with the current state a ProjectPushException will be thrown.

It is expected that consumers of this API will then pull and resolve any conflicts before attempting to push again.

Parameters:

changeOperations - a list of ChangeOperations to apply.

Throws:

ProjectPushException - if any changes conflict with the current state.

pull

List<ProjectDiff.AbsoluteDiff> pull(List<ProjectSnapshot> snapshots)
                             throws ProjectPullException

Pull any changes for the given snapshots.

Parameters:

snapshots - the ProjectSnapshots to pull changes for.

Returns:

ProjectDiffs for each ProjectSnapshot containing any resource diffs.

Throws:

ProjectPullException

pull

List<ProjectDiff.AbsoluteDiff> pull(List<ProjectSnapshot> snapshots,
 ResourceFilter filter)
                             throws ProjectPullException

Pull any changes for the given snapshots, but only changes for resources that match the filter.

Parameters:

snapshots - the ProjectSnapshots to pull changes for.

filter - the ResourceFilter.

Returns:

ProjectDiff.AbsoluteDiffs for each ProjectSnapshot containing any resource diffs.

Throws:

ProjectPullException

requestScan

CompletableFuture<Void> requestScan()

Requests that a scan for Project Resources on the filesystem be performed immediately. If this method is called while a scan is already in progress, a new scan will not be initiated and will complete when the current scan is done.

Returns:

a CompletableFuture that completes when a new scan or currently running scan has completed.