Class ClientConnectionProperties


  • public class ClientConnectionProperties
    extends ConnectionProperties
    Diese Klasse enthält die Eigenschaften, die benötigt werden, um eine Verbindung zum Datenverteiler aufzubauen.
    • Method Detail

      • getCommunicationParameters

        public CommunicationParameters getCommunicationParameters()
        Gibt die Parameter für die Kommunikation zwischen Applikation und Datenverteiler zurück.
        Returns:
        die Parameter für die Kommunikation zwischen Applikation und Datenverteiler
      • getApplicationName

        public final java.lang.String getApplicationName()
        Gibt den Namen der Applikation zurück.
        Returns:
        der Name der Applikation
      • getIncarnationName

        public java.lang.String getIncarnationName()
        Liefert den via Aufrufparameter von Start/Stopp vorgegebenen Inkarnationsnamen.
        Returns:
        Inkarnationsname oder "", falls das entsprechende Aufrufargument nicht angegeben wurde.
      • setApplicationName

        public final void setApplicationName​(java.lang.String applicationName)
        Setzt den Namen der Applikation.
        Parameters:
        applicationName - Name der Applikation
      • getApplicationTypePid

        public final java.lang.String getApplicationTypePid()
        Gibt den Typ der Applikation zurück.
        Returns:
        Typ der Applikation
      • setApplicationTypePid

        public final void setApplicationTypePid​(java.lang.String applicationTypePid)
        Setzt den Typ der Applikation.
        Parameters:
        applicationTypePid - Typ der Applikation
      • getConfigurationPid

        public final java.lang.String getConfigurationPid()
        Gibt die Pid der Konfiguration zurück.
        Returns:
        die Pid der Konfiguration
      • setConfigurationPid

        public final void setConfigurationPid​(java.lang.String configurationPid)
        Setzt die Pid der Konfiguration.
        Parameters:
        configurationPid - Pid der Konfiguration
      • getCommunicationAddress

        public final java.lang.String getCommunicationAddress()
        Gibt die Kommunikationsadresse des Datenverteilers zurück.
        Returns:
        die Kommunikationsadresse
      • setCommunicationAddress

        public final void setCommunicationAddress​(java.lang.String address)
        Setzt die Kommunikationsadresse des Datenverteilers.
        Parameters:
        address - die Kommunikationsadresse des Datenverteilers
      • getCommunicationSubAddress

        public final int getCommunicationSubAddress()
        Gibt die Kommunikationssubadresse des Datenverteilers zurück.
        Returns:
        die Kommunikationssubadresse
      • setCommunicationSubAddress

        public final void setCommunicationSubAddress​(int subAddress)
        Setzt die Kommunikationssubadresse des Datenverteilers.
        Parameters:
        subAddress - die Kommunikationssubadresse
      • isSelfClientDavConnection

        public boolean isSelfClientDavConnection()
        Gibt true zurück, wenn es sich um die lokale Verbindung des Datenverteilers handelt
        Returns:
        true, wenn es sich um die lokale Verbindung des Datenverteilers handelt, sonst false
      • getPasswordIndex

        public int getPasswordIndex()
        Gibt den Einmalpasswortindex oder -1 für kein Einmalpasswort zurück
        Returns:
        den Einmalpasswortindex oder -1 für kein Einmalpasswort
      • setPasswordIndex

        public void setPasswordIndex​(int passwordIndex)
        Setzt den passwortindex
        Parameters:
        passwordIndex - Einmalpasswortindex oder -1 für kein Einmalpasswort
      • disconnect

        public void disconnect​(boolean error,
                               java.lang.String message,
                               DataTelegram terminationTelegram)
        Diese Methode wird von der Protokollschicht DaV-DAF aufgerufen, wenn die Kommunikationskanäle geschlossen werden sollen.
        Parameters:
        error - Besagt, ob es sich um eine Terminierung mit Fehler handelt.
        message - der Fehlertext
        terminationTelegram - Terminierungstelegramm
        Since:
        3.13