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 dieses 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() Sollte die L�nge des Response Streams liefern.
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 kann zur �berpr�fung der Erreichbarkeit einer URL implementiert und verwendet werden.

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 kann zur �berpr�fung der Erreichbarkeit einer URL implementiert und verwendet werden. Die Bibliothek selbst ruft diese Methode nicht auf.

Parameters:

uri - URI des Kommunikationspartners

Returns:

true wenn der Kommunikationspartners erreichbar ist

Throws:

java.io.IOException - im Fehlerfall

getContentLength

public long getContentLength()

Sollte die L�nge des Response Streams liefern. Auch diese Methode wird von der Bibliothek z.Zt. nicht ben�tigt.

Returns:

Anzahl der empfangenen Bytes

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 die serialisierte OSCI-Nachricht schreibt.

Parameters:

uri - URI des Kommunikationspartners

length - L�nge der �bertragungsdaten (Anz d. Bytes)

Returns:

Output-Stream in den die Daten geschrieben werden k�nnen

Throws:

java.io.IOException - Im Fehlerfall eine IOException