Class GlobalProps
- java.lang.Object
- 
- com.inductiveautomation.ignition.common.project.GlobalProps
 
- 
 public class GlobalProps extends java.lang.ObjectA serialized property resource that is defined by the framework itself, and holds some of the core project properties.
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringDEF_TAG_PROVIDER_PROPstatic java.lang.StringMODULE_IDstatic ResourceTypeRESOURCE_TYPE
 - 
Constructor SummaryConstructors Constructor Description GlobalProps()Deprecated.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetAuditProfileName()java.lang.StringgetAuthProfileName()java.lang.StringgetDefaultDatasourceName()java.lang.StringgetDefaultSQLTagsProviderName()java.lang.StringgetIdp()java.util.Map<java.lang.String,java.lang.Boolean>getPermissionEnabledMap()java.lang.StringgetRequiredClientRoles(java.lang.String id)java.util.List<ZoneRoleRequirement>getRequiredClientRolesAsList(java.lang.String id)Turns the comma-separated string into a list.java.util.Map<java.lang.String,java.lang.String>getRequiredClientRolesMap()java.util.List<java.lang.String>getRequiredDeleteRoles()java.util.List<java.lang.String>getRequiredResourceRoles()java.util.List<java.lang.String>getRequiredRoles()java.util.List<java.lang.String>getRequiredSaveRoles()java.util.List<java.lang.String>getRequiredViewRoles()intgetSqltagsClientPollRate()booleanisAuditingEnabled()booleanisAutoIdpAuth()booleanisForceIdpAuth()booleanisLegacyProject()booleanisPermissionEnabled(java.lang.String id)static GlobalPropsnewInstance()Create a newGlobalPropsinstance.voidsetAuditingEnabled(boolean auditingEnabled)voidsetAuditProfileName(java.lang.String auditProfileName)voidsetAuthProfileName(java.lang.String authProfileName)voidsetAutoIdpAuth(boolean autoIdpAuth)voidsetCommitMessageMode(ProjectCommitMessageMode commitMessageMode)voidsetDefaultDatasourceName(java.lang.String defaultDatasourceName)voidsetDefaultSQLTagsProviderName(java.lang.String defaultSqlTagsProviderName)voidsetForceIdpAuth(boolean forceIdpAuth)voidsetIdp(java.lang.String idp)voidsetLegacyProject(boolean legacyProject)voidsetPermissionEnabled(java.lang.String id, boolean enabled)voidsetPermissionEnabledMap(java.util.Map<java.lang.String,java.lang.Boolean> permissionEnabledMap)voidsetPublishMode(ProjectPublishMode publishMode)Deprecated.voidsetRequiredClientRoles(java.lang.String id, java.lang.String roles)voidsetRequiredClientRolesMap(java.util.Map<java.lang.String,java.lang.String> requiredClientRolesMap)voidsetRequiredCopyRoles(java.util.List<java.lang.String> requiredCopyRoles)Deprecated.voidsetRequiredDeleteRoles(java.util.List<java.lang.String> requiredDeleteRoles)voidsetRequiredExportRoles(java.util.List<java.lang.String> requiredExportRoles)Deprecated.voidsetRequiredPublishRoles(java.util.List<java.lang.String> requiredPublishRoles)Deprecated.voidsetRequiredResourceRoles(java.util.List<java.lang.String> requiredResourceRoles)voidsetRequiredRoles(java.util.List<java.lang.String> requiredRoles)voidsetRequiredSaveRoles(java.util.List<java.lang.String> requiredSaveRoles)voidsetRequiredViewRoles(java.util.List<java.lang.String> requiredViewRoles)voidsetSqltagsClientPollRate(int sqltagsClientPollRate)ProjectResourcetoResource(java.lang.String projectName)
 
- 
- 
- 
Field Detail- 
MODULE_IDpublic static final java.lang.String MODULE_ID - See Also:
- Constant Field Values
 
 - 
RESOURCE_TYPEpublic static final ResourceType RESOURCE_TYPE 
 - 
DEF_TAG_PROVIDER_PROPpublic static final java.lang.String DEF_TAG_PROVIDER_PROP - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
GlobalProps@Deprecated public GlobalProps() Deprecated.Default constructor for serialization.This should not be invoked unless by deserialization. - See Also:
- newInstance()
 
 
- 
 - 
Method Detail- 
newInstancepublic static GlobalProps newInstance() Create a newGlobalPropsinstance.- Returns:
- a new instance of GlobalProps.
 
 - 
getDefaultDatasourceNamepublic java.lang.String getDefaultDatasourceName() 
 - 
setDefaultDatasourceNamepublic void setDefaultDatasourceName(java.lang.String defaultDatasourceName) 
 - 
getDefaultSQLTagsProviderNamepublic java.lang.String getDefaultSQLTagsProviderName() 
 - 
