Apache Sling 13 API

Apache Sling ™ is an innovative web framework that is intended to bring back the fun to web development.

Apache Sling in five bullets points

  • REST based web framework
  • Content-driven, using a JCR content repository
  • Powered by OSGi
  • Scripting inside, multiple languages (JSP, server-side javascript, Scala, etc.)
  • Apache Open Source project

Apache Sling in a hundred words

Apache Sling is a web framework that uses a Java Content Repository, such as Apache Jackrabbit, to store and manage content.

Sling applications use either scripts or Java servlets, selected based on simple name conventions, to process HTTP requests in a RESTful way.

The embedded Apache Felix OSGi framework and console provide a dynamic runtime environment, where code and content bundles can be loaded, unloaded and reconfigured at runtime.

As the first web framework dedicated to JSR-170 Java Content Repositories, Sling makes it very simple to implement simple applications, while providing an enterprise-level framework for more complex applications.

JavaDoc generation

This documentation has been created using the generate_javadoc_for_release.sh script.

Packages
Package
Description
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Provides the authentication helper service as well as a number of utility functions in the AuthUtil class.
 
 
Provides API to be implemented by provides of authentication mechanisms.
 
 
API for accessing context-aware configuration.
Annotations for context-aware configurations.
 
 
 
Management API of the Context-Aware configuration implementation.
 
Multiplexer services provide aggregated access to all implementations of the related SPI interface.
API for accessing context-aware configuration resources.
 
 
SPI for applications hooking into the configuration resource infrastructure for parameterizing and customizing.
SPI for applications hooking into the configuration infrastructure for parameterizing and customizing.
Defining configuration and parameter metadata for the SPI.
 
 
 
 
Provides configuration support for the Logback based logging in Sling
 
 
 
Provides configuration support for the Logback based logging in Sling
Provides an API to generate and collect metrics in various forms
Provides the MimeTypeService service used by client to resolve MIME type information as well as the MimeTypeProvider service interface for providers to extend the MIME type setup provided by the MimeTypeService.
 
 
 
 
 
Provides a service to interface which may be implemented by applications to get notified on cluster topology changes.
Provides some common classes for discovery implementors that choose to extend from discovery.base
Provides topology connector related classes for discovery implementors that choose to extend from discovery.base
Provides topology announcement implementations for discovery implementors that choose to extend from discovery.base
Provides topology connector implementations for discovery implementors that choose to extend from discovery.base
Provides whitelist-related classes for discovery implementors that choose to extend from discovery.base
Provides commons utility for users for the Discovery API.
Provides commons utility for providers of the Discovery API.
Provides commons implementations for providers of the Discovery API.
Provides an SPI for providers, used by discovery.commons.providers.impl
Provides default SPI-implementations used by discovery.commons.providers.impl
Provides some static helpers for providers of the Discovery API.
 
 
 
 
 
Provides the original authentication handler service API initially bundled with the Sling Engine bundle.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The org.apache.sling.jcr.base package provides basic support to expose JCR repositories in Sling.
 
 
The org.apache.sling.jcr.base.spi package provides a way to bifurcate requests to subpaths to a mount provider.
 
 
 
 
 
 
 
 
The org.apache.sling.jcr.registration package exports the AbstractRegistrationSupport class which may be extended by service exposing JCR Repository services in any one non-OSGi registry such as RMI or JNDI.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 
 
 
 
 
 
 
 
 
 
 
 
 
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
The org.apache.sling.scripting.api.resource package provides a unified API for scripting bundles that need to perform script resolution across the Resource space.
 
 
 
 
 
 
 
 
 
 
 
 
 
This package should only be used by compiled JSP scripts when being executed on the platform.
 
 
 
 
 
 
 
 
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
The org.apache.sling.scripting.sightly.compiler package defines the API exposed by the SightlyCompiler.
The org.apache.sling.scripting.sightly.compiler.backend defines the API that can be used by HTL Backend Compilers, used to compile HTL Commands into executable code for other languages.
The org.apache.sling.scripting.sightly.compiler.commands package defines the API for Command processing.
The org.apache.sling.scripting.sightly.compiler.expression package defines the API for Expression processing.
The org.apache.sling.scripting.sightly.compiler.expression.nodes package exposes the various ExpressionNode types.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 
 
 
 
 
 
 
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
XSS Protection Service