扩展多站点管理器

本页帮助您扩展多站点管理器的功能:

  • 了解MSM Java API的主要成员。
  • 创建可在转出配置中使用的新同步操作。
  • 修改默认语言和国家代码。
注意

本页应结合以下内容进行阅读:

注意

创作网站时使用多站点管理器及其API,因此仅用于创作环境。

Java API概述

多站点管理包括以下包:

主MSM API对象交互如下(另请参阅使用的术语):

chlimage_1-35

  • Blueprint
    A( Blueprint 如在 Blueprint配置中)指定Live Copy可从中继承内容的页面。

    chlimage_1-36

    • 使用Blueprint配置(Blueprint)是可选的,但是:

      • 允许作者在源上使用​Rollout​选项(将修改(显式)推送到继承自此源的Live Copy)。
      • 允许作者使用​创建站点;这允许用户轻松选择语言并配置Live Copy的结构。
      • 为任何生成的Live Copy定义默认转出配置。
  • LiveRelationshipLiveRelationship 定Live Copy分支中的资源与其等效的源/蓝图资源之间的连接(关系)。

    • 在实现继承和转出时使用关系。
    • LiveRelationship 对象提供对转出配置()、和与关 RolloutConfig系相关 LiveCopy的对 LiveStatus 象的访问(引用)。
    • 例如,在/content/copy/us中从/content/we-retail/language-masters的source/blueprint创建Live Copy。 资源/content/we.retail/language-masters/en/jcr:content/content/copy/us/en/jcr:content构成关系。
  • LiveCopy 包含Live Copy资源与其源/ LiveRelationshipBlueprint资源之间关系()的配置详细信息。

    • 使用LiveCopy类可访问页面路径、源/蓝图页面的路径、转出配置以及子页面是否也包含在LiveCopy中。
    • 每次使用​创建站点​或​创建Live Copy​时,都会创建LiveCopy节点。
  • LiveStatus 对象提供对的运行时状态的访 LiveRelationship问。用于查询Live Copy的同步状态。

  • LiveAction 是对转出中涉及的每个资源执行的操作。

    • LiveActions只由RolloutConfigs生成。
  • LiveActionFactory 创建 LiveAction 给定配置的 LiveAction 对象。配置作为资源存储在存储库中。

  • RolloutConfig 保存列表 LiveActions,在触发时使用。LiveCopy继承RolloutConfig,结果显示在LiveRelationship中。

    • 首次设置Live Copy时还会使用RolloutConfig(它触发LiveActions)。

创建新同步操作

创建要用于转出配置的自定义同步操作。 当已安装的操作不符合您的特定应用程序要求时,创建同步操作。 为此,请创建两个类:

LiveActionFactory为给定配置创建LiveAction类的实例:

  • LiveAction 类包括以下方法:

    • getName:返回操作的名称。名称用于引用操作,例如转出配置中。
      • execute:执行操作的任务。
  • LiveActionFactory 类包括以下成员:

    • LIVE_ACTION_NAME:包含关联名称的字段 LiveAction。此名称必须与LiveAction类的getName方法返回的值一致。
    • createAction:创建实例 LiveAction。可选的Resource参数可用于提供配置信息。
    • createsAction:返回关联的名称 LiveAction

访问LiveAction配置节点

使用存储库中的LiveAction配置节点存储影响LiveAction实例的运行时行为的信息。 存储LiveAction配置的存储库中的节点在运行时可用于LiveActionFactory对象。 因此,您可以根据需要向配置节点添加属性并在LiveActionFactory实现中使用这些属性。

例如,LiveAction需要存储blueprint作者的名称。 配置节点的属性包括存储信息的蓝图页的属性名称。 在运行时,LiveAction从配置中检索属性名称,然后获取属性值。

LiveActionFactory.createAction方法的参数是Resource对象。 此Resource对象表示转出配置中此实时操作的cq:LiveSyncAction节点;请参阅创建转出配置。 与通常使用配置节点时一样,您应将其调整为ValueMap对象:

public LiveAction createAction(Resource resource) throws WCMException {
        ValueMap config;
        if (resource == null || resource.adaptTo(ValueMap.class) == null) {
            config = new ValueMapDecorator(Collections.<String, Object>emptyMap());
        } else {
            config = resource.adaptTo(ValueMap.class);
        }
        return new MyLiveAction(config, this);
}

访问目标节点、源节点和LiveRelationship

以下对象作为LiveAction对象的execute方法的参数提供:

  • 一个Resource对象,它表示Live Copy的源。

  • 一个Resource对象,它表示Live Copy的目标。

  • Live Copy的LiveRelationship对象。

  • autoSave值指示您的LiveAction是否应保存对存储库所做的更改。

  • 重置值指示转出重置模式。

