de.bsvrz.pua.prot.client
Class PuaClient

java.lang.Object
  extended by de.bsvrz.pua.prot.client.PuaClient

public class PuaClient
extends java.lang.Object

Schnittstelle des Clients zu Protokolle und Auswertungen. Vereinfacht das das Stellen von Anfragen an Pua.

Version:
$Revision: 1.2 $ / $Date: 2008/01/22 16:55:50 $ / ($Author: yvonnes $)
Author:
beck et al. projects GmbH, Martin Hilgers

Field Summary
static byte INVALID_STATUS
          Status der protokollerstellung konnt enicht abgefragt werden.
 DynamicObject recentlyCreatedScript
          Zuletzt automatisch angelegtes Skriptobjekt.
 long recentRequestId
          Anfrage-Id des letzten Auftrags zur Protokollerstellung.
 
Constructor Summary
PuaClient(ClientDavInterface dav, ConfigurationAuthority configAuth)
           
 
Method Summary
 ProtocolRequestResult abortProtocol(long protocolId)
          Bricht die Protokollerstellung ab.
 ProtocolResultStream createProtocol(ProcessingParameter pp)
          Stößt die Protokollerstellung an.
 ProtocolRequestResult createScript(DynamicObject script, AtlBase baseInfo, java.lang.String source)
          Sendet den Auftrag 'Skript anlegen/editieren'.
 ProtocolRequestResult createScript(java.lang.String pid, java.lang.String name, AtlBase baseInfo, java.lang.String source)
          Sendet den Auftrag 'Skript anlegen/editieren'.
 ProtocolRequestResult deleteSaveProtocol(long protocolId)
          Löscht ein gespeichertes Protokoll.
 ProtocolRequestResult deleteScript(DynamicObject script)
          Entfernt ein Skriptobjekt und den zugehörigen Skriptquelltext.
 ProtocolResultStream getProtocol(long protocolId, boolean read)
          Fragt ein bereits gespeichertes bzw.
 ProtocolResultStream getSavedProtocol(long protocolId)
          Fragt ein bereits gespeichertes Protokoll ab.
 Tuple<java.lang.Long,ProcessingParameter>[] getSavedProtocolList(ProtocolRequestResult resultInfo)
          Liefert eine Liste der gespeicherten Protokolle und Protokollinformationen.
 ProtocolRequestResult getSource(DynamicObject script, java.lang.StringBuffer source, AtlMeta meta)
          Liefert den Quelltext eines Skripts zurück.
 byte getStatus(long protocolId, ProtocolRequestResult resultInfo)
          Liefert den Status der Protokollerstellung.
 ProtocolResultStream getUnreadProtocol(long protocolId)
          Fragt ein noch nicht abgerufenes gespeichertes Protokoll ab.
 Tuple<java.lang.Long,ProcessingParameter>[] getUnreadProtocolList(ProtocolRequestResult resultInfo)
          Liefert eine Liste der noch nicht abgerufenen Protokolle und Protokollinformationen.
 ProtocolRequestResult resumeProtocol(long protocolId)
          Setzt die Protokollerstellung fort.
 void setTimeout(long timeout)
          Maximale Wartezeit in ms, bis eine Antwort eingetroffen sein muss.
 ProtocolRequestResult suspendProtocol(long protocolId)
          Hält die Protokollerstellung an.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INVALID_STATUS

public static final byte INVALID_STATUS
Status der protokollerstellung konnt enicht abgefragt werden.

See Also:
Constant Field Values

recentlyCreatedScript

public DynamicObject recentlyCreatedScript
Zuletzt automatisch angelegtes Skriptobjekt. Wird von createScript(DynamicObject, AtlBase, String) und createNewScriptObject(String, String) gesetzt.


recentRequestId

public long recentRequestId
Anfrage-Id des letzten Auftrags zur Protokollerstellung. Wird durch createProtocol(ProcessingParameter) gesetzt.

Constructor Detail

PuaClient

public PuaClient(ClientDavInterface dav,
                 ConfigurationAuthority configAuth)
          throws ScopeException,
                 ConfigurationException
