EPIC: Export - New REST Endpoints for Content Export Job Management

Parent Issue

https://github.com/dotCMS/core/issues/29575

Task

We need to create REST endpoints to interact with the new ExportContentletProcessor to manage content export operations through the job queue system.

Objectives

• Implement REST endpoints for content export job management
• Provide real-time monitoring capabilities
• Enable configurable export options
• Support secure file download mechanisms

REST Endpoints Specification

1. Create Export Job

• Endpoint: POST /content/export
• Purpose: Creates and enqueues a new content export job
• Returns: Job identifier

1. List Export Jobs

• Endpoint: GET /content/export
• Parameters:
  • page: Page number
  • size: Items per page
  • status: Filter by job status
• Purpose: Lists all enqueued export jobs with pagination

1. Get Job Status

• Endpoint: GET /content/export/{jobId}
• Parameters: jobId
• Returns:
  • Job state
  • Progress percentage
  • Executing node
  • Download URL (when completed)

1. Cancel Job

• Endpoint: POST /content/export/{jobId}/cancel
• Parameters: jobId
• Purpose: Cancels a running export job

1. Monitor Job

• Endpoint: GET /content/export/{jobId}/monitor
• Parameters: jobId
• Type: Server-Sent Events (SSE)
• Purpose: Real-time job status monitoring

1. Get Export File

• Endpoint: GET /content/export/{jobId}/download
• Parameters: jobId
• Purpose: Downloads the generated export file
• Security: Requires valid authentication and authorization

Technical Requirements

Export Features:

• Secure file storage
• Download link generation
• System notifications integration

Job Queue Implementation:

• Asynchronous job processing
• Progress tracking
• Job status management
• Cancellation support
• File cleanup management

Error Handling:

• Proper HTTP status codes
• Detailed error messages
• Download link expiration
• File access validation

Acceptance Criteria

• All endpoints return appropriate HTTP status codes
• SSE endpoint provides real-time updates
• Error messages are clear and actionable
• Export files are securely stored
• Download links are properly generated and secured
• System notifications are sent upon job completion
• Job cancellation effectively stops processing
• Exported files are cleaned up according to retention policy

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

Start with the parent issue and the new ExportContentletProcessor to understand the job queue and export flow. Map the six specified REST endpoints to job creation, monitoring, cancellation, and secure download requirements. Done means the endpoints, SSE updates, validation, notifications, cleanup, and acceptance criteria are implemented and verified.