Package com.inductiveautomation.ignition.gateway.model

Class SystemPropertiesRecord

java.lang.Object

simpleorm.dataset.SRecordInstance

com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

com.inductiveautomation.ignition.gateway.model.SystemPropertiesRecord

All Implemented Interfaces:

java.io.Serializable

public class SystemPropertiesRecord
extends PersistentRecord

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class simpleorm.dataset.SRecordInstance

SRecordInstance.BrokenOptimisticLockException

Field Summary

Fields

Modifier and Type	Field	Description
static BooleanField	AllowDesignerSSO
static BooleanField	AllowUserAdmin
static BooleanField	ClientFallbackEnabled
static BlobField	ConfigPermissions
static StringField	ConfigRoleName	Deprecated.
static BlobField	CreateProjectPermissions	These permissions are used when the DesignerAuthStrategy is set to AuthenticationStrategy.IDENTITY_PROVIDER
static StringField	CreateProjectRoleName	These roles are used when the DesignerAuthStrategy is set to AuthenticationStrategy.CLASSIC
static PermissionsConfig	DEFAULT_ADMIN_ROLE_PERMISSIONS
static IntField	DemoTimeRemaining	Represents the amount of demo time remaining, in seconds.
static EnumField<AuthenticationStrategy>	DesignerAuthStrategy
static BlobField	DesignerPermissions	These permissions are used when the DesignerAuthStrategy is set to AuthenticationStrategy.IDENTITY_PROVIDER
static EnumField<RamOption>	DesignerRAM
static StringField	DesignerRoleName	These roles are used when the DesignerAuthStrategy is set to AuthenticationStrategy.CLASSIC
static BooleanField	Disable3DPipeline
static BooleanField	DisableDirectDraw
static BooleanField	EnableUpdateNotifications
static StringField	ErrorReportFromEmail
static StringField	ErrorReportPassword	Deprecated.
static EncodedStringField	ErrorReportPasswordE
static StringField	ErrorReportSMTPServer
static StringField	ErrorReportToEmail
static StringField	ErrorReportUsername
static ReferenceField<ProjectRecord>	FallbackProject
static LongField	FallbackProjectId
static StringField	FallbackProjectName
static BooleanField	ForceIdpAuth
static StringField	GatewayAuditProfile
static StringField	GatewayScriptingProject
static BlobField	HomePagePermissions
static StringField	HomePageRoleName	Deprecated.
static StringField	HomepageUrl
static LongField	Id
static StringField	LaunchJREs
static EnumField<LaunchScriptPolicy>	LaunchScriptingPolicy
static RecordMeta<SystemPropertiesRecord>	META
static BooleanField	MulticastEnabled
static StringField	MulticastIntervalMillis
static StringField	MulticastIPAddr
static StringField	MulticastReceivePort
static StringField	MulticastSendPort
static BooleanField	PersistAlerts
static StringField	ScheduledBackupPath
static IntField	ScheduledBackupRetentionCount
static BooleanField	ScheduledBackupsEnabled
static StringField	ScheduledBackupTimes
static IntField	SecondsBeforeFailover
static BlobField	StatusPagePermissions
static StringField	StatusPageRoleName	Deprecated.
static ReferenceField<UserSourceProfileRecord>	SystemAuthProfile
static LongField	SystemAuthProfileId
static StringField	SystemIdentityProvider
static StringField	SystemName
static StringField	SystemUID
static LongField	UserInactivityTimeout	User Inactivity Timeout (in minutes).
static BooleanField	UseSSL	Deprecated.

Fields inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

DEFAULT_VALUE, FORM_META_KEY, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor	Description
SystemPropertiesRecord()

Method Summary

Modifier and Type	Method	Description
PermissionsConfig	getConfigPermissions()
PermissionsConfig	getCreateProjectPermissions()
PermissionsConfig	getDesignerPermissions()
java.lang.String	getGatewayAuditProfile()
java.lang.String	getGatewayScriptingProject()
PermissionsConfig	getHomePagePermissions()
java.lang.String	getHomepageUrl()
RecordMeta<?>	getMeta()	This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
PermissionsConfig	getPermissions(BlobField field, PermissionsConfig defaultPermissions)
static PermissionsConfig	getPermissions(SRecordInstance record, BlobField field, PermissionsConfig defaultPermissions)
PermissionsConfig	getStatusPagePermissions()
java.lang.Long	getSystemAuthProfileId()
java.lang.String	getSystemName()
java.lang.String	getSystemUID()
boolean	isUseSSL()	Deprecated.
void	setConfigPermissions(PermissionsConfig permissions)
void	setCreateProjectPermissions(PermissionsConfig permissions)
void	setDesignerPermissions(PermissionsConfig permissions)
void	setGatewayScriptingProject(java.lang.String project)
void	setHomePagePermissions(PermissionsConfig permissions)
void	setPermissions(BlobField field, PermissionsConfig permissions)
void	setStatusPagePermissions(PermissionsConfig permissions)

