Package energy.eddie.regionconnector.at.eda.ponton

Record Class PontonXPAdapterConfiguration

java.lang.Object
java.lang.Record
energy.eddie.regionconnector.at.eda.ponton.PontonXPAdapterConfiguration
Record Components:
adapterId - ID of the adapter that will be used by the Ponton XP Messenger. The value used for this should be configured as the default adapter in the messenger
adapterVersion - Version of the adapter.
hostname - Address of the Ponton XP Messenger
port - Port of the Ponton XP Messenger adapter interface (default: 2600)
apiEndpoint - API endpoint of the Ponton XP Messenger
workFolder - Path to the folder where the Ponton XP Adapter will store its files like id.dat which is used by the messenger to identify the adapter.
username - Username for the Ponton XP Messenger to use REST API endpoints that require authentication. Needs to be a user without 2FA activated.
password - Password for the given username.
inboundConnections - Expected amount of inbound WebSocket connections to the Ponton XP Messenger.
outboundConnections - Expected amount of outbound WebSocket connections to the Ponton XP Messenger.
connectionWatchdogInterval - How often the Ponton XP Messenger adapter WebSocket connection is checked.
connectionStatusTimeout - Maximum time after start or reconnect until a connection-status callback must be received.
@Validated @ConfigurationProperties("region-connector.at.eda.ponton.messenger") public record PontonXPAdapterConfiguration(String adapterId, String adapterVersion, String hostname, int port, String apiEndpoint, String workFolder, String username, String password, @jakarta.validation.constraints.Positive int inboundConnections, @jakarta.validation.constraints.Positive int outboundConnections, @DurationMin(nanos=1L) Duration connectionWatchdogInterval, @DurationMin(nanos=1L) Duration connectionStatusTimeout) extends Record
This record defines all information needed for a PontonXPAdapter to establish a connection to a Ponton XP Messenger.

  • Constructor Details

    • PontonXPAdapterConfiguration

      public PontonXPAdapterConfiguration(@Name("adapter.id") String adapterId, @Name("adapter.version") String adapterVersion, @Name("hostname") String hostname, @Name("port") int port, @Name("api.endpoint") String apiEndpoint, @Name("folder") String workFolder, @Name("username") String username, @Name("password") String password, @Name("inbound-connections") @Positive @DefaultValue("1") @jakarta.validation.constraints.Positive int inboundConnections, @Name("outbound-connections") @Positive @DefaultValue("1") @jakarta.validation.constraints.Positive int outboundConnections, @Name("connection-watchdog.interval") @DurationMin(nanos=1L) @DefaultValue("1m") @DurationMin(nanos=1L) Duration connectionWatchdogInterval, @Name("connection-watchdog.status-timeout") @DurationMin(nanos=1L) @DefaultValue("2m") @DurationMin(nanos=1L) Duration connectionStatusTimeout)
      Creates an instance of a PontonXPAdapterConfiguration record class.
      Parameters:
      adapterId - the value for the adapterId record component
      adapterVersion - the value for the adapterVersion record component
      hostname - the value for the hostname record component
      port - the value for the port record component
      apiEndpoint - the value for the apiEndpoint record component
      workFolder - the value for the workFolder record component
      username - the value for the username record component
      password - the value for the password record component
      inboundConnections - the value for the inboundConnections record component
      outboundConnections - the value for the outboundConnections record component
      connectionWatchdogInterval - the value for the connectionWatchdogInterval record component
      connectionStatusTimeout - the value for the connectionStatusTimeout 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • adapterId

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

    • adapterVersion

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

    • hostname

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

    • port

      public int port()
      Returns the value of the port record component.
      Returns:
      the value of the port record component

    • apiEndpoint

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

    • workFolder

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

    • username

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

    • password

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

    • inboundConnections

      @Positive public @jakarta.validation.constraints.Positive int inboundConnections()
      Returns the value of the inboundConnections record component.
      Returns:
      the value of the inboundConnections record component

    • outboundConnections

      @Positive public @jakarta.validation.constraints.Positive int outboundConnections()
      Returns the value of the outboundConnections record component.
      Returns:
      the value of the outboundConnections record component

    • connectionWatchdogInterval

      @DurationMin(nanos=1L) public @DurationMin(nanos=1L) Duration connectionWatchdogInterval()
      Returns the value of the connectionWatchdogInterval record component.
      Returns:
      the value of the connectionWatchdogInterval record component

    • connectionStatusTimeout

      @DurationMin(nanos=1L) public @DurationMin(nanos=1L) Duration connectionStatusTimeout()
      Returns the value of the connectionStatusTimeout record component.
      Returns:
      the value of the connectionStatusTimeout record component