Replication

adobe/skills/plugins/aem/cloud-service/skills/content-distribution/replication

作者 adobe940b8795c0dfApache-2.0197 个星标收录于 2026年10月9日更新于 2026年10月8日仓库今天更新

Publish, deactivate, and delete AEM content programmatically via the Cloud Service Replication API (com.day.cq.replication). Covers single-path and bulk activation, preview-tier targeting with AgentFilter, synchronous/async options, ReplicationStatus checks, permission validation, workflow process steps, and replication event handling. Use when the user needs to publish pages, activate or deactivate content, check replication status, build workflow steps that replicate content, listen to replication events, query batch publication state, or work with Replicator, ReplicationOptions, or ReplicationStatusProvider in AEM Cloud Service.

仅含说明Software Development
AI 生成的概览

指导通过 Replication API 以编程方式发布、取消发布和检查 AEM Cloud Service 内容状态。

功能
提供使用 com.day.cq.replication API 激活、停用和删除 AEM 内容的 Java 代码模式，涵盖单路径与批量复制、使用 AgentFilter 定位预览层、同步与异步选项以及权限检查。还介绍 ReplicationStatus 与批量状态查询、工作流处理步骤，以及用于复制事件的 OSGi 事件处理器。配套参考文件包含自动发布、缓存清除和服务用户配置的完整实现。
适用场景
适用于构建以编程方式发布或取消发布 AEM Cloud Service 内容的自定义 OSGi 服务、工作流步骤或自动化流水线。也适合检查复制状态、查询批量发布状态或响应复制事件。对于基于界面的发布，该技能建议改用 Manage Publication 或 Quick Publish。
运行要求
需要具备 com.day.cq.replication API 的 AEM Cloud Service 环境、OSGi 与 Sling 依赖以及 JCR 会话。复制操作需要拥有 jcr:read 和 crx:replicate 权限的服务用户，且预览代理必须在 Cloud Manager 中配置。不附带脚本，仅为说明文档加一份参考文档。

AEM Cloud Service Replication API

Programmatic content publishing and unpublishing using the official AEM Replication API.

When to Use This Skill

Use the Replication API for programmatic content distribution:

  • Custom OSGi services that publish content
  • Workflow process steps requiring activation
  • Automated publishing pipelines
  • Integration with external systems
  • Bulk operations (with proper constraints)

For UI-based publishing, use Manage Publication or Quick Publish instead.

Official API Documentation

Javadoc: https://developer.adobe.com/experience-manager/reference-materials/cloud-service/javadoc/com/day/cq/replication/package-summary.html

Key Classes:

  • com.day.cq.replication.Replicator - Main replication service
  • com.day.cq.replication.ReplicationOptions - Configuration options
  • com.day.cq.replication.ReplicationStatus - Publication status
  • com.day.cq.replication.ReplicationActionType - Action types (ACTIVATE, DEACTIVATE, DELETE, TEST)

Basic Replication: Single Path

Example: Activate a Page

java
import com.day.cq.replication.Replicator;import com.day.cq.replication.ReplicationActionType;import com.day.cq.replication.ReplicationException;import org.osgi.service.component.annotations.Component;import org.osgi.service.component.annotations.Reference;import javax.jcr.Session;
@Component(service = ContentPublisher.class)public class ContentPublisher {        @Reference    private Replicator replicator;        /**     * Activate a single page to Publish tier     */    public void publishPage(Session session, String pagePath)             throws ReplicationException {                replicator.replicate(            session,            ReplicationActionType.ACTIVATE,            pagePath        );    }        /**     * Deactivate a page from Publish tier     */    public void unpublishPage(Session session, String pagePath)             throws ReplicationException {                replicator.replicate(            session,            ReplicationActionType.DEACTIVATE,            pagePath        );    }        /**     * Delete content from Publish tier     */    public void deleteFromPublish(Session session, String path)             throws ReplicationException {                replicator.replicate(            session,            ReplicationActionType.DELETE,            path        );    }}

Bulk Replication: Multiple Paths

CONSTRAINTS (per official Javadoc):

  • Recommended limit: 100 paths per call for a transactional guarantee
  • Above 100 paths: the system automatically splits into multiple non-transactional chunks — no extra options needed
  • Payload size: 10 MB maximum (excluding binaries)

Note: ReplicationOptions.setUseAtomicCalls() is @Deprecated and marked "no longer required" in the Cloud Service Javadoc. Do not call it; the system handles auto-bucketing automatically.

Example: Bulk Activation

