Add support for package properties "requiresRoot", "requiresRestart", "allowIndexDefinitions".

Author: stefanseifert

changes.xml

@@ -25,7 +25,7 @@
 
     <release version="1.11.0" date="not released">
       <action type="add" dev="sseifert">
-        Add support for new package property "contentPackage.packageType".
+        Add support for package properties "packageType", "requiresRoot", "requiresRestart", "allowIndexDefinitions".
       </action>
       <action type="add" dev="sseifert">
         Add validator for content package based on Jackrabbit FileVault Validation (for packages with a packageType set).

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOptions.java

@@ -88,4 +88,19 @@ private ContentPackageOptions() {
    */
   public static final String PROPERTY_PACKAGE_PACKAGE_TYPE = "contentPackage.packageType";
 
+  /**
+   * Package requires root.
+   */
+  public static final String PROPERTY_PACKAGE_REQUIRES_ROOT = "contentPackage.requiresRoot";
+
+  /**
+   * Package requires restart.
+   */
+  public static final String PROPERTY_PACKAGE_REQUIRES_RESTART = "contentPackage.requiresRestart";
+
+  /**
+   * Package allows index definitions.
+   */
+  public static final String PROPERTY_PACKAGE_ALLOW_INDEX_DEFINITIONS = "contentPackage.allowIndexDefinitions";
+
 }

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java

@@ -20,13 +20,16 @@
 package io.wcm.devops.conga.plugins.aem.util;
 
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_AC_HANDLING;
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_ALLOW_INDEX_DEFINITIONS;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_DESCRIPTION;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_FILES;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_FILTERS;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_GROUP;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_NAME;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_PACKAGE_TYPE;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_PROPERTIES;
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_REQUIRES_RESTART;
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_REQUIRES_ROOT;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_ROOT_PATH;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_THUMBNAIL_IMAGE;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_VERSION;
@@ -88,7 +91,10 @@ public static ContentPackageBuilder getContentPackageBuilder(Map<String, Object>
         .group(getMandatoryProp(options, PROPERTY_PACKAGE_GROUP))
         .name(getMandatoryProp(options, PROPERTY_PACKAGE_NAME))
         .version(getOptionalProp(options, PROPERTY_PACKAGE_VERSION))
-        .packageType(getOptionalProp(options, PROPERTY_PACKAGE_PACKAGE_TYPE));
+        .packageType(getOptionalProp(options, PROPERTY_PACKAGE_PACKAGE_TYPE))
+        .requiresRoot(getOptionalPropBoolean(options, PROPERTY_PACKAGE_REQUIRES_ROOT))
+        .requiresRestart(getOptionalPropBoolean(options, PROPERTY_PACKAGE_REQUIRES_RESTART))
+        .allowIndexDefinitions(getOptionalPropBoolean(options, PROPERTY_PACKAGE_ALLOW_INDEX_DEFINITIONS));
 
     // description
     if (fileHeader != null) {
@@ -292,6 +298,23 @@ else if (value != null) {
     return null;
   }
 
+  /**
+   * Get boolean property from options or return null if not set.
+   * @param options Options
+   * @param key Key
+   * @return Option value or false
+   */
+  private static boolean getOptionalPropBoolean(Map<String, Object> options, String key) {
+    Object value = getOptionalProp(options, key);
+    if (value instanceof Boolean) {
+      return (Boolean)value;
+    }
+    else if (value != null) {
+      return BooleanUtils.toBoolean(value.toString());
+    }
+    return false;
+  }
+
   /**
    * Get property from options or return null if not set.
    * @param options Options

src/site/markdown/extensions.md

@@ -42,6 +42,9 @@ Both post processor plugins support a set of options that allow further configur
 | `contentPackage.files`          | List of additional binary files to be included in content package. For each file you have to specify a `path` property (target path), and for the source an `url` property for an external file, or a `file` and `dir` property for a file that was generated by CONGA. If the file should be deleted after the inclusion you can additionally specify `delete: true`.
 | `contentPackage.properties`     | Defines map with additional custom properties for package metadata.
 | `contentPackage.packageType`    | Defines the [packageType][jackrabbit-filevault-packagetype] for the content package. Uses for [FileVault validation][jackrabbit-filevault-validation] of the package.
+| `contentPackage.requiresRoot`   | Package requires root.
+| `contentPackage.requiresRestart`| Package requires restart.
+| `contentPackage.allowIndexDefinitions` | Package allows index definitions.
 
 
 Example for defining package properties with a set of filters: