Java-API voor het maken en activeren van pakketten id175UB30E05Z

Met de volgende Java-API kunt u CRX-pakketten maken en activeren. Deze API is beschikbaar in de vorm van een bundel. U moet deze bundel in uw code omvatten om deze APIs te gebruiken.

Details bundel:

Pakketten maken en activeren

De activate wordt een CRX-pakket gemaakt voor de instantie van de auteur en wordt zo nodig in de instantie publish gerepliceerd. Men veronderstelt dat de AEM replicatieparameters reeds opstelling op de auteursinstantie zijn geweest. Met deze methode wordt het CRX-pakket gemaakt op basis van een lijst met regels die als invoerparameters in een JSON-tekenreeks worden opgegeven.

Voorbeeld met twee parameters

Syntaxis:

public static void activate
(
  String json,
  OutputStream outputstream,
  Session session
)
throws GuidesApiException

Voorbeeld met derde optionele parameter

public static void activate
(
  String json,
  OutputStream outputstream,
  String activationTarget,
  Session session
)
throws GuidesApiException

Parameters: |Naam|Type|Omschrijving| |—|—|—| |json|String|JSON-tekenreeks die het te bouwen CRX-pakket bepaalt. Gebruik de volgende indeling om de JSON-tekenreeks te maken:
- activate: Is van het type Boolean (true/false). Bepaalt of het CRX-pakket dat in de auteurinstantie is gemaakt, wordt gerepliceerd naar de publicatie-instantie.
- rules: is van het type JSON Array. Een array met JSON-regels, die opeenvolgend worden verwerkt om het CRX-pakket samen te stellen.
- rootPath: Is van het type String. Het basispad waarop de query's voor het knooppunt/de eigenschap worden uitgevoerd. Als er geen knooppunten/eigenschapquery's aanwezig zijn, worden het hoofdpad en alle knooppunten die zich onder het hoofdpad bevinden opgenomen in het CRX-pakket.
- nodeQueries: is van het type Regex Array. Een array van reguliere expressies die wordt gebruikt om specifieke bestanden op te nemen onder het hoofdpad.
- propertyQueries: is van het type JSON Array. Een array van JSON-objecten met elk JSON-object dat bestaat uit een XPath-query die moet worden uitgevoerd op het hoofdpad en de naam van een eigenschap die aanwezig is in elk JCR-knooppunt nadat de query is uitgevoerd. De waarde van de eigenschap in elk JCR-knooppunt moet een pad of een array van paden zijn. De paden in deze eigenschap worden toegevoegd aan het CRX-pakket.| |outputstream|java.io.OutputStream|This is used to write the result of various stage, such as query implementation, file inclusion, CRX package creation, or activation. Alle fouten die tijdens het maken of activeren zijn aangetroffen, worden naar de outputstream. Dit is handig voor foutopsporing.| |session|String|Een geldige JCR-sessie met activeringsmachtigingen.| |activationTarget|String|(Optioneel) preview of publish voor Cloud Service en publish voor on-premise software
- Voor Cloud Service geldt dat als de parameter een ongeldige waarde bevat, de pakketactivering mislukt.
- Voor Software op locatie, als de parameter een ongeldige waarde bevat, wordt de fout geregistreerd en wordt het publiceren gedaan gebruikend de standaardwaarde, publish. |

Uitzondering:

Pijlen java.io.IOException en java.io.IllegalArgumentException

Als u de optionele parameter niet definieert, activationTarget, activeert het het gebruiken van de standaard publicatieagent voor zowel Cloud Service als Software op-gebouw.

Voorbeeld: In het volgende voorbeeld wordt getoond hoe u een JSON-query bouwt:

{
  "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"
        }
      ]
    }
  ]
}

De voorbeeld-JSON-query bestaat uit de volgende regels: