使用自定义通用编辑器扩展在AEM Sites Cloud中自动锁定页面

本文介绍如何通过创建自定义Universal Editor扩展和经过身份验证的Adobe Experience Manager Sites as a Cloud Service,在AEM Sites AEM中自动锁定页面,以确保在作者首次更改内容后锁定页面。

描述 description

环境

Adobe Experience Manager as a Cloud Service(所有版本)

问题/症状

  • 组织可能希望在首次有意更改内容后自动锁定AEM Sites页面,而不是依赖手动锁定或锁定页面打开,以防止并发编辑冲突。
  • 页面在首次编辑后不会自动锁定,需要手动操作并增加编辑冲突的风险。

原因

通用编辑器中的标准AEM页面锁定扩展不提供用于自动化或扩展的公共API。 支持的自动化需要自定义通用编辑器扩展和客户拥有的AEM服务,该服务在内容更改后使用文档记录的API锁定页面。

解决方法 resolution

请按照以下步骤解决问题。

  1. 构建自定义通用编辑器扩展。

    • 使用通用编辑器的可扩展性点来监听第一个有意或持续的内容更改事件。 在打开或选择页面时不会触发锁定。
    • 示例(伪代码):
    code language-none
    editor.on('contentChanged', (event) => {
        if (!pageLocked) {
            lockPage(event.pagePath);
            pageLocked = true;
        }
    });
    
  2. 实施客户拥有的AEM服务。

    • 在AEM中创建服务器端OSGi服务或Sling servlet以公开以下端点:
    • 检查当前锁定状态
    • 获取页面锁定
    • 释放页面锁定
    • 使用AEM WCM PageManager API执行锁定和解锁操作。 示例(Java):
    code language-none
    PageManager pageManager = resourceResolver.adaptTo(PageManager.class);
    Page page = pageManager.getPage(pagePath);
    
    if (page != null && !page.isLocked()) {
        page.lock();
    }
    
  3. 使用编辑器的身份验证请求。

    • Universal Editor扩展应将当前编辑器的IMS持有者令牌作为授权标头转发到AEM端点。
    • 确保已启用AEM的Granite持有者身份验证处理程序,并将其配置为接受令牌中存在的OAuth客户端ID。
    • AEM服务必须使用请求的ResourceResolver(例如request.getResourceResolver())以确保锁定归因于编辑器,而不是服务用户。
  4. 处理锁定冲突和权限。

    • 验证页面路径并解析页面。
    • 检查页面是否已锁定以及锁定者。
    • 如果无法获得锁定(例如,已由其他作者锁定),则返回清除响应。
    • 强制实施AEM权限和CSRF保护。
  5. 更新编辑器状态。

    • 成功锁定操作后,更新通用编辑器UI以反映新的锁定状态。
    • 如果页面已被其他作者锁定,则显示一条清除消息。
  6. 在发布之前解锁页面。

    • 作者应在发布之前手动解锁页面,以允许工作流继续进行。

要进行验证,请通过在通用编辑器中编辑页面来测试扩展。 确认页面在首次更改内容后已被锁定,且只有编辑作者才能将其解锁。

相关阅读

通用编辑器概述

recommendation-more-help
experience-cloud-kcs-help-kbarticles