Parameters:
dav - Verbindung zum Datneverteiler.
configAuth - Konfigurationsverantwortlicher, der verwendet wird.
Throws:
ScopeException - Anfrage wird vom Konfigurationsverantwortlichen nicht unterstützt.
ConfigurationException - Fehler bei der Kommunikation mit der Konfiguration
Method Detail

setTimeout

public void setTimeout(long timeout)
Maximale Wartezeit in ms, bis eine Antwort eingetroffen sein muss. Default: 60s.

Parameters:
timeout - Maximale Wartezeit, bis eine Antwort eingetroffen sein muss.

createProtocol

public ProtocolResultStream createProtocol(ProcessingParameter pp)
                                    throws FailureException
Stößt die Protokollerstellung an. Fängt alle(!) Exceptions ab.

Parameters:
pp - Auftragsparameter
Returns:
Objekt zum Abfragen der Antwort.
Throws:
FailureException - Fehler beim Absetzen der Anfrage.

getSavedProtocol

public ProtocolResultStream getSavedProtocol(long protocolId)
                                      throws FailureException
Fragt ein bereits gespeichertes Protokoll ab.

Parameters:
protocolId - Protokoll-Id des gespeicherten Protokolls.
Returns:
Objekt zum Abfragen der Antwort.
Throws:
FailureException - Fehler beim Absetzen der Anfrage.

getUnreadProtocol

public ProtocolResultStream getUnreadProtocol(long protocolId)
                                       throws FailureException
Fragt ein noch nicht abgerufenes gespeichertes Protokoll ab.

Parameters:
protocolId - Protokoll-Id des gespeicherten Protokolls.
Returns:
Objekt zum Abfragen der Antwort.
Throws:
FailureException - Fehler beim Absetzen der Anfrage.

getProtocol

public ProtocolResultStream getProtocol(long protocolId,
                                        boolean read)
                                 throws FailureException
Fragt ein bereits gespeichertes bzw. noch nicht abgerufenens Protokoll ab.

Parameters:
protocolId - Protokoll-Id des gespeicherten Protokolls.
read - true gespeicherte Protokolle abrufen. false noch nicht abgerufene Protokolle senden.
Returns:
Objekt zum Abfragen der Antwort.
Throws:
FailureException - Fehler beim Absetzen der Anfrage.

suspendProtocol

public ProtocolRequestResult suspendProtocol(long protocolId)
                                      throws FailureException
Hält die Protokollerstellung an.

Parameters:
protocolId - Protokoll-Id
Returns:
Informationen über das Absetzen der Anfrage.
Throws:
FailureException - Fehler bei der Kommunikation mit der Konfiguration.

resumeProtocol

public ProtocolRequestResult resumeProtocol(long protocolId)
                                     throws FailureException
Setzt die Protokollerstellung fort.

Parameters:
protocolId - Protokoll-Id
Returns:
Informationen über das Absetzen der Anfrage.
Throws:
FailureException - Fehler bei der Kommunikation mit der Konfiguration.

abortProtocol

public ProtocolRequestResult abortProtocol(long protocolId)
Bricht die Protokollerstellung ab. Wartet, bis die Protokollerstellung eine Quittung sendet. ProtocolResultStream.take() liefert null und ProtocolResultStream.hasNext() true zurück.

Parameters:
protocolId - Protokoll-Id
Returns:
Informationen über das Absetzen der Anfrage. Positive Quittung nur dann, wenn die Protokollerstellung abgebrochen wurde.

getStatus

public byte getStatus(long protocolId,
                      ProtocolRequestResult resultInfo)
Liefert den Status der Protokollerstellung.

Parameters:
protocolId - Protokoll-Id.
resultInfo - Informationen über den Ablauf der Aktion. Kann null sein.
Returns:
Status der Protokollerstellung. -1 bei Fehler.

getSavedProtocolList

public Tuple<java.lang.Long,ProcessingParameter>[] getSavedProtocolList(ProtocolRequestResult resultInfo)
Liefert eine Liste der gespeicherten Protokolle und Protokollinformationen.

