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, smtp/pop, Filesystem oder jms.

Copyright © 2004 Freie Hansestadt Bremen

Erstellt von bremen online services Entwicklungs- und Betriebsgesellschaft GmbH & Co. KG

Diese Bibliothek kann von jedermann nach Maßgabe der Bremer Lizenz für freie Softwarebibliotheken genutzt werden.

Die Lizenzbestimmungen können unter der URL www.osci.de abgerufen oder bei der OSCI-Leitstelle, Senator für Finanzen, Freie Hansestadt Bremen, Postfach 10 15 40, 28015 Bremen schriftlich angefordert werden.

Version:

1.2.1

Method Summary

java.io.OutputStream	getConnection(java.net.URI uri, long length) Liefert eine konkrete Verbindung 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.
TransportI	newInstance() Die Implementierung dieser statischen Methode muss eine neue Instanz der Klasse zurückgeben.

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

newInstance

public TransportI newInstance()
                       throws java.io.IOException

Die Implementierung dieser statischen Methode muss eine neue Instanz der Klasse zurückgeben.

Returns:

neue Instanz der implementierenden Klasse

Throws:

java.io.IOException - wenn ein Fehler auftritt

getResponseStream

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

Liefert den Response-Stream.

Returns:

den InputStream der eingehenden Antwortdaten

Throws:

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 Kommunikationspartner 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 oder -1, falls die Länge nicht bekannt ist.

getConnection

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

Liefert eine konkrete Verbindung 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