setDefaultSQLTagsProviderNamepublic void setDefaultSQLTagsProviderName(java.lang.String defaultSqlTagsProviderName) 
 - 
getAuthProfileNamepublic java.lang.String getAuthProfileName() 
 - 
setAuthProfileNamepublic void setAuthProfileName(java.lang.String authProfileName) 
 - 
isAuditingEnabledpublic boolean isAuditingEnabled() 
 - 
setAuditingEnabledpublic void setAuditingEnabled(boolean auditingEnabled) 
 - 
getAuditProfileNamepublic java.lang.String getAuditProfileName() 
 - 
setAuditProfileNamepublic void setAuditProfileName(java.lang.String auditProfileName) 
 - 
getSqltagsClientPollRatepublic int getSqltagsClientPollRate() 
 - 
setSqltagsClientPollRatepublic void setSqltagsClientPollRate(int sqltagsClientPollRate) 
 - 
getRequiredRolespublic java.util.List<java.lang.String> getRequiredRoles() 
 - 
setRequiredRolespublic void setRequiredRoles(java.util.List<java.lang.String> requiredRoles) 
 - 
setCommitMessageModepublic void setCommitMessageMode(ProjectCommitMessageMode commitMessageMode) 
 - 
setRequiredPublishRoles@Deprecated public void setRequiredPublishRoles(java.util.List<java.lang.String> requiredPublishRoles) Deprecated.
 - 
setPublishMode@Deprecated public void setPublishMode(ProjectPublishMode publishMode) Deprecated.
 - 
setRequiredCopyRoles@Deprecated public void setRequiredCopyRoles(java.util.List<java.lang.String> requiredCopyRoles) Deprecated.The property requiredCopyRoles has been removed. This method is here to stop serialization issues.
 - 
setRequiredExportRoles@Deprecated public void setRequiredExportRoles(java.util.List<java.lang.String> requiredExportRoles) Deprecated.The property requiredExportRoles has been removed. This method is here to stop serialization issues.
 - 
getRequiredSaveRolespublic java.util.List<java.lang.String> getRequiredSaveRoles() 
 - 
setRequiredSaveRolespublic void setRequiredSaveRoles(java.util.List<java.lang.String> requiredSaveRoles) 
 - 
getRequiredViewRolespublic java.util.List<java.lang.String> getRequiredViewRoles() 
 - 
setRequiredViewRolespublic void setRequiredViewRoles(java.util.List<java.lang.String> requiredViewRoles) 
 - 
getRequiredDeleteRolespublic java.util.List<java.lang.String> getRequiredDeleteRoles() 
 - 
setRequiredDeleteRolespublic void setRequiredDeleteRoles(java.util.List<java.lang.String> requiredDeleteRoles) 
 - 
getRequiredResourceRolespublic java.util.List<java.lang.String> getRequiredResourceRoles() 
 - 
setRequiredResourceRolespublic void setRequiredResourceRoles(java.util.List<java.lang.String> requiredResourceRoles) 
 - 
isPermissionEnabledpublic boolean isPermissionEnabled(java.lang.String id) 
 - 
setPermissionEnabledpublic void setPermissionEnabled(java.lang.String id, boolean enabled)
 - 
getRequiredClientRolespublic java.lang.String getRequiredClientRoles(java.lang.String id) 
 - 
setRequiredClientRolespublic void setRequiredClientRoles(java.lang.String id, java.lang.String roles)
 - 
getIdppublic java.lang.String getIdp() 
 - 
setIdppublic void setIdp(java.lang.String idp) 
 - 
isForceIdpAuthpublic boolean isForceIdpAuth() 
 - 
setForceIdpAuthpublic void setForceIdpAuth(boolean forceIdpAuth) 
 - 
isAutoIdpAuthpublic boolean isAutoIdpAuth() 
 - 
setAutoIdpAuthpublic void setAutoIdpAuth(boolean autoIdpAuth) 
 - 
getPermissionEnabledMappublic java.util.Map<java.lang.String,java.lang.Boolean> getPermissionEnabledMap() 
 - 
setPermissionEnabledMappublic void setPermissionEnabledMap(java.util.Map<java.lang.String,java.lang.Boolean> permissionEnabledMap) 
 - 
getRequiredClientRolesMappublic java.util.Map<java.lang.String,java.lang.String> getRequiredClientRolesMap() 
 - 
setRequiredClientRolesMappublic void setRequiredClientRolesMap(java.util.Map<java.lang.String,java.lang.String> requiredClientRolesMap) 
 - 
isLegacyProjectpublic boolean isLegacyProject() 
 - 
setLegacyProjectpublic void setLegacyProject(boolean legacyProject) 
 - 
getRequiredClientRolesAsListpublic java.util.List<ZoneRoleRequirement> getRequiredClientRolesAsList(java.lang.String id) 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.
 
 - 
toResourcepublic ProjectResource toResource(java.lang.String projectName) 
 
- 
 
-