|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.bsvrz.pua.prot.client.PuaClient
public class PuaClient
Schnittstelle des Clients zu Protokolle und Auswertungen. Vereinfacht das das Stellen von Anfragen an Pua.
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 |
---|
public static final byte INVALID_STATUS
public DynamicObject recentlyCreatedScript
createScript(DynamicObject, AtlBase, String)
und
createNewScriptObject(String, String)
gesetzt.
public long recentRequestId
createProtocol(ProcessingParameter)
gesetzt.
Constructor Detail |
---|
public PuaClient(ClientDavInterface dav, ConfigurationAuthority configAuth) throws ScopeException, ConfigurationException
dav
- Verbindung zum Datneverteiler.configAuth
- Konfigurationsverantwortlicher, der verwendet wird.
ScopeException
- Anfrage wird vom Konfigurationsverantwortlichen nicht unterstützt.
ConfigurationException
- Fehler bei der Kommunikation mit der KonfigurationMethod Detail |
---|
public void setTimeout(long timeout)
timeout
- Maximale Wartezeit, bis eine Antwort eingetroffen sein muss.public ProtocolResultStream createProtocol(ProcessingParameter pp) throws FailureException
pp
- Auftragsparameter
FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolResultStream getSavedProtocol(long protocolId) throws FailureException
protocolId
- Protokoll-Id des gespeicherten Protokolls.
FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolResultStream getUnreadProtocol(long protocolId) throws FailureException
protocolId
- Protokoll-Id des gespeicherten Protokolls.
FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolResultStream getProtocol(long protocolId, boolean read) throws FailureException
protocolId
- Protokoll-Id des gespeicherten Protokolls.read
- true
gespeicherte Protokolle abrufen. false
noch nicht abgerufene Protokolle senden.
FailureException
- Fehler beim Absetzen der Anfrage.public ProtocolRequestResult suspendProtocol(long protocolId) throws FailureException
protocolId
- Protokoll-Id
FailureException
- Fehler bei der Kommunikation mit der Konfiguration.public ProtocolRequestResult resumeProtocol(long protocolId) throws FailureException
protocolId
- Protokoll-Id
FailureException
- Fehler bei der Kommunikation mit der Konfiguration.public ProtocolRequestResult abortProtocol(long protocolId)
ProtocolResultStream.take()
liefert null
und ProtocolResultStream.hasNext()
true
zurück.
protocolId
- Protokoll-Id
public byte getStatus(long protocolId, ProtocolRequestResult resultInfo)
protocolId
- Protokoll-Id.resultInfo
- Informationen über den Ablauf der Aktion. Kann null
sein.
public Tuple<java.lang.Long,ProcessingParameter>[] getSavedProtocolList(ProtocolRequestResult resultInfo)
resultInfo
- In diesem Objekt werden Fehlermeldungen abgelegt.
null
bei Fehler.public Tuple<java.lang.Long,ProcessingParameter>[] getUnreadProtocolList(ProtocolRequestResult resultInfo)
resultInfo
- In diesem Objekt werden Fehlermeldungen abgelegt.
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, 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(DynamicObject script, 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(DynamicObject script, java.lang.StringBuffer source, AtlMeta meta)
script
- Skriptobjekt dessen Quelltext geliefert werden soll.source
- Buffer, in den der Skriptquelltext abgelegt wird.meta
- Metainformationen über das Skript.
public ProtocolRequestResult deleteScript(DynamicObject script)
script
- Skriptobjekt das gelöscht wird.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |