public class ProtocolResultStream
extends java.lang.Object
implements java.lang.AutoCloseable
Modifier and Type | Field and Description |
---|---|
protected ProtocolAdministrationData |
_protocolAdministrationData |
protected ProtocolAggregationData |
_protocolAggregationData |
Constructor and Description |
---|
ProtocolResultStream(ProtocolAnswerReceiver receiver,
ProtocolRequestResult result,
PuaClient puaClient) |
Modifier and Type | Method and Description |
---|---|
void |
abort()
Deprecated.
Unklarer Name, da die Protokollerstellung nciht abgebrochen wird, sodnern nur der Abruf der Daten. Durch
close() ersetzt. |
int |
bufferedDataSize()
Liefert die Anzahl der im Client-Puffer liegenden Datensätze.
|
void |
close()
Beendet die Übertragung der Protokolldaten.
|
java.lang.String |
getErrorMsg() |
java.lang.Long |
getJobId()
Liefert die Auftrags-Id.
|
java.lang.Long |
getProtocolId()
Deprecated.
Diese Methode liefert nicht mehr die Protokoll-Id, sondern die eindeutige ID des protokollbezogenen Auftrags
|
boolean |
hasNext()
Zeigt an dass keine weiteren Ergebnisdatensätze mehr eintreffen werden.
|
boolean |
isComplete()
Zeigt an ob das Protokoll vollständig und erfolgreich übertragen wurde.
|
boolean |
isRequestSuccessful()
Zeigt den Status der Aktion ab.
|
ProtocolResult |
take()
Liefert jeweils einen Antwortdatensatz.
|
java.lang.String |
toString() |
boolean |
wasAborted()
Zeigt ob die Protokollerstellung abgebrochen wurde.
|
protected ProtocolAdministrationData _protocolAdministrationData
protected ProtocolAggregationData _protocolAggregationData
public ProtocolResultStream(ProtocolAnswerReceiver receiver, ProtocolRequestResult result, PuaClient puaClient) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
receiver
- Empfänger der Ergebnisdaten.result
- Zeigt ob das Absetzen des Auftrags zur Protokollerstellung erfolgreich war.puaClient
- PuaClientde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler bei der Initialisierung.public boolean isRequestSuccessful()
take()
verändern. Wird beispielsweise ein Protokoll erstellt, so ist
wird die Methode true
zurückliefern, wenn die Anfrage an den Server gesendet werden konnte. D.h. true
bedeutet in diesem Fall
nicht, dass das Protokoll erfolgreich erstellt wurde, sondern nur, dass die Anfrage an den Server gesendet wurde. Ruft man nun take()
auf, und
anschließend wieder isRequestSuccessful()
, dann wird z.B. false
geliefert, wenn es zu einem fehler bei der Protokollerstellung kam -
etwa durch einen Syntaxfehler im Skript.public boolean isComplete()
true
falls das Protokoll vollständig übertragen wurde.false
falls noch nicht alle Ergebnisdatensätze eingetroffen sind oder
das Protokoll abgebrochen wurde.public java.lang.String getErrorMsg()
public ProtocolResult take() throws java.lang.InterruptedException
null
falls bereits alle Antwortdatensätze ausgeliefert wurden oder ein Fehler aufgetreten ist.java.lang.InterruptedException
- Warten auf Antwortdatensatz wurde unterbrochen.public boolean hasNext()
take()
wird genau 1x null
zurückliefern, bevor
isDone
true
zurückliefert.true
falls alle Ergebnisdatensätze abgeholt wurden.@Deprecated public void abort()
close()
ersetzt.public boolean wasAborted()
true
falls die Protokollerstellung abgebrochen wurde.public java.lang.Long getJobId()
null
falls die Auftrags-Id unbekannt ist. Bei Protokoll-Erstellen-Aufträgen ist die Auftrags-ID
identisch zur Protokoll-Id.@Deprecated public final java.lang.Long getProtocolId()
null
zurückgegeben!null
falls die Auftrags-Id noch unbekannt ist. Bei Protokoll-Erstellen-Aufträgen ist die Auftrags-ID
identisch zur Protokoll-Id.public int bufferedDataSize()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public void close()
close
in interface java.lang.AutoCloseable