XML-Blueprint-Dateien erstellen
Die Blueprint-Konfigurationsdatei enthält die Komponentenassemblierung und die Konfigurationsdaten für das Bundle. Die Datei beschreibt, wie die Komponenten in der OSGi-Serviceregistry registriert werden oder wie sie Services aus der OSGi-Serviceregistry abrufen. Diese Informationen werden zur Laufzeit verwendet, um die erforderlichen Komponenten beim Starten des Bundles zu instanziieren und zu konfigurieren.
Vorgehensweise
- Klicken Sie mit der rechten Maustaste auf Ihr Bundleprojekt und wählen Sie Neu > Blueprint-Datei aus. Der Assistent zum Erstellen einer neuen Blueprint-Datei wird geöffnet.
- Geben Sie im Feld Dateiname den Namen Ihrer Blueprint-Konfigurationsdatei ein und klicken Sie dann auf Weiter.
- Wählen Sie auf der Assistentenseite zum Hinzufügen oder Entfernen von zusätzlichen Blueprint-Namespaces die Namespaces aus, die Sie Ihrer Blueprint-Datei hinzufügen möchten. Sie können Namespaces für Blueprint-Erweiterungen, JPA, Ressourcenreferenzen und Transaktionen hinzufügen.Weitere Informaitonen zu Blueprint-Namespaces:
Tabelle 1. Beschreibung von Blueprint-Namespaces Schema URL Beschreibung Blueprint-Erweiterung http://aries.apache.org/blueprint/xmlns/blueprint-ext/v1.0.0 IBM® Blueprint-Erweiterungen
Erweiterungen für das OSGi-Blueprint-Programmiermodell, wie z. B. Feldinjektion.
Blueprint-Sicherheit http://www.ibm.com/appserver/schemas/blueprint/security/v1.0.0 IBM Blueprint-Sicherheit
Konfigurieren Sie Bean-Sicherheit so, dass nur Benutzer, denen eine bestimmte Rolle zugeordnet wurde, auf die Methoden der Bean zugreifen können.
Weitere Informationen: Blueprint-Sicherheit und OSGi-Anwendungen
JPA http://aries.apache.org/xmlns/jpa/v1.0.0 JPA-Blueprint-Support
Stellt JPA-Integration (Java™ Persistence API) in Blueprint zur Verfügung. Persistenzeinheiten und Persistenzkontexte können in Blueprint Managed Beans injiziert werden.
Ressourcenreferenz http://www.ibm.com/appserver/schemas/8.0/blueprint/resourcereference Unterstützung für Blueprint-Ressourcenreferenz
Ermöglicht, dass Objekte, die in WAS JNDI deklartiert sind (z. B. Datenquellen und Verbindungsfactorys), in Blueprint Managed Beans injiziert werden.
Transaktionen http://aries.apache.org/xmlns/transactions/v1.0.0 Blueprint-Transaktionsunterstützung
Gibt dem Entwickler die Möglichkeit, Transaktionsanforderungen für Blueprint Managed Beans zu deklarieren.
Anmerkung: Wenn Sie Namespaces hinzufügen möchten, die nicht in dieser Liste enthalten sind, wechseln Sie in die Ansicht "Quelle" und geben Sie den Namespace ein. - Klicken Sie auf Fertigstellen. Die Blueprint-Konfigurationsdatei wird im Editor geöffnet.
- Klicken Sie auf Hinzufügen, um die Komponentenassemblierung und die Konfigurationsinformationen zu Ihrer Blueprint-Konfigurationsdatei hinzuzufügen.
- bean
- Das Element bean definiert eine Blueprint-Komponente, die instanziiert wird. Klicken Sie auf OK, um der Bean Argumente und Eigenschaften hinzuzufügen.
- Weitere Informationen zu Attributen für das bean-Element:
- id
- Das Attribut id gibt die Bean an. Es ist obligatorisch, wenn die Komponente von einer anderen Stelle im Entwurf (zum Beispiel von einer Servicedefinition) referenziert wird.
- class
- Das Attribut class gibt an, welche Implementierungsklasse der Komponente instanziiert wird.
- activation
- Dieses optionale Attribut definiert den Aktivierungsmodus für den Manager.
Es werden zwei Aktivierungsmodi unterstützt:
- eager
- Der Manager wird während der Initialisierung des Blueprint-Containers aktiviert.
- lazy
- Der Manager wird auf Anforderung gestartet.
- scope
- Je nach der Geltungsbereichseinstellung kann ein Bean-Manager einzelne oder mehrere Objektinstanzen erstellen. Die Blueprint-Container-Spezifikation definiert zwei Hauptgeltungsbereiche:
- singleton
- Der Bean-Manager erstellt eine einzige Instanz der Bean und gibt diese Instanz jedes Mal zurück, wenn der Manager aufgefordert wird, ein Objekt bereitzustellen.
- prototype
- Der Bean-Manager erstellt jedes Mal eine neue Instanz der Bean, wenn er aufgefordert wird, ein Objekt bereitzustellen.
- dependsOn
- Gibt eine Liste von Manager-IDs an. Die aufgelisteten Manager werden zuerst aktiviert, bevor der Manager aktiviert wird. Ein Manager kann explizit und implizit Abhängigkeiten aufweisen. Das Attribut dependsOn definiert die expliziten Abhängigkeiten. Die impliziten Abhängigkeiten werden durch die Referenzen auf andere Manager innerhalb einer Managerdefinition definiert.
- factory-ref
- Gibt die ID einer Bean oder eines Referenzmanagers an, der als Factory fungiert. Das angegebene Objekt muss eine Factory-Methode haben, die vom Factory-Methodenattribut angegeben ist.
- destroy-method
- Gibt eine Methode an, die aufgerufen werden soll, wenn der Blueprint-Container die Objektinstanz löscht.
- factory-method
- Gibt den Namen der statischen Factory-Methode an.
- init-method
- Die Initialisierungsmethode (init-method) wird aufgerufen, wenn die Komponente erstellt wird. Wenn Sie eine Methode nicht während der Bundleinitialisierung aufrufen möchten, entfernen Sie dieses Attribut.
- reference
- Das Element reference gibt Services an, die sich in der Service-Registry befinden. Klicken Sie auf OK, um der Referenz Elemente hinzuzufügen.
- Weitere Informationen zu Attributen für das reference-Element:
- id
- Das Attribut id gibt die Bean an. Es ist obligatorisch, wenn die Komponente von einer anderen Stelle im Entwurf (zum Beispiel von einer Servicedefinition) referenziert wird.
- interface
- Das Attribut interface verweist auf die Schnittstelle, die die Komponentenklasse implementiert.
- activation
- Dieses optionale Attribut definiert den Aktivierungsmodus für den Manager.
Es werden zwei Aktivierungsmodi unterstützt:
- eager
- Der Manager wird während der Initialisierung des Blueprint-Containers aktiviert.
- lazy
- Der Manager wird auf Anforderung gestartet.
- availability
- Steuert Anforderungen durch den Servicereferenzmanager, dass den mindestens ein Service, der mit den Auswahlkriterien übereinstimmt, vorhanden sein muss, bevor die Blueprint-Containerinitialisierung fortgesetzt wird. Für das Attribut "availability" gibt es zwei Werte:
- optional
- Services, die den Kriterien entsprechen, müssen nicht vorhanden sein.
- mandatory
- Es muss mindestens ein Service vorhanden sein, der den Kriterien entspricht.
- filter
- Gibt den Filterausdruck für die Serviceauswahl an.
- timeout
- Gibt die Zeitspanne in Millisekunden an, in der ein Proxy darauf wartet, dass ein Unterstützungsservice verfügbar wird.
- component-name
- Gibt die über den Filter gesuchte Komponente an.
- dependsOn
- Gibt eine Liste von Manager-IDs an. Die aufgelisteten Manager werden zuerst aktiviert, bevor der Manager aktiviert wird. Ein Manager kann explizit und implizit Abhängigkeiten aufweisen. Das Attribut dependsOn definiert die expliziten Abhängigkeiten. Die impliziten Abhängigkeiten werden durch die Referenzen auf andere Manager innerhalb einer Managerdefinition definiert.
- reference-list
- Das Element reference-list aktiviert das Referenzelement, um mehrere übereinstimmende Services zu finden. Klicken Sie auf OK, um der Referenzliste Elemente hinzuzufügen.
- Weitere Informationen zu Attributen für das reference-list-Element:
- id
- Das Attribut id gibt die Bean an. Es ist obligatorisch, wenn die Komponente von einer anderen Stelle im Entwurf (zum Beispiel von einer Servicedefinition) referenziert wird.
- interface
- Das Attribut interface verweist auf die Schnittstelle, die die Komponentenklasse implementiert.
- activation
- Dieses optionale Attribut definiert den Aktivierungsmodus für den Manager.
Es werden zwei Aktivierungsmodi unterstützt:
- eager
- Der Manager wird während der Initialisierung des Blueprint-Containers aktiviert.
- lazy
- Der Manager wird auf Anforderung gestartet.
- availability
- Steuert Anforderungen durch den Servicereferenzmanager, dass den mindestens ein Service, der mit den Auswahlkriterien übereinstimmt, vorhanden sein muss, bevor die Blueprint-Containerinitialisierung fortgesetzt wird. Für das Attribut "availability" gibt es zwei Werte:
- optional
- Services, die den Kriterien entsprechen, müssen nicht vorhanden sein.
- mandatory
- Es muss mindestens ein Service vorhanden sein, der den Kriterien entspricht.
- filter
- Gibt den Filterausdruck für die Serviceauswahl an.
- member-type
- Gibt den Typ des über den Manager "reference-list" bereitgestellten Member an. Das Attribut "member-type" unterstützt Folgendes:
- service-object
- Injiziert eine Liste von Service-Proxy-Objekten.
- service-reference
- Injiziert eine Liste von Servicereferenzobjekten.
- component-name
- Gibt die über den Filter gesuchte Komponente an.
- dependsOn
- Gibt eine Liste von Manager-IDs an. Die aufgelisteten Manager werden zuerst aktiviert, bevor der Manager aktiviert wird. Ein Manager kann explizit und implizit Abhängigkeiten aufweisen. Das Attribut dependsOn definiert die expliziten Abhängigkeiten. Die impliziten Abhängigkeiten werden durch die Referenzen auf andere Manager innerhalb einer Managerdefinition definiert.
- service
- Das Element service definiert den Export einer Komponente in die OSGi-Service-Registry. Klicken Sie auf OK, um dem Service Elemente hinzuzufügen.
- Weitere Informationen zu Serviceattributen:
- id
- Das Attribut id gibt die Bean an. Es ist obligatorisch, wenn die Komponente von einer anderen Stelle im Entwurf (zum Beispiel von einer Servicedefinition) referenziert wird.
- interface
- Das Attribut interface verweist auf die Schnittstelle, die die Komponentenklasse implementiert.
- activation
- Dieses optionale Attribut definiert den Aktivierungsmodus für den Manager.
Es werden zwei Aktivierungsmodi unterstützt:
- eager
- Der Manager wird während der Initialisierung des Blueprint-Containers aktiviert.
- lazy
- Der Manager wird auf Anforderung gestartet.
- auto-export
- Die Funktion für den automatischen Export wird über das Attribut "auto-export" angegeben und unterstützt die folgenden vier Optionen:
- disabled
- Dies ist der Standardwert, wenn das Attribut "auto-export" nicht angegeben ist. Die Liste der Schnittstellen muss mithilfe des Attributs "interface" oder über Unterelemente des Attributs "interfaces" angegeben werden.
- interfaces
- Registrieren Sie den Service, indem Sie alle öffentlichen Schnittstellen verwenden, die von der Serviceklasse und allen zugehörigen übergeordneten Klassen implementiert wurden.
- class-hierarchy
- Registrieren Sie den Service, indem Sie die Serviceklassen und alle zugehörigen übergeordneten öffentlichen Klassen verwenden.
- all-classes
- Kombiniert die Optionen für "interfaces" und "class-hierarchy".
- ranking
- Sie können das Attribut "ranking" verwenden, um den Service mit einer bestimmten Rangordnung verfügbar zu machen.
- ref
- Das Attribut ref bezieht sich auf die Komponenten-ID der exportierten Komponente. Diese ID wird im Komponentenelement festgelegt.
- dependsOn
- Gibt eine Liste von Manager-IDs an. Die aufgelisteten Manager werden zuerst aktiviert, bevor der Manager aktiviert wird. Ein Manager kann explizit und implizit Abhängigkeiten aufweisen. Das Attribut dependsOn definiert die expliziten Abhängigkeiten. Die impliziten Abhängigkeiten werden durch die Referenzen auf andere Manager innerhalb einer Managerdefinition definiert.
- Typconverter
- Das Element type-converters konvertiert Werte zwischen Datentypen. Klicken Sie auf OK, um dem Typconverter Elemente hinzuzufügen.
Weitere Informationen zur Blueprint-Konfigurationsdatei finden Sie in den Hilfethemen OSGi-Blueprint-XML-Dateien und OSGi-Blueprint-Container-Spezifikation.
- Klicken Sie auf WebSphere-Blueprint-Bindingdeskriptor öffnen, um eine OSGi Blueprint-Konfigurationsdatei zu erstellen, die die Ressourcenreferenzen für die Authentifizierungsaliasbindung für ein Bundle enthält.
Wenn eine OSGi-Anwendung eine OSGi-Blueprint-Bindungskonfigurationsdatei enthält, wenn sie als Asset implementiert wird, dann stellt die Bindungskonfigurationsdatei die Standardwerte für den Authentifizierungsalias bereit, die beim Binden der Ressourcenreferenzen verwendet werden.
Weitere Informationen zur Blueprint-Bindungsdatei finden Sie unter XML-Blueprint-Bindungsdatei erstellen.
- Klicken Sie auf Zusätzliche Blueprint-Namespaces hinzufügen, um der Blueprint-XML-Datei Namespaces hinzuzufügen.
- Wählen Sie im Dialog "Blueprint-Namespaces" die Namespaces aus, die Sie der Blueprint-Datei hinzufügen möchten.
- Klicken Sie auf Fertigstellen.
Diese Elemente werden auf der Basis der Blueprint-Namespaces aktiviert, die Sie der Blueprint-XML-Datei hinzufügen.
- Kontext
- Das Element bpjpa:context erweitert die Apache Aries-Blueprint-Spezifikation für JPA-Beans, die innerhalb von Blueprint-Transaktionen verwendet werden. Dieses Element wird hinzugefügt, wenn Sie den JPA-Namespace hinzufügen. Klicken Sie auf Hinzufügen, um Attribute zum Element hinzuzufügen.
- Platzhalter für Eigenschaften
- Das Element bpext:property-placeholder fügt der Apache Aries-Blueprint-Spezifikation Erweiterungen hinzu. Dieses Element wird hinzugefügt, wenn Sie den Blueprint-Erweiterungs-Namespace hinzufügen. Klicken Sie auf Hinzufügen, um Attribute zum Element hinzuzufügen.
- Ressourcenreferenz
- Das Element bpresref:resource-reference injiziert Ressourcenreferenzen beispielsweise in Beans oder Services. Dieses Element wird hinzugefügt, wenn Sie den Namespace für eine Ressourcenreferenz hinzufügen. Klicken Sie auf Hinzufügen, um Attribute zum Element hinzuzufügen.
- transaction
- Das Element tx:transaction erweitert die Apache Aries-Blueprint-Spezifikation, indem es der Blueprint-Datei Transaktionseigenschaften hinzufügt. Dieses Element wird hinzugefügt, wenn Sie den Namespace für eine Transaktion hinzufügen. Klicken Sie auf Hinzufügen, um Attribute zum Element hinzuzufügen.
- Speichern Sie die Datei.
Weitere Informationen zu OSGi-Blueprint-XML-Dateien finden Sie in den folgenden Unterabschnitten:
- OSGi-Blueprint-XML-Dateien
Blueprint-XML-Dateien definieren und beschreiben die verschiedenen Komponenten einer Anwendung. - XML-Blueprint-Bindungsdatei erstellen
Die XML-Blueprint-Bindungsdatei ibm-eba-bnd.xml enthält die Ressourcenreferenzen für die Authentifizierungsaliasbindung für ein Bundle. Wenn eine OSGi-Anwendung eine OSGi-Blueprint-Bindungskonfigurationsdatei enthält, wenn sie als Asset implementiert wird, dann stellt die Bindungskonfigurationsdatei die Standardwerte für den Authentifizierungsalias bereit, die beim Binden der Ressourcenreferenzen verwendet werden.