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:

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

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

DEFAULT_VALUE, FORM_META_KEY, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor and Description
WSConnectionSettings()

Method Summary

Modifier and Type	Method and Description
void	fromPojo(GanSetupItem ganSetup) Updates record settings, using a GanSetupItem for reference
java.util.Properties	getAllProperties(int index) Returns a Properties object that can be used to completely recreate a WSConnectionSettings record from properties.
java.util.Properties	getConnectProperties() Returns a Properties object that holds all properties needed to create a Metro Connection.
java.lang.String	getFactoryId()
java.lang.String	getHost()
java.lang.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.
java.lang.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 Detail

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

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 Detail

WSConnectionSettings

public WSConnectionSettings()

Method Detail

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 java.lang.String getName()

getHost

public java.lang.String getHost()

getPort

public int getPort()

isEnabled

public boolean isEnabled()

isSSL

public boolean isSSL()

getId

public java.lang.Long getId()

getFactoryId

public java.lang.String getFactoryId()

getConnectProperties

public java.util.Properties getConnectProperties()
                                          throws java.lang.Exception

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

Throws:

java.lang.Exception

getAllProperties

public java.util.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 void fromPojo(GanSetupItem ganSetup)

Updates record settings, using a GanSetupItem for reference

toPojo

public GanSetupItem toPojo()