Package de.iip_ecosphere.platform.transport.connectors

Class TransportParameter

java.lang.Object
de.iip_ecosphere.platform.transport.connectors.TransportParameter
public class TransportParameter extends Object
Captures common transport parameter for all connector types. Connectors shall document which of the optional settings are required.
Author:
Holger Eichelberger, SSE

  • Field Details

    • host

      private String host

    • port

      private int port

    • actionTimeout

      private int actionTimeout

    • applicationId

      private String applicationId

    • autoApplicationId

      private boolean autoApplicationId

    • keepAlive

      private int keepAlive

    • keyAlias

      private String keyAlias

    • keystoreKey

      private String keystoreKey

    • hostnameVerification

      private boolean hostnameVerification

    • authenticationKey

      private String authenticationKey

    • qos

      private MqttQoS qos

    • closeAction

      private TransportParameter.CloseAction closeAction

  • Constructor Details

    • TransportParameter

      private TransportParameter(String host, int port)
      Creates a transport parameter instance.
      Parameters:
      host - the network name of the host
      port - the TCP communication port of the host

  • Method Details

    • getHost

      public String getHost()
      Returns the network name of the host.
      Returns:
      the name

    • getPort

      public int getPort()
      Returns the TCP communication port of the host.
      Returns:
      the port

    • getActionTimeout

      public int getActionTimeout()
      Returns the timeout for individual send/receive actions.
      Returns:
      the timeout in milliseconds

    • getKeepAlive

      public int getKeepAlive()
      Returns the time to keep a connection alive.
      Returns:
      the time in milliseconds

    • getApplicationId

      public String getApplicationId()
      Returns the unique application/client identifier.
      Returns:
      the unique application/client identifier

    • getAutoApplicationId

      public boolean getAutoApplicationId()
      Returns whether the application identification is expected to be unique or shall be made unique upon first connect. May be ignored if not applicable.
      Returns:
      true (default) for make unique, false else

    • getKeystoreKey

      public String getKeystoreKey()
      Returns the optional key to access the TLS keystore key to be obtained from IdentityStore.
      Returns:
      the (logical) key to access the keystore, may be null for none

    • getKeyAlias

      public String getKeyAlias()
      Returns the alias of the key in getKeystoreKey() to use.
      Returns:
      the alias or null for none/first match

    • getAuthenticationKey

      public String getAuthenticationKey()
      Returns the IdentityStore key for the authentication, usually a password token.
      Returns:
      the identity store key, may be empty or null

    • getHostnameVerification

      public boolean getHostnameVerification()
      Returns whether TLS hostname verification shall be performed.
      Returns:
      false for no verification (default), true else

    • getMqttQoS

      public MqttQoS getMqttQoS()
      Returns the MQTT QoS level (may not apply to other protocols).
      Returns:
      the QoS level

    • getCloseAction

      public TransportParameter.CloseAction getCloseAction()
      Returns the close action.
      Returns:
      the close action (default is TransportParameter.CloseAction.UNSUBSCRIBE)