Package com.inductiveautomation.ignition.gateway.gan

Class WSConnectionSettings

  • All Implemented Interfaces:
    java.io.Serializable
    public class WSConnectionSettings
extends PersistentRecord
    Created by colby.clegg on 2/13/2015.
    See Also:
    Serialized Form

    • 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 boolean fromPojo​(GanSetupItem ganSetup)
        Updates record settings, using a GanSetupItem for reference