de.extrastandard.api.observer.ITransportObserver Maven / Gradle / Ivy
The newest version!
package de.extrastandard.api.observer;
/**
* Beobachter von Ereignissen der eXTRa Transportschicht in einem Client.
*
*
* Vom konkreten Ziel und Protokoll für die Nachrichten wird abstrahiert.
*
*
*
* Die erwartete Abfolge der Ereignisse ist:
* requestDataReceived+ requestFilled requestForwarded [responseFilled responseForwarded]
*
*
*
*
* Ob Response Ereignisse auftreten, hängt vom im Request spezifizierten
* erwarteten Antwortverhalten ab. Die Response-Ereignisse müssen
* auftreten, wenn der Request eine synchrone Response angefordert hat.
*
*
* TODO: Acknowledge, Error (extra Kompendium kap. 4.3.2) TODO: Benachrichtigung
* über extra-LogElement im XMLTransport (Kap. 4.3.4)
*/
public interface ITransportObserver {
/**
* Ende des Empfangs einer Einheit Daten.
*
* @param unitName
* möglichts eindeutige und menschenlesbare Kurzbezeichnung der
* Dateneinheit (zum Beispiel Dateiname), muss gleich dem
* zu Beginn verwendeten sein
*/
public void requestDataReceived(String unitName, long size);
/**
* Der Request ist als Objekt im Speicher vollständig aufgebaut.
*
* @param requestHeader
* fertig gestellter Header
*/
public void requestFilled(ITransportInfo transportInfo);
/**
* Der Request ist auf den Weg an sein Ziel an den Empfänger gebracht
* worden.
*
* @param destination
* möglichst eindeutige, menschenlesbare Kurzbezeichnung des
* Ziels (hier zum Beispiel im physikalischen Empfänger); kann
* (zum Beispiel, wenn er ins Dateisystem geschrieben wurde),
* muss aber nicht spezifisch pro Message sein
* @param size
* Größe in Bytes der Transport-Message
*/
public void requestForwarded(String destination, long size);
/**
* Der Client hat eine Response empfangen und als Objekt im Speicher
* vollständig aufgebaut.
*
* @param responseHeader
* fertig gestellter Header
*/
public void responseFilled(ITransportInfo transportInfo);
/**
* Der Client hat die Response weitergegeben an das Ziel innerhalb des
* Senders (des Requests).
*
* @param destination
* möglichst eindeutige, menschenlesbare Kurzbezeichnung des
* Ziels (hier meist zum logischen Sender) kann (zum Beispiel,
* wenn sie ins Dateisystem geschrieben wurde), muss aber nicht
* spezifisch pro Message sein
* @param size
* Größe in Bytes der Transport-Message
*/
public void responseDataForwarded(String destination, long size);
}