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 SummaryFieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final ResourceType
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptiongetIdp()Turns the comma-separated string into a list.intbooleanbooleanbooleanbooleanbooleanstatic GlobalPropsCreate a newGlobalPropsinstance.voidsetAuditingEnabled(boolean auditingEnabled) voidsetAuditProfileName(String auditProfileName) voidsetAuthProfileName(String authProfileName) voidsetAutoIdpAuth(boolean autoIdpAuth) voidsetCommitMessageMode(ProjectCommitMessageMode commitMessageMode) voidsetDefaultDatasourceName(String defaultDatasourceName) voidsetDefaultSQLTagsProviderName(String defaultSqlTagsProviderName) voidsetForceIdpAuth(boolean forceIdpAuth) voidvoidsetLegacyProject(boolean legacyProject) voidsetPermissionEnabled(String id, boolean enabled) voidsetPermissionEnabledMap(Map<String, Boolean> permissionEnabledMap) voidsetPublishMode(ProjectPublishMode publishMode) Deprecated.voidsetRequiredClientRoles(String id, String roles) voidsetRequiredClientRolesMap(Map<String, String> requiredClientRolesMap) voidsetRequiredCopyRoles(List<String> requiredCopyRoles) Deprecated.voidsetRequiredDeleteRoles(List<String> requiredDeleteRoles) voidsetRequiredExportRoles(List<String> requiredExportRoles) Deprecated.voidsetRequiredPublishRoles(List<String> requiredPublishRoles) Deprecated.voidsetRequiredResourceRoles(List<String> requiredResourceRoles) voidsetRequiredRoles(List<String> requiredRoles) voidsetRequiredSaveRoles(List<String> requiredSaveRoles) voidsetRequiredViewRoles(List<String> requiredViewRoles) voidsetSqltagsClientPollRate(int sqltagsClientPollRate) toResource(String projectName) 
- 
Field Details- 
MODULE_ID- See Also:
 
- 
RESOURCE_TYPE
- 
DEF_TAG_PROVIDER_PROP- See Also:
 
 
- 
- 
Constructor Details- 
GlobalPropsDeprecated.Default constructor for serialization.This should not be invoked unless by deserialization. - See Also:
 
 
- 
- 
Method Details- 
newInstanceCreate a newGlobalPropsinstance.- Returns:
- a new instance of GlobalProps.
 
- 
getDefaultDatasourceName
- 
setDefaultDatasourceName
- 
getDefaultSQLTagsProviderName
- 
setDefaultSQLTagsProviderName
- 
getAuthProfileName
- 
setAuthProfileName
- 
isAuditingEnabledpublic boolean isAuditingEnabled()
- 
setAuditingEnabledpublic void setAuditingEnabled(boolean auditingEnabled) 
- 
getAuditProfileName
- 
setAuditProfileName
- 
getSqltagsClientPollRatepublic int getSqltagsClientPollRate()
- 
setSqltagsClientPollRatepublic void setSqltagsClientPollRate(int sqltagsClientPollRate) 
- 
getRequiredRoles
- 
setRequiredRoles
- 
setCommitMessageMode
- 
setRequiredPublishRolesDeprecated.
- 
setPublishModeDeprecated.
- 
setRequiredCopyRolesDeprecated.The property requiredCopyRoles has been removed. This method is here to stop serialization issues.
- 
setRequiredExportRolesDeprecated.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
- 
isForceIdpAuthpublic boolean isForceIdpAuth()
- 
setForceIdpAuthpublic void setForceIdpAuth(boolean forceIdpAuth) 
- 
isAutoIdpAuthpublic boolean isAutoIdpAuth()
- 
setAutoIdpAuthpublic void setAutoIdpAuth(boolean autoIdpAuth) 
- 
getPermissionEnabledMap
- 
setPermissionEnabledMap
- 
getRequiredClientRolesMap
- 
setRequiredClientRolesMap
- 
isLegacyProjectpublic boolean isLegacyProject()
- 
setLegacyProjectpublic void setLegacyProject(boolean legacyProject) 
- 
getRequiredClientRolesAsListTurns 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
 
-