Package com.inductiveautomation.ignition.gateway.model

Record Class WebServerDetails

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.model.WebServerDetails
Record Components:
address - The Hostname of the gateway. Determined by the Public Address setting or NIC detection
httpPort - The HTTP port of the server. May be empty if 'force secure redirect' is enabled, which guarantees a value for httpsPort
httpsPort - The HTTPS port of the server. May be empty if HTTPS has not been configured which guarantees a value for httpPort
public record WebServerDetails(String address, OptionalInt httpPort, OptionalInt httpsPort) extends Record
Web Server settings taking into account all of the web servers settings to provide connection details for the Gateway. HTTPS should be preferred if present.

  • Constructor Details

    • WebServerDetails

      public WebServerDetails(String address, OptionalInt httpPort, OptionalInt httpsPort)
      Creates an instance of a WebServerDetails record class.
      Parameters:
      address - the value for the address record component
      httpPort - the value for the httpPort record component
      httpsPort - the value for the httpsPort record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • address

      public String address()
      Returns the value of the address record component.
      Returns:
      the value of the address record component

    • httpPort

      public OptionalInt httpPort()
      Returns the value of the httpPort record component.
      Returns:
      the value of the httpPort record component

    • httpsPort

      public OptionalInt httpsPort()
      Returns the value of the httpsPort record component.
      Returns:
      the value of the httpsPort record component