Methods inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

getBoolean, getDoubleObj, getIntObj, getLongObj, getString, installDefaultValues

Methods inherited from class simpleorm.dataset.SRecordInstance

allFields, assertNewRow, assertNotNewRow, defineInitialValue, deleteRecord, doQueryRecord, doValidateRecord, equals, findReference, findReference, findReference, findReference, getBigDecimal, getBytes, getDataSet, getDate, getDouble, getEnum, getInitialValue, getInt, getLogger, getLong, getObject, getRawArrayValue, getReferenceNoQuery, getTime, getTimestamp, hashCode, isAttached, isDeleted, isDirty, isDirty, isEmpty, isNewRow, isNotDestroyed, isNull, isReadOnly, isValid, onQueryRecord, onValidateField, onValidateRecord, setBigDecimal, setBoolean, setBytes, setDate, setDirty, setDouble, setEmpty, setEnum, setInt, setLong, setNewRow, setNull, setObject, setObject, setRawArrayValue, setReadOnly, setReference, setString, setTime, setTimestamp, toString, validatePrimaryKeys, wasInCache

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

META

public static final RecordMeta<SystemPropertiesRecord> META

Id

public static final LongField Id

SystemName

public static final StringField SystemName

SystemAuthProfileId

public static final LongField SystemAuthProfileId

SystemAuthProfile

public static final ReferenceField<UserSourceProfileRecord> SystemAuthProfile

SystemIdentityProvider

public static final StringField SystemIdentityProvider

ForceIdpAuth

public static final BooleanField ForceIdpAuth

DesignerAuthStrategy

public static final EnumField<AuthenticationStrategy> DesignerAuthStrategy

ConfigRoleName

@Deprecated
public static final StringField ConfigRoleName

Deprecated.

Deprecated. Use ConfigPermissions instead

StatusPageRoleName

@Deprecated
public static final StringField StatusPageRoleName

Deprecated.

Deprecated. Use StatusPagePermissions instead

HomePageRoleName

@Deprecated
public static final StringField HomePageRoleName

Deprecated.

Deprecated. Use HomePagePermissions instead

DesignerRoleName

public static final StringField DesignerRoleName

These roles are used when the DesignerAuthStrategy is set to AuthenticationStrategy.CLASSIC

See Also:

DesignerPermissions

CreateProjectRoleName

public static final StringField CreateProjectRoleName

These roles are used when the DesignerAuthStrategy is set to AuthenticationStrategy.CLASSIC

See Also:

CreateProjectPermissions

DEFAULT_ADMIN_ROLE_PERMISSIONS

public static final PermissionsConfig DEFAULT_ADMIN_ROLE_PERMISSIONS

ConfigPermissions

public static final BlobField ConfigPermissions

StatusPagePermissions

public static final BlobField StatusPagePermissions

HomePagePermissions

public static final BlobField HomePagePermissions

DesignerPermissions

public static final BlobField DesignerPermissions

These permissions are used when the DesignerAuthStrategy is set to AuthenticationStrategy.IDENTITY_PROVIDER

See Also:

DesignerRoleName

CreateProjectPermissions

public static final BlobField CreateProjectPermissions

These permissions are used when the DesignerAuthStrategy is set to AuthenticationStrategy.IDENTITY_PROVIDER

See Also:

CreateProjectRoleName

UserInactivityTimeout

public static final LongField UserInactivityTimeout

User Inactivity Timeout (in minutes). Default value is 10 minutes. A number less than or equal to zero disables the user inactivity timeout altogether.

AllowUserAdmin

public static final BooleanField AllowUserAdmin

AllowDesignerSSO

public static final BooleanField AllowDesignerSSO

UseSSL

@Deprecated
public static final BooleanField UseSSL

Deprecated.

LaunchScriptingPolicy

public static final EnumField<LaunchScriptPolicy> LaunchScriptingPolicy

LaunchJREs

public static final StringField LaunchJREs

DesignerRAM

