de.osci.osci12.messagetypes
Class OSCIMessage

java.lang.Object
  de.osci.osci12.messagetypes.OSCIMessage

Direct Known Subclasses:

OSCIRequest, OSCIResponseTo

public abstract class OSCIMessage

extends java.lang.Object

Die Klasse ist die Superklasse aller OSCI-Nachrichten-Objekte.

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

Field Summary

static int	ACCEPT_DELIVERY Konstante, die einen Annahmeauftrag anzeigt.
java.util.Hashtable	attachments Enthält die Attachment-Objekte der Nachricht.
java.util.Hashtable	contentContainer Enthält die ContentContainer der Nachricht.
static java.lang.String	contentID Content-Id der Nachricht.
de.osci.osci12.soapheader.ControlBlockH	controlBlock ControlBlock-Headereintrag, nur bei geparsten Nachrichten zugewiesen.
de.osci.osci12.soapheader.DesiredLanguagesH	desiredLanguagesH DesiredLanguages-Header
DialogHandler	dialogHandler Verwendeter DialogHandler
java.lang.String	dsNSPrefix
java.util.Hashtable	encryptedData Enthält die EncryptedData-Objekte der Nachricht.
static int	EXIT_DIALOG Konstante, die einen Dialogendeauftrag anzeigt.
static int	FETCH_DELIVERY Konstante, die einen Abbholauftrag anzeigt.
static int	FETCH_PROCESS_CARD Konstante, die einen Laufzettelabholauftrag anzeigt.
static int	FORWARD_DELIVERY Konstante, die einen Weiterleitungsauftrag anzeigt.
static int	GET_MESSAGE_ID Konstante, die einen MessageId-Anforderungsauftrag anzeigt.
java.util.Hashtable	hashableMsgPart
static int	INIT_DIALOG Konstante, die einen Dialoginitialisierungsauftrag anzeigt.
de.osci.osci12.soapheader.IntermediaryCertificatesH	intermediaryCertificatesH IntermediaryCertificates-Headereintrag
static int	MEDIATE_DELIVERY Konstante, die einen Abwicklungsauftrag anzeigt.
static int	NO_SELECTION_RULE Kein Auswahlmodus gesetzt.
de.osci.osci12.soapheader.NonIntermediaryCertificatesH	nonIntermediaryCertificatesH NonIntermediaryCertificates-Headereintrag
java.lang.String	ns
java.lang.String	osciNSPrefix
static int	PROCESS_DELIVERY Konstante, die einen Bearbeitungsauftrag anzeigt.
de.osci.osci12.soapheader.QualityOfTimestampH	qualityOfTimestampTypeCreation QualityOfTimestampCreation-Headereintrag
de.osci.osci12.soapheader.QualityOfTimestampH	qualityOfTimestampTypeReception QualityOfTimestampReception-Headereintrag
static int	RESPONSE_TO_ACCEPT_DELIVERY Konstante, die eine Annahmeantwort anzeigt.
static int	RESPONSE_TO_EXIT_DIALOG Konstante, die eine Dialogendeantwort anzeigt.
static int	RESPONSE_TO_FETCH_DELIVERY Konstante, die eine Abbholantwort anzeigt.
static int	RESPONSE_TO_FETCH_PROCESS_CARD Konstante, die eine Laufzettelabholantwort anzeigt.
static int	RESPONSE_TO_FORWARD_DELIVERY Konstante, die eine Weiterleitungsantwort anzeigt.
static int	RESPONSE_TO_GET_MESSAGE_ID Konstante, die eine MessageId-Anforderungsantwort anzeigt.
static int	RESPONSE_TO_INIT_DIALOG Konstante, die eine Dialoginitialisierungsantwort anzeigt.
static int	RESPONSE_TO_MEDIATE_DELIVERY Konstante, die eine Abwicklungsantwort anzeigt.
static int	RESPONSE_TO_PROCESS_DELIVERY Konstante, die eine Bearbeitungsantwort anzeigt.
static int	RESPONSE_TO_STORE_DELIVERY Konstante, die eine Zustellungsantwort anzeigt.
static int	SELECT_ADDRESSEE Auswahlmodus für Laufzettel von Nachrichten an den Absender eines Laufzettelabholauftrags.
static int	SELECT_ALL Auswahlmodus für alle Laufzettel (default).
static int	SELECT_BY_DATE_OF_RECEPTION Auswahlmodus für Nachrichten/Laufzettel nach Empfangsdatum.
static int	SELECT_BY_MESSAGE_ID Auswahlmodus für Nachrichten/Laufzettel nach Message-Id.
static int	SELECT_BY_RECENT_MODIFICATION Auswahlmodus für Nachrichten/Laufzettel nach Datum der letzten Modifikation.
static int	SELECT_ORIGINATOR Auswahlmodus für Laufzettel von Nachrichten vom Absender eines Laufzettelabholauftrags.
OSCISignature	signatureHeader Signatureintrag im Header (Client- oder Suppliersignatur.
static int	SOAP_FAULT_MESSAGE Konstante, die eine Rückmeldung auf Nachrichtenebene (SOAP-Fault) anzeigt.
static int	SOAP_MESSAGE_ENCRYPTED Konstante, die eine verschlüsselte SOAP-Nachricht anzeigt.
java.lang.String	soapNSPrefix
static int	STORE_DELIVERY Konstante, die einen Zustellungsauftrag anzeigt.
static int	TYPE_UNDEFINED Konstante, die einen undefinierten Nachrichtentyp anzeigt.
java.lang.String	xencNSPrefix
java.lang.String	xsiNSPrefix

Method Summary

void	addCustomHeader(java.lang.String xml) Mit dieser Methode können beliebige Einträge dem SOAP-Header der Nachricht hinzugefügt werden.
void	addRole(Role role) Diese Methode ermöglicht es Anwendungen, zusätzliche Zertifikate in den NonIntermediaryCertificates-Header einzustellen, die dann vom Intermediär mit geprüft werden.
static java.lang.String	formatISO8601(java.util.Date date) Helfermethode zum Formatieren eines Datums in das für OSCI erforderliche ISO-8601-Format.
Addressee	getAddressee() Liefert das Addressee-Rollenobjekt des Nachrichtenobjektes.
boolean	getBase64Encoding() Gibt an, ob der äußere verschlüsselte Transportumschlag Base64-codiert übertragen wird / wurde.
java.lang.String[]	getCustomHeaders() Liefert vorhandene SOAP-Header-Einträge.
DialogHandler	getDialogHandler() Liefert den DialogHandler des Nachrichtenobjektes.
int	getMessageType() Liefert den Identifier für den Nachrichtentyp (ACCEPT_DELIVERY, EXIT_DIALOG...).
Originator	getOriginator() Liefert das Originator-Rollenobjekt des Nachrichtenobjektes.
Author[]	getOtherAuthors() Liefert alle Author-Rollenobjekte, die für die Signatur von Inhaltsdaten in der Nachricht verwendet wurden oder die mit der Methode addRole(Role) der Nachricht hinzugefügt wurden.
Reader[]	getOtherReaders() Liefert alle Reader-Rollenobjekte, für die Inhaltsdaten in der Nachricht verschlüsselt wurden oder die mit der Methode addRole(Role) der Nachricht hinzugefügt wurden.
Role	getRoleForRefID(java.lang.String uri) Diese Methode liefert ein Role-Objekt passend zu der übergebenem RefID.
boolean	isSigned() Liefert Status der Nachricht (signiert/unsigniert)
static java.util.Date	parseISO8601(java.lang.String date) Helfermethode zum Parsen eines Datumsstrings im ISO-8601-Format.
void	setBase64Encoding(boolean b64) Legt fest, ob der äußere verschlüsselte Transportumschlag Base64-codiert übertragen wird.
java.lang.String	toString() undocumented

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

hashableMsgPart

public java.util.Hashtable hashableMsgPart

TYPE_UNDEFINED

public static final int TYPE_UNDEFINED

Konstante, die einen undefinierten Nachrichtentyp anzeigt.

See Also:

Constant Field Values

ACCEPT_DELIVERY

public static final int ACCEPT_DELIVERY

Konstante, die einen Annahmeauftrag anzeigt.

See Also:

Constant Field Values

EXIT_DIALOG

public static final int EXIT_DIALOG

Konstante, die einen Dialogendeauftrag anzeigt.

See Also:

Constant Field Values

FETCH_DELIVERY

public static final int FETCH_DELIVERY

Konstante, die einen Abbholauftrag anzeigt.

See Also:

Constant Field Values

FETCH_PROCESS_CARD

public static final int FETCH_PROCESS_CARD

Konstante, die einen Laufzettelabholauftrag anzeigt.

See Also:

Constant Field Values

FORWARD_DELIVERY

public static final int FORWARD_DELIVERY

Konstante, die einen Weiterleitungsauftrag anzeigt.

See Also:

Constant Field Values

GET_MESSAGE_ID

public static final int GET_MESSAGE_ID

Konstante, die einen MessageId-Anforderungsauftrag anzeigt.

See Also:

Constant Field Values

INIT_DIALOG

public static final int INIT_DIALOG

Konstante, die einen Dialoginitialisierungsauftrag anzeigt.

See Also:

Constant Field Values

MEDIATE_DELIVERY

public static final int MEDIATE_DELIVERY

Konstante, die einen Abwicklungsauftrag anzeigt.

See Also:

Constant Field Values

PROCESS_DELIVERY

public static final int PROCESS_DELIVERY

Konstante, die einen Bearbeitungsauftrag anzeigt.

See Also:

Constant Field Values

STORE_DELIVERY

public static final int STORE_DELIVERY

Konstante, die einen Zustellungsauftrag anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_ACCEPT_DELIVERY

public static final int RESPONSE_TO_ACCEPT_DELIVERY

Konstante, die eine Annahmeantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_EXIT_DIALOG

public static final int RESPONSE_TO_EXIT_DIALOG

Konstante, die eine Dialogendeantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_FETCH_DELIVERY

public static final int RESPONSE_TO_FETCH_DELIVERY

Konstante, die eine Abbholantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_FETCH_PROCESS_CARD

public static final int RESPONSE_TO_FETCH_PROCESS_CARD

Konstante, die eine Laufzettelabholantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_FORWARD_DELIVERY

public static final int RESPONSE_TO_FORWARD_DELIVERY

Konstante, die eine Weiterleitungsantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_GET_MESSAGE_ID

public static final int RESPONSE_TO_GET_MESSAGE_ID

Konstante, die eine MessageId-Anforderungsantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_INIT_DIALOG

public static final int RESPONSE_TO_INIT_DIALOG

Konstante, die eine Dialoginitialisierungsantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_MEDIATE_DELIVERY

public static final int RESPONSE_TO_MEDIATE_DELIVERY

Konstante, die eine Abwicklungsantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_PROCESS_DELIVERY

public static final int RESPONSE_TO_PROCESS_DELIVERY

Konstante, die eine Bearbeitungsantwort anzeigt.

See Also:

Constant Field Values

RESPONSE_TO_STORE_DELIVERY

public static final int RESPONSE_TO_STORE_DELIVERY

Konstante, die eine Zustellungsantwort anzeigt.

See Also:

Constant Field Values

SOAP_MESSAGE_ENCRYPTED

public static final int SOAP_MESSAGE_ENCRYPTED

Konstante, die eine verschlüsselte SOAP-Nachricht anzeigt.

See Also:

Constant Field Values

SOAP_FAULT_MESSAGE

public static final int SOAP_FAULT_MESSAGE

Konstante, die eine Rückmeldung auf Nachrichtenebene (SOAP-Fault) anzeigt.

See Also:

Constant Field Values

NO_SELECTION_RULE

public static final int NO_SELECTION_RULE

Kein Auswahlmodus gesetzt.

See Also:

Constant Field Values

SELECT_BY_MESSAGE_ID

public static final int SELECT_BY_MESSAGE_ID

Auswahlmodus für Nachrichten/Laufzettel nach Message-Id.

See Also:

Constant Field Values

SELECT_BY_DATE_OF_RECEPTION

public static final int SELECT_BY_DATE_OF_RECEPTION

Auswahlmodus für Nachrichten/Laufzettel nach Empfangsdatum.

See Also:

Constant Field Values

SELECT_BY_RECENT_MODIFICATION

public static final int SELECT_BY_RECENT_MODIFICATION

Auswahlmodus für Nachrichten/Laufzettel nach Datum der letzten Modifikation.

See Also:

Constant Field Values

SELECT_ALL

public static final int SELECT_ALL

Auswahlmodus für alle Laufzettel (default).

See Also:

Constant Field Values

SELECT_ADDRESSEE

public static final int SELECT_ADDRESSEE

Auswahlmodus für Laufzettel von Nachrichten an den Absender eines Laufzettelabholauftrags.

See Also:

Constant Field Values

SELECT_ORIGINATOR

public static final int SELECT_ORIGINATOR

Auswahlmodus für Laufzettel von Nachrichten vom Absender eines Laufzettelabholauftrags.

See Also:

Constant Field Values

contentID

public static java.lang.String contentID

Content-Id der Nachricht.

contentContainer

public java.util.Hashtable contentContainer

Enthält die ContentContainer der Nachricht.

encryptedData

public java.util.Hashtable encryptedData

Enthält die EncryptedData-Objekte der Nachricht.

attachments

public java.util.Hashtable attachments

Enthält die Attachment-Objekte der Nachricht.

signatureHeader

public OSCISignature signatureHeader

Signatureintrag im Header (Client- oder Suppliersignatur.

desiredLanguagesH

public de.osci.osci12.soapheader.DesiredLanguagesH desiredLanguagesH

DesiredLanguages-Header

qualityOfTimestampTypeCreation

public de.osci.osci12.soapheader.QualityOfTimestampH qualityOfTimestampTypeCreation

QualityOfTimestampCreation-Headereintrag

qualityOfTimestampTypeReception

public de.osci.osci12.soapheader.QualityOfTimestampH qualityOfTimestampTypeReception

QualityOfTimestampReception-Headereintrag

nonIntermediaryCertificatesH

public de.osci.osci12.soapheader.NonIntermediaryCertificatesH nonIntermediaryCertificatesH

NonIntermediaryCertificates-Headereintrag

intermediaryCertificatesH

public de.osci.osci12.soapheader.IntermediaryCertificatesH intermediaryCertificatesH

IntermediaryCertificates-Headereintrag

controlBlock

public de.osci.osci12.soapheader.ControlBlockH controlBlock

ControlBlock-Headereintrag, nur bei geparsten Nachrichten zugewiesen.

dialogHandler

public DialogHandler dialogHandler

Verwendeter DialogHandler

soapNSPrefix

public java.lang.String soapNSPrefix

osciNSPrefix

public java.lang.String osciNSPrefix

dsNSPrefix

public java.lang.String dsNSPrefix

xencNSPrefix

public java.lang.String xencNSPrefix

xsiNSPrefix

public java.lang.String xsiNSPrefix

ns

public java.lang.String ns

Method Detail

isSigned

public boolean isSigned()

Liefert Status der Nachricht (signiert/unsigniert)

Returns:

signierte Nachricht -> true

See Also:

DialogHandler.setCheckSignatures(boolean)

addRole

public void addRole(Role role)
             throws java.lang.IllegalArgumentException

Diese Methode ermöglicht es Anwendungen, zusätzliche Zertifikate in den NonIntermediaryCertificates-Header einzustellen, die dann vom Intermediär mit geprüft werden. Die Zertifikate werden in Form von Reader- oder Author-Objekten übergeben, die die entsprechenden Zertifikate enthalten müssen.

Die Methoden ContentContainer.sign(Role) und EncryptedData.encrypt(Role) fügen die übergebenen Rollenobjekte der Nachricht automatisch hinzu, so dass diese Methode in der Regel nicht benötigt wird.

Parameters:

role - Hinzuzufügendes Reader- oder Author-Objekt

Throws:

java.lang.IllegalArgumentException

See Also:

ContentContainer.sign(Role), EncryptedDataOSCI.encrypt(Role)

getDialogHandler

public DialogHandler getDialogHandler()

Liefert den DialogHandler des Nachrichtenobjektes.

Returns:

den DialogHandler

getMessageType

public int getMessageType()

Liefert den Identifier für den Nachrichtentyp (ACCEPT_DELIVERY, EXIT_DIALOG...).

Returns:

den Messagetyp-Identifier

getRoleForRefID

public Role getRoleForRefID(java.lang.String uri)

Diese Methode liefert ein Role-Objekt passend zu der übergebenem RefID.

Returns:

Role Objekt oder Null

getAddressee

public Addressee getAddressee()

Liefert das Addressee-Rollenobjekt des Nachrichtenobjektes.

Returns:

den Addressee

getOriginator

public Originator getOriginator()

Liefert das Originator-Rollenobjekt des Nachrichtenobjektes.

Returns:

den Originator

getOtherAuthors

public Author[] getOtherAuthors()

Liefert alle Author-Rollenobjekte, die für die Signatur von Inhaltsdaten in der Nachricht verwendet wurden oder die mit der Methode addRole(Role) der Nachricht hinzugefügt wurden.

Returns:

Array von Author-Objekten

See Also:

addRole(Role), ContentContainer.sign(Role)

getOtherReaders

public Reader[] getOtherReaders()

Liefert alle Reader-Rollenobjekte, für die Inhaltsdaten in der Nachricht verschlüsselt wurden oder die mit der Methode addRole(Role) der Nachricht hinzugefügt wurden.

Returns:

Array von Reader-Objekten

See Also:

addRole(Role), EncryptedDataOSCI.encrypt(Role)

addCustomHeader

public void addCustomHeader(java.lang.String xml)

Mit dieser Methode können beliebige Einträge dem SOAP-Header der Nachricht hinzugefügt werden. Die übergebenen Strings müssen vollständige XML-Tags sein. Das unterste Element muss ein id-Attribut besitzen, welches innerhalb der Nachricht eindeutig sein muss. Die Bibliothek verwendet für die id-Attribute die Namen der Einträge (ohne Namespace) in Kleinschreibung, es sollten daher beispielsweise nicht "desiredlanguages", "clientsignature" oder "body" verwendet werden. Bei zu signierenden Nachrichten muß der Tag außerdem in kanonischer Form übergeben werden. Der äußerste Tag muß alle Namespace-Deklarationen der OSCI-Nachricht enthalten.

Parameters:

xml - XML-Tag

See Also:

getCustomHeaders()

getCustomHeaders

public java.lang.String[] getCustomHeaders()

Liefert vorhandene SOAP-Header-Einträge.

Returns:

Array der SOAP-Header-Einträge

See Also:

addCustomHeader(String)

formatISO8601

public static java.lang.String formatISO8601(java.util.Date date)

Helfermethode zum Formatieren eines Datums in das für OSCI erforderliche ISO-8601-Format.

Parameters:

date - Datum-Objekt

Returns:

formatierten Datum-String

parseISO8601

public static java.util.Date parseISO8601(java.lang.String date)
                                   throws java.text.ParseException

Helfermethode zum Parsen eines Datumsstrings im ISO-8601-Format. ISO-8601-Format.

Parameters:

date - Datum-String

Returns:

Datum-Objekt

Throws:

java.text.ParseException - bei Parse-Problemen

setBase64Encoding

public void setBase64Encoding(boolean b64)

Legt fest, ob der äußere verschlüsselte Transportumschlag Base64-codiert übertragen wird.

Parameters:

b64 - true -> Daten werden Base64-codiert

getBase64Encoding

public boolean getBase64Encoding()

Gibt an, ob der äußere verschlüsselte Transportumschlag Base64-codiert übertragen wird / wurde.

Returns:

true -> Daten sind Base64-codiert

toString

public java.lang.String toString()

undocumented

Returns:

undocumented