Class GlobalProps
- java.lang.Object
-
- com.inductiveautomation.ignition.common.project.GlobalProps
-
public class GlobalProps extends java.lang.Object
A 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.String
DEF_TAG_PROVIDER_PROP
static java.lang.String
MODULE_ID
static ResourceType
RESOURCE_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.String
getAuditProfileName()
java.lang.String
getAuthProfileName()
java.lang.String
getDefaultDatasourceName()
java.lang.String
getDefaultSQLTagsProviderName()
java.lang.String
getIdp()
java.util.Map<java.lang.String,java.lang.Boolean>
getPermissionEnabledMap()
java.lang.String
getRequiredClientRoles(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()
int
getSqltagsClientPollRate()
boolean
isAuditingEnabled()
boolean
isLegacyProject()
boolean
isPermissionEnabled(java.lang.String id)
static GlobalProps
newInstance()
Create a newGlobalProps
instance.void
setAuditingEnabled(boolean auditingEnabled)
void
setAuditProfileName(java.lang.String auditProfileName)
void
setAuthProfileName(java.lang.String authProfileName)
void
setCommitMessageMode(ProjectCommitMessageMode commitMessageMode)
void
setDefaultDatasourceName(java.lang.String defaultDatasourceName)
void
setDefaultSQLTagsProviderName(java.lang.String defaultSqlTagsProviderName)
void
setIdp(java.lang.String idp)
void
setLegacyProject(boolean legacyProject)
void
setPermissionEnabled(java.lang.String id, boolean enabled)
void
setPermissionEnabledMap(java.util.Map<java.lang.String,java.lang.Boolean> permissionEnabledMap)
void
setPublishMode(ProjectPublishMode publishMode)
Deprecated.void
setRequiredClientRoles(java.lang.String id, java.lang.String roles)
void
setRequiredClientRolesMap(java.util.Map<java.lang.String,java.lang.String> requiredClientRolesMap)
void
setRequiredCopyRoles(java.util.List<java.lang.String> requiredCopyRoles)
Deprecated.void
setRequiredDeleteRoles(java.util.List<java.lang.String> requiredDeleteRoles)
void
setRequiredExportRoles(java.util.List<java.lang.String> requiredExportRoles)
Deprecated.void
setRequiredPublishRoles(java.util.List<java.lang.String> requiredPublishRoles)
Deprecated.void
setRequiredResourceRoles(java.util.List<java.lang.String> requiredResourceRoles)
void
setRequiredRoles(java.util.List<java.lang.String> requiredRoles)
void
setRequiredSaveRoles(java.util.List<java.lang.String> requiredSaveRoles)
void
setRequiredViewRoles(java.util.List<java.lang.String> requiredViewRoles)
void
setSqltagsClientPollRate(int sqltagsClientPollRate)
ProjectResource
toResource(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 newGlobalProps
instance.- 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)
-
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)
-
-