java
public class BulkPublisher {        @Reference    private Replicator replicator;        /**     * Publish multiple pages.     * ≤100 paths → replicated atomically (transactional guarantee).     * >100 paths → system automatically splits into non-transactional chunks.     */    public void publishMultiplePages(Session session, String[] pagePaths)             throws ReplicationException {                replicator.replicate(            session,            ReplicationActionType.ACTIVATE,            pagePaths,            null  // No options needed; system handles auto-bucketing above 100 paths        );    }}

Best Practice: For large hierarchical content trees, use the Tree Activation workflow step instead of custom code.

Publishing to Preview Tier

The Preview tier requires explicit agent filtering.

Example: Publish to Preview

java
import com.day.cq.replication.Agent;import com.day.cq.replication.AgentFilter;
public class PreviewPublisher {        @Reference    private Replicator replicator;        /**     * Publish to Preview tier only     */    public void publishToPreview(Session session, String pagePath)             throws ReplicationException {                ReplicationOptions options = new ReplicationOptions();                // Filter to target Preview agent only        options.setFilter(new AgentFilter() {            @Override            public boolean isIncluded(Agent agent) {                return "preview".equals(agent.getId());            }        });                replicator.replicate(            session,            ReplicationActionType.ACTIVATE,            pagePath,            options        );    }        /**     * Publish to BOTH Preview and Publish tiers     */    public void publishToBothTiers(Session session, String pagePath)             throws ReplicationException {                ReplicationOptions options = new ReplicationOptions();                // Include both preview and publish agents        options.setFilter(new AgentFilter() {            @Override            public boolean isIncluded(Agent agent) {                String agentId = agent.getId();                return "preview".equals(agentId) || "publish".equals(agentId);            }        });                replicator.replicate(            session,            ReplicationActionType.ACTIVATE,            pagePath,            options        );    }}

Note: Preview agent is disabled by default and must be configured in Cloud Manager.

Advanced Options: ReplicationOptions

Synchronous vs. Asynchronous Replication

java
public class SynchronousPublisher {        @Reference    private Replicator replicator;        /**     * Synchronous replication (wait for completion)     */    public void publishSynchronously(Session session, String pagePath)             throws ReplicationException {                ReplicationOptions options = new ReplicationOptions();        options.setSynchronous(true);  // Block until complete                // Optional: Add listener for synchronous feedback        options.setListener(new ReplicationListener() {            @Override            public void onStart(ReplicationAction action) {                // Called when replication starts            }                        @Override            public void onMessage(ReplicationLog.Level level, String message) {                // Called for progress updates            }                        @Override            public void onEnd(ReplicationAction action, ReplicationResult result) {                // Called when replication completes            }                        @Override            public void onError(ReplicationAction action, Exception error) {                // Called if replication fails            }        });                replicator.replicate(            session,            ReplicationActionType.ACTIVATE,            pagePath,            options        );    }}

Important: ReplicationListener only works with synchronous replication.

Suppress Status Updates

java
/** * Replicate without updating replication metadata properties */public void replicateWithoutStatusUpdate(Session session, String path)         throws ReplicationException {        ReplicationOptions options = new ReplicationOptions();    options.setSuppressStatusUpdate(true);  // Don't update cq:lastReplicated, etc.        replicator.replicate(        session,        ReplicationActionType.ACTIVATE,        path,        options    );}

Suppress Versioning

java
/** * Replicate without creating implicit versions */public void replicateWithoutVersioning(Session session, String path)         throws ReplicationException {        ReplicationOptions options = new ReplicationOptions();    options.setSuppressVersions(true);  // Don't auto-version on replication        replicator.replicate(        session,        ReplicationActionType.ACTIVATE,        path,        options    );}

Checking Replication Status

Example: Check if Page is Published

java
import com.day.cq.replication.ReplicationStatus;import org.apache.sling.api.resource.Resource;
public class StatusChecker {        @Reference    private Replicator replicator;        /**     * Check if content is currently published     */    public boolean isPublished(Session session, String path)             throws ReplicationException {                ReplicationStatus status = replicator.getReplicationStatus(session, path);                if (status == null) {            return false;  // No replication metadata        }                return status.isActivated();    }        /**     * Get detailed replication information     */    public void printReplicationInfo(Session session, String path)             throws ReplicationException {                ReplicationStatus status = replicator.getReplicationStatus(session, path);                if (status != null) {            System.out.println("Activated: " + status.isActivated());            System.out.println("Deactivated: " + status.isDeactivated());            System.out.println("Last Published: " + status.getLastPublished());            System.out.println("Published By: " + status.getLastPublishedBy());            System.out.println("Last Action: " + status.getLastReplicationAction());            System.out.println("Pending: " + status.isPending());        }    }        /**     * Alternative: Adapt resource to ReplicationStatus     */    public boolean isPublished(Resource resource) {        ReplicationStatus status = resource.adaptTo(ReplicationStatus.class);        return status != null && status.isActivated();    }}

Batch Status Queries

Use ReplicationStatusProvider.getBatchReplicationStatus() when you need to check the publication state of multiple resources in a single call. It is more efficient than calling Replicator.getReplicationStatus() in a loop.

Javadoc: com.day.cq.replication.ReplicationStatusProvider

java
import com.day.cq.replication.ReplicationStatus;import com.day.cq.replication.ReplicationStatusProvider;import org.apache.sling.api.resource.Resource;import org.apache.sling.api.resource.ResourceResolver;import org.osgi.service.component.annotations.Component;import org.osgi.service.component.annotations.Reference;
@Component(service = BatchStatusChecker.class)public class BatchStatusChecker {
    @Reference    private ReplicationStatusProvider replicationStatusProvider;
    /**     * Returns a map of path → ReplicationStatus for all given paths.     * Uses ReplicationStatusProvider.getBatchReplicationStatus(Resource...)     * which is more efficient than per-path Replicator.getReplicationStatus() calls.     */    public Map<String, Boolean> checkPublishedState(ResourceResolver resolver, String[] paths) {        // Resolve all paths to Resource objects        Resource[] resources = Arrays.stream(paths)            .map(resolver::getResource)            .filter(Objects::nonNull)            .toArray(Resource[]::new);
        // Single batch call — returns Map<path, ReplicationStatus>        Map<String, ReplicationStatus> statusMap =            replicationStatusProvider.getBatchReplicationStatus(resources);
        Map<String, Boolean> result = new LinkedHashMap<>();        for (String path : paths) {            ReplicationStatus status = statusMap.get(path);            result.put(path, status != null && status.isActivated());        }        return result;    }}

Required imports:

java
import java.util.Arrays;import java.util.LinkedHashMap;import java.util.Map;import java.util.Objects;

Permission Checks

Example: Validate User Can Replicate

java
public class PermissionValidator {        @Reference    private Replicator replicator;        /**     * Check if user has permission to replicate     */    public boolean canUserReplicate(Session session, String path) {        try {            replicator.checkPermission(                session,                ReplicationActionType.ACTIVATE,                path            );            return true;        } catch (ReplicationException e) {            // User lacks permission            return false;        }    }        /**     * Validate before replicating     */    public void safeReplicate(Session session, String path)             throws ReplicationException {                // Check permission first        replicator.checkPermission(session, ReplicationActionType.ACTIVATE, path);                // Proceed with replication        replicator.replicate(session, ReplicationActionType.ACTIVATE, path);    }}

Workflow Integration

Example: Workflow Process Step

java
import com.adobe.granite.workflow.WorkflowException;import com.adobe.granite.workflow.WorkflowSession;import com.adobe.granite.workflow.exec.WorkItem;import com.adobe.granite.workflow.exec.WorkflowProcess;import com.adobe.granite.workflow.metadata.MetaDataMap;import org.osgi.service.component.annotations.Component;
@Component(    service = WorkflowProcess.class,    property = {        "process.label=Publish Content to Publish Tier"    })public class PublishWorkflowProcess implements WorkflowProcess {        @Reference    private Replicator replicator;        @Override    public void execute(WorkItem workItem, WorkflowSession workflowSession,                        MetaDataMap args) throws WorkflowException {                String payloadPath = workItem.getWorkflowData().getPayload().toString();                try {            Session session = workflowSession.adaptTo(Session.class);                        replicator.replicate(                session,                ReplicationActionType.ACTIVATE,                payloadPath            );                    } catch (ReplicationException e) {            throw new WorkflowException("Failed to publish content", e);        }    }}

Process Arguments (configured in workflow model):

  • Can use MetaDataMap args to pass custom parameters like target tier

Listening to Replication Events

Use OSGi Event Handlers to react to replication events:

java
import org.osgi.service.component.annotations.Component;import org.osgi.service.event.Event;import org.osgi.service.event.EventHandler;import org.slf4j.Logger;import org.slf4j.LoggerFactory;
@Component(    service = EventHandler.class,    property = {        org.osgi.service.event.EventConstants.EVENT_TOPIC + "=" + "com/day/cq/replication"    })public class ReplicationEventLogger implements EventHandler {        private static final Logger LOG = LoggerFactory.getLogger(ReplicationEventLogger.class);        @Override    public void handleEvent(Event event) {        String[] paths = (String[]) event.getProperty("paths");        String action = (String) event.getProperty("action");        String userId = (String) event.getProperty("userId");                if (paths != null) {            for (String path : paths) {                LOG.info("Replication: action={}, path={}, user={}", action, path, userId);            }        }    }}

Event Properties:

  • paths - Array of replicated paths
  • action - Replication action (Activate, Deactivate, etc.)
  • userId - User who triggered replication

Best Practices

1. Respect Rate Limits

  • ≤100 paths per call for transactional guarantee; system auto-splits if exceeded
  • ≤10 MB payload size

2. Use Workflow for Large Operations

Don't build custom bulk publishing code. Use Tree Activation workflow step.

3. Validate Permissions

Always check permissions before replication to avoid exceptions.

4. Use Service Users

Never replicate with admin credentials. Map a sub-service name to the principal that holds crx:replicate via ServiceUserMapperImpl.amended config. Provision the principal with jcr:read + crx:replicate on /content via Repo Init scripts — see AEM Project Structure — Repo Init. See references/patterns.md [blocked] for the full service user setup example.

5. Publish Only What's Needed

Minimize replication volume to reduce queue pressure and pipeline load.

Common Patterns

See references/patterns.md [blocked] for complete implementations:

  • Auto-Publish on Content Fragment Save — event-driven publish using SlingConstants.TOPIC_RESOURCE_CHANGED
  • External Cache Purge After Publication — CDN invalidation via replication event handler
  • Service User Setup for Replication — OSGi service user mapping and Repo Init provisioning

Troubleshooting

Issue: Replication Fails Silently

Check: Verify replication queues in Felix console (Sling Jobs console):

https://author-p<programId>-e<envId>.adobeaemcloud.com/system/console/slingjobs

Look for failed jobs with topic: com/day/cq/replication

Issue: Permission Errors

Error: javax.jcr.AccessDeniedException

Solution: Verify service user has replication permissions:

/content/mysite -> jcr:read, crx:replicate

Issue: Content Not Appearing

Check:

  1. Verify replication status: replicator.getReplicationStatus()
  2. Check logs for distribution errors
  3. Verify target tier (Preview vs. Publish)

References

来源与署名

来源：adobe/skills位于plugins/aem/cloud-service/skills/content-distribution/replication提交940b879

许可证： Apache-2.0

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

更多来自 adobe/skills 的技能

Prototype

adobe

Render a proposed redesign of a page on the current website as a self-contained static HTML file, then iterate via the impeccable craft loop. Per-page, idempotent, stale-aware. Use when the user asks for a redesign prototype, a before/after comparison, a design preview, a page mockup, a visual diff of the redesign, or invokes `$stardust prototype` (`/stardust:prototype` in Claude Code).

包含脚本
待分类197今天更新

Direct

adobe

为现有网站设定改版方向，产出目标规范文件与推理记录。

Design & Creative197今天更新

Prepare Migration

adobe

编排五阶段网站迁移准备流程，产出带类型的页面清单、已确认的模块目录、设计规范与准备好的资源。

DevOps & Cloud197今天更新

Testing Blocks

adobe

指导测试 AEM Edge Delivery Services 代码改动：代码检查、强制浏览器验证以及可选的单元测试。

Software Development197今天更新

Ue Component Model

adobe

指导创建和编辑用于在 Universal Editor 中配置 AEM Edge Delivery Services 区块的三个 JSON 文件。

Software Development197今天更新

Preview Import

adobe

在本地 AEM Edge Delivery Services 开发服务器中预览并核对导入的 HTML 内容，与原始页面进行对比。

Software Development197今天更新

更多Software Development技能

Playground

anthropics

精选

构建自包含的交互式 HTML 演练场，包含控件、实时预览和可复制的提示词输出。

Software Development37K今天更新

M5 Onboard

anthropics

精选

通过 USB 检测 M5Stack ESP32 开发板，刷写 UIFlow 2.0 固件并安装 MicroPython 应用包。

Software Development37K今天更新

Cardputer Buddy

anthropics

精选

指导迭代 Cardputer-Adv 的 MicroPython 应用包：添加应用、通过 USB 串口推送文件、查看日志并运行 REPL 命令。

Software Development37K今天更新

Web Design Guidelines

vercel-labs

精选

依据从远程来源获取的 Web Interface Guidelines 审查 UI 代码，并以 file:line 形式报告问题。

Software Development32K5周前更新

Vercel React Native Skills

vercel-labs

精选

React Native 与 Expo 最佳实践规则，涵盖列表性能、动画、导航、UI 模式、状态与 monorepo 配置。

Software Development32K5周前更新

Vercel React Best Practices

vercel-labs

精选

Vercel 的 React 与 Next.js 性能指南，以 70 条规则的形式用于编写、审查和重构代码。

Software Development32K5周前更新