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 Summary
Fields Modifier and Type Field Description static java.lang.StringDEF_TAG_PROVIDER_PROPstatic java.lang.StringMODULE_IDstatic ResourceTypeRESOURCE_TYPE 
- 
Constructor Summary
Constructors Constructor Description GlobalProps()Deprecated. 
- 
Method Summary
All 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_ID
public static final java.lang.String MODULE_ID
- See Also:
 - Constant Field Values
 
 
- 
RESOURCE_TYPE
public static final ResourceType RESOURCE_TYPE
 
- 
DEF_TAG_PROVIDER_PROP
public 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
- 
newInstance
public static GlobalProps newInstance()
Create a newGlobalPropsinstance.- Returns:
 - a new instance of 
GlobalProps. 
 
- 
getDefaultDatasourceName
public java.lang.String getDefaultDatasourceName()
 
- 
setDefaultDatasourceName
public void setDefaultDatasourceName(java.lang.String defaultDatasourceName)
 
- 
getDefaultSQLTagsProviderName
public java.lang.String getDefaultSQLTagsProviderName()
 
- 
setDefaultSQLTagsProviderName
public void setDefaultSQLTagsProviderName(java.lang.String defaultSqlTagsProviderName)
 
- 
getAuthProfileName
public java.lang.String getAuthProfileName()
 
- 
setAuthProfileName
public void setAuthProfileName(java.lang.String authProfileName)
 
- 
isAuditingEnabled
public boolean isAuditingEnabled()
 
- 
setAuditingEnabled
public void setAuditingEnabled(boolean auditingEnabled)
 
- 
getAuditProfileName
public java.lang.String getAuditProfileName()
 
- 
setAuditProfileName
public void setAuditProfileName(java.lang.String auditProfileName)
 
- 
getSqltagsClientPollRate
public int getSqltagsClientPollRate()
 
- 
setSqltagsClientPollRate
public void setSqltagsClientPollRate(int sqltagsClientPollRate)
 
- 
getRequiredRoles
public java.util.List<java.lang.String> getRequiredRoles()
 
- 
setRequiredRoles
public void setRequiredRoles(java.util.List<java.lang.String> requiredRoles)
 
- 
setCommitMessageMode
public 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. 
- 
getRequiredSaveRoles
public java.util.List<java.lang.String> getRequiredSaveRoles()
 
- 
setRequiredSaveRoles
public void setRequiredSaveRoles(java.util.List<java.lang.String> requiredSaveRoles)
 
- 
getRequiredViewRoles
public java.util.List<java.lang.String> getRequiredViewRoles()
 
- 
setRequiredViewRoles
public void setRequiredViewRoles(java.util.List<java.lang.String> requiredViewRoles)
 
- 
getRequiredDeleteRoles
public java.util.List<java.lang.String> getRequiredDeleteRoles()
 
- 
setRequiredDeleteRoles
public void setRequiredDeleteRoles(java.util.List<java.lang.String> requiredDeleteRoles)
 
- 
getRequiredResourceRoles
public java.util.List<java.lang.String> getRequiredResourceRoles()
 
- 
setRequiredResourceRoles
public void setRequiredResourceRoles(java.util.List<java.lang.String> requiredResourceRoles)
 
- 
isPermissionEnabled
public boolean isPermissionEnabled(java.lang.String id)
 
- 
setPermissionEnabled
public void setPermissionEnabled(java.lang.String id, boolean enabled) 
- 
getRequiredClientRoles
public java.lang.String getRequiredClientRoles(java.lang.String id)
 
- 
setRequiredClientRoles
public void setRequiredClientRoles(java.lang.String id, java.lang.String roles) 
- 
getIdp
public java.lang.String getIdp()
 
- 
setIdp
public void setIdp(java.lang.String idp)
 
- 
isForceIdpAuth
public boolean isForceIdpAuth()
 
- 
setForceIdpAuth
public void setForceIdpAuth(boolean forceIdpAuth)
 
- 
isAutoIdpAuth
public boolean isAutoIdpAuth()
 
- 
setAutoIdpAuth
public void setAutoIdpAuth(boolean autoIdpAuth)
 
- 
getPermissionEnabledMap
public java.util.Map<java.lang.String,java.lang.Boolean> getPermissionEnabledMap()
 
- 
setPermissionEnabledMap
public void setPermissionEnabledMap(java.util.Map<java.lang.String,java.lang.Boolean> permissionEnabledMap)
 
- 
getRequiredClientRolesMap
public java.util.Map<java.lang.String,java.lang.String> getRequiredClientRolesMap()
 
- 
setRequiredClientRolesMap
public void setRequiredClientRolesMap(java.util.Map<java.lang.String,java.lang.String> requiredClientRolesMap)
 
- 
isLegacyProject
public boolean isLegacyProject()
 
- 
setLegacyProject
public void setLegacyProject(boolean legacyProject)
 
- 
getRequiredClientRolesAsList
public 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.
 
 
- 
toResource
public ProjectResource toResource(java.lang.String projectName)
 
 - 
 
 -