从这些对象中,您可以获得有关LiveCopy的所有信息。 还可以使用Resource对象获取ResourceResolverSessionNode对象。 这些对象可用于处理存储库内容:

在以下代码的第一行中,source是源页面的Resource对象:

ResourceResolver resolver = source.getResourceResolver();
Session session = resolver.adaptTo(javax.jcr.Session.class);
Node sourcenode = source.adaptTo(javax.jcr.Node.class);
注意

Resource参数可以是不适应Node对象的nullResources对象,如NonExistingResource对象。

创建新转出配置

当安装的转出配置不符合您的应用程序要求时,创建转出配置:

在 Blueprint 或 Live Copy 页面上设置转出配置时,您可以使用该新转出配置。

注意

另请参阅自定义推广的最佳实践

创建转出配置

要创建新转出配置,请执行以下操作:

  1. 开放CRXDE Lite;例如:
    http://localhost:4502/crx/de

  2. 导航至 :
    /apps/msm/<your-project>/rolloutconfigs

    注意

    这是您项目的自定义版本:
    /libs/msm/wcm/rolloutconfigs
    如果这是您的第一个配置,则必须创建。

    注意

    您不得更改/libs路径中的任何内容。
    这是因为下次升级实例时,/libs的内容会被覆盖(当您应用修补程序或功能包时,很可能会被覆盖)。
    建议的配置和其他更改方法是:

    • 在/apps下重新创建所需项(即,它存在于/libs中)
    • 在/apps中进行任何更改
  3. 在此​下创建​具有以下属性的节点:

    • 名称:转出配置的节点名称。md#installed-synchronization-actions),例如contentCopyworkflow
    • 类型: cq:RolloutConfig
  4. 向此节点添加以下属性:

    • 名称: jcr:title

      类型: String
      :将在UI中显示的标识标题。

    • 名称: jcr:description

      类型: String
      :可选描述。

    • 名称: cq:trigger

      类型: String
      :要 使用 的转出触发器。选择自:

      • rollout
      • modification
      • publish
      • deactivate
  5. 单击​保存全部

将同步操作添加到转出配置

转出配置存储在转出配置节点下,您已在/apps/msm/<your-project>/rolloutconfigs节点下创建该节点。

添加类型为cq:LiveSyncAction的子节点,以将同步操作添加到转出配置。 同步操作节点的顺序决定操作的发生顺序。

  1. 仍处于CRXDE Lite状态,请选择转出配置节点。

    例如:
    /apps/msm/myproject/rolloutconfigs/myrolloutconfig

  2. 建具有以下节点属性的节点:

    • 名称:同步操作的节点名称。该名称必须与同步操作下的表中的​操作名称​相同,例如contentCopyworkflow
    • 类型: cq:LiveSyncAction
  3. 根据需要添加和配置任意数量的同步操作节点。 重新排列操作节点,使其顺序与您希望它们出现的顺序相匹配。 最先出现的操作节点。

  4. 单击​保存全部

创建和使用简单LiveActionFactory类

按照本节中的步骤开发LiveActionFactory并将其用于转出配置。 该过程使用Maven和Eclipse开发和部署LiveActionFactory:

  1. 创建主项 目并将其导入Eclipse。
  2. 将依 赖项添加到POM文件。
  3. 实施接 LiveActionFactory 口并部署OSGi捆绑包。
  4. 创建转出配置
  5. 创建Live Copy

Maven项目和Java类的源代码可在公共Git存储库中使用。

GITHUB上的代码

您可以在GitHub上找到此页面的代码

创建Maven项目

以下过程要求您已将adobe-public用户档案添加到Maven设置文件。

  1. 打开终端或命令行会话并更改目录以指向创建项目的位置。

  2. 输入以下命令:

    mvn archetype:generate -DarchetypeGroupId=com.day.jcr.vault -DarchetypeArtifactId=multimodule-content-package-archetype -DarchetypeVersion=1.0.0 -DarchetypeRepository=adobe-public-releases
    
  3. 在交互式提示符下指定以下值:

    • groupId: com.adobe.example.msm
    • artifactId: MyLiveActionFactory
    • version: 1.0-SNAPSHOT
    • package: MyPackage
    • appsFolderName: myapp
    • artifactName: MyLiveActionFactory package
    • packageGroup: myPackages
  4. 开始Eclipse和导入Maven项目

向POM文件添加依赖项

