Class GlobalProps
java.lang.Object
com.inductiveautomation.ignition.common.project.GlobalProps
A serialized property resource that is defined by the framework itself, and holds some of the core project
properties.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final ResourceType
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetIdp()
Turns the comma-separated string into a list.int
boolean
boolean
boolean
boolean
boolean
static GlobalProps
Create a newGlobalProps
instance.void
setAuditingEnabled
(boolean auditingEnabled) void
setAuditProfileName
(String auditProfileName) void
setAuthProfileName
(String authProfileName) void
setAutoIdpAuth
(boolean autoIdpAuth) void
setCommitMessageMode
(ProjectCommitMessageMode commitMessageMode) void
setDefaultDatasourceName
(String defaultDatasourceName) void
setDefaultSQLTagsProviderName
(String defaultSqlTagsProviderName) void
setForceIdpAuth
(boolean forceIdpAuth) void
void
setLegacyProject
(boolean legacyProject) void
setPermissionEnabled
(String id, boolean enabled) void
setPermissionEnabledMap
(Map<String, Boolean> permissionEnabledMap) void
setPublishMode
(ProjectPublishMode publishMode) Deprecated.void
setRequiredClientRoles
(String id, String roles) void
setRequiredClientRolesMap
(Map<String, String> requiredClientRolesMap) void
setRequiredCopyRoles
(List<String> requiredCopyRoles) Deprecated.void
setRequiredDeleteRoles
(List<String> requiredDeleteRoles) void
setRequiredExportRoles
(List<String> requiredExportRoles) Deprecated.void
setRequiredPublishRoles
(List<String> requiredPublishRoles) Deprecated.void
setRequiredResourceRoles
(List<String> requiredResourceRoles) void
setRequiredRoles
(List<String> requiredRoles) void
setRequiredSaveRoles
(List<String> requiredSaveRoles) void
setRequiredViewRoles
(List<String> requiredViewRoles) void
setSqltagsClientPollRate
(int sqltagsClientPollRate) toResource
(String projectName)
-
Field Details
-
MODULE_ID
- See Also:
-
RESOURCE_TYPE
-
DEF_TAG_PROVIDER_PROP
- See Also:
-
-
Constructor Details
-
GlobalProps
Deprecated.Default constructor for serialization.This should not be invoked unless by deserialization.
- See Also:
-
-
Method Details
-
newInstance
Create a newGlobalProps
instance.- Returns:
- a new instance of
GlobalProps
.
-
getDefaultDatasourceName
-
setDefaultDatasourceName
-
getDefaultSQLTagsProviderName
-
setDefaultSQLTagsProviderName
-
getAuthProfileName
-
setAuthProfileName
-
isAuditingEnabled
public boolean isAuditingEnabled() -
setAuditingEnabled
public void setAuditingEnabled(boolean auditingEnabled) -
getAuditProfileName
-
setAuditProfileName
-
getSqltagsClientPollRate
public int getSqltagsClientPollRate() -
setSqltagsClientPollRate
public void setSqltagsClientPollRate(int sqltagsClientPollRate) -
getRequiredRoles
-
setRequiredRoles
-
setCommitMessageMode
-
setRequiredPublishRoles
Deprecated. -
setPublishMode
Deprecated. -
setRequiredCopyRoles
Deprecated.The property requiredCopyRoles has been removed. This method is here to stop serialization issues. -
setRequiredExportRoles
Deprecated.The property requiredExportRoles has been removed. This method is here to stop serialization issues. -
getRequiredSaveRoles
-
setRequiredSaveRoles
-
getRequiredViewRoles
-
setRequiredViewRoles
-
getRequiredDeleteRoles
-
setRequiredDeleteRoles
-
getRequiredResourceRoles
-
setRequiredResourceRoles
-
isPermissionEnabled
-
setPermissionEnabled
-
getRequiredClientRoles
-
setRequiredClientRoles
-
getIdp
-
setIdp
-
isForceIdpAuth
public boolean isForceIdpAuth() -
setForceIdpAuth
public void setForceIdpAuth(boolean forceIdpAuth) -
isAutoIdpAuth
public boolean isAutoIdpAuth() -
setAutoIdpAuth
public void setAutoIdpAuth(boolean autoIdpAuth) -
getPermissionEnabledMap
-
setPermissionEnabledMap
-
getRequiredClientRolesMap
-
setRequiredClientRolesMap
-
isLegacyProject
public boolean isLegacyProject() -
setLegacyProject
public void setLegacyProject(boolean legacyProject) -
getRequiredClientRolesAsList
Turns the comma-separated string into a list. Does its best to decipher zone/role if included- Parameters:
id
- Permissions id- Returns:
- Required client zone/roles as list. Not null.
-
toResource
-