com.inductiveautomation.ignition.gateway.project

Interface ProjectManager

public interface ProjectManager

Field Summary

Fields

Modifier and Type	Field and Description
static long	GLOBAL_PROJECT_ID The project id of the global project.

Method Summary

Modifier and Type	Method and Description
long	addProject(Project project, boolean overwriteIfExists)
void	addProjectListener(ProjectListener listener)
long	copyProject(java.lang.String copyFrom, java.lang.String copyTo, boolean overwrite)
java.lang.Object	executeNamedQuery(java.lang.Long projectId, NamedQuery query, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean canCache, boolean canLimit)
java.lang.Object	executeNamedQuery(java.lang.Long projectId, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean canCache, boolean canLimit)
java.lang.Object	executeNamedQuery(java.lang.String project, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters) Deprecated.
java.lang.Object	executeNamedQuery(java.lang.String project, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean useLimit, int limit) Deprecated.
java.util.List<ProjectChangeRecord>	getAvailableRollbacks(long projectId) Gets a list of edits for the given project that could be rolled back to.
Project	getGlobalProject(int scope) Returns the special "global" project, which is really just project with id=-1.
java.lang.Long	getNewResourceId() Provides the next project resource id, used when creating new resources to add to a project.
Project	getProject(long id, int applicationScope, ProjectVersion version) Returns a project for the given id loaded with all project resources that meet the given application scope.
Project	getProject(java.lang.String name, int applicationScope, ProjectVersion version) Returns a project for the given name loaded with all project resources that meet the given application scope.
Project	getProjectDiff(long projectId, java.util.UUID uuid, long fromEditCount, int scope, ProjectVersion version) Creates a diff of the given project from the given edit count to the current edit count.
Project	getProjectDiff(long projectId, java.util.UUID uuid, long fromEditCount, long toEditCount, int scope, ProjectVersion version) Creates a diff of the given project between any two edits.
java.lang.Long	getProjectId(java.lang.String name) Returns the Id for the given project, or null if none found
java.lang.String	getProjectName(long projectId, ProjectVersion version) Returns the project's name for the given id
ProjectPublishReport	getProjectPublishReport(long projectId)
java.util.List<ProjectScriptDiagnostic>	getProjectScriptDiagnostics(long projectId, int type)
java.util.List<ScriptExecutionReport>	getProjectScriptExecutionReports(long projectId)
ScriptManager	getProjectScriptManager(long id) Returns the script manager for the given project.
java.util.List<Project>	getProjectsFull(ProjectVersion version) Returns a list of all projects, fully loaded
java.util.List<Project>	getProjectsLite(ProjectVersion version) Returns a list of all projects, but without their resources
TagHistoryManager	getProjectTagHistoryManager(long id, ProjectVersion version)
TagManager	getProjectTagManager(long id, ProjectVersion version) Returns a TagManager for the project that will correctly delegate for the default tag provider
GlobalProps	getProps(long projectId, ProjectVersion version) High-speed cached call to get the project's current GlobalProps object
NamedQuery	getQueryFromPath(long projectId, java.lang.String queryPath)
java.lang.Long	getResourceLastEditCount(long projectId, long resourceId) Returns the edit count of the project that the given resource was most recently edited in.
Project	getRollbackDiff(Project project, long editCount)
java.util.List<Project>	getUnlicensedProjects() Returns a list of all projects that cannot be loaded due to licensing.
void	invokeGWMessageHandler(java.lang.String projectName, java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler) Deprecated.
void	invokeGWMessageHandler(java.lang.String projectName, java.lang.String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler, java.util.Properties properties) Invokes the specified Gateway message handler on a project.
boolean	isProjectEditable(long id) Returns whether the current licensing allows the given project id to be edited.
boolean	isResourceProtected(long resourceId)
void	lockProject(long projectId, ProgressListener progress) Locks the specified project using the installed Runtime Lock.
void	publishProject(long projectId, AuthenticatedUser user, java.lang.String host, java.lang.String commitMessage)
void	publishSelected(long projectId, java.util.Collection<java.lang.Long> resources, AuthenticatedUser user, java.lang.String host, java.lang.String commitMessage)
void	removeProjectListener(ProjectListener listener)
java.lang.Long	saveProject(Project diff, AuthenticatedUser user, java.lang.String host, java.lang.String commitMessage, boolean publish) Saves the project diff to the internal database.
void	unlockProject(long projectId, ProgressListener progress) Unlocks a runtime locked project.

