de.osci.osci12.roles
Class Role

java.lang.Object
  de.osci.osci12.roles.Role

Direct Known Subclasses:

Addressee, Author, Intermed, Originator, Reader

public abstract class Role

extends java.lang.Object

Diese Klasse ist die Superklasse aller OSCI-Rollenobjekte.

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

java.lang.String	cipherRefId Referenz-Ids, sollten von Anwendungen nicht gesetzt werden.
java.lang.String	id Interne Id, sollte von Anwendungen nicht gesetzt werden.
java.lang.String	signatureRefId Referenz-Ids, sollten von Anwendungen nicht gesetzt werden.

Method Summary

java.security.cert.X509Certificate	getCipherCertificate() Liefert das eingestellte Verschlüsselungszertifikat.
java.lang.String	getCipherCertificateId() Liefert die Id, mit der in der OSCI-Nachricht das Verschlüsselungszertifikat referenziert wird.
Decrypter	getDecrypter() Liefert das eingestellte Decrypter-Objekt oder null, wenn kein Objekt an den Konstruktor übergeben wurde.
java.lang.String	getSignatureAlgorithm() Liefert den gesetzten Signaturalgorithmus.
java.security.cert.X509Certificate	getSignatureCertificate() Liefert das eingestellte Signaturzertifikat.
java.lang.String	getSignatureCertificateId() Liefert die Id, mit der in der OSCI-Nachricht das Signaturzertifikat referenziert wird.
Signer	getSigner() Liefert das eingestellte Signer-Objekt oder null, wenn kein Objekt an den Konstruktor übergeben wurde.
boolean	hasCipherCertificate() Stellt fest, ob ein Verschlüsselungszertifikat (bzw.
boolean	hasCipherPrivateKey() Stellt fest, ob ein Verschlüsselungs-Privatschlüssel (Decrypter) verfügbar ist.
boolean	hasSignatureCertificate() Stellt fest, ob ein Signaturzertifikat (bzw.
boolean	hasSignaturePrivateKey() Stellt fest, ob ein Signatur-Privatschlüssel (Signer) verfügbar ist.
void	setCipherCertificate(java.security.cert.X509Certificate cipherCertificate) Setzt das Verschlüsselungszertifikat des Rollenobjektes.
void	setDecrypter(Decrypter decrypter) Setzt das zu verwendende Decrypter-Objekt.
void	setSignatureAlgorithm(java.lang.String signatureAlgorithm) Setzt den Algorithmus, der zur Erstellung der Signatur verwendet wird.
void	setSignatureCertificate(java.security.cert.X509Certificate signatureCertificate) Setzt das Signaturzertifikat des Rollenobjektes.
void	setSigner(Signer signer) Setzt das zu verwendende Signer-Objekt.

Methods inherited from class java.lang.Object

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

Field Detail

id

public java.lang.String id

Interne Id, sollte von Anwendungen nicht gesetzt werden.

cipherRefId

public java.lang.String cipherRefId

Referenz-Ids, sollten von Anwendungen nicht gesetzt werden.

signatureRefId

public java.lang.String signatureRefId

Referenz-Ids, sollten von Anwendungen nicht gesetzt werden.

Method Detail

getCipherCertificateId

public java.lang.String getCipherCertificateId()

Liefert die Id, mit der in der OSCI-Nachricht das Verschlüsselungszertifikat referenziert wird. Die Id ist ein String, der aus dem Rollennamen, bei Author- und Reader-Objekten einer lfd. Nummer, der Funktionbezeichnung (cipher) und dem SHA-1-Hashwert über den Bytes des Zertifikats besteht.

Returns:

Id des CipherCertificate-Elementes

See Also:

getSignatureCertificateId()

getSignatureCertificateId

public java.lang.String getSignatureCertificateId()

Liefert die Id, mit der in der OSCI-Nachricht das Signaturzertifikat referenziert wird. Die Id ist ein String, der aus dem Rollennamen, bei Author- und Reader-Objekten einer lfd. Nummer, der Funktionbezeichnung (signature) und dem SHA-1-Hashwert über den Bytes des Zertifikats besteht.

Returns:

Id des SignatureCertificate-Elementes

See Also:

getCipherCertificateId()

getSigner

public Signer getSigner()
                 throws OSCIRoleException

Liefert das eingestellte Signer-Objekt oder null, wenn kein Objekt an den Konstruktor übergeben wurde.

Returns:

Signer-Objekt

Throws:

OSCIRoleException - wenn kein Signer gesetzt wurde

hasSignaturePrivateKey

public boolean hasSignaturePrivateKey()

Stellt fest, ob ein Signatur-Privatschlüssel (Signer) verfügbar ist.

Returns:

true -> Signer wurde gesetzt

getDecrypter

public Decrypter getDecrypter()
                       throws OSCIRoleException

Liefert das eingestellte Decrypter-Objekt oder null, wenn kein Objekt an den Konstruktor übergeben wurde.

Returns:

Decrypter-Objekt

Throws:

OSCIRoleException - wenn kein Decrypter gesetzt wurde

hasCipherPrivateKey

public boolean hasCipherPrivateKey()

Stellt fest, ob ein Verschlüsselungs-Privatschlüssel (Decrypter) verfügbar ist.

Returns:

true -> Decrypter wurde gesetzt

setSigner

public void setSigner(Signer signer)

Setzt das zu verwendende Signer-Objekt. Falls bereits ein Signaturzertifikat gesetzt wurde, wird dieses nach Aufruf dieser Methode ignoriert. Alle weiteren Aufrufe von getSignatureCertificate() liefern dann das Zertifkat des Signer-Objektes zurück. setSigner(null) löscht das Signer-Objekt.

Parameters:

signer - das Signer-Objekt

See Also:

getSigner()

setDecrypter

public void setDecrypter(Decrypter decrypter)

Setzt das zu verwendende Decrypter-Objekt. Falls bereits ein Signaturzertifikat gesetzt wurde, wird dieses nach Aufruf dieser Methode ignoriert. Alle weiteren Aufrufe von getCipherCertificate() liefern dann das Zertifkat des Decrypter-Objektes zurück. setDecrypter(null) löscht das Decrypter-Objekt.

Parameters:

decrypter - das Decrypter-Objekt

See Also:

getDecrypter()

setSignatureCertificate

public void setSignatureCertificate(java.security.cert.X509Certificate signatureCertificate)

Setzt das Signaturzertifikat des Rollenobjektes.

Parameters:

signatureCertificate - das Signaturzertifikat

getSignatureCertificate

public java.security.cert.X509Certificate getSignatureCertificate()
                                                           throws OSCIRoleException

Liefert das eingestellte Signaturzertifikat.

Returns:

des Signaturzertifikat

Throws:

OSCIRoleException - wenn kein Signaturzertifikat eingestellt ist

hasSignatureCertificate

public boolean hasSignatureCertificate()

Stellt fest, ob ein Signaturzertifikat (bzw. Signer) verfügbar ist.

Returns:

true -> Signaturzertifikat wurde gesetzt

setCipherCertificate

public void setCipherCertificate(java.security.cert.X509Certificate cipherCertificate)

Setzt das Verschlüsselungszertifikat des Rollenobjektes. Sollte nur in Ausnahmefällen von Anwendungen aufgreufen werden, wenn z.B. kein Decrypter zur Verfügung steht.

Parameters:

cipherCertificate - das Signaturzertifikat

getCipherCertificate

public java.security.cert.X509Certificate getCipherCertificate()
                                                        throws OSCIRoleException

Liefert das eingestellte Verschlüsselungszertifikat.

Returns:

des Verschlüsselungszertifikat

Throws:

OSCIRoleException - wenn kein Verschlüsselungszertifikat eingestellt ist

hasCipherCertificate

public boolean hasCipherCertificate()

Stellt fest, ob ein Verschlüsselungszertifikat (bzw. Decrypter) verfügbar ist.

Returns:

true -> Verschlüsselungszertifikat wurde gesetzt

setSignatureAlgorithm

public void setSignatureAlgorithm(java.lang.String signatureAlgorithm)

Setzt den Algorithmus, der zur Erstellung der Signatur verwendet wird. Es kommen lt. Spezifikation als Parameter in Frage:

• http://www.w3.org/2001/09/xmldsig#rsa-sha1 und
• http://www.osci.de/2002/04/osci#rsa-ripemd160

Z.Zt. wird von der Bibliothek nur RSA mit SHA-1 unterstützt.

Parameters:

signatureAlgorithm - der Algorithmus-Identifier

See Also:

getSignatureAlgorithm()

getSignatureAlgorithm

public java.lang.String getSignatureAlgorithm()

Liefert den gesetzten Signaturalgorithmus.

Returns:

den Identifier des Algorithmus

See Also:

setSignatureAlgorithm(String)