public static final EnumField<RamOption> DesignerRAM

Disable3DPipeline

public static final BooleanField Disable3DPipeline

DisableDirectDraw

public static final BooleanField DisableDirectDraw

PersistAlerts

public static final BooleanField PersistAlerts

HomepageUrl

public static final StringField HomepageUrl

ClientFallbackEnabled

public static final BooleanField ClientFallbackEnabled

SecondsBeforeFailover

public static final IntField SecondsBeforeFailover

FallbackProjectId

public static final LongField FallbackProjectId

FallbackProject

public static final ReferenceField<ProjectRecord> FallbackProject

FallbackProjectName

public static final StringField FallbackProjectName

ScheduledBackupsEnabled

public static final BooleanField ScheduledBackupsEnabled

ScheduledBackupPath

public static final StringField ScheduledBackupPath

ScheduledBackupTimes

public static final StringField ScheduledBackupTimes

ScheduledBackupRetentionCount

public static final IntField ScheduledBackupRetentionCount

ErrorReportSMTPServer

public static final StringField ErrorReportSMTPServer

ErrorReportToEmail

public static final StringField ErrorReportToEmail

ErrorReportFromEmail

public static final StringField ErrorReportFromEmail

ErrorReportUsername

public static final StringField ErrorReportUsername

ErrorReportPassword

@Deprecated
public static final StringField ErrorReportPassword

Deprecated.

ErrorReportPasswordE

public static final EncodedStringField ErrorReportPasswordE

MulticastEnabled

public static final BooleanField MulticastEnabled

MulticastIPAddr

public static final StringField MulticastIPAddr

MulticastSendPort

public static final StringField MulticastSendPort

MulticastReceivePort

public static final StringField MulticastReceivePort

MulticastIntervalMillis

public static final StringField MulticastIntervalMillis

DemoTimeRemaining

public static final IntField DemoTimeRemaining

Represents the amount of demo time remaining, in seconds. Updated on shutdown, not kept up-to-date while the system is running.

SystemUID

public static final StringField SystemUID

EnableUpdateNotifications

public static final BooleanField EnableUpdateNotifications

GatewayScriptingProject

public static final StringField GatewayScriptingProject

GatewayAuditProfile

public static final StringField GatewayAuditProfile

Constructor Detail

SystemPropertiesRecord

public SystemPropertiesRecord()

Method Detail

getMeta

public RecordMeta<?> getMeta()

Description copied from class: SRecordInstance

This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance. It is normally defined as:-

 SRecord getMeta() {
   return meta;
 };
 

The actual meta variable is thus not Serialized, but it would not be anyway as it is usually static.

Specified by:

getMeta in class PersistentRecord

getSystemAuthProfileId

public java.lang.Long getSystemAuthProfileId()

getSystemName

public java.lang.String getSystemName()

isUseSSL

@Deprecated
public boolean isUseSSL()

Deprecated.

getSystemUID

public java.lang.String getSystemUID()

getHomepageUrl

public java.lang.String getHomepageUrl()

getGatewayScriptingProject

public java.lang.String getGatewayScriptingProject()

setGatewayScriptingProject

public void setGatewayScriptingProject(java.lang.String project)

getGatewayAuditProfile

public java.lang.String getGatewayAuditProfile()

getPermissions

public static PermissionsConfig getPermissions(SRecordInstance record,
                                               BlobField field,
                                               PermissionsConfig defaultPermissions)

getPermissions

public PermissionsConfig getPermissions(BlobField field,
                                        PermissionsConfig defaultPermissions)

setPermissions

public void setPermissions(BlobField field,
                           PermissionsConfig permissions)

getConfigPermissions

public PermissionsConfig getConfigPermissions()

setConfigPermissions

public void setConfigPermissions(PermissionsConfig permissions)

getStatusPagePermissions

public PermissionsConfig getStatusPagePermissions()

setStatusPagePermissions

public void setStatusPagePermissions(PermissionsConfig permissions)

getHomePagePermissions

public PermissionsConfig getHomePagePermissions()

setHomePagePermissions

public void setHomePagePermissions(PermissionsConfig permissions)

getDesignerPermissions

public PermissionsConfig getDesignerPermissions()

setDesignerPermissions

public void setDesignerPermissions(PermissionsConfig permissions)

getCreateProjectPermissions

public PermissionsConfig getCreateProjectPermissions()

setCreateProjectPermissions

public void setCreateProjectPermissions(PermissionsConfig permissions)