Dokumentation AEM Guides Dokumentation zu AEM Guides

Java-basierte APIs für die Arbeit mit DITA-Zuordnungen

Letzte Aktualisierung: 19. Dezember 2024

Themen:
Java-basierte API-DITA-Karte

Erstellt für:

Experte
Entwickler

HINWEIS

Sie können die in Experience Manager Guides verfügbaren Java-basierten APIs verwenden, um benutzerdefinierte Plug-ins zu erstellen und vordefinierte Workflows zu erweitern. Dieser Artikel wird im November 2024 archiviert.
In

finden Sie die neueste und detaillierte Dokumentation zur Verwendung der Java-basierten API.

Mit den folgenden Java-basierten APIs können Sie in AEM Guides mit DITA-Zuordnungen arbeiten. Diese APIs sind in Form eines Bundles verfügbar. Sie müssen dieses Bundle in Ihren Code aufnehmen, um diese APIs verwenden zu können.

Paketdetails:

Gruppen-ID: com.adobe.fmdita
Artefakt-ID: api
Version: .2
Paket: com.adobe.fmdita.api.maps
Klassendetails:
public class MapUtilities extends Object
Die MapUtilities-Klasse enthält Methoden zum Abrufen von Metadateninformationen aus einer DITA-Zuordnungsdatei.

DITA Map mit Angehörigen herunterladen

Die zipMapWithDependents-Methode erstellt eine ZIP-Datei, die eine DITA-Zuordnung zusammen mit allen abhängigen Elementen wie referenzierten Themen, Unterkarten, Bildern und DTDs enthält. Die ZIP-Datei für die DITA-Map wird basierend auf einer bestimmten Grundlinie erstellt.

Außerdem können Sie entweder dieselbe Struktur (übergeordnete und untergeordnete Ordner) beibehalten oder eine flache Dateistruktur in einem einzigen Ordner für alle abhängigen Dateien erstellen.

WICHTIG

Die API löst eine Ausnahme aus und kann keine ZIP-Datei erstellen, wenn eine der abhängigen Dateien fehlt.

Syntax:

public static void zipMapWithDependents(Session session,
                     String sourcePath,
                     String baseline,
                     OutputStream outputStream,
                     boolean flatFS)
                     throws RepositoryException, IOException

Parameter:

Name

Typ

Beschreibung

session

javax.jcr.Session

Eine gültige JCR-Sitzung.

sourcePath

Zeichenfolge

Pfad (im AEM-Repository) der DITA-Zuordnungsdatei, die heruntergeladen werden muss.

outputStream

java.io.OutputStream

Der Stream, in den die ZIP geschrieben werden soll.

baseline

Zeichenfolge

Der Titel der Baseline, die zum Abrufen des versionierten Inhalts verwendet wird.
Hinweis: Beim Wert wird zwischen Groß- und Kleinschreibung unterschieden.

flatFS

Boolesch

(Optional) Wenn auf „true“ gesetzt, wird eine flache Struktur von Dateien in der ZIP-Datei zurückgegeben. Wenn sich Ihre DITA-Zuordnung beispielsweise auf Inhalte in mehreren Ordnern bezieht, werden alle referenzierten Dateien in einen einzelnen Ordner gezogen. Wenn es Dateien mit demselben Namen gibt, werden diese Dateien durch Hinzufügen eines numerischen Suffix umbenannt. Alle Verweise (in DITA-Map und Themen) werden automatisch verarbeitet, da sie auf der Grundlage des neuen Speicherorts der Dateien in der flachen Ordnerstruktur aktualisiert werden. Wenn dies auf „false“ festgelegt ist, wird die Ordnerstruktur in der ZIP-Datei unverändert beibehalten. Wenn sich die DITA-Zuordnung auf Dateien aus mehreren Speicherorten bezieht, werden alle diese Speicherorte ebenfalls in der ZIP-Datei erstellt. Wenn Sie die ZIP-Datei wiederherstellen, wird die exakte Ordnerstruktur am Zielspeicherort erstellt.
Der Standardwert für diesen Parameter ist „false“.

Rückgabe:
Der Inhalt der ZIP-Datei wird in die outputStream geschrieben.

Ausnahme:
Gibt javax.jcr.RepositoryException, java.io.IOException.

DITA-Map mit abhängigen Elementen herunterladen (asynchron)

Alternativ können Sie DITA Map mit abhängigen Elementen im asynchronen Modus herunterladen. Dieser Ansatz ist bei größeren DITA-Karten nützlicher.

Die zipMapWithDependents-Methode erstellt eine ZIP-Datei, die eine DITA-Zuordnung zusammen mit allen abhängigen Elementen wie referenzierten Themen, Unterkarten, Bildern und DTDs enthält. Die ZIP-Datei für die DITA-Map wird basierend auf einer bestimmten Grundlinie erstellt.

Außerdem können Sie entweder dieselbe Struktur (übergeordnete und untergeordnete Ordner) beibehalten oder eine flache Dateistruktur in einem einzigen Ordner für alle abhängigen Dateien erstellen.

NOTE

Dieser Knoten wird nach einiger Zeit automatisch gelöscht, basierend auf der Konfiguration output.history.purgetime , falls definiert, oder 5 Tage als Standard.

Syntax:

public static CompletableFuture<Node> zipMapWithDependencies(Session session,
                     String sourcePath,
                     String baseline,
                     boolean flatFS)