添加依赖关系,以便Eclipse编译器可以引用LiveActionFactory代码中使用的类。

  1. 从Eclipse项目资源管理器中,打开文件:

    MyLiveActionFactory/pom.xml

  2. 在编辑器中,单击pom.xml选项卡并找到project/dependencyManagement/dependencies部分。

  3. dependencyManagement元素中添加以下XML,然后保存文件。

     <dependency>
      <groupId>com.day.cq.wcm</groupId>
      <artifactId>cq-msm-api</artifactId>
      <version>5.6.2</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>org.apache.sling</groupId>
      <artifactId>org.apache.sling.api</artifactId>
      <version>2.4.3-R1488084</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>com.day.cq.wcm</groupId>
      <artifactId>cq-wcm-api</artifactId>
      <version>5.6.6</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>org.apache.sling</groupId>
      <artifactId>org.apache.sling.commons.json</artifactId>
      <version>2.0.6</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>com.day.cq</groupId>
      <artifactId>cq-commons</artifactId>
      <version>5.6.4</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>org.apache.sling</groupId>
      <artifactId>org.apache.sling.jcr.jcr-wrapper</artifactId>
      <version>2.0.0</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>com.day.cq</groupId>
      <artifactId>cq-commons</artifactId>
      <version>5.6.4</version>
      <scope>provided</scope>
     </dependency>
    
  4. 从​项目资源管理器​打开包的POM文件,地址为MyLiveActionFactory-bundle/pom.xml

  5. 在编辑器中,单击pom.xml选项卡并找到项目/依赖关系部分。 在依赖关系元素中添加以下XML,然后保存文件:

     <dependency>
      <groupId>com.day.cq.wcm</groupId>
      <artifactId>cq-msm-api</artifactId>
     </dependency>
     <dependency>
      <groupId>org.apache.sling</groupId>
      <artifactId>org.apache.sling.api</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.cq.wcm</groupId>
      <artifactId>cq-wcm-api</artifactId>
     </dependency>
     <dependency>
      <groupId>org.apache.sling</groupId>
      <artifactId>org.apache.sling.commons.json</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.cq</groupId>
      <artifactId>cq-commons</artifactId>
     </dependency>
     <dependency>
      <groupId>org.apache.sling</groupId>
      <artifactId>org.apache.sling.jcr.jcr-wrapper</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.cq</groupId>
      <artifactId>cq-commons</artifactId>
     </dependency>
    

实施LiveActionFactory

