public class PuaClient
extends java.lang.Object
implements java.lang.AutoCloseable
Modifier and Type | Field and Description |
---|---|
static int |
CURRENT_PROTOCOL_VERSION
Unterstütze Protokoll-Version des Clients
|
static byte |
INVALID_STATUS
Status der Protokollerstellung konnte nicht abgefragt werden.
|
de.bsvrz.dav.daf.main.config.DynamicObject |
recentlyCreatedScript
Zuletzt automatisch angelegtes Skriptobjekt.
|
long |
recentRequestId
Anfrage-Id des letzten Auftrags zur Protokollerstellung.
|
Constructor and Description |
---|
PuaClient(de.bsvrz.dav.daf.main.ClientDavInterface dav,
de.bsvrz.dav.daf.main.config.ConfigurationAuthority configAuth) |
Modifier and Type | Method and Description |
---|---|
ProtocolRequestResult |
abortProtocol(long jobId)
Bricht eine protokollbezogene Operation ab.
|
ProtocolRequestResult |
abortProtocol(long jobId,
boolean resumeSaving)
Bricht eine protokollbezogene Operation ab.
|
ProtocolRequestResult |
addProtocolListener(ProtocolListener listener)
Meldet einen Empfänger an, der über fertiggestellte Protokolle informiert wird
|
ProtocolRequestResult |
addProtocolListener(ProtocolListenerEx listener)
Meldet einen Empfänger an, der über fertiggestellte Protokolle informiert wird
|
boolean |
addStatusListener(StatusListener listener)
Fügt einen Listener hinzu, mit dem sich der Anwender über Änderungen am Verfügbarkeitszustand von PuA
und dem von PuA verwendeten Archivsystem informieren kann.
|
void |
close()
Gibt belegte Ressourcen frei und meldet Datenverteiler-Anmeldungen ab.
|
ProtocolResultStream |
createProtocol(ProcessingParameter pp)
Stößt die Protokollerstellung an.
|
ProtocolRequestResult |
createScript(de.bsvrz.dav.daf.main.config.DynamicObject script,
de.bsvrz.sys.funclib.losb.datk.AtlBase baseInfo,
java.lang.String source)
Sendet den Auftrag 'Skript anlegen/editieren'.
|
ProtocolRequestResult |
createScript(java.lang.String pid,
java.lang.String name,
de.bsvrz.sys.funclib.losb.datk.AtlBase baseInfo,
java.lang.String source)
Sendet den Auftrag 'Skript anlegen/editieren'.
|
ProtocolRequestResult |
deleteSaveProtocol(long protocolId)
Löscht ein gespeichertes Protokoll.
|
ProtocolRequestResult |
deleteScript(de.bsvrz.dav.daf.main.config.DynamicObject script)
Entfernt ein Skriptobjekt und den zugehörigen Skriptquelltext.
|
ProtocolRequestResult |
getDefaults(de.bsvrz.dav.daf.main.config.DynamicObject script,
de.bsvrz.sys.funclib.losb.datk.AtlDefaults defaults,
de.bsvrz.sys.funclib.losb.datk.AtlMeta meta)
Liefert die Standardwerte und die definierbaren Aspekte/Aliase eines Skripts zurück.
|
int |
getFlowControlWindowSize()
Gibt die Größe des "Sliding Window" für die automatische Flusskontrolle zurück
|
boolean |
getIsActive(ProtocolRequestResult resultInfo)
Deprecated.
Kann durch die Funktionen isPuaOnline() und isArchiveOnline() ersetzt werden, die detaillierte Informationen bieten
|
java.util.List<JobInProgress> |
getJobList(ProtocolRequestResult resultInfo)
Ruft eine liste mit aktuell in Bearbeitung befindlichen Aufträgen ab.
|
ProtocolResultStream |
getProtocol(long protocolId,
boolean read)
Fragt ein bereits gespeichertes bzw. noch nicht abgerufenens Protokoll ab.
|
ProtocolResultStream |
getSavedProtocol(long protocolId)
Fragt ein bereits gespeichertes Protokoll ab.
|
de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,ProcessingParameter>[] |
getSavedProtocolList(ProtocolRequestResult resultInfo,
java.lang.String user)
Liefert eine Liste der gespeicherten Protokolle und Protokollinformationen.
|
int |
getServerProtocolVersion()
Gibt die vom Server aktuell unterstützte Protokollversion zurück.
|
ProtocolRequestResult |
getSource(de.bsvrz.dav.daf.main.config.DynamicObject script,
java.lang.StringBuffer source,
de.bsvrz.sys.funclib.losb.datk.AtlMeta meta)
Liefert den Quelltext eines Skripts zurück.
|
byte |
getStatus(long jobId,
ProtocolRequestResult resultInfo)
Liefert den Status der Protokollerstellung.
|
ProtocolResultStream |
getUnreadProtocol(long protocolId)
Fragt ein noch nicht abgerufenes gespeichertes Protokoll ab.
|
de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,ProcessingParameter>[] |
getUnreadProtocolList(ProtocolRequestResult resultInfo,
java.lang.String user)
Liefert eine Liste der noch nicht abgerufenen Protokolle und Protokollinformationen.
|
boolean |
isArchiveOnline()
Gibt true zurück, wenn PuA erreichbar ist und PuA das Archiv erreichen kann.
|
boolean |
isPuaOnline()
Gibt true zurück, wenn PuA erreichbar ist
|
ProtocolRequestResult |
removeProtocolListener(ProtocolListener listener)
Meldet einen Empfänger ab, der über fertiggestellte Protokolle informiert wurde
|
ProtocolRequestResult |
removeProtocolListener(ProtocolListenerEx listener)
Meldet einen Empfänger ab, der über fertiggestellte Protokolle informiert wurde
|
boolean |
removeStatusListener(StatusListener listener)
Entfernt einen, mit dem sich der Anwender über Änderungen am Verfügbarkeitszustand von PuA
und dem von PuA verwendeten Archivsystem informieren kann
|
ProtocolRequestResult |
resumeProtocol(long jobId)
Deprecated.
Diese Methode war zur Flusskontrolle gedacht und wird nicht mehr benötigt, weil mittlerweile eine automatische Flusskontrolle zwischen
PuA-Server und -Client implementiert ist.
|
void |
setFlowControlWindowSize(int flowControlWindowSize)
Setzt die Größe des "Sliding Window" für die automatische Flusskontrolle.
|
void |
setTimeout(long timeout)
Maximale Wartezeit in ms, bis eine Antwort eingetroffen sein muss.
|
ProtocolRequestResult |
suspendProtocol(long jobId)
Deprecated.
Diese Methode war zur Flusskontrolle gedacht und wird nicht mehr benötigt, weil mittlerweile eine automatische Flusskontrolle zwischen
PuA-Server und -Client implementiert ist.
|
java.lang.String |
toString() |
public static final int CURRENT_PROTOCOL_VERSION
public static final byte INVALID_STATUS
public de.bsvrz.dav.daf.main.config.DynamicObject recentlyCreatedScript
createScript(DynamicObject,AtlBase,String)
und createNewScriptObject(String,String)
gesetzt.public long recentRequestId
createProtocol(ProcessingParameter)
gesetzt.public PuaClient(de.bsvrz.dav.daf.main.ClientDavInterface dav, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configAuth) throws ScopeException, de.bsvrz.dav.daf.main.config.ConfigurationException
dav
- Verbindung zum Datneverteiler.configAuth
- Konfigurationsverantwortlicher, der verwendet wird.ScopeException
- Anfrage wird vom Konfigurationsverantwortlichen nicht unterstützt.de.bsvrz.dav.daf.main.config.ConfigurationException
- Fehler bei der Kommunikation mit der Konfigurationpublic void setTimeout(long timeout)
timeout
- Maximale Wartezeit, bis eine Antwort eingetroffen sein muss.public ProtocolResultStream createProtocol(ProcessingParameter pp) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
pp
- Auftragsparameterde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolRequestResult addProtocolListener(ProtocolListenerEx listener) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
listener
- Empfängerde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exceptionpublic ProtocolRequestResult removeProtocolListener(ProtocolListenerEx listener) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
listener
- Empfängerde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exceptionpublic ProtocolRequestResult addProtocolListener(ProtocolListener listener) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
listener
- Empfänger. Für erweiterte Benachrichtigungen kann und sollte hier eine Instanz von ProtocolListenerEx
statt ProtocolListener
verwendet
werden.de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exceptionpublic boolean addStatusListener(StatusListener listener)
listener
- Listener-Interface (nicht null)public boolean removeStatusListener(StatusListener listener)
listener
- Listener-Interface (nicht null)public ProtocolRequestResult removeProtocolListener(ProtocolListener listener) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
listener
- Empfängerde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exceptionpublic ProtocolResultStream getSavedProtocol(long protocolId) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
protocolId
- Protokoll-Id des gespeicherten Protokolls.de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolResultStream getUnreadProtocol(long protocolId) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
protocolId
- Protokoll-Id des gespeicherten Protokolls.de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolResultStream getProtocol(long protocolId, boolean read) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
protocolId
- Protokoll-Id des gespeicherten Protokolls.read
- true
gespeicherte Protokolle abrufen. false
noch nicht abgerufene Protokolle senden.de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler beim Absetzen der Anfrage.@Deprecated public ProtocolRequestResult suspendProtocol(long jobId) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
jobId
- Auftrags-ID des anzuhaltenden Auftrags. Bei Protokollerstellungsaufträgen identisch mit Protokoll-ID.
Die Auftrags-ID kann über ProtocolResultStream.getJobId()
oder getJobList(de.bsvrz.pua.prot.util.ProtocolRequestResult)
abgerufen werden.de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler bei der Kommunikation mit der Konfiguration.@Deprecated public ProtocolRequestResult resumeProtocol(long jobId) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
jobId
- Auftrags-ID des fortzusetzenden Auftrags. Bei Protokollerstellungsaufträgen identisch mit Protokoll-ID.
Die Auftrags-ID kann über ProtocolResultStream.getJobId()
oder getJobList(de.bsvrz.pua.prot.util.ProtocolRequestResult)
abgerufen werden.de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler bei der Kommunikation mit der Konfiguration.public ProtocolRequestResult abortProtocol(long jobId)
ProtocolResultStream.take()
liefert nach dem Abbrechen null
und ProtocolResultStream.hasNext()
true
zurück.jobId
- Auftrags-ID des abzubrechenden Auftrags. Bei Protokollerstellungsaufträgen identisch mit Protokoll-ID.
Die Auftrags-ID kann über ProtocolResultStream.getJobId()
oder getJobList(ProtocolRequestResult)
abgerufen werden.public ProtocolRequestResult abortProtocol(long jobId, boolean resumeSaving)
ProtocolResultStream.take()
liefert nach dem Abbrechen null
und ProtocolResultStream.hasNext()
true
zurück.jobId
- Auftrags-ID des abzubrechenden Auftrags. Bei Protokollerstellungsaufträgen identisch mit Protokoll-ID.
Die Auftrags-ID kann über ProtocolResultStream.getJobId()
oder getJobList(ProtocolRequestResult)
abgerufen werden.resumeSaving
- Falls es sich um einen Auftrag zur Protokollerstellung handelt: Soll das Protokoll trotzdem gespeichert werden? Es wird dann nur die
Übertragung des Protokolls abgebrochen. True wird nur von PuA-Versionen ab 2.9.0 unterstützt.public byte getStatus(long jobId, ProtocolRequestResult resultInfo)
jobId
- Auftrags-ID des abzurufenden Auftrags. Bei Protokollerstellungsaufträgen identisch mit Protokoll-ID.
Die Auftrags-ID kann über ProtocolResultStream.getJobId()
oder getJobList(de.bsvrz.pua.prot.util.ProtocolRequestResult)
abgerufen werden.resultInfo
- Informationen über den Ablauf der Aktion. Kann null
sein.@Deprecated public boolean getIsActive(ProtocolRequestResult resultInfo)
resultInfo
- Ergebnis der Anfrage, seit PuA 2.9.0 immer erfolgreichpublic boolean isPuaOnline()
public boolean isArchiveOnline()
public de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,ProcessingParameter>[] getSavedProtocolList(ProtocolRequestResult resultInfo, java.lang.String user)
resultInfo
- In diesem Objekt werden Fehlermeldungen abgelegt.user
- Benutzer, für den die Anfrage ausgeführt wird. (kann null oder ein Leerstring sein, dann werden keine benutzerspezifischen Skripte zurückgegeben)null
bei Fehler.public de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,ProcessingParameter>[] getUnreadProtocolList(ProtocolRequestResult resultInfo, java.lang.String user)
resultInfo
- In diesem Objekt werden Fehlermeldungen abgelegt.user
- Benutzer, für den die Anfrage ausgeführt wird. (kann null oder ein Leerstring sein, dann werden keine benutzerspezifischen Protokolle zurückgegeben)null
bei Fehler.public ProtocolRequestResult deleteSaveProtocol(long protocolId)
protocolId
- Protokoll das gelöscht werden soll.public ProtocolRequestResult createScript(java.lang.String pid, java.lang.String name, de.bsvrz.sys.funclib.losb.datk.AtlBase baseInfo, java.lang.String source)
recentlyCreatedScript
abgelegt.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.public ProtocolRequestResult createScript(de.bsvrz.dav.daf.main.config.DynamicObject script, de.bsvrz.sys.funclib.losb.datk.AtlBase baseInfo, java.lang.String source)
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.public ProtocolRequestResult getSource(de.bsvrz.dav.daf.main.config.DynamicObject script, java.lang.StringBuffer source, de.bsvrz.sys.funclib.losb.datk.AtlMeta meta)
script
- Skriptobjekt dessen Quelltext geliefert werden soll.source
- Buffer, in den der Skriptquelltext abgelegt wird.meta
- Metainformationen über das Skript.public ProtocolRequestResult getDefaults(de.bsvrz.dav.daf.main.config.DynamicObject script, de.bsvrz.sys.funclib.losb.datk.AtlDefaults defaults, de.bsvrz.sys.funclib.losb.datk.AtlMeta meta)
script
- Skriptobjekt dessen Standardwerte geliefert werden sollen.defaults
- Hier werden die Standardwerte abgelegt. Es ist ein leeres AtlDefaults-Objekt zu übergeben.meta
- Hier werden die Metainformationen über das Skript abgelegt. Es ist ein leeres AtlMeta-Objekt zu übergeben.public ProtocolRequestResult deleteScript(de.bsvrz.dav.daf.main.config.DynamicObject script)
script
- Skriptobjekt das gelöscht wird.public java.util.List<JobInProgress> getJobList(ProtocolRequestResult resultInfo)
resultInfo
- Wird mit Ergebnis der Operation belegt. Darf null sein.abortProtocol(long)
abgebrochen werden kann.public int getFlowControlWindowSize()
public void setFlowControlWindowSize(int flowControlWindowSize)
flowControlWindowSize
- Maximale Anzahl Protokoll-Ergebnis-Datensätze, die gleichzeitig von PuA-Server bis zum PuaClient gesendet werden.
Auf 0 setzen um Flusskontrolle abzuschalten.public void close()
close
in interface java.lang.AutoCloseable
public int getServerProtocolVersion()
public java.lang.String toString()
toString
in class java.lang.Object