Package de.elo.mover.main

Class IXconnect

  • public class IXconnect
extends java.lang.Object

    Überschrift: IXConnect.

    Beschreibung: Klasse für eine Index Server Verbindung.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018-2019

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int globF3  

    • Constructor Summary

      Constructors 
      Constructor Description
      IXconnect()
      Standardkonstruktor für eigenen Verbindungsaufbau
      IXconnect​(de.elo.ix.client.IXConnection connection)
      Kontruktor für die Verwendungen einer bestehenden Verbindung.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearTicketCache()
      Entfernt die einzelnen Einträge im Ticket Cache.
      void closeIxThreadsPool()
      Beendet den Thread-Pool für die Index Server Aufrufe.
      void connect()
      Baut eine Indexserververbindung aus den vorgegebenen Parametern auf.
      de.elo.ix.client.IXConnection createFromTicket​(java.lang.String ticket)
      Erzeugt eine Index Server Verbindung aus dem angegebenen Ticket.
      java.lang.String decryptAs​(java.lang.String encryptedPassword)
      Entschlüsselt ein ELOas Passwort.
      void disconnect()
      Beendet die Verbindung zum Indexserver.
      de.elo.ix.client.IXConnection getClient()
      Gibt das IXClient Objekt der aktuellen Verbindung zurück
      int getUserId()
      Gibt die Anwendernummer des aktuell angemeldeten Anwenders zurück oder -1 wenn keine Anmeldung aktiv ist.
      void setContext​(WebAppContextParam webAppContextParam)
      Speichert die Konfigurationseinstellungen für den Skript Zugriff
      void setIxLocale​(java.lang.String value)
      Bestimmt das Ländereinstellung für die Indexserververbindung und die lokalen Operationen
      void setIxPassword​(java.lang.String value)
      Setzt das angegebene Passwort für die Indexserververbindung.
      void setIxUrl​(java.lang.String value)
      Setzt die angegebene Index Server URL.
      void setIxUser​(java.lang.String value)
      Setzt den angegebenen Anmeldenamen für die Indexserververbindung.
      int verifyTicket​(java.lang.String ticket)
      Erzeugt eine IX Sitzung aus einem bestehenden ELOas Ticket.
      java.lang.String WEGgetParamValue​(java.lang.String paramName)
      Liest eine Configurationseinstellung, für den Skript Zugriff auf die config.xml Datei

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • globF3

        public static int globF3

    • Constructor Detail

      • IXconnect

        public IXconnect​(de.elo.ix.client.IXConnection connection)
        Kontruktor für die Verwendungen einer bestehenden Verbindung. Wenn diese Form verwendet wird, dann sind die lokalen connect und disconnect Methoden ohne Funktion, da die Verbindung an einer anderen Stelle verwaltet wird.
        Parameters:
        connection - Index Server Verbindung

      • IXconnect

        public IXconnect()
        Standardkonstruktor für eigenen Verbindungsaufbau

    • Method Detail

      • getClient

        public de.elo.ix.client.IXConnection getClient()
        Gibt das IXClient Objekt der aktuellen Verbindung zurück
        Returns:
        IXClient

      • setContext

        public void setContext​(WebAppContextParam webAppContextParam)
        Speichert die Konfigurationseinstellungen für den Skript Zugriff
        Parameters:
        webAppContextParam - Parameter der Webanwendung

      • setIxUrl

        public void setIxUrl​(java.lang.String value)
        Setzt die angegebene Index Server URL.
        Parameters:
        value - Index Server URL

      • setIxUser

        public void setIxUser​(java.lang.String value)
        Setzt den angegebenen Anmeldenamen für die Indexserververbindung.
        Parameters:
        value - Benutzer

      • setIxPassword

        public void setIxPassword​(java.lang.String value)
        Setzt das angegebene Passwort für die Indexserververbindung.
        Parameters:
        value - Passwort

      • decryptAs

        public java.lang.String decryptAs​(java.lang.String encryptedPassword)
        Entschlüsselt ein ELOas Passwort. Achtung: es wird ein anderer DES Schlüssel als bei ELO Passwörtern verwendet!
        Parameters:
        encryptedPassword - Passwort zum entschlüsseln
        Returns:
        entschlüsseltes Passwort

      • setIxLocale

        public void setIxLocale​(java.lang.String value)
        Bestimmt das Ländereinstellung für die Indexserververbindung und die lokalen Operationen
        Parameters:
        value - Ländereinstellung

      • getUserId

        public int getUserId()
        Gibt die Anwendernummer des aktuell angemeldeten Anwenders zurück oder -1 wenn keine Anmeldung aktiv ist.
        Returns:
        Anwendernummer

      • connect

        public void connect()
             throws java.rmi.RemoteException
        Baut eine Indexserververbindung aus den vorgegebenen Parametern auf.
        Throws:
        java.rmi.RemoteException

      • verifyTicket

        public int verifyTicket​(java.lang.String ticket)
                 throws java.rmi.RemoteException
        Erzeugt eine IX Sitzung aus einem bestehenden ELOas Ticket.
        Parameters:
        ticket - ELOas Ticket
        Returns:
        Benutzer ID
        Throws:
        java.rmi.RemoteException

      • createFromTicket

        public de.elo.ix.client.IXConnection createFromTicket​(java.lang.String ticket)
                                               throws java.lang.Exception
        Erzeugt eine Index Server Verbindung aus dem angegebenen Ticket.
        Parameters:
        ticket - ELOas Ticket
        Returns:
        Index Server Verbindung
        Throws:
        java.lang.Exception

      • disconnect

        public void disconnect()
        Beendet die Verbindung zum Indexserver. Falls das Fehlschlägt (z.B. wegen eines externen Verbindungsabbruchs) wird kein Fehler gemeldet.

      • WEGgetParamValue

        public java.lang.String WEGgetParamValue​(java.lang.String paramName)
        Liest eine Configurationseinstellung, für den Skript Zugriff auf die config.xml Datei
        Parameters:
        paramName - Name der Einstellung
        Returns:
        aktueller Wert

      • closeIxThreadsPool

        public void closeIxThreadsPool()
        Beendet den Thread-Pool für die Index Server Aufrufe.

      • clearTicketCache

        public void clearTicketCache()
        Entfernt die einzelnen Einträge im Ticket Cache.