Parameters:
resultInfo - In diesem Objekt werden Fehlermeldungen abgelegt.
Returns:
Array mit Ids der gespeicherten Protokolle oder null bei Fehler.

getUnreadProtocolList

public Tuple<java.lang.Long,ProcessingParameter>[] getUnreadProtocolList(ProtocolRequestResult resultInfo)
Liefert eine Liste der noch nicht abgerufenen Protokolle und Protokollinformationen.

Parameters:
resultInfo - In diesem Objekt werden Fehlermeldungen abgelegt.
Returns:
Array mit Ids der gespeicherten Protokolle oder null bei Fehler.

deleteSaveProtocol

public ProtocolRequestResult deleteSaveProtocol(long protocolId)
Löscht ein gespeichertes Protokoll.

Parameters:
protocolId - Protokoll das gelöscht werden soll.
Returns:
Informationen über den Ausgang des Löschvorgangs.

createScript

public ProtocolRequestResult createScript(java.lang.String pid,
                                          java.lang.String name,
                                          AtlBase baseInfo,
                                          java.lang.String source)
Sendet den Auftrag 'Skript anlegen/editieren'. Wartet auf eine Antwort von PuA. Behandelt alle(!) Exceptions. Wertet nur die erste Antwort aus, und beendet danach den Empfang von Daten. Es wird zweimal versucht, die Anfrage an PuA zu senden. Dies hat den Grund, dass, falls von createScript auch das dynamische Skriptobjekt erzeugt wurde, PuA eine gewisse Zeit gegeben werde muss, um sich als Empfänger auf dieses Skriptobjekt anzumelden. Das Skriptobjekt wird zudem in recentlyCreatedScript abgelegt.

Parameters:
pid - Pid des Skriptobjekts, das angelegt / editiert werden soll. Sollte nicht null sein. Existiert noch kein Skriptobjekt mit der übergebenen pid, so wird eins angelegt.
name - Name des Skripts.
baseInfo - Grundinformationen.
source - Skript Quelltext.
Returns:
Ergebnis der Anfrage.

createScript

public ProtocolRequestResult createScript(DynamicObject script,
                                          AtlBase baseInfo,
                                          java.lang.String source)
Sendet den Auftrag 'Skript anlegen/editieren'. Wartet auf eine Antwort von PuA. Behandelt alle(!) Exceptions. Wertet nur die erste Antwort aus, und beendet danach den Empfang von Daten. Es wird zweimal versucht, die Anfrage an PuA zu senden. Dies hat den Grund, dass, falls von createScript auch das dynamische Skriptobjekt erzeugt wurde, PuA eine gewisse Zeit gegeben werde muss, um sich als Empfänger auf dieses Skriptobjekt anzumelden.

Parameters:
script - Skriptobjekt das angelegt / editiert werden soll. Kann null sein. Dann wird ein neues Skriptobjekt erzeugt. Der Name des erzeugten Skriptobjekts ist das aktuelle Datum + Zeit. Auf das Skriptobjekt kann durch recentlyCreatedScript zugegriffen werden.
baseInfo - Grundinformationen.
source - Skript Quelltext.
Returns:
Ergebnis der Anfrage.

getSource

public ProtocolRequestResult getSource(DynamicObject script,
                                       java.lang.StringBuffer source,
                                       AtlMeta meta)
Liefert den Quelltext eines Skripts zurück. Blockiert, bis die Antwort eintrifft. Sendet die Anfrage als einfacher Sender.

Parameters:
script - Skriptobjekt dessen Quelltext geliefert werden soll.
source - Buffer, in den der Skriptquelltext abgelegt wird.
meta - Metainformationen über das Skript.
Returns:
Ergebnis der Operation.

deleteScript

public ProtocolRequestResult deleteScript(DynamicObject script)
Entfernt ein Skriptobjekt und den zugehörigen Skriptquelltext. Löscht Skript aus der Menge der Skriptobjekte.

Parameters:
script - Skriptobjekt das gelöscht wird.
Returns:
Ergebnis der Anfrage


Copyright © 2005-2008 beck et al. projects GmbH All Rights Reserved.