用于创建和激活包的基于Java的API id175UB30E05Z

以下基于Java的API允许您创建和激活CRX包。 此API以捆绑包形式提供。 您必须在代码中包含此捆绑包才能使用此API。

捆绑包详细信息:

  • 组ID: com.adobe.fmdita

  • 项目ID: api

  • 版本: 3.3

  • 包: com.adobe.fmdita.api.crxactivate

  • 类详细信息:

    code language-java
    public class CRXActivator
    

    CRXActivator ​类包含用于在发布实例上创建CRX包并复制该包的方法。

创建和激活包

activate方法会在创作实例上创建CRX包,并在发布实例上复制该包(如果需要)。 假定已在创作实例上设置了AEM复制参数。 此方法会根据JSON字符串中作为输入参数提供的规则列表来创建CRX包。

NOTE
在创建或激活过程中遇到的错误将写入outputstream

具有两个参数的示例

语法

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

带有第三个可选参数的示例

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

参数
名称|类型|描述|
--------文-----------
|json|字符串|JSON字符串,用于确定要构建的CRX包。 使用以下格式创建JSON字符串:
- activate:属于布尔型(true/false)。 确定是否在创作实例中创建的CRX包复制到发布实例。
- rules:属于JSON数组的类型。 一系列JSON规则,将按顺序处理这些规则以构建CRX包。
- rootPath:属于字符串类型。 执行节点/属性查询的基本路径。 如果不存在节点/属性查询,则根路径以及根路径下存在的所有节点都将包含在CRX包中。
- nodeQueries:属于正则表达式数组的类型。 一个正则表达式数组,用于包含根路径下的特定文件。
- propertyQueries:属于JSON数组的类型。 JSON对象数组,每个JSON对象由要在根路径上执行的XPath查询以及执行查询后每个JCR节点中存在的属性名称组成。 每个JCR节点中的属性值应该是一个路径或路径数组。 此属性中存在的路径已添加到CRX包。|
|outputstream|java.io.OutputStream|用于编写各个阶段的结果,例如查询执行、文件包含、CRX包创建或激活。 在创建或激活过程中遇到的任何错误都会写入outputstream。 这对调试很有用。|
|session|字符串|具有激活权限的有效JCR会话。|
|activationTarget|字符串|(可选previewpublish用于Cloud Service,而publish用于内部部署软件
— 对于Cloud Service,如果参数包含无效值,则包激活失败。
— 对于On-Premise Software,如果参数包含无效值,将记录错误,并使用默认值publish完成发布。 |

异常

引发java.io.IOExceptionjava.io.IllegalArgumentException

如果未定义可选参数activationTarget,则它会使用Cloud Service和内部部署软件的默认发布代理来激活。

示例
以下示例显示如何构建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"
        }
      ]
    }
  ]
}

示例JSON查询包含以下规则:

  • 该包中仅包含/content/dam/nested路径下的.png、.jpg和.gif图像。
  • /content/output/sites/hierarchy_ditamap下的所有节点都包含在包中。
  • /content/output/sites/hierarchy_ditamap下的节点的fileReference属性中存在的路径包含在包中。
recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178