All Classes and Interfaces

Class
Description
The AbstractResource is an abstract implementation of the Resource interface.
This visitor will traverse the given resource and all its children in a depth-first approach and call the AbstractResourceVisitor.visit(Resource) method for each visited resource.
Exception thrown by methods of ResourceAccessSecurity This exception is used to catch unpredictable situations in methods of ResourceAccessSecurity
The Adaptable interface identifies objects which can be adapted to other types or representations of the same object.
The AdapterFactory interface defines the API for helpers which may be provided to enhance the adaptability of adaptable objects.
The AdapterManager defines the service interface for a manager for object adaption.
Deprecated.
The Authenticator interface defines the service interface which may be used by applications to enforce requests to be authenticated (see Authenticator.login(HttpServletRequest, HttpServletResponse)) or to end enforced authentication (see Authenticator.logout(HttpServletRequest, HttpServletResponse) ).
Enumeration for the auth type of a resource provider.
Creates builders.
Deprecated.
A value map wrapper which implements deep reading of properties based on the resource tree and also supports ModifiableValueMap.
A value map wrapper which implements deep reading of properties based on the resource tree.
Deprecated.
Deprecated.
Use JakartaErrorHandler instead.
This interface is normally used to extend an InputStream to indicate that it has a URI form that could be used in place of the InputStream if desired.
This is a marker interface to receive external events.
Failure reason for a failed resource provider.
Deprecated.
use org.apache.sling.servlets.post.HtmlResponse instead.
HTTP-related constants
Thrown when an invalid service filter is used
Wrapper class for Iterators, that forwards all method calls to the wrapped Iterator.
The JakartaErrorHandler defines the interface of the service used by the Sling to handle calls to jakarta.servlet.http.HttpServletResponse.sendError and to handle uncaught Throwables.
Facilitates parsing of the Accept HTTP request header.
The JakartaOptingServlet interface may be implemented by Servlets used by Sling which may choose to not handle all requests for which they would be selected based on their registration properties.
This class wraps a filter based on the Jakarta Servlet API to implement Servlet API 3.
 
Wrapper for SlingJakartaHttpServletRequest to adapt it to the Javax Servlet API.
Wrapper for SlingJakartaHttpServletResponse to adapt it to the Jacax Servlet API.
This class wraps a servlet based on the Jakarta Servlet API to implement Servlet API 3.
 
This class wraps a filter based on the Servlet API 3 to implement Jakarta Servlet API.
 
Wrapper for SlingHttpServletRequest to adapt it to the Jakarta Servlet API.
Wrapper for SlingHttpServletResponse to adapt it to the Jacax Servlet API.
This class wraps a servlet based on the Servlet API 3 to implement Jakarta Servlet API.
 
The LazyBindings wraps another map and dynamically provides entries for the wrapped map through a map of LazyBindings.Suppliers.
This marker interface should be used for suppliers which should be unwrapped when used as values stored in a LazyBindings map.
Exception thrown by ResourceResolverFactory.getAdministrativeResourceResolver(java.util.Map) , ResourceResolverFactory.getResourceResolver(java.util.Map) , and ResourceResolver.clone(java.util.Map) if a resource resolver cannot be created because the credential data is not valid.
Deprecated.
The ModifiableValueMap is an extension of the ValueMap which allows to modify and persist properties.
ModifiableValueMapDecorator decorates another Map to provide a basic implementation for the additional methods of a ModifiableValueMap.
Deprecated.
The NoAuthenticationHandlerException is thrown to indicate that the Authenticator.login(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse) method could not find a way to authenticate the request user.
Simple helper class representing nonexisting resources.
A ResourceProvider must use an observation reporter to report changes to resources.
A observer configuration describes active configurations from registered listeners.
Deprecated.
Deprecated.
Simple helper class for path matching.
The PathBuilder offers a convenient way of creating a valid path from multiple fragments
Simple helper class for path matching against a set of paths.
Deprecated.
Use the ModifiableValueMap instead.
This exception will be thrown during the commit to persist changes to a PersistableValueMap, a ModifiableValueMap or the ResourceResolver.
The provider context...
Deprecated.
The JCR query provider supports querying based on the JCR spec.
The QuerySyntaxException is thrown by the ResourceResolver.findResources(String, String) and ResourceResolver.queryResources(String, String) methods if the query syntax is wrong or the requested query language is not available.
The RecursionTooDeepException is thrown by the Sling implementation if to many recursive content inclusions take place.
Deprecated.
RequestDispatcherOptions are used in the SlingHttpServletRequest.getRequestDispatcher(org.apache.sling.api.resource.Resource, RequestDispatcherOptions) method, to give more control on some aspects of the include/forward mechanism.
The RequestParameter class represents a single parameter sent with the client request.
The RequestParameterMap encapsulates all request parameters of a request.
Sling breaks the request URI into four parts: the path itself, optional dot-separated selectors and extension that follow it, and an optional path suffix.
The RequestPathInfoWrapper class is a default wrapper class around a RequestPathInfo which may be extended to amend the functionality of the original request path info object.
The RequestProgressTracker class provides the functionality to track the progress of request processing.
Request related utility methods.
The resolve context is passed to most of the methods of the ResourceProvider to provide additional context information for the provider.
Resources are pieces of content on which Sling acts
The ResourceAccessSecurity defines a service API which is used in two different context: for securing resource providers which have no own access control and on the application level to further restrict the access to resources in general.
A resource change event is immutable.
The type of the change
An instance of ResourceChangeList is passed to ResourceChangeListener.onChange(List) to pass in additional information like the search path.
Listener for resource change events.
The resource context provides additional information for resource resolving.
Optional service to decorate Resources returned by the ResourceResolver.
Allows access to resource mappings
The ResourceMetadata interface defines the API for the metadata of a Sling Resource.
An Exception that causes Sling to return a 404 (NOT FOUND) status code.
Deprecated.
API for providers of resources.
Represents a org.apache.sling.spi.resource.provider.ResourceProvider.
Deprecated.
Represents a failed org.apache.sling.spi.resource.provider.ResourceProvider.
The ResourceResolver defines the API which may be used to resolve Resource objects and work with such resources like creating, editing or updating them.
The ResourceResolverFactory defines the service API to get and create ResourceResolvers.
The ResourceResolverWrapper is a wrapper for any ResourceResolver, delegating all method calls to the wrapped resource resolver by default.
The ResourceUtil class provides helper methods dealing with resources.
A batch resource remover deletes resources in batches.
The ResourceWrapper is a wrapper for any Resource delegating all method calls to the wrapped resource by default.
Response related utility methods
Represents the resource resolver runtime
Runtime service providing introspection of the state of the resource resolver and the resource providers.
The ScriptEvaluationException is thrown by the SlingScript.eval(SlingBindings) method if an error occurrs evaluating the script.
The ServletResolver defines the API for a service capable of resolving jakarta.servlet.Servlet instances to handle the processing of a request or resource.
Service registration properties and common values used for registering a Sling Servlet.
The SlingAdaptable class is an (abstract) default implementation of the Adaptable interface.
Deprecated.
The SlingBindings class is used to prepare global variables for script execution.
The SlingConstants interface provides some symbolic constants for well known constant strings in Sling.
The SlingException is the base exception used throughout the Sling API.
Deprecated.
Fluent helper for building a request.
Deprecated.
Fluent helper for building a response.
Deprecated.
The SlingIOException is a runtime exception wrapper for the Java IOException.
Helper base class for data modifying Servlets used in Sling.
The SlingHttpServletRequest defines the interface to provide client request information to a servlet.
The SlingJakartaHttpServletRequestWrapper class is a default wrapper class around a SlingJakartaHttpServletRequest which may be extended to amend the functionality of the original request object.
The SlingHttpServletResponse defines the interface to assist a servlet in creating and sending a response to the client.
This is an extension of a SlingJakartaHttpServletResponse to get the result from a processing operation.
The SlingJakartaHttpServletResponseWrapper class is a default wrapper class around a SlingJakartaHttpServletResponse which may be extended to amend the functionality of the original response object.
represents an event published by the Sling engine while dispatching a request.
type of the event
Implementations of this service interface receive notifications about changes to Sling request of the Sling application they are part of.
Helper base class for read-only Servlets used in Sling.
Deprecated.
type of the event
Deprecated.
This class is not a "wrapper" per se, but computes the correct path info, request URI, etc.
Deprecated.
The SlingScript defines the API for objects which encapsulate a script.
Some constants for the scripting.
The SlingScriptHelper interface defines the API of a helper class which is provided to the scripts called from sling through the global sling variable.
Deprecated.
The SlingScriptResolver interface is intended to be implemented and also used by project specific code.
The SlingServletException is a runtime exception wrapper for the Servlet API ServletException.
Represents an immutable URI in the same way as java.net.URI but is extended with Sling-specific URI parts (e.g.
Builder for immutable SlingUris.
The SyntheticResource class is a simple implementation of the Resource interface which may be used to provide a resource object which has no actual resource data (except for the mandatory property "sling:resourceType").
The TooManyCallsException is thrown by the Sling implementation if to many inclusions have been called for during a single request.
Provides a URI in exchange for a Resource.
Defines which operation the URI may be used to perform.
Defines the scope in which the URI may be used.
The ValueMap is an easy way to access properties of a resource.
ValueMapDecorator decorates another Map to provide a basic implementation for the additional methods of a ValueMap.
Factory methods to create ValueMaps.