Package de.elo.mover.main

Class IXconnect

java.lang.Object
de.elo.mover.main.IXconnect
public class IXconnect
extends java.lang.Object

Überschrift: IXConnect.

Beschreibung: Klasse für eine Indexserver-Verbindung.

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

  • 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

    Modifier and Type Method Description
    void clearHeaderCache()
    Entfernt die einzelnen Einträge im Header-Cache.
    void clearTicketCache()
    Entfernt die einzelnen Einträge im Ticket-Cache.
    void closeIxThreadsPool()
    Beendet den Thread-Pool für die Indexserver-Aufrufe.
    void connect()
    Baut eine Indexserver-Verbindung aus den vorgegebenen Parametern auf.
    de.elo.ix.client.IXConnection createFromTicket​(java.lang.String ticket)
    Erzeugt eine Indexserver-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 setAddStartMaskWorkflowOption​(boolean addStartMaskFlowOption)
    Aktiviert die Indexserver-Option für den Workflowstart einer Maske.
    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 Indexserver-Verbindung und die lokalen Operationen
    void setIxPassword​(java.lang.String value)
    Setzt das angegebene Passwort für die Indexserver-Verbindung.
    void setIxUrl​(java.lang.String value)
    Setzt die angegebene Indexserver-URL.
    void setIxUser​(java.lang.String value)
    Setzt den angegebenen Anmeldenamen für die Indexserver-Verbindung.
    int verifyHeader​(java.lang.String basicAuthHeader)
    Erzeugt eine Indexserver-Sitzung aus dem angegebenen Basic Authentification Header.
    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 Datei "config.xml".

    Methods inherited from class java.lang.Object

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

  • Field Details

    • globF3

      public static int globF3

  • Constructor Details

    • 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 - Indexserver-Verbindung

    • IXconnect

      public IXconnect()
      Standardkonstruktor für eigenen Verbindungsaufbau.

  • Method Details

    • 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 Indexserver-URL.
      Parameters:
      value - Indexserver-URL

    • setIxUser

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

    • setIxPassword

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

    • setAddStartMaskWorkflowOption

      public void setAddStartMaskWorkflowOption​(boolean addStartMaskFlowOption)
      Aktiviert die Indexserver-Option für den Workflowstart einer Maske.
      Parameters:
      addStartMaskFlowOption - Workflow einer Maske starten

    • 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 Indexserver-Verbindung 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 Indexserver-Verbindung 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 Indexserver-Verbindung aus dem angegebenen Ticket.
      Parameters:
      ticket - ELOas Ticket
      Returns:
      Indexserver-Verbindung
      Throws:
      java.lang.Exception

    • verifyHeader

      public int verifyHeader​(java.lang.String basicAuthHeader) throws java.io.UnsupportedEncodingException, java.rmi.RemoteException
      Erzeugt eine Indexserver-Sitzung aus dem angegebenen Basic Authentification Header.
      Parameters:
      basicAuthHeader - Basic Authentification Header
      Returns:
      Benutzer-ID
      Throws:
      java.io.UnsupportedEncodingException
      java.rmi.RemoteException

    • 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 Datei "config.xml".
      Parameters:
      paramName - Name der Einstellung
      Returns:
      Aktueller Wert

    • closeIxThreadsPool

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

    • clearTicketCache

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

    • clearHeaderCache

      public void clearHeaderCache()
      Entfernt die einzelnen Einträge im Header-Cache.