Google Git
Sign in
apache/sling-org-apache-sling-servlets-post

Apache Sling Default POST Servlets

Mirrored from https://github.com/apache/sling-org-apache-sling-servlets-post.git
Clone this repo:

Branches

Tags

More...
  1. 7abcfcc Add security section to AGENTS.md by Robert Munteanu · 3 days ago master
  2. 7881ffd docs: update AGENTS.md and README.md with PostOperationProxyProvider and JSON stack details (#39) by Carsten Ziegeler · 3 days ago
  3. 0b10a20 docs: update AGENTS.md and README.md with clarifications and new entries (#38) by Carsten Ziegeler · 3 days ago
  4. f7f2681 docs: add AGENTS.md, CLAUDE.md, and expand README (#36) by Carsten Ziegeler · 3 days ago
  5. fce040a SLING-13168 Update to Parent 66 (#35) by Stefan Seifert · 8 weeks ago

Apache Sling

Build Status Test Status Coverage Sonarcloud Status JavaDoc Maven Central servlets License

Apache Sling Default POST Servlets

Provides the default POST servlet bundle for Apache Sling.

This module is part of the Apache Sling project. You can read more about this module on our documentation site.

Overview

The bundle provides the default SlingPostServlet and built-in POST operations for Sling content changes, including:

  • create and modify
  • delete
  • copy and move
  • import
  • restore
  • checkin/checkout and versioning helpers
  • file upload (regular, streamed, and chunked)

The implementation is Jakarta Servlet-first and uses Sling Jakarta APIs. Legacy javax.servlet SPI integration remains supported via adapters in impl/wrapper and service proxying in PostOperationProxyProvider.

Extension points

Custom behavior can be provided via OSGi services such as:

  • JakartaPostOperation
  • SlingJakartaPostProcessor
  • JakartaNodeNameGenerator
  • JakartaPostResponseCreator

The corresponding legacy extension types (PostOperation, SlingPostProcessor, NodeNameGenerator, PostResponseCreator) are still supported through compatibility wrappers.

Build and test

Java 17 is required.

  • Full build: mvn clean install
  • Build without tests: mvn clean install -DskipTests
  • Unit tests: mvn test
  • Integration tests (Failsafe, including ModifyOperationIT): mvn verify
  • Single unit test class: mvn test -Dtest=HtmlResponseTest
  • Single integration test class: mvn verify -Dit.test=ModifyOperationIT
  • Inspect generated bundle metadata: jar tf target/org.apache.sling.servlets.post-*.jar | grep -E 'META-INF/MANIFEST.MF|SLING-INF/nodetypes/chunk.cnd'

Manual upload smoke tests

For manual file-upload protocol checks against a running Sling instance on localhost:8080 (admin:admin), use:

sh developer-tests/testFileUploads.sh <testfile>

The script uploads using regular, streamed, and chunked streamed protocols, then downloads and compares content. See developer-tests/README.md and Protocols.md for protocol and script details.

Repository layout

pom.xml                        Maven build descriptor (packaging: jar)
bnd.bnd                        OSGi bundle instructions and embedded resources
Jenkinsfile                    ASF Jenkins pipeline definition
Protocols.md                   Protocol notes for POST and upload behavior
src/
  main/java/org/apache/sling/servlets/post/
    *.java                     Public Jakarta-first API/SPI (+ legacy compatibility APIs)
    exceptions/                Persistence-related exceptions
    impl/                      Internal servlet and operation implementations
      PostOperationProxyProvider.java  Legacy service proxy registration
      operations/              Built-in POST operations
      helper/                  Internal helpers (upload, property handling, naming, chunking)
      wrapper/                 Jakarta <-> javax bridging adapters
  main/resources/
    SLING-INF/nodetypes/chunk.cnd   Chunked upload node type definitions
    org/apache/sling/servlets/post/ HTML response templates
    system/sling.js            Bundled JS resource
  test/java/                   Unit and integration tests
developer-tests/               Manual developer test scripts

Notes

  • OSGi metadata is generated with bnd (bnd-maven-plugin), with API baseline checks via bnd-baseline-maven-plugin.
  • The build shades selected classes from jackrabbit-jcr-commons and sling-jcr-contentparser into internal impl packages.
  • JCR (javax.jcr.*) and org.apache.sling.jcr.contentloader imports are configured as dynamic for runtime flexibility.
  • The bundle uses jakarta.servlet-api as the primary servlet API while keeping javax.servlet-api and org.apache.felix.http.wrappers for compatibility adapters.
  • JSON support is split between Jakarta JSON APIs for Jakarta responses and legacy JSON support for backwards-compatible APIs.