Package com.inductiveautomation.ignition.common.project

Interface ProjectsRpc

public interface ProjectsRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ProjectsRpc.ProjectInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final com.inductiveautomation.ignition.common.gson.Gson	GSON
static final String	PROJECT_CHANGED_MESSAGE_TYPE
static final String	PROJECT_DELETED_MESSAGE_TYPE
static final ProtoRpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
void	addMonitor(String projectName, int scope)	Add the session monitor that watches for project changes
boolean	canSaveProject(String projectName)
boolean	canViewProject(String projectName)
void	create(String newProjectName, ResourceCollectionManifest manifest, List<Resource> resources)	Creates a new project with the given name, or throws a GatewayFunctionException if a project with that name already exists.
static com.inductiveautomation.ignition.common.gson.GsonBuilder	customizeGson(com.inductiveautomation.ignition.common.gson.GsonBuilder builder)
byte[]	getGlobalProps(String projectToLoad)	Retrieves the GlobalProps data for the supplied project
List<ProjectsRpc.ProjectInfo>	getProjectInfos()	Get info about all projects
Map<String,ResourceCollectionManifest>	getValidProjectManifests()	Retrieves project metadata for all projects
ResourceInsertionResponse	insertResources(List<String> targetProjectNames, List<Resource> resources)	This is the Gateway-side functionality of the Designer's "Send to" context menu for windows and templates.
RuntimeResourceCollection	loadProject(String projectToLoad)	Note - loads synchronously
List<ResourceCollectionDiff>	pull(List<Snapshot> snapshots)	Retrieves the latest changes from the current session's project
void	push(List<ChangeOperation> diffs)	Pushes changes to the current session's project
String	saveAs(String newProjectName, ResourceCollectionManifest manifest, List<Resource> resources)	Save the current session project under a new name and switch to the new project
void	setProject(String projectName, boolean audit)	This should only be used by the designer when first loading a project, or when switching from one project to another (i.e.

Field Details

GSON

static final com.inductiveautomation.ignition.common.gson.Gson GSON

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

PROJECT_CHANGED_MESSAGE_TYPE

static final String PROJECT_CHANGED_MESSAGE_TYPE

See Also:

• Constant Field Values

PROJECT_DELETED_MESSAGE_TYPE

static final String PROJECT_DELETED_MESSAGE_TYPE

See Also:

• Constant Field Values

Method Details

getValidProjectManifests

Map<String,ResourceCollectionManifest> getValidProjectManifests()

Retrieves project metadata for all projects

Returns:

the map of project names to manifest metadata

getProjectInfos

List<ProjectsRpc.ProjectInfo> getProjectInfos()

Get info about all projects

saveAs

String saveAs(String newProjectName,
 ResourceCollectionManifest manifest,
 List<Resource> resources)
       throws GatewayAuthException,
ResourceCollectionNotFoundException,
IOException

Save the current session project under a new name and switch to the new project

Parameters:

newProjectName - the name of the new project

manifest - the manifest metadata for the new project

resources - the set of resources to save to the new project

Returns:

the name of the newly recreated resource collection (project)

Throws:

GatewayAuthException - if the user lacks sufficient authorization to create the new project

ResourceCollectionNotFoundException - if the current project can not be found

IOException - if there is an error saving the new project

pull

List<ResourceCollectionDiff> pull(List<Snapshot> snapshots)
                           throws PullException

Retrieves the latest changes from the current session's project

Parameters:

snapshots - the list of Snapshot to compare against

Returns:

the list of ResourceCollectionDiff representing new changes

Throws:

PullException - if there is an error pulling the changes

push

void push(List<ChangeOperation> diffs)
   throws PushException,
ResourceCollectionNotFoundException,
GatewayAuthException

Pushes changes to the current session's project

Parameters:

diffs - the collection of ChangeOperation to apply

Throws:

PushException - if there is an error applying the changes

ResourceCollectionNotFoundException - if the project can not be found

GatewayAuthException - if the user lacks sufficient authorization to edit the target resources

create

void create(String newProjectName,
 ResourceCollectionManifest manifest,
 List<Resource> resources)
     throws ResourceCollectionInvalidException,
ResourceCollectionNotFoundException,
NameInUseException,
IOException,
GatewayAuthException

Creates a new project with the given name, or throws a GatewayFunctionException if a project with that name already exists.

Parameters:

newProjectName - the name of the new project

manifest - the manifest for the new project

resources - the resources to add to the new project

Throws:

ResourceCollectionInvalidException - if the manifest is invalid

ResourceCollectionNotFoundException - if the manifest references a missing resource

NameInUseException - if a resource name is already in use

IOException - if there is an error saving the project

GatewayAuthException - if the user does not have the required roles to create a project

setProject

void setProject(String projectName,
 boolean audit)

This should only be used by the designer when first loading a project, or when switching from one project to another (i.e. File > Open Project).

Parameters:

projectName - the name of the project to bind the session to

audit - whether to audit the project switch

loadProject

RuntimeResourceCollection loadProject(String projectToLoad)
                               throws ResourceCollectionNotFoundException,
ResourceCollectionInvalidException

Note - loads synchronously

Parameters:

projectToLoad - the name of the project to load

Returns:

the RuntimeResourceCollection for the project

Throws:

ResourceCollectionNotFoundException - if the project does not exist

ResourceCollectionInvalidException - if the project is invalid

insertResources

ResourceInsertionResponse insertResources(List<String> targetProjectNames,
 List<Resource> resources)

This is the Gateway-side functionality of the Designer's "Send to" context menu for windows and templates. It merges the resources into the target projects, creating folders if necessary. It also checks if the resources to be sent are protected and if the user doing the sending has the required Protected Resource roles. It also checks if the user has the required save roles.

Parameters:

targetProjectNames - the list of project names to send the resources to

resources - the resources to send

Returns:

a ResourceInsertionResponse object that contains the results of the insertion

addMonitor

void addMonitor(String projectName,
 int scope)

Add the session monitor that watches for project changes

Parameters:

projectName - the name of the project to monitor

scope - the ApplicationScope of the monitor

getGlobalProps

byte[] getGlobalProps(String projectToLoad)

Retrieves the GlobalProps data for the supplied project

Parameters:

projectToLoad - the name of the project to load

Returns:

the raw byte array

canViewProject

boolean canViewProject(String projectName)

Parameters:

projectName - the name of the project to check

Returns:

True if the project is viewable

canSaveProject

boolean canSaveProject(String projectName)

Parameters:

projectName - the name of the project to check

Returns:

True if the project is savable

customizeGson

static com.inductiveautomation.ignition.common.gson.GsonBuilder customizeGson(com.inductiveautomation.ignition.common.gson.GsonBuilder builder)