All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AbstractResource TheAbstractResource
is an abstract implementation of theResource
interface.AbstractResourceVisitor This visitor will traverse the given resource and all its children in a depth-first approach and call theAbstractResourceVisitor.visit(Resource)
method for each visited resource.AccessSecurityException Exception thrown by methods ofResourceAccessSecurity
This exception is used to catch unpredictable situations in methods ofResourceAccessSecurity
Adaptable TheAdaptable
interface identifies objects which can be adapted to other types or representations of the same object.AdapterFactory TheAdapterFactory
interface defines the API for helpers which may be provided to enhance the adaptability of adaptable objects.AdapterManager TheAdapterManager
defines the service interface for a manager for object adaption.AttributableResourceProvider Deprecated. Use theResourceProvider
Authenticator TheAuthenticator
interface defines the service interface which may be used by applications to enforce requests to be authenticated (seeAuthenticator.login(HttpServletRequest, HttpServletResponse)
) or to end enforced authentication (seeAuthenticator.logout(HttpServletRequest, HttpServletResponse)
).AuthType Enumeration for the auth type of a resource provider.CachingValueMap ValueMap decorator that caches key-value pairs that were accessed before.CompositeValueMap Deprecated. UseValueMapUtil.merge(ValueMap...)
instead.DeepReadModifiableValueMapDecorator A value map wrapper which implements deep reading of properties based on the resource tree and also supportsModifiableValueMap
.DeepReadValueMapDecorator A value map wrapper which implements deep reading of properties based on the resource tree.DynamicResourceProvider Deprecated. Use theResourceProvider
ExternalizableInputStream 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.ExternalResourceChangeListener This is a marker interface to receive external events.FailureReason Failure reason for a failed resource provider.HtmlResponse Deprecated. use org.apache.sling.servlets.post.HtmlResponse instead.HttpConstants HTTP-related constantsInvalidServiceFilterSyntaxException Thrown when an invalid service filter is usedIteratorWrapper<T> Wrapper class forIterator
s, that forwards all method calls to the wrappedIterator
.JcrRules LazyBindings TheLazyBindings
wraps another map and dynamically provides entries for the wrapped map through a map ofLazyBindings.Supplier
s.LazyBindings.Supplier This marker interface should be used for suppliers which should be unwrapped when used as values stored in aLazyBindings
map.LoginException Exception thrown by
,ResourceResolverFactory.getAdministrativeResourceResolver(java.util.Map)
, andResourceResolverFactory.getResourceResolver(java.util.Map)
if a resource resolver cannot be created because the credential data is not valid.ResourceResolver.clone(java.util.Map)
MediaRangeList Facilitates parsing of the Accept HTTP request header.MergingValueMap Merge providedValueMaps
into a single viewValueMap
that aggregates all key-value pairs of the given maps.ModifiableValueMap TheModifiableValueMap
is an extension of theValueMap
which allows to modify and persist properties.ModifiableValueMapDecorator ModifiableValueMapDecorator
decorates anotherMap
to provide a basic implementation for the additional methods of aModifiableValueMap
.ModifyingResourceProvider Deprecated. Use theResourceProvider
NoAuthenticationHandlerException TheNoAuthenticationHandlerException
is thrown to indicate that theAuthenticator.login(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method could not find a way to authenticate the request user.NonExistingResource Simple helper class representing nonexisting resources.ObjectConverter Converts objects to specific types.ObservationReporter AResourceProvider
must use an observation reporter to report changes to resources.ObserverConfiguration A observer configuration describes active configurations from registered listeners.OptingServlet TheOptingServlet
interface may be implemented byServlets
used by Sling which may choose to not handle all requests for which they would be selected based on their registration properties.ParametrizableResourceProvider Deprecated. Use theResourceProvider
Path Simple helper class for path matching.PathBuilder ThePathBuilder
offers a convenient way of creating a valid path from multiple fragmentsPathSet Simple helper class for path matching against a set of paths.PersistableValueMap Deprecated. Use theModifiableValueMap
instead.PersistenceException This exception will be thrown during the commit to persist changes to aPersistableValueMap
, aModifiableValueMap
or theResourceResolver
.ProviderContext The provider context...QueriableResourceProvider Deprecated. Use theResourceProvider
QueryLanguageProvider<T> The JCR query provider supports querying based on the JCR spec.QuerySyntaxException TheQuerySyntaxException
is thrown by theResourceResolver.findResources(String, String)
andResourceResolver.queryResources(String, String)
methods if the query syntax is wrong or the requested query language is not available.RecursionTooDeepException TheRecursionTooDeepException
is thrown by the Sling implementation if to many recursive content inclusions take place.RefreshableResourceProvider Deprecated. Use theResourceProvider
RequestDispatcherOptions RequestDispatcherOptions
are used in theSlingHttpServletRequest.getRequestDispatcher(org.apache.sling.api.resource.Resource, RequestDispatcherOptions)
method, to give more control on some aspects of the include/forward mechanism.RequestParameter TheRequestParameter
class represents a single parameter sent with the client request.RequestParameterMap TheRequestParameterMap
encapsulates all request parameters of a request.RequestPathInfo 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.RequestProgressTracker TheRequestProgressTracker
class provides the functionality to track the progress of request processing.RequestUtil Request related utility methods.ResolveContext<T> The resolve context is passed to most of the methods of theResourceProvider
to provide additional context information for the provider.Resource Resources are pieces of content on which Sling actsResourceAccessSecurity TheResourceAccessSecurity
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.ResourceChange A resource change event is immutable.ResourceChange.ChangeType The type of the changeResourceChangeList An instance ofResourceChangeList
is passed toResourceChangeListener.onChange(List)
to pass in additional information like the search path.ResourceChangeListener Listener for resource change events.ResourceContext The resource context provides additional information for resource resolving.ResourceDecorator Optional service to decorateResource
s returned by theResourceResolver
.ResourceMapper Allows access to resource mappingsResourceMetadata TheResourceMetadata
interface defines the API for the metadata of a SlingResource
.ResourceNotFoundException An Exception that causes Sling to return a 404 (NOT FOUND) status code.ResourceProvider Deprecated. Use theResourceProvider
ResourceProvider<T> API for providers of resources.ResourceProviderDTO Represents aorg.apache.sling.spi.resource.provider.ResourceProvider
.ResourceProviderFactory Deprecated. ResourceProviderFailureDTO Represents a failedorg.apache.sling.spi.resource.provider.ResourceProvider
.ResourceResolver TheResourceResolver
defines the API which may be used to resolveResource
objects and work with such resources like creating, editing or updating them.ResourceResolverFactory TheResourceResolverFactory
defines the service API to get and createResourceResolver
s.ResourceResolverWrapper TheResourceResolverWrapper
is a wrapper for anyResourceResolver
, delegating all method calls to the wrapped resource resolver by default.ResourceUtil TheResourceUtil
class provides helper methods dealing with resources.ResourceUtil.BatchResourceRemover A batch resource remover deletes resources in batches.ResourceWrapper TheResourceWrapper
is a wrapper for anyResource
delegating all method calls to the wrapped resource by default.ResponseUtil Response related utility methodsRuntimeDTO Represents the resource resolver runtimeRuntimeService Runtime service providing introspection of the state of the resource resolver and the resource providers.ScriptEvaluationException TheScriptEvaluationException
is thrown by theSlingScript.eval(SlingBindings)
method if an error occurrs evaluating the script.ServletResolver TheServletResolver
defines the API for a service capable of resolvingjavax.servlet.Servlet
instances to handle the processing of a request or resource.ServletResolverConstants Service registration properties and common values used for registering a Sling Servlet.SlingAdaptable TheSlingAdaptable
class is an (abstract) default implementation of theAdaptable
interface.SlingAllMethodsServlet Helper base class for data modifying Servlets used in Sling.SlingBindings TheSlingBindings
class is used to prepare global variables for script execution.SlingConstants TheSlingConstants
interface provides some symbolic constants for well known constant strings in Sling.SlingException TheSlingException
is the base exception used throughout the Sling API.SlingHttpServletRequest TheSlingHttpServletRequest
defines the interface to provide client request information to a servlet.SlingHttpServletRequestWrapper TheSlingHttpServletRequestWrapper
class is a default wrapper class around aSlingHttpServletRequest
which may be extended to amend the functionality of the original request object.SlingHttpServletResponse TheSlingHttpServletResponse
defines the interface to assist a servlet in creating and sending a response to the client.SlingHttpServletResponseWrapper TheSlingHttpServletResponseWrapper
class is a default wrapper class around aSlingHttpServletResponse
which may be extended to amend the functionality of the original response object.SlingIOException TheSlingIOException
is a runtime exception wrapper for the JavaIOException
.SlingRequestEvent represents an event published by the Sling engine while dispatching a request.SlingRequestEvent.EventType type of the eventSlingRequestListener Implementations of this service interface receive notifications about changes to Sling request of the Sling application they are part of.SlingRequestPaths This class is not a "wrapper" per se, but computes the correct path info, request URI, etc.SlingSafeMethodsServlet Helper base class for read-only Servlets used in Sling.SlingScript TheSlingScript
defines the API for objects which encapsulate a script.SlingScriptConstants Some constants for the scripting.SlingScriptHelper TheSlingScriptHelper
interface defines the API of a helper class which is provided to the scripts called from sling through the global
variable.sling
SlingScriptResolver Deprecated. The SlingScriptResolver interface is intended to be implemented and also used by project specific code.SlingServletException TheSlingServletException
is a runtime exception wrapper for the Servlet APIServletException
.SlingUri Represents an immutable URI in the same way as java.net.URI but is extended with Sling-specific URI parts (e.g.SlingUriBuilder Builder for SlingUris that allows to set any properties of aSlingUri
.SyntheticResource TheSyntheticResource
class is a simple implementation of theResource
interface which may be used to provide a resource object which has no actual resource data.TooManyCallsException TheTooManyCallsException
is thrown by the Sling implementation if to many inclusions have been called for during a single request.URIProvider Provides a URI in exchange for a Resource.URIProvider.Operation Defines which operatio the URI may be used to perform.URIProvider.Scope Defines the scope in which the URI may be used.ValueMap TheValueMap
is an easy way to access properties of a resource.ValueMapDecorator ValueMapUtil Factory methods to createValueMap
s.