以下LiveActionFactory类实现一个LiveAction,它记录有关源和目标页的消息,并将cq:lastModifiedBy属性从源节点复制到目标节点。 实时操作的名称为exampleLiveAction

  1. 在Eclipse项目资源管理器中,右键单击MyLiveActionFactory-bundle/src/main/java/com.adobe.example.msm包,然后单击​新建 > 。 对于​名称,输入ExampleLiveActionFactory,然后单击​完成

  2. 打开ExampleLiveActionFactory.java文件,用以下代码替换内容并保存文件。

    package com.adobe.example.msm;
    
    import java.util.Collections;
    
    import org.apache.felix.scr.annotations.Component;
    import org.apache.felix.scr.annotations.Property;
    import org.apache.felix.scr.annotations.Service;
    import org.apache.sling.api.resource.Resource;
    import org.apache.sling.api.resource.ResourceResolver;
    import org.apache.sling.api.resource.ValueMap;
    import org.apache.sling.api.wrappers.ValueMapDecorator;
    import org.apache.sling.commons.json.io.JSONWriter;
    import org.apache.sling.commons.json.JSONException;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    import javax.jcr.Node;
    import javax.jcr.RepositoryException;
    import javax.jcr.Session;
    
    import com.day.cq.wcm.msm.api.ActionConfig;
    import com.day.cq.wcm.msm.api.LiveAction;
    import com.day.cq.wcm.msm.api.LiveActionFactory;
    import com.day.cq.wcm.msm.api.LiveRelationship;
    import com.day.cq.wcm.api.WCMException;
    
    @Component(metatype = false)
    @Service
    public class ExampleLiveActionFactory implements LiveActionFactory<LiveAction> {
     @Property(value="exampleLiveAction")
     static final String actionname = LiveActionFactory.LIVE_ACTION_NAME;
    
     public LiveAction createAction(Resource config) {
      ValueMap configs;
      /* Adapt the config resource to a ValueMap */
            if (config == null || config.adaptTo(ValueMap.class) == null) {
                configs = new ValueMapDecorator(Collections.<String, Object>emptyMap());
            } else {
                configs = config.adaptTo(ValueMap.class);
            }
    
      return new ExampleLiveAction(actionname, configs);
     }
     public String createsAction() {
      return actionname;
     }
     /************* LiveAction ****************/
     private static class ExampleLiveAction implements LiveAction {
      private String name;
      private ValueMap configs;
      private static final Logger log = LoggerFactory.getLogger(ExampleLiveAction.class);
    
      public ExampleLiveAction(String nm, ValueMap config){
       name = nm;
       configs = config;
      }
    
      public void execute(Resource source, Resource target,
        LiveRelationship liverel, boolean autoSave, boolean isResetRollout)
          throws WCMException {
    
       String lastMod = null;
    
       log.info(" *** Executing ExampleLiveAction *** ");
    
       /* Determine if the LiveAction is configured to copy the cq:lastModifiedBy property */
       if ((Boolean) configs.get("repLastModBy")){
    
        /* get the source's cq:lastModifiedBy property */
        if (source != null && source.adaptTo(Node.class) !=  null){
         ValueMap sourcevm = source.adaptTo(ValueMap.class);
         lastMod = sourcevm.get(com.day.cq.wcm.msm.api.MSMNameConstants.PN_PAGE_LAST_MOD_BY, String.class);
        }
    
        /* set the target node's la-lastModifiedBy property */
        Session session = null;
        if (target != null && target.adaptTo(Node.class) !=  null){
         ResourceResolver resolver = target.getResourceResolver();
         session = resolver.adaptTo(javax.jcr.Session.class);
         Node targetNode;
         try{
          targetNode=target.adaptTo(javax.jcr.Node.class);
          targetNode.setProperty("la-lastModifiedBy", lastMod);
          log.info(" *** Target node lastModifiedBy property updated: {} ***",lastMod);
         }catch(Exception e){
          log.error(e.getMessage());
         }
        }
        if(autoSave){
         try {
          session.save();
         } catch (Exception e) {
          try {
           session.refresh(true);
          } catch (RepositoryException e1) {
           e1.printStackTrace();
          }
          e.printStackTrace();
         }
        }
       }
      }
      public String getName() {
       return name;
      }
    
      /************* Deprecated *************/
      @Deprecated
      public void execute(ResourceResolver arg0, LiveRelationship arg1,
        ActionConfig arg2, boolean arg3) throws WCMException {  
      }
      @Deprecated
      public void execute(ResourceResolver arg0, LiveRelationship arg1,
        ActionConfig arg2, boolean arg3, boolean arg4)
          throws WCMException {  
      }
      @Deprecated
      public String getParameterName() {
       return null;
      }
      @Deprecated
      public String[] getPropertiesNames() {
       return null;
      }
      @Deprecated
      public int getRank() {
       return 0;
      }
      @Deprecated
      public String getTitle() {
       return null;
      }
      @Deprecated
      public void write(JSONWriter arg0) throws JSONException {
      }
     }
    }
    
  3. 使用终端或命令会话,将目录更改为MyLiveActionFactory目录(Maven项目目录)。 然后,输入以下命令:

    mvn -PautoInstallPackage clean install
    

    AEM error.log文件应指示已启动捆绑包。

    例如,http://localhost:4502/system/console/status-slinglogs

    13.08.2013 14:34:55.450 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle BundleEvent RESOLVED
    13.08.2013 14:34:55.451 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle BundleEvent STARTING
    13.08.2013 14:34:55.451 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle BundleEvent STARTED
    13.08.2013 14:34:55.453 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle Service [com.adobe.example.msm.ExampleLiveActionFactory,2188] ServiceEvent REGISTERED
    13.08.2013 14:34:55.454 *INFO* [OsgiInstallerImpl] org.apache.sling.audit.osgi.installer Started bundle com.adobe.example.msm.MyLiveActionFactory-bundle [316]
    

创建示例转出配置