Parameter:

Name

Typ

Beschreibung

session

javax.jcr.Session

Eine gültige JCR-Sitzung.

sourcePath

Zeichenfolge

Pfad (im AEM-Repository) der DITA-Zuordnungsdatei, die heruntergeladen werden muss.

baseline

Zeichenfolge

Der Titel der Baseline, die zum Abrufen des versionierten Inhalts verwendet wird.
Hinweis: Beim Wert wird zwischen Groß- und Kleinschreibung unterschieden.

flatFS

Boolesch

(Optional) Wenn auf „true“ gesetzt, wird eine flache Struktur von Dateien in der ZIP-Datei zurückgegeben. Wenn sich Ihre DITA-Zuordnung beispielsweise auf Inhalte in mehreren Ordnern bezieht, werden alle referenzierten Dateien in einen einzelnen Ordner gezogen. Wenn es Dateien mit demselben Namen gibt, werden diese Dateien durch Hinzufügen eines numerischen Suffix umbenannt. Alle Verweise (in DITA-Map und Themen) werden automatisch verarbeitet, da sie auf der Grundlage des neuen Speicherorts der Dateien in der flachen Ordnerstruktur aktualisiert werden. Wenn dies auf „false“ festgelegt ist, wird die Ordnerstruktur in der ZIP-Datei unverändert beibehalten. Wenn sich die DITA-Zuordnung auf Dateien aus mehreren Speicherorten bezieht, werden alle diese Speicherorte ebenfalls in der ZIP-Datei erstellt. Wenn Sie die ZIP-Datei wiederherstellen, wird die exakte Ordnerstruktur am Zielspeicherort erstellt.
Der Standardwert für diesen Parameter ist „false“.

Rückgabe:
Der Knoten der ZIP-Datei wird in die Klasse CompletableFutureumschlossen. Der Benutzer kann die asynchrone Verarbeitung fortsetzen und den Thread mithilfe .get()Methode der Zukunft blockieren, wenn der Knoten benötigt wird. Der zurückgegebene Wert kann auch mit einem Fehler enden, der mit .exceptionally() Methode verarbeitet werden kann.

Abrufen einer Liste von Baselines

Die getBaselineList Methode ruft eine Liste aller Baselines ab, die für eine bestimmte DITA-Zuordnung vorhanden sind.

Syntax:

public static List<HashMap<String,String>> getBaselineList(
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

Parameter:

Name

Typ

Beschreibung

session

javax.jcr.Session

Eine gültige JCR-Sitzung.

sourcePath

Zeichenfolge

Pfad (im AEM-Repository) der DITA-Map-Datei, für die die Baseline-Informationen abgerufen werden sollen.

Rückgabe:
Eine Liste mit HashMap Objekten. Jedes HashMap-Objekt stellt eine Baseline dar und enthält den Namen und Titel der Baseline.

Ausnahme:
Löst javax.jcr.RepositoryException aus.

Abrufen einer Liste von bedingten Voreinstellungen

Die getConditionalPresetList-Methode ruft eine Liste aller bedingten Vorgaben ab, die für eine bestimmte DITA-Zuordnung vorhanden sind.

Syntax:

public static List<HashMap<String,String>> getConditionalPresetList (
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

Parameter:

Name

Typ

Beschreibung

session

javax.jcr.Session

Eine gültige JCR-Sitzung.

sourcePath

Zeichenfolge

Pfad (im AEM-Repository) der DITA-Zuordnungsdatei, für die die Informationen der bedingten Voreinstellung abgerufen werden sollen.

Rückgabe:
Eine Liste mit HashMap Objekten. Jedes HashMap-Objekt stellt eine bedingte Vorgabe dar und enthält den Namen und Titel der bedingten Vorgabe.

Ausnahme:
Löst javax.jcr.RepositoryException aus.

Abrufen der DITAVAL-Dateiinformationen für eine bedingte Vorgabe

Die getDitavalFromConditionalPreset Methode ruft den Pfad der DITAVAL-Datei ab, die einer bedingten Voreinstellung für eine bestimmte DITA-Zuordnung entspricht.

Syntax:

public static String getDitavalFromConditionalPreset
    (Session session,
    String sourcePath,
    String cpName) throws RepositoryException

Parameter:

Name

Typ

Beschreibung

session

javax.jcr.Session

Eine gültige JCR-Sitzung.

sourcePath

Zeichenfolge

Pfad (im AEM-Repository) der DITA-Map-Datei, für die die DITAVAL-Datei abgerufen werden soll.

cpName

Zeichenfolge

Name der bedingten Voreinstellung in der DITA-Map, für die die DITAVAL-Datei abgerufen werden soll.

Rückgabe:
Der Pfad der DITAVAL-Datei, die der in der DITA-Zuordnungsdatei definierten bedingten Voreinstellung entspricht.

Abrufen aller Abhängigkeiten für einen Knoten

Die getAllDependencies-Methode gibt alle Abhängigkeiten eines bestimmten Knotens zurück.

Syntax:

public static List
<Node> getAllDependencies
(Node rootNode) throws GuidesApiException

Parameter:

Name

Typ

Beschreibung

rootNode

javax.jcr.Node

Der Stammknoten, für den alle Abhängigkeiten abgerufen werden sollen.

Rückgabe:
Eine Knotenliste mit allen Abhängigkeiten des Stammknotens.

recommendation-more-help