Befehl "wsappid"

Die Spezifikation "Java™ Persistence API (JPA)" bietet die Möglichkeit, den Primärschlüssel einer Entität aus mehreren Spalten zu bilden. In diesem Fall wird der Primärschlüssel als zusammengesetzter oder Verbundprimärschlüssel bezeichnet. Stellen Sie ID-Klasse bereit, die mit der Annotation "@IdClass" angegeben wird, um einen zusammengesetzten Primärschlüssel zu verwalten. Verwenden Sie das Identitätstool für JPA, um eine ID-Klasse für Entitäten zu generieren, die zusammengesetzte Primärschlüssel verwenden.

Syntax

Bevor Sie den Befehl ausführen, müssen Sie eine Kopie der Datei persistence.xml im Klassenpfad haben oder mit dem Argument "-p [Pfad_der_Datei_persistence.xml]" als Eigenschaftendatei angeben. Setzen Sie den Befehl über das Unterverzeichnis bin des Verzeichnisses Profilstammverzeichnis ab.

Der Befehl hat die folgende Syntax:

[AIX][HP-UX][Linux][Solaris][z/OS]
wsappid.sh [Parameter][Argumente]
[IBM i]
wsappid [Parameter][Argumente]
[Windows]
wsappid.bat [Parameter][Argumente]

Parameter

Das Tool "wsappid" akzeptiert den Standardsatz von Befehlszeilenargumenten, die vom Konfigurationsframework zusammen mit Folgendem definiert werden:
  • -directory/-d <Ausgabeverzeichnis>: Der Pfad des Ausgabeverzeichnisses.

    Wenn das Verzeichnis dem generierten Klassenpaket für die Ausgabe-ID nicht entspricht, wird die Paketstruktur unterhalb dieses Verzeichnisses erstellt. Wenn Sie diesen Parameter nicht angeben, versucht das Tool "wsappid", das Verzeichnis der Datei mit der Erweiterung .java für die Klasse, die die Persistenz unterstützt, zu ermitteln. Wird keine Datei mit der Erweiterung .java gefunden, verwendet das Tool "wsappid" das aktuelle Verzeichnis.

  • -ignoreErrors/-i <true/t | false/f>: Wenn Sie diesen Parameter auf false setzen, tritt eine Ausnahme ein, wenn das Tool für eine Klasse ausgeführt wird, die die Anwendungsidentität nicht verwendet. Ein Fehler wird auch ausgegeben, wenn eine Klasse nicht die Basisklasse in der Vererbungshierarchie hat.
  • -token/-t <Token>: Das Token, das verwendet wird, um die Werte aneinandergereihter Primärschlüssel im Zeichenfolgeformat der Objekt-ID zu trennen.

    Verwenden Sie diese Option nur, wenn es mehrere Primärschlüsselfelder gibt. Die Standardeinstellung ist "::".

  • -name/-n <Name_der_ID-Klasse>: Der Name der zu generierenden Identitätsklasse.

    Wenn Sie diese Option angeben, darf das Tool "wsappid" nur für eine einzige Klasse ausgeführt werden. Enthalten die Metadaten der Klasse bereits eine ID-Klasse für das Objekt, wird diese Option ignoriert. Wenn der Name nicht vollständig qualifiziert ist, wird das Paket der Persistenzklasse angehängt, um den vollständig qualifizierten Namen zu bilden.

  • suffix <Suffix_der_ID-Klasse>: Eine Zeichenfolge, die dem Namen jeder persistenten Klasse angehängt wird, um den Namen der Identitätsklasse zu bilden.

    Diese Option wird vom Parameter -name/-n bzw. von jeder Objekt-ID-Klasse überschrieben, die in den Metadaten angegeben ist.

Jedes weitere Argument für das Tool "wsappid" muss die folgenden Bedingungen erfüllen:
  • Der vollständige Name einer persistenten Klasse.
  • Der .java-Name für eine persistente Klasse.
  • Die .class-Datei einer persistenten Klasse.

Verwendung

Das mit JPA für Anwendungsserver verwendete Identitätstool vereinfacht die Erstellung einer Identitätsklasse für Entitäten, die zusammengesetzte IDs verwenden. Eine zusammengesetzte ID ist eine Identität, die mehrere Felder als Primärschlüssel verwendet. Die Entitätsklasse muss kompiliert werden und die Primärschlüssel müssen in der Entitätsklasse angegeben werden. Führen Sie das Tool "wsappid" über die Befehlszeile im Verzeichnis "Profilstammverzeichnis/bin/" aus. Wenn Sie diesen Befehl ausführen, wird eine neue Klasse generiert, die die zusammengesetzte ID der Entität darstellt. Nachrichten und Fehler werden wie angegeben in der Konsole protokolliert.

Beispiele

Sehen Sie sich die folgende Entität an:
@Entity 
public class Employee { 

@Id 
private int division;  

@Id private int id;  
// . . . 
}
Bevor die Entität verwendet wird, muss eine ID-Klasse angegeben werden. Für dieses Beispiel wird angenommen, dass die Entität im Verzeichnis src/main/java enthalten ist.

Zum Generieren einer ID-Klasse für die Entität "Magazine" führen Sie den folgenden Befehl aus:

[AIX][HP-UX][Linux][Solaris][z/OS]
wsappid.sh -s Id src/main/java/Employee.java -d src/main/java
[IBM i]
wsappid -s Id src/main/java/Employee.java -d src/main/java
[Windows]
wsappid.bat -s Id src\main\java\Employee.java -d src\main\java
Die neue Klasse "EmployeeId.java" wird im Verzeichnis src/main/java generiert.

Weitere Informationen

Weitere Einzelheiten finden Sie in den Informationen zur Verwendung des Tools für Anwendungsidentitäten in Persistenzklassen in der Veröffentlichung "Apache OpenJPA User Guide".


Symbol, das den Typ des Artikels anzeigt. Referenzartikel



Symbol für Zeitmarke Letzte Aktualisierung: 25.05.2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rejb_wsappid
Dateiname:rejb_wsappid.html