Package com.inductiveautomation.ignition.gateway.gan

Class WSChannelSettings

java.lang.Object

simpleorm.dataset.SRecordInstance

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

com.inductiveautomation.ignition.gateway.gan.WSChannelSettings

All Implemented Interfaces:

Serializable

public class WSChannelSettings
extends PersistentRecord

Created by colby.clegg on 2/13/2015. Holds settings applicable to all GAN connections

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 final IntField	AllowedProxyHops
static final BooleanField	AllowIncoming
static final BooleanField	Enabled
static final LongField	Id
static final IntField	IncomingPingMaxMissed
static final IntField	IncomingPingRateMillis
static final IntField	IncomingPingTimeoutMillis
static final RecordMeta<WSChannelSettings>	META
static final IntField	Overload_Wait_Secs
static final BooleanField	ProxyInterceptServiceCalls
static final IntField	Receive_Queue_Max
static final BooleanField	RequireSSL
static final BooleanField	RequireTwoWayAuth
static final EnumField<ConnectionSecurityPolicy>	SecurityPolicy
static final IntField	TempFilesMaxAgeHours
static final IntField	WebsocketSessionIdleTimeout
static final StringField	Whitelist

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

DEFAULT_VALUE, FORM_META_KEY, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor	Description
WSChannelSettings()

Method Summary

Modifier and Type	Method	Description
int	getAllowedProxyHops()
RecordMeta<WSChannelSettings>	getMeta()	This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
ConnectionSecurityPolicy	getSecurityPolicy()
List<String>	getWhitelist()	Returns a parsed whitelist.
boolean	isEnabled()
boolean	isProxyCallInterceptEnabled()	If true, this allows CentralManagerImpl on a proxy gateway to intercept and return service enumeration calls bound for a gateway on the other side of a proxy.
boolean	isProxyEnabled()
boolean	requireSSL()
boolean	requireTwoWayAuth()	Returns true if two-way authentication is required, meaning that both the client and server must validate each other before SSL handshake is complete.

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 Details

META

public static final RecordMeta<WSChannelSettings> META

Id

public static final LongField Id

Enabled

public static final BooleanField Enabled

RequireSSL

public static final BooleanField RequireSSL

RequireTwoWayAuth

public static final BooleanField RequireTwoWayAuth

Receive_Queue_Max

public static final IntField Receive_Queue_Max

Overload_Wait_Secs

public static final IntField Overload_Wait_Secs

AllowIncoming

public static final BooleanField AllowIncoming

SecurityPolicy

public static final EnumField<ConnectionSecurityPolicy> SecurityPolicy

Whitelist

public static final StringField Whitelist

AllowedProxyHops

public static final IntField AllowedProxyHops

WebsocketSessionIdleTimeout

public static final IntField WebsocketSessionIdleTimeout

TempFilesMaxAgeHours

public static final IntField TempFilesMaxAgeHours

IncomingPingRateMillis

public static final IntField IncomingPingRateMillis

IncomingPingTimeoutMillis

public static final IntField IncomingPingTimeoutMillis

IncomingPingMaxMissed

public static final IntField IncomingPingMaxMissed

ProxyInterceptServiceCalls

public static final BooleanField ProxyInterceptServiceCalls

Constructor Details

WSChannelSettings

public WSChannelSettings()

Method Details

getMeta

public RecordMeta<WSChannelSettings> 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

isEnabled

public boolean isEnabled()

requireSSL

public boolean requireSSL()

requireTwoWayAuth

public boolean requireTwoWayAuth()

Returns true if two-way authentication is required, meaning that both the client and server must validate each other before SSL handshake is complete.

getSecurityPolicy

public ConnectionSecurityPolicy getSecurityPolicy()

getWhitelist

public List<String> getWhitelist()

Returns a parsed whitelist. Elements are parsed by the comma character.

Returns:

the list of server IDs to accept connections from, not null.

isProxyEnabled

public boolean isProxyEnabled()

getAllowedProxyHops

public int getAllowedProxyHops()

isProxyCallInterceptEnabled

public boolean isProxyCallInterceptEnabled()

If true, this allows CentralManagerImpl on a proxy gateway to intercept and return service enumeration calls bound for a gateway on the other side of a proxy. The local proxy gateway already knows the service enumeration state of the other gateway since the local gateway regularly queries the other gateway anyway.