Class GatewaySystemProperties
java.lang.Object
com.inductiveautomation.ignition.gateway.model.GatewaySystemProperties
Use with the SystemPropertiesManager to get or set various gateway system properties.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BasicProperty<PermissionsConfig> static final BasicProperty<Boolean> static final BasicProperty<PermissionsConfig> static final BasicProperty<Boolean> static final BasicProperty<Boolean> static final BasicProperty<Integer> static final BasicProperty<Integer> static final BasicProperty<Boolean> static final BasicProperty<Integer> static final BasicProperty<Integer> static final Stringstatic final BasicProperty<Boolean> static final PermissionsConfigstatic final BasicProperty<Integer> static final BasicProperty<AuthenticationStrategy> static final BasicProperty<Long> static final BasicProperty<Long> static final BasicProperty<PermissionsConfig> static final BasicProperty<RamOption> static final BasicProperty<String> static final BasicProperty<Boolean> static final BasicProperty<Boolean> static final BasicProperty<Boolean> static final BasicProperty<String> static final BasicProperty<SecretConfig> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<Boolean> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<Boolean> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<PermissionsConfig> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<Integer> static final BasicProperty<Boolean> static final BasicProperty<String> static final BasicProperty<ScriptMessageEncoding> static final BasicProperty<Integer> static final BasicProperty<String> static final BasicProperty<String> Deprecated, for removal: This API element is subject to removal in a future version.static final BasicProperty<List> static final BasicProperty<String> static final BasicProperty<String> static final BasicProperty<SystemIdentityProvider> static final BasicProperty<Boolean> static final BasicProperty<Long> static final BasicProperty<PermissionsConfig> -
Method Summary
Modifier and TypeMethodDescriptionstatic booleanisValidFilename(String filename) static booleanisValidSystemName(String newName) static StringsanitizeSystemName(@NonNull String name) Replaces characters that are not valid for a gateway name in the supplied string with underscores.
-
Field Details
-
DEFAULT_ADMIN_PERMISSIONS
-
backupFilenameRegex
- See Also:
-
SystemName
-
SystemAuthProfile
-
SystemIdentityProvider
@Deprecated(forRemoval=true, since="2027.02") public static final BasicProperty<String> SystemIdentityProviderDeprecated, for removal: This API element is subject to removal in a future version.The legacy single-IdP property. Retained only so that pre-2027 (single-IdP) configs can still be read; superseded bySystemIdentityProviders. New configuration is written to the list property. Reads should go throughSecurityPropertiesResource.getSystemIdentityProviders(), which falls back to this scalar when the list is absent. -
SystemIdentityProviders
@ListType(SystemIdentityProvider.class) public static final BasicProperty<List> SystemIdentityProviders -
UnauthenticatedSystemIdentityProvider
-
ForceIdpAuth
-
DesignerAuthStrategy
-
DesignerAuthTokenInactivityTimeout
-
DesignerAuthTokenTimeToLive
-
DesignerRoleName
-
AccessPermissions
-
ReadPermissions
-
WritePermissions
-
DesignerPermissions
-
UserInactivityTimeout
-
AllowUserAdmin
-
AllowDesignerSSO
-
DesignerRAM
-
Disable3DPipeline
-
DisableDirectDraw
-
UseCondensedDialogFont
-
HomepageUrl
-
HomepageNotes
-
DemoTimeRemaining
-
SystemUID
-
ClientFallbackEnabled
-
SecondsBeforeFailover
-
FallbackProjectName
-
ScheduledBackupsEnabled
-
ScheduledBackupPath
-
ScheduledBackupTimes
-
ScheduledBackupRetentionCount
-
ScheduledBackupFilename
-
AutomaticThreadDumpsEnabled
-
AutomaticThreadDumpsIntervalSeconds
-
AutomaticThreadDumpsCpuThreshold
-
AutomaticThreadDumpsCpuThresholdExceededDuration
-
AutomaticThreadDumpsRetentionCount
-
ErrorReportSMTPServer
-
ErrorReportToEmail
-
ErrorReportFromEmail
-
ErrorReportUsername
-
ErrorReportPassword
-
MulticastEnabled
-
MulticastIPAddr
-
MulticastSendPort
-
MulticastReceivePort
-
MulticastIntervalMillis
-
GatewayScriptingProject
-
GatewayAuditProfile
-
EnableTagReferenceStore
-
ScriptMessageEncoding
-
ActsAsRedundancyAdvisor
-
AdvisorApiPermissions
-
-
Method Details
-
sanitizeSystemName
-
isValidSystemName
- Returns:
- true if the provided name is an allowable gateway name - not null, not empty, and not
containing
|characters.
-
isValidFilename
- Returns:
- true if the provided scheduled backup filename is valid - it must end with '.gwbk' and not contain illegal characters.
-