Package com.inductiveautomation.ignition.gateway.gan

Class WSConnectionSettings

java.lang.Object

simpleorm.dataset.SRecordInstance

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

com.inductiveautomation.ignition.gateway.gan.WSConnectionSettings

All Implemented Interfaces:

Serializable

public class WSConnectionSettings
extends PersistentRecord

Created by colby.clegg on 2/13/2015.

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 StringField	Description
static final BooleanField	Enabled
static final StringField	Host
static final IntField	HttpConnectTimeoutMillis
static final IntField	HttpReadTimeoutMillis
static final IdentityField	Id
static final RecordMeta<WSConnectionSettings>	META
static final IntField	PingMaxMissed
static final IntField	PingRateMillis
static final IntField	PingTimeoutMillis
static final IntField	Port
static final BooleanField	UseSSL
static final IntField	WSTimeoutMillis

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

DEFAULT_VALUE, FORM_META_KEY, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor	Description
WSConnectionSettings()

Method Summary

Modifier and Type	Method	Description
boolean	fromPojo(GanSetupItem ganSetup)	Updates record settings, using a GanSetupItem for reference
Properties	getAllProperties(int index)	Returns a Properties object that can be used to completely recreate a WSConnectionSettings record from properties.
Properties	getConnectProperties()	Returns a Properties object that holds all properties needed to create a Metro Connection.
String	getDescription()
String	getFactoryId()
String	getHost()
Long	getId()
RecordMeta<WSConnectionSettings>	getMeta()	This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
String	getName()
int	getPort()
boolean	isEnabled()
boolean	isSSL()
GanSetupItem	toPojo()

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<WSConnectionSettings> META

Id

public static final IdentityField Id

Host

public static final StringField Host

Port

public static final IntField Port

Enabled

public static final BooleanField Enabled

UseSSL

public static final BooleanField UseSSL

Description

public static final StringField Description

PingRateMillis

public static final IntField PingRateMillis

PingTimeoutMillis

public static final IntField PingTimeoutMillis

PingMaxMissed

public static final IntField PingMaxMissed

WSTimeoutMillis

public static final IntField WSTimeoutMillis

HttpConnectTimeoutMillis

public static final IntField HttpConnectTimeoutMillis

HttpReadTimeoutMillis

public static final IntField HttpReadTimeoutMillis

Constructor Details

WSConnectionSettings

public WSConnectionSettings()

Method Details

getMeta

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

getName

public String getName()

getHost

public String getHost()

getPort

public int getPort()

isEnabled

public boolean isEnabled()

isSSL

public boolean isSSL()

getId

public Long getId()

getFactoryId

public String getFactoryId()

getDescription

public String getDescription()

getConnectProperties

public Properties getConnectProperties()
                                throws Exception

Returns a Properties object that holds all properties needed to create a Metro Connection.

Throws:

Exception

getAllProperties

public Properties getAllProperties(int index)

Returns a Properties object that can be used to completely recreate a WSConnectionSettings record from properties. Use the index to set which gan connection this represents in a file with many gan connections; e.g if the index is 0, then a property might be 'gateway.network.0.Host=localhost'

fromPojo

public boolean fromPojo(GanSetupItem ganSetup)

Updates record settings, using a GanSetupItem for reference

toPojo

public GanSetupItem toPojo()