创建使用您创建的LiveActionFactory的MSM转出配置:

  1. 使用标准过程](/docs/experience-manager-64/administering/introduction/msm-sync.html?lang=zh-Hans#creating-a-rollout-configuration)创建和配置[转出配置——并使用属性:

    • 标题:示例转出配置
    • 名称:examplerolloutconfig
    • cq:trigger: publish

将Live Action添加到示例转出配置

配置您在上一个过程中创建的转出配置,以使其使用ExampleLiveActionFactory类。

  1. 开放CRXDE Lite;例如,http://localhost:4502/crx/de

  2. /apps/msm/rolloutconfigs/examplerolloutconfig/jcr:content下创建以下节点:

    • 名称: exampleLiveAction
    • 类型: cq:LiveSyncAction
  3. 单击​保存全部

  4. 选择exampleLiveAction节点并添加以下属性:

    • 名称: repLastModBy
    • 类型: Boolean
    • : true

    此属性向ExampleLiveAction类指示应将cq:LastModifiedBy属性从源复制到目标节点。

  5. 单击​保存全部

创建Live Copy

使用转 出配置创建We.Retail Reference Site的English/Products分支的实时版本:

  • 来源: /content/we-retail/language-masters/en/products

  • 转出配置:示例转出配置

激活源分支的​产品(英语)页,并观察LiveAction类生成的日志消息:

16.08.2013 10:53:33.055 *INFO* [Thread-444535] com.adobe.example.msm.ExampleLiveActionFactory$ExampleLiveAction  *** ExampleLiveAction has been executed.***
16.08.2013 10:53:33.055 *INFO* [Thread-444535] com.adobe.example.msm.ExampleLiveActionFactory$ExampleLiveAction  *** Target node lastModifiedBy property updated: admin ***

更改语言名称和默认国家/地区

AEM使用默认的语言和国家代码集。

  • 默认语言代码是ISO-639-1定义的小写双字母代码。
  • 默认国家/地区代码是ISO 3166定义的小写或大写双字母代码。

MSM使用语言和国家代码的存储列表来确定与页面语言版本名称关联的国家/地区名称。 您可以根据需要更改列表的以下方面:

  • 语言标题
  • 国家/地区名称
  • 语言的默认国家/地区(对于代码,如ende等)

语言列表存储在/libs/wcm/core/resources/languages节点下。 每个子节点表示语言或语言国家/地区:

  • 节点的名称是语言代码(如ende),或language_country代码(如en_usde_ch)。

  • 节点的language属性存储代码语言的全名。

  • 节点的country属性存储代码的国家/地区的完整名称。

  • 当节点名称仅包含语言代码(如en)时,国家/地区属性为*,而附加的defaultCountry属性存储语言国家/地区的代码以指示要使用的国家/地区。

chlimage_1-38

要修改语言,请执行以下操作:

  1. 在Web浏览器中打开CRXDE Lite;例如http://localhost:4502/crx/de

  2. 选择/apps文件夹,单击​创建,然后单击​创建文件夹。

    命名新文件夹wcm

  3. 重复上一步,创建/apps/wcm/core文件夹树。 在核心中创建名为resources的类型为sling:Folder的节点。

  4. 右键单击/libs/wcm/core/resources/languages节点,然后单击​复制

  5. 右键单击/apps/wcm/core/resources文件夹,然后单击​粘贴。 根据需要修改子节点。

  6. 单击​保存全部

  7. 单击​工具操作,然后单击​Web控制台。 在此控制台中,单击​OSGi,然后单击​配置

  8. 找到并单击​Day CQ WCM语言管理器,将​语言列表​的值更改为/apps/wcm/core/resources/languages,然后单击​保存

    chlimage_1-40

在页面属性上配置MSM锁(触屏优化UI)

创建自定义页面属性时,您可能需要考虑新属性是否有资格转出到任何Live Copy。

例如,如果添加了两个新页面属性:

  • 联系电子邮件:

    • 此属性不必推出,因为它在每个国家/地区(或品牌等)都会有所不同。
  • 关键视觉样式:

    • 项目要求是,此属性将按所有国家(或品牌等)共同的方式(通常)推广。

然后,您需要确保:

  • 联系电子邮件:

  • 关键视觉样式:

    • 确保在触屏优化UI中不允许编辑此属性,除非取消继承,还可以恢复继承;可通过单击切换以指示连接状态的链/断链链链接来控制此连接。

页面属性是否可以滚出,因此在编辑时可以取消/恢复继承,这由对话框属性控制:

  • cq-msm-lockable

    • 适用于触屏优化UI对话框中的项

    • 将在对话框中创建链式链接符号

    • 仅允许在继承被取消(链链链断开)时进行编辑

    • 仅适用于资源的第一个子级别

    • 类型: String

    • :持有所考虑物业之名称(及与物业价值相若 name;例如,请参阅

      /libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

定义cq-msm-lockable后,断开/关闭链将通过以下方式与MSM交互:

  • 如果cq-msm-lockable的值为:

    • 相对 (例如 myProperty./myProperty)

      • 它将从cq:propertyInheritanceCancelled添加和删除属性。
    • 绝对 (例如, /image)

      • 通过将cq:LiveSyncCancelled mixin添加到./image并将cq:isCancelledForChildren设置为true,中断链将取消继承。
      • 关闭链将恢复继承。
注意

cq-msm-lockable适用于要编辑的资源的第一个子级,它在任何更深层的上级上都不起作用,无论该值是定义为绝对值还是相对值。

注意

重新启用继承时,Live Copy页面属性不会自动与源属性同步。 如果需要,可以手动请求同步。

在此页面上