de.osci.osci12.extinterfaces
Interface TransportI

public interface TransportI

Interface-Klasse für das Übermitteln von OSCI-Nachrichten Die OSCI-Bibliothek sieht nicht vor den Nutzer auf ein Transportprotokoll festzulegen. Aus diesem Grund wird ein Transport-Interface zur Verfügung gestellt welches es der Anwendung ermöglicht die erstellten OSCI-Nachrichten mit dem gewünschtem Protokoll oder auf die gewünschte Art zu übermitteln oder zu speichern. Vorstellbare Implementierungen sind z.B. http, https, ftp, smpt/pop, Filesystem, oder jms.

Method Summary

java.io.OutputStream	getConnection(java.net.URI uri, long length) Liefert eine konkrete Konnektion zum versenden eines Streams.
long	getContentLength() Liefert die Länge des Response Streams
java.io.InputStream	getResponseStream() Liefert den Response Stream
java.lang.String	getVendor() Sollte den Namen des Herstellers zurückgeben.
java.lang.String	getVersion() Liefert die Versionsnummer
boolean	isOnline(java.net.URI uri) Methode wird zur Online-Überprüfung vor jedem DialogInit oder bei keinem Dialog direkt vor dem sendMsg jeder Nachricht aufgerufen.
TransportI	newInstance() Erzeugt eine neue Instanze von der Transprotschicht

Method Detail

getVersion

public java.lang.String getVersion()

Liefert die Versionsnummer

Returns:

Versionsnummer

getVendor

public java.lang.String getVendor()

Sollte den Namen des Herstellers zurückgeben.

Returns:

Herstellername

getResponseStream

public java.io.InputStream getResponseStream()
                                      throws java.io.IOException

Liefert den Response Stream

Returns:

den InputStream der eingehenden Antwortdaten

java.io.IOException

isOnline

public boolean isOnline(java.net.URI uri)
                 throws java.io.IOException

Methode wird zur Online-Überprüfung vor jedem DialogInit oder bei keinem Dialog direkt vor dem sendMsg jeder Nachricht aufgerufen.

Parameters:

uri - URI des Kommunikationspartners

Returns:

true sobald der Kommunikationspartners online ist

Throws:

java.io.IOException - Im Fehlerfall eine IOException

getContentLength

public long getContentLength()

Liefert die Länge des Response Streams

Returns:

The contentLength value

newInstance

public TransportI newInstance()

Erzeugt eine neue Instanze von der Transprotschicht

Returns:

Transport-Objekt

getConnection

public java.io.OutputStream getConnection(java.net.URI uri,
                                          long length)
                                   throws java.io.IOException

Liefert eine konkrete Konnektion zum versenden eines Streams. Die Methode konnektet zu der übergebenen URI und liefert als Ergebnis einen Outputstream in den die Bibliothek dann seine die OSCI-Nachricht serilisiert.

Parameters:

uri - URI des Kommunikationspartners

length - Länge der Übertragungsdaten

Returns:

Den Output-Stream in den die Daten geschrieben werden können

Throws:

java.io.IOException - Im Fehlerfall eine IOException