API basata su Java per la creazione e l’attivazione di pacchetti id175UB30E05Z
La seguente API basata su Java consente di creare e attivare pacchetti CRX. Questa API è disponibile sotto forma di bundle. Per utilizzare queste API, devi includere questo bundle nel codice.
Dettagli bundle:
-
ID gruppo: com.adobe.fmdita
-
ID artefatto: api
-
Versione: 3.3
-
Pacchetto: com.adobe.fmdita.api.crxactivate
-
Dettagli classe:
code language-java public class CRXActivator
La classe
CRXActivator
contiene un metodo per creare pacchetti CRX e replicarli nell'istanza Publish.
Creare e attivare pacchetti
Il metodo activate
crea un pacchetto CRX nell'istanza di authoring e lo replica nell'istanza di pubblicazione, se necessario. Si presume che i parametri di replica AEM siano già stati impostati nell’istanza di authoring. Questo metodo crea il pacchetto CRX in base a un elenco di regole fornite come parametri di input in una stringa JSON.
outputstream
.Esempio con due parametri
Sintassi:
public static void activate
(
String json,
OutputStream outputstream,
Session session
)
throws GuidesApiException
Esempio con terzo parametro opzionale
public static void activate
(
String json,
OutputStream outputstream,
String activationTarget,
Session session
)
throws GuidesApiException
Parametri:
json
-
activate
: è di tipo booleano (true
/false
). Determina se il pacchetto CRX creato nell’istanza di authoring viene replicato nell’istanza di pubblicazione.-
rules
: è di tipo array JSON. Array di regole JSON, elaborate in sequenza per generare il pacchetto CRX.-
rootPath
: è di tipo String. Percorso di base su cui vengono eseguite le query nodo/proprietà. Se non sono presenti query nodo/proprietà, il percorso radice e tutti i nodi presenti nel percorso radice vengono inclusi nel pacchetto CRX.-
nodeQueries
: è di tipo Regex Array. Array di espressioni regolari utilizzate per includere file specifici nel percorso principale.-
propertyQueries
: è di tipo array JSON. Array di oggetti JSON con ogni oggetto JSON costituito da una query XPath da eseguire sul percorso principale e dal nome di una proprietà presente in ogni nodo JCR dopo l’esecuzione della query. Il valore della proprietà in ciascun nodo JCR deve essere un percorso o un array di percorsi. I percorsi presenti in questa proprietà vengono aggiunti al pacchetto CRX.outputstream
outputstream
. Questa opzione è utile per il debug.session
activationTarget
preview
o publish
per il Cloud Service e publish
per il software locale. Per il Cloud Service, se il parametro contiene un valore non valido, l'attivazione del pacchetto non riesce.
- Per il software locale, se il parametro contiene un valore non valido, l'errore viene registrato e la pubblicazione viene eseguita utilizzando il valore predefinito
publish
.Eccezione:
Genera java.io.IOException
e java.io.IllegalArgumentException
Se non si definisce il parametro opzionale activationTarget
, verrà attivato utilizzando l'agente di pubblicazione predefinito sia per il software di Cloud Service che per quello locale.
Esempio:
L’esempio seguente mostra come creare una query JSON:
{
"activate": true,
"rules": [
{
"rootPath": "/content/dam/nested",
"nodeQueries": [
".*\\.jpg",
".*\\.png",
".*\\.gif"
]
},
{
"rootPath": "/content/output/sites/hierarchy_ditamap"
},
{
"rootPath": "/content/output/sites/hierarchy_ditamap",
"propertyQueries": [
{
"query": "//*[@fileReference]",
"property": "fileReference"
}
]
}
]
}
La query JSON di esempio è costituita dalle regole seguenti:
- Solo le immagini .png, .jpg e .gif nel percorso /content/dam/nested sono incluse nel pacchetto.
- Tutti i nodi in /content/output/sites/hierarchy_ditamap sono inclusi nel pacchetto.
- I percorsi presenti nella proprietà
fileReference
dei nodi in /content/output/sites/hierarchy_ditamap sono inclusi nel pacchetto.