Field Detail

GLOBAL_PROJECT_ID

static final long GLOBAL_PROJECT_ID

The project id of the global project.

See Also:

Constant Field Values

Method Detail

addProject

long addProject(Project project,
                boolean overwriteIfExists)
         throws java.lang.Exception

Throws:

java.lang.Exception

getProjectsLite

java.util.List<Project> getProjectsLite(ProjectVersion version)

Returns a list of all projects, but without their resources

getProjectsFull

java.util.List<Project> getProjectsFull(ProjectVersion version)

Returns a list of all projects, fully loaded

getUnlicensedProjects

java.util.List<Project> getUnlicensedProjects()

Returns a list of all projects that cannot be loaded due to licensing. Most commonly the projects have been locked with the Runtime Lock system, and that lock is not installed.

Projects that are not licensed will not show up in the other project lists.

getResourceLastEditCount

java.lang.Long getResourceLastEditCount(long projectId,
                                        long resourceId)

Returns the edit count of the project that the given resource was most recently edited in.

getProject

Project getProject(long id,
                   int applicationScope,
                   ProjectVersion version)

Returns a project for the given id loaded with all project resources that meet the given application scope. Returns null if no project exists for that id.

Parameters:

applicationScope - The ApplicationScope mask that project resources must match.

getProject

@Nullable
Project getProject(java.lang.String name,
                             int applicationScope,
                             ProjectVersion version)

Returns a project for the given name loaded with all project resources that meet the given application scope. Returns null if no project exists for that id.

Parameters:

applicationScope - The ApplicationScope mask that project resources must match.

getGlobalProject

Project getGlobalProject(int scope)

Returns the special "global" project, which is really just project with id=-1.

addProjectListener

void addProjectListener(ProjectListener listener)

removeProjectListener

void removeProjectListener(ProjectListener listener)

isProjectEditable

boolean isProjectEditable(long id)

Returns whether the current licensing allows the given project id to be edited.

getProjectScriptManager

ScriptManager getProjectScriptManager(long id)

Returns the script manager for the given project. This script manager will be unique for this project, and have the project's global script module loaded under app.*, as well as correctly delegate references to the default datasource and default tag provider.

Returns:

A ScriptManager, or null if the project doesn't exist

getProjectTagManager

TagManager getProjectTagManager(long id,
                                ProjectVersion version)

Returns a TagManager for the project that will correctly delegate for the default tag provider

getProjectTagHistoryManager

TagHistoryManager getProjectTagHistoryManager(long id,
                                              ProjectVersion version)

getProps

GlobalProps getProps(long projectId,
                     ProjectVersion version)

High-speed cached call to get the project's current GlobalProps object

Returns:

The current GlobalProps for the project

Throws:

java.lang.IllegalArgumentException - if the project doesn't exist

getProjectName

java.lang.String getProjectName(long projectId,
                                ProjectVersion version)

Returns the project's name for the given id

getProjectId

java.lang.Long getProjectId(java.lang.String name)

Returns the Id for the given project, or null if none found

lockProject

void lockProject(long projectId,
                 ProgressListener progress)
          throws java.lang.Exception

Locks the specified project using the installed Runtime Lock. Takes a progress listener that will be updated as resources are locked. Can be null.

Throws:

UnlicensedFeatureException - if a Runtime Lock is not installed.

java.lang.IllegalArgumentException - if the specified project doesn't exist or is already locked.

java.lang.Exception

unlockProject

void unlockProject(long projectId,
                   ProgressListener progress)
            throws java.lang.Exception

Unlocks a runtime locked project.

Throws:

java.lang.Exception

getProjectDiff

Project getProjectDiff(long projectId,
                       java.util.UUID uuid,
                       long fromEditCount,
                       int scope,
                       ProjectVersion version)
                throws java.lang.Exception

Creates a diff of the given project from the given edit count to the current edit count.

Throws:

java.lang.Exception

getProjectDiff

Project getProjectDiff(long projectId,
                       java.util.UUID uuid,
                       long fromEditCount,
                       long toEditCount,
                       int scope,
                       ProjectVersion version)
                throws java.lang.Exception

Creates a diff of the given project between any two edits. If the current project doesn't match the given uuid, the entire project will be returned.

Throws:

java.lang.Exception

getAvailableRollbacks

java.util.List<ProjectChangeRecord> getAvailableRollbacks(long projectId)

Gets a list of edits for the given project that could be rolled back to.

getRollbackDiff

Project getRollbackDiff(Project project,
                        long editCount)
                 throws java.sql.SQLException

Throws:

java.sql.SQLException

saveProject

java.lang.Long saveProject(Project diff,
                           AuthenticatedUser user,
                           java.lang.String host,
                           java.lang.String commitMessage,
                           boolean publish)
                    throws java.lang.Exception

Saves the project diff to the internal database.

Parameters:

commitMessage - An option commit message to record with this save.

Throws:

java.lang.Exception

copyProject

long copyProject(java.lang.String copyFrom,
                 java.lang.String copyTo,
                 boolean overwrite)
          throws java.lang.Exception

Throws:

java.lang.Exception

publishProject

void publishProject(long projectId,
                    AuthenticatedUser user,
                    java.lang.String host,
                    java.lang.String commitMessage)
             throws java.lang.Exception

Throws:

java.lang.Exception

publishSelected

void publishSelected(long projectId,
                     java.util.Collection<java.lang.Long> resources,
                     AuthenticatedUser user,
                     java.lang.String host,
                     java.lang.String commitMessage)
              throws java.lang.Exception

Throws:

java.lang.Exception

getProjectPublishReport

ProjectPublishReport getProjectPublishReport(long projectId)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isResourceProtected

boolean isResourceProtected(long resourceId)

getNewResourceId

java.lang.Long getNewResourceId()
                         throws java.lang.Exception

Provides the next project resource id, used when creating new resources to add to a project.

Throws:

java.lang.Exception

getProjectScriptExecutionReports

java.util.List<ScriptExecutionReport> getProjectScriptExecutionReports(long projectId)

Parameters:

projectId - The id of the Project.

Returns:

The current list of ScriptExecutionReports for the project specified by projectId.

getProjectScriptDiagnostics

java.util.List<ProjectScriptDiagnostic> getProjectScriptDiagnostics(long projectId,
                                                                    int type)

invokeGWMessageHandler

@Deprecated
void invokeGWMessageHandler(java.lang.String projectName,
                                        java.lang.String messageHandlerName,
                                        org.python.core.PyDictionary messageParams,
                                        MessageResultHandler handler)
                                 throws MessageHandlerException

Deprecated.

Throws:

MessageHandlerException

invokeGWMessageHandler

void invokeGWMessageHandler(java.lang.String projectName,
                            java.lang.String messageHandlerName,
                            org.python.core.PyDictionary messageParams,
                            MessageResultHandler handler,
                            java.util.Properties properties)
                     throws MessageHandlerException

Invokes the specified Gateway message handler on a project. The messageParams PyDictionary object is passed to the message handler.

Parameters:

projectName - The project name.

messageHandlerName - The name of the Gateway message handler in the Project.

messageParams - a PyDictionary that is passed to the message handler. See MessageDispatchManager for details.

handler - a result handler. May be null.

properties - Contains associated properties, like originating user and zone. May be null.

Throws:

MessageHandlerException - if the message handler cannot be found in the project or some other problem occurred.

executeNamedQuery

java.lang.Object executeNamedQuery(java.lang.Long projectId,
                                   java.lang.String queryPath,
                                   java.util.Map<java.lang.String,java.lang.Object> parameters,
                                   boolean canCache,
                                   boolean canLimit)
                            throws java.lang.Exception

Throws:

java.lang.Exception

executeNamedQuery

java.lang.Object executeNamedQuery(java.lang.Long projectId,
                                   NamedQuery query,
                                   java.util.Map<java.lang.String,java.lang.Object> parameters,
                                   boolean canCache,
                                   boolean canLimit)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getQueryFromPath

NamedQuery getQueryFromPath(long projectId,
                            java.lang.String queryPath)
                     throws java.lang.Exception

Throws:

java.lang.Exception

executeNamedQuery

@Deprecated
java.lang.Object executeNamedQuery(java.lang.String project,
                                               java.lang.String queryPath,
                                               java.util.Map<java.lang.String,java.lang.Object> parameters)
                                        throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

executeNamedQuery

@Deprecated
java.lang.Object executeNamedQuery(java.lang.String project,
                                               java.lang.String queryPath,
                                               java.util.Map<java.lang.String,java.lang.Object> parameters,
                                               boolean useLimit,
                                               int limit)
                                        throws java.lang.Exception

Deprecated.

Overload for using where test limits apply

Throws:

java.lang.Exception