All Classes and Interfaces
Class
Description
Base class for all the POST servlets for the AccessManager operations
Base class for all the servlets for the AccessManager operations
The
AbstractAuthenticationFormServlet provides a basic
implementation of a simple servlet to render a login form for authentication
purposes.Deprecated.
Base class for all the POST servlets for the UserManager operations
Abstract base class for bundle related tasks.
Abstract class for Tags for interactiving with Context-Aware Configuration
resources to extend.
This class can be extended by
CommandVisitor implementations that don't provide support for all the available Commands.The
IncludeTagHandler implements the
<sling:include> custom tag.Base class for servlets manipulating groups
Deprecated.
Use
AbstractInjectAnnotationProcessor2 insteadDefault implementation of
InjectAnnotationProcessor2.Abstract base class for an iterator
Deprecated.
(SLING-6722): this class mixes Sling and JCR APIs which is not
optimal as nowadays we favor the Sling APIs.
The
AbstractPostOperation class is a base implementation of the
PostOperation service interface providing actual implementations with
useful tooling and common functionality like preparing the change logs or
saving or refreshing.The
AbstractPostResponse class provides a basic implementation
of the PostResponse interface maintaining properties to be
prepared for sending the response in an internal map.Provides a simple implementation of PostResponse that can be subclassed by developers wishing to provide specialized behavior
to an existing PostResponse instance.
Base class for all the POST servlets for the UserManager operations
The
AbstractRegistrationSupport class is the base class for
registration purposes of embedded repositories.The
AbstractResource is an abstract implementation of the
Resource interface.The
ResourceCollector class provides a single public method -
AbstractResourceCollector.getServlets(ResourceResolver,List<String>) - which is used to find an ordered collection
of Resource instances which may be used to find a servlet or
script to handle a request to the given resource.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.Default abstract implementation of
RuntimeObjectModel.This abstract class can be used for own script engine
factory implementations.
Deprecated.
Base class which implements the concept of a 'BackgroundCheck',
a thread that periodically executes a check until that one succeeds.
Deprecated.
as of 2.0.8 (Bundle version 2.2.0) and replaced by
AbstractPostOperation.The
AbstractSlingRepository2 is an abstract implementation of
the SlingRepository version 2.3 interface (phasing
AbstractSlingRepository2.loginAdministrative(String) out in favor of
AbstractSlingRepository2.loginService(String, String)) which provides default support for
attached repositories.The
AbstractSlingRepositoryManager is the basis for controlling
the JCR repository instances used by Sling.Configuration pojo to be passed to the
AbstractSlingRepositoryManager.start(BundleContext, Config) method.Abstract TEI that that provides the type for a single
variable named in the tag's "var" attribute.
Marker interface for an injector to declare that it ignores the name
parameter.
A simple utility class providing utilities with respect to
access control over repositories.
Helper class to report on repository access.
Exception thrown by methods of
ResourceAccessSecurity This exception
is used to catch unpredictable situations in methods of
ResourceAccessSecurityA single "set ACL" or "remove ACL" line
The
Adaptable interface identifies objects which can be adapted
to other types or representations of the same object.Component Property Type (as defined by OSGi DS 1.4) for the condition for Sling Adapters.
Component Property Type (as defined by OSGi DS 1.4) for the condition for Sling Adapters.
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.The Adaption is a marker interface which is registered as a service by the AdapterManager once a
certain AdapterFactory is available
Tag for adapting adaptables to classes.
Plugin invoke which aggregates the behavior of several plugin invokes.
Detects configuration annotation classes deployed by any bundle via OSGi extender pattern.
Helper methods for parsing metadata from configuration annotation classes.
Verify the annotation and Process it.
Comment
An announcement is the information exchanged by the topology connector and
contains all clusters and instances which both the topology connector client
and servlet see (in their part before joining the two worlds).
Filter used during announcement processing internally
The announcement registry keeps track of all the announcement that this
instance either received by a joined topology connector or that a topology
connector inherited from the counterpart (the topology connector servlet)
Default implementation of the AnnouncementRegistry which
handles JSON-backed announcements and does so by storing
them in a local like /var/discovery/impl/clusterNodes/$slingId/announcement.
Syntactical structure for an array of items.
Description of an artifact.
A artifact group holds a set of artifacts.
A simple ASCII byte reader.
Simple container for asynchronously provided values
An AsyncEvent can be enqueued to the AsyncEventSender for
later, asynchronous triggering
An
Atom defines an ExpressionNode that can be translated to simple text, like identifiers or primitive constants
(strings, booleans and numbers).Deprecated.
Use the
ResourceProviderContains the list of attributes inside an HTML tag.
Implementation for the attribute plugin.
The
AuthConstants provides a collection of constants used to
configure and customize the Sling authentication infrastructure.This
AuthenticatedResourceProvider implementation keeps a resource
provider and the authentication information (through the ResolveContext).The
AuthenticationFeedbackHandler may be implemented by
AuthenticationHandler services to request being informed on the
success or failure of authentication.The
AuthenticationHandler interface defines the service API used
by the authentication implementation to support plugin various ways of
extracting credentials from the request.Deprecated.
use
AuthenticationHandler
insteadThis enum indicates the supported detailed login failure reason codes:
invalid_login: indicates username/password mismatch.
password_expired: indicates password has expired or was never set and
change initial password is enabled
account_locked: the account was disabled or locked
account_not_found: the account was not found (not the same as username password mismatch)
expired_token: the token credentials used have expired
The
AuthenticationInfo conveys any authentication credentials
and/or details extracted by the
AuthenticationHandler.extractCredentials(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method from the request.Deprecated.
Service interface which allows bundles to modify the
AuthenticationInfo object
right after one AuthenticationHandler has returned an {AuthenticationInfo
from the AuthenticationHandler.extractCredentials(HttpServletRequest, HttpServletResponse)
method or an anonymous AuthenticationInfo has been created.The
AuthenticationSupport provides the service API used to
implement the HttpContext.handleSecurity method as defined in
the OSGi Http Service specification.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)
).Deprecated.
use
AuthenticationSupport insteadAn enumeration of the possible types of property changes
Resource implementation for Authorizable
Resource Provider implementation for jackrabbit UserManager resources.
Interface for lambda expressions to do work on a resolved authorizable + optional relative path
Interface for lambda expressions to do work on a resolved principal
ValueMap implementation for the root property container of Authorizable Resources
Enumeration for the auth type of a resource provider.
The
AuthUtil provides utility functions for implementations of
AuthenticationHandler services and
users of the Sling authentication infrastructure.
A
BackendCompiler can be hooked in into the SightlyCompiler in order to transpile HTL Commands into other
JVM supported languages.base implementation for ValueMap implementations for Authorizable Resources
Configuration for discovery.base
Abstract base class for DiscoveryService implementations which uses the
ClusterViewService plus Topology Connectors to calculate
the current TopologyView
Base Resource implementation for the common parts
Base class for statistics implementations
Very simple abstract base class for the TopologyView which
comes with the 'setNotCurrent()' method - that allows the
ViewStateManager to mark a topologyView as no longer current
- and the isCurrent() is handled accordingly.
The heartbeat handler is responsible and capable of issuing both local and
remote heartbeats and registers a periodic job with the scheduler for doing so.
Implementation of the observation reporter.
Implementation of a
ObserverConfigurationResolve context implementation for a resource provider.
This class can be used for batch removal of resources
Marker class for using the JavaBean @Via provider.
Repository of {page, request, session, application}-scoped beans
Provides URIs for direct binary read-access based on the Jackrabbit API
BinaryDownload.A {code BinaryOperation} defines an expression where a binary operator is applied (e.g.
Binary operators used in expressions.
Generator for a binary operator
BindingsUtils provides helper methods for retrieving commonly used objects from a Bindings map.Service interface which allows for the Bindings object.
Provides
BindingsValuesProvider for specific contexts, based on
their "context" service property.Bloom filter utilities.
Write text to a character-output stream, buffering characters so as
to provide for the efficient writing of single characters, arrays,
and strings.
Defines a Boolean constant (e.g.
A converter for Boolean
Broadcasts commands to other handlers
Processes a bundle file by changing its Bundle-SymbolicName.
Creates builders.
BundleVersionInfo based on a Bundle object
Health check component that monitors the bundle content
loading progress for all of the deployed bundles.
A
BundledRenderUnit represents a pre-packaged script or precompiled script (Java class) that will be executed in order to
render a HttpServletRequest.A
BundledRenderUnitCapability encapsulates the values of a Provided-Capability, based on which BundledRenderUnits
are generated.The
BundledScriptFinder finds the BundledRenderUnit corresponding to a certain chain of TypeProviders or
corresponding to a certain path-based BundledRenderUnitCapability.This service allows various components to work with
BundledRenderUnit instance and perform dependency resolution based on their availability in
the Bindings maps passed to the HTL Script Engine.The
BundleFileProcessor can transform a bundle Manifest
by creating a modified copy of the bundle file.Holds the bundle info that we need, makes it easier to test
without an OSGi framework.
Install a bundle supplied as a RegisteredResource.
Service for refreshing bundles.
Remove a bundle from a RegisteredResource.
Start a bundle given its bundle ID
Restarts if the bundle does not start on the first try,
but only after receiving a bundle or framework event,
indicating that it's worth retrying
Task creator for bundles
Update a bundle from a RegisteredResource.
Provides bundle version information, which can be
extracted from bundle files or Bundle objects.
With SLING-3389 the Announcement itself doesn't use the created
(ie timeout) field anymore (it still has it currently for backwards
compatibility on the wire-level) - hence that's why there's this
small in-memory wrapper object which contains an Announcement and
carries a lastHeartbeat property.
The
CachedScript provides an abstraction on top of CompiledScript such that compiled scripts can be cached for further
executions.
The
CachingMap class offers an implementation of a LinkedHashMap that can be used for caches.Web console configuration printer.
A converter for Calendar
The
CallTag implements the
<sling:call> custom tag.Extends the HttpServletResponse to wrap the response and capture the results.
Simple general task, setting the state of a registered resource.
The
ChangeUserPassword service api.
Changes the password associated with a user.
The
CheckinOperation class implements the
checkin
operation for the Sling default POST servlet.The
CheckoutOperation class implements the
checkout
operation for the Sling default POST servlet.The check topology task checks for changes in the topology and queue configuration
and reassigns jobs.
Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a child resource
Marker class for using the ChildResource @Via provider.
Defines the validation rules for a child resource, allowing
ValidationModels to be applied to Resource trees.Implements a
ChildResourceChunk encapsulates all chunk upload attributes.The
ChunkCleanUpTask implements a job run at regular intervals
to find incomplete chunk uploads and remove them from the repository to
prevent littering the repository with incomplete chunks.This interface provides information about classes that will be generated by the
JavaClassBackendCompiler.A class loader writer is a service allowing to dynamically generate
classes and resources.
Whiteboard interface for scripting implementations which need to respond to
ClassLoader clearing events.
Maintenance task...
Wrap an IOException to signal that its cause is most
certainly a client abort/disconnect.
Helper class to detect instances that are only partially started.
The ClusterSyncService can be used to establish strong
consistency with the underlying (eventually consistent) repository in use.
Allows chaining of ClusterSyncService, itself implementing
the ClusterSyncService interface
A ClusterView represents the instances of a cluster that are
up and running and that all can see each other at a certain point in time.
Contains some static helper methods around ClusterView
The ClusterViewService is capable of determining the
ClusterView of the local cluster (ie of the instances
that are all hooked to the same underlying repository).
Aggregate consecutive writes in bigger chunks of text
The
CollectionInheritanceDecider is an SPI which should be used by
all ConfigurationResourceResolvingStrategy implementations if they
support inheritance for collections.A
Command represents the type of instruction a certain HTL expression or block element should execute.The
CommandHandler is the mechanism through which a CommandStream can be processed synchronously, as the stream is
written.
This interface defines a stream to which
Commands are pushed during the compilation of a HTL script by the SightlyCompiler.Extracts the variables used in a command
The
CommandVisitor is the mechanism through which a Command can be processed.A commentable has a comment and a location.
CommonJS module implementation
Generator for logical operators
Predicates to handle comparisons that are defined in the filter language
The
CompilationOutput encapsulates the result of a compile operation as processed by the JavaClassBackendCompiler.The compilation result allows clients of the java compiler
to check for error messages, warnings (if not disabled by
the options) and allows to access the compiled classes.
This class encapsulates the result of a compile operation performed by the
SightlyCompiler.This interface describes a compilation unit - usually a java class.
This class describes a compilation unit that the
SightlyCompiler will process during the call of the compile methods.Extension of the CompilationUnit interface which allows for the explicit
declaration of the source file name.
Main JSP compiler class.
Default implementation for the compiler context
This class encapsulates a message produced the compiler.
This class describes the messages (warnings or errors) the
SightlyCompiler will produce when compiling a script.Deprecated.
Use
ValueMapUtil.merge(ValueMap...) instead.Concatenation operator generation
This
Command imposes a condition on the next rendering commands.Configuration object used as a central config point for the discovery service
implementation
Helper methods for configuration names.
Provides source for Logback configuration fragment.
Marks an annotation class to be useable with Sling context-aware configuration.
A configuration has either
- a pid
- or a factory pid and an alias (pid)
and properties.
Defines how the configuration should be mapped and returned.
Listener interface to get topology / queue changes.
Provides access to the configuration collection data and metadata for a given context path.
Data for persisting configuration collections.
Constants for the queue configuration.
Provides access to the configuration data and metadata for a given context path.
Defines how (and if) resources in a resource hierarchy should inherit form each other.
Detects all
ConfigurationInheritanceStrategy implementations in the container
and consolidates their result based on service ranking.Defines how to look up the current context resource to be used for getting the context-aware configurations
for injecting into Sling Models or for Sling Scripting (BindingsValuesProvider).
Detects all
ConfigurationInjectResourceDetectionStrategy implementations in the container
and consolidates their result based on service ranking.Settings for reading and writing configurations.
Manages reading and writing configurations e.g. for Editor GUIs.
Defines a configuration.
Allows applications to provide the necessary metadata for configurations.
Detects all
ConfigurationMetadataProvider implementations in the container
and consolidates their result based on service ranking.Detects all
ConfigurationMetadataProvider implementations in the container
and consolidates their result based on service ranking.Detects all
ConfigurationOverrideProvider implementations in the container
and consolidates their result based on service ranking.Detects all
ConfigurationOverrideProvider implementations in the container
and consolidates their result based on service ranking.Provide information to override configuration data.
Data for persisting configuration properties.
Is thrown when configuration cannot be persisted because the user is not allowed to write to repository.
Is thrown when configuration cannot be persisted.
Deprecated.
Please use
ConfigurationPersistenceStrategy2 instead.Defines how configuration data is stored in the configuration resource.
Detects all
ConfigurationPersistenceStrategy2 implementations in the container
and consolidates their result based on service ranking.Is thrown when configuration cannot be resolved.
Getting context-aware configurations for a given resource context.
Getting context-aware configuration resources for a given resource context.
Service for accessing the ConfigurationResourceResolver configuration from other services.
Defines how and where the configuration resources are looked up.
Detects all
ConfigurationResourceResolvingStrategy implementations in the container
and consolidates their result based on service ranking.Web console plugin to test configuration resolution.
Registry for topology connector clients
Default implementation of the ConnectorRegistry which
keeps a list of outgoing connectors and is capable of
pinging them.
Optimization which evaluates constant expressions during compilation-time
Some constants and other global data that are used by the compiler and the runtime.
Constructor parameters aren't normally accessible using the
AnnotatedElement.
The
ContainerRequestParameter TODOThe
ContentCreator is used by the ContentReader to create the actual content.The
ContentData class provides objects which are relevant for
the processing of a single Content object by its Component.Represents a resource or node in the content hierarchy.
Reference to a file that contains a content fragment (e.g.
Cache for parsed content from content files (e.g.
Represents a JSON File with resource content.
Content file types.
The
ContentImporter serviceListener interface to provide callbacks for all imported updates
for interested parties.
The
ContentReaderContent types.
Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a context-aware configuration.
Allows application to define a strategy to find context paths and config references for content paths.
Deprecated.
Please use
ContextPathStrategyMultiplexer instead.Detects all
ContextPathStrategy implementations in the container
and consolidates their result based on service ranking.Holds reference to a context root resource and configuration reference path
that was detected for the configuration context.
A converter converts a value to a specific target type.
The
CopyOperation class implements the
copy
operation for the Sling default POST servlet.An incrementing and decrementing counter metric.
The
CreateGroup service api.
Sling Post Servlet implementation for creating a group in the jackrabbit UserManager.
Deprecated.
Use
EnsureNodes instead.The
CreateUser service api.
Sling Post Servlet implementation for creating a user in the jackrabbit UserManager.
Configuration for the DataStore Cleanup Service
A converter for Date
Takes a string representation of a time-date string and tries for parse it
using different formats.
The
DEAConstants provides some constants for
handling distributed OSGi events.Removes code under conditionals which are proven to fail.
Enumerates the types of ACE declarations, typically
used for constructing the output of the declaredAt structure of
the effective ace/acl json
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.
Default value for an injection.
Default implementation of the ClusterView interface.
Default implementation of
ConfigurationInjectResourceDetectionStrategy which always
uses the resource of the current request.The default persistence strategy is quite simple: directly use the configuration resources.
The
DefaultErrorHandlerServlet
This is the default error handler servlet registered at the end of the
global search pathWraps
DefaultHandler in order to run
it as a service.Base implementation for the InstanceDescription interface.
The
DefaultLocaleResolver resolves the request's Locale by
calling the ServletRequest.getLocales() method, which generally
will be the Servlet Container's implementation of this method and thus be
based on the client's Accept-Language header.HealthCheck that runs an arbitrary script.Generates a node name based on a set of well-known request parameters
like title, description, etc.
Empty implementation for plugin invocation.
The
DefaultServlet is a very simple default resource handler.Default Implementation of the topology view interface
Wraps a message key (being looked up in a
ResourceBundle), messageArguments (being used with MessageFormat.format(String, Object...)
and the location where the validation failure occurred.Default implementation of
ValidationResult wrapping a list of ValidationFailures.This class defines the scripting variables that are created by the
DefineObjectsTag.The
DeleteAces service api.
Sling Post Servlet implementation for deleting the ACE for a set of principals on a JCR
resource.
The
DeleteAuthorizables service api.Rest Service Description
The
DeleteGroup service api.The
DeleteOperation class implements the
delete operation for the Sling default POST servlet.The
DeletePrincipalAces service api.
Sling Post Servlet implementation for deleting the principal ACE for a set of principals on a JCR
resource.
The
DeleteUser service api.Resolves dependencies specified by the Use function
Wraps
DirListingExportHandler in order to run it as a service.Provides the configuration of a few paths needed by discovery-lite processing services
Simplifies access to the underlying JSON-backed oak discovery-lite descriptor
The discovery service can be used to get the current topology view.
Callback interface which can be implemented by Injectors to perform some action
when a created object is destroyed.
Interface which allows for the registration of DisposalCallback listeners.
Invoked by the
HTMLParser when elements are scanned.Extends the default policy to support dynamic attributes.
A dynamic class loader is a class loader which might get
invalid over time.
The dynamic class loader manager is a central
service managing all dynamic class loaders.
Deprecated.
The dynamic class loader provider is not supported
anymore and any service implementing this is not
considered for dynamic class loading anymore!
Deprecated.
Use the
ResourceProviderImplementation of ELContext
Simple ELContextWrapper for runtime evaluation of EL w/ dynamic FunctionMappers
Data structure used by
MarkupHandler.This class generates functions mappers for the EL expressions in the page.
This class implements a parser for EL expressions.
Command visitor which writes to an output stream.
Dummy stats that just returns 0 for all info, used where the queue doesnt
implement the Statistics interface.
Tag for writing properly XSS encoded text to the response using the OWASP
ESAPI for supporting a number of encoding modes.
EncodingMap is a convenience class which handles conversions between
IANA encoding names and Java encoding names, and vice versa.
The
EngineAuthenticationHandlerHolder class represents an
old-style Sling AuthenticationHandler service in the internal data
structure of the
SlingAuthenticator.The
CoreConstants interface provides some symbolic constants for
well known constant strings in Sling.The
EngineSlingAuthenticator class is a simple proxy service
providing the old Sling Engine Authenticator service calling into the
new standalone Apache Sling
AuthenticationSupport service.Set ACL statement that groups a set of AclLines
that all refer to the same set of principals.
This class provides "global settings"
to all services, like the application id and the thread pool.
Generator for logical operators
Class responsible for dispatching JSP parse and javac compilation errors
to the configured error handler.
The
ErrorHandler defines the interface of the service used by
the Sling to handle calls to HttpServletResponse.sendError and
to handle uncaught Throwables.Deprecated.
Please use
ErrorHandler instead.Interface for handling JSP parse and javac compilation errors.
Manages deescaping for platform file names to resource names.
The
EspReader is a FilterReader which takes
JSP like input and produces plain ECMA script output.Data structure used in expression reducing
The
EvalTagHandler implements the
<sling:eval> custom tag.Contains static factory methods for creating TopologyEvents with BaseTopologyView
as well as some TopologyEvent related helper methods
Simulates an event loop for the Rhino JS engine.
Event-loop utilities for interoperability with JS code
The topic must match exactly.
Annotation to declare an model exporter servlet mapping.
Annotation to specify options on an model's export operation.
Annotation to declare multiple exporter servlets for a model.
The default exports object
This class represents a HTL Expression.
Defines a context for the
Expression that will be processed by a Filter.Defines a node in a HTL expression tree.
Try to evaluate constant parts in expressions
This object wraps expressions in filter applications depending on options.
Aggregator for all runtime extensions.
Helper class for
RuntimeExtension implementations.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.
A feature is a collection of
- a name
- a version
- variables
- run modes
Constants for common feature types.
BundleVersionInfo based on a bundle jar file
Comparator sorting files by filename.
The
FsResource represents a file system file or folder as
a Sling Resource.Provide a filter on an @Inject.
A filter is a transformation which performs modifications on expressions.
Token literal values and constants.
Token Manager.
Contains a set of predicates that helps testing whether to enable a filter for a request or not
it can only be constructed from a filter service reference, from whose properties it builds its
predicates
This is the management interface for the Filter.
This is the implementation of the management interface for the
FilterProcessorMBean.
Tag for searching for resources using the given query formulated in the given
language.
This task is executed when the job handling starts.
Marker class for using the ForcedResourceType @Via provider.
Implementation for the format filter & runtime support.
The
ForwardTagHandler implements the
<sling:forward> custom tag.A segment in an interpolation.
A fragment which is an expression.
A text fragment.
MBean interface for interacting with the FSClassLoader
Simplified implementation of read-only content access via the JCR API.
A gauge metric is an instantaneous reading of a particular value.
The
GetAce service api.
Sling Get Servlet implementation for getting the ACE for a principal on a JCR
resource.
The
GetAcl service api.
Sling GET servlet implementation for dumping the declared ACL of a resource to JSON.
Tag for retrieving Context-Aware Configuration resource collection for a
specified resource, bucket and name.
Tag for retrieving Context-Aware Configuration resources for a specified
resource, bucket and name.
The
GetEffectiveAce service api.
Sling Get Servlet implementation for getting the effective ACE for a principal on a JCR
resource.
The
GetAcl service api.
Sling GET servlet implementation for dumping the declared ACL of a resource to JSON.
Tag for retrieving all of the parent resources of a specified resource,
returning them in hierarchy order.
Tag for retrieving a parent resource based on the absolute parent level
The
GetPrincipalAce service api.
Sling Get Servlet implementation for getting the principal based ACE for a principal on a JCR
resource.
Tag for retrieving a property from a ValueMap.
Tag for retrieving resources based on either an absolute path or a relative
path and a base resource.
Wrapping
BackendCompiler that checks for global bindings shadowing.The
HeadServletResponse is a Sling response wrapper which
ensures that nothing will ever be written by return null writers or output
streams.A metric which calculates the distribution of a value.
Task to clean up the history,
A clean up task can be configured with three properties:
- age : only jobs older than this amount of minutes are removed (default is two days)
- topic : only jobs with this topic are removed (default is no topic, meaning all jobs are removed)
The value should either be a string or an array of string
- state : only jobs in this state are removed (default is no state, meaning all jobs are removed)
The value should either be a string or an array of string.
HTML parser.
Deprecated.
The
HtmlRendererServlet renders the current resource in HTML
on behalf of the DefaultGetServlet.Deprecated.
use org.apache.sling.servlets.post.HtmlResponse instead.
The
HtmlResponse is an AbstractPostResponse preparing
the response in HTML (actually XHTML) such that it can be interpreted
as a plain response in a browser or as XML response in an Ajax request.The
HtmlResponseProxy extends the Sling API
HtmlResponse overwriting all public methods and redirecting to a
proxied PostResponse.HTTP-related constants
This is the super class of all JSP-generated servlets.
Instances of this class can be used in both HTL & JavaScript scripts.
Filter for i18n translation
Defines a single variable.
The IdMapService is responsible for storing a slingId-clusterNodeId
pair to the repository and given all other instances in the cluster
do the same can map clusterNodeIds to slingIds (or vice-versa)
Ignore a nested range of commands.
Defines a strategy to choose an implementation for a model if multiple are registered
for the same interface or super class.
The
ImportOperation class implements the
SlingPostConstants.OPERATION_IMPORT
import operation for the Sling default POST servlet.Encapsulates the options for the content import.
Implementation for the include plugin
Runtime support for including resources in a HTL script through
data-sly-include.The
IncludeTagHandler implements the
<sling:include> custom tag.The info provider delivers information about the current state of the
OSGi installer
Return values for
CollectionInheritanceDecider.This listener facade applies a 'startup delay' to a topology event handler,
that is, it allows to specify a startup time during which any topology events
will be queued and processing only starts after this time.
This listener facade applies a 'startup delay' to a topology event handler,
that is, it allows to specify a startup time during which any topology events
will be queued and processing only starts after this time.
Declares an annotation as a custom inject annotation.
Deprecated.
Use
InjectAnnotationProcessor2 insteadProcessor for injector-specific annotations.
Deprecated.
Use
StaticInjectAnnotationProcessorFactory preferably or in case of a dependency to the adaptable InjectAnnotationProcessorFactory2Factory for
InjectAnnotationProcessor2 that is evaluated at runtime for each
sling model adaption and may depend on the adaptable.Service interface for pluggable value injectors.
Operator generator for
BinaryOperator.IN.A piece of data that can be installed by the
OsgiInstaller
Currently the OSGi installer supports bundles and configurations,
but it can be extended by additional task factories supporting
other formats.Context for the installation tasks.
Optional listener which can be used to monitor the activities
of the installer.
Optional listener which can be used to monitor the activities
of the installer.
The state of the OSGi installer at a given time.
Update the installer itself
Base class for tasks that can be executed by the
OsgiInstaller.The install task factory creates a task for a given
resource.
An InstanceDescription represents and contains information about an
instance that is part of a TopologyView.
Used to filter InstanceDescriptions in a TopologyView.
Data object containing all infos about a particular Sling instance
Contains the outcome of reading an InstanceInfo
The
InstancesDiff allows to combine and filter two collections of InstanceDescription instances,
an "old" collection and a "new" collection.The state of the job after it has been processed by a
JobExecutor.A sequence with alternating string fragments and HTL expressions.
Replace place holders in a string
The value for the replacement is returned by this provider
Exception which is triggered whenever a Sling Model could not be
instantiated because it could not be adapted from the given adaptable.
Thrown in case the given model type could not be validated through the model validation.
Exception embedding a
ValidationResult from Sling Validation.Exception embedding a
ValidationResult from Sling Validation.Thrown when an invalid service filter is used
This is a inventory plugin displaying the active queues, some statistics
and the configurations.
The
IOProvider is an interface to provide more control of
sending output from JSP Java and Class generation phases as well as cleaning
up in case of problems.Generator for IS_WHITESPACE operator
Helper class to hold a list of items.
Wrapper class for
Iterators, that forwards all method calls to the wrapped Iterator.Base class for all exceptions generated by the JSP engine.
Class providing details about a javac compilation error.
BackendCompiler that generates a Java class.The
JavaCompiler provides platform independant Java
compilation support.The
JavaEscapeHelper class provides various methods which can be used to generate valid Java identifiers or package / class
names, especially when generating them from a transcompiler.Deprecated.
since version 2.1.0 of the API; see
JavaEscapeHelper for a replacement.The
JavaImportsAnalyzer allows checking imports in generated HTL Java classes, in order to optimise dependencies.A lazy initialised input stream wrapping a JCR Property that also has a Public URI representation.
The
JcrNodeResourceIterator class is a resource iterator,
which returns resources for each node of an underlying
NodeIterator.BindingsValuesProvider for currentNode and currentSession object.
Apply Operations produced by the repoinit parser to a JCR Repository
Extension of
ResourceChange to support user id and user data (if available)The
JcrResourceConstants interface provides constant values.The
JcrResourceUtil class provides helper methods used
throughout this bundle.JDT class compiler.
A job is executed by the
Scheduler service.Fluent builder API
This component manages/keeps track of all job consumer services.
The context for a
Job.Implementation of the job execution context passed to
job executors.
Call back interface to the queue.
The job execution result.
This object adds actions to a
JobImpl.This object encapsulates all information about a job.
Configuration of the job handling
Implementation of the job manager.
The job blocking queue extends the blocking queue by some
functionality for the job event handling.
The builder implementation for scheduled jobs.
The scheduler for managing scheduled jobs.
The job topic traverser is an utility class to traverse all jobs
of a specific topic in order of creation.
Callback called for each found job.
Callback called for each found resource.
The JoinerDelay is an ClusterSyncService used in the sync chain and got
introduced as part of SLING-10489.
Filter providing support for the
join option applied to arrays.Serializes dictionary configuration objects (as specified in the configuration admin) into JSON format.
The
JsonReader Parses a Json document on content load and
creates the corresponding node structure with properties.The
JsonRendererServlet renders the current resource in JSON
on behalf of the DefaultGetServlet.The
JSONResponse is an AbstractPostResponse preparing
the response in JSON.Rendering options
Implementation of JspApplicationContext
A place holder for various things that are used through out the JSP
engine.
Handles the jsp-config element in WEB_INF/web.xml.
Implementation of a JSP Context Wrapper.
Implementation of JspFactory.
Helper class from which all Jsp Fragment helper classes extend.
Class for tracking JSP compile time file dependencies when the
&060;%@include file="
This is a delegate forwarding either to our own factory
or the original one.
Bunch of util methods that are used by code generated for useBean,
getProperty and setProperty.
The JSP engine (a.k.a Jasper).
The
JspSlingHttpServletResponseWrapper class may be used by
tag library implementors to create a RenderResponse object
which wraps the writer of the response of a given page context.Interface for tracking the source files dependencies, for the purpose
of compiling out of date pages.
This class has all the utility method(s).
Wrapper for providing context to ValueExpressions
Write text to a character-output stream, buffering characters so as
to provide for the efficient writing of single characters, arrays,
and strings.
Utilities when inter-operating with JS scripts
Converts JS objects to Java objects
Helper class to hold key value pairs.
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.Lazily acquired InputStream which only accesses the JCR Value InputStream if
data is to be read from the stream.
Generator for the collection length operator
Removes an prefix at the beginning of
each line in a String.
Tag for listing the children of a Resource.
The
Loader TODODeprecated.
The
RequestLocaleResolver should be used instead.Class responsible for converting error codes to corresponding localized
error messages.
Use to holds details of a privilege
Use to holds details of a restriction
The
LocationCollector provides access to an ordered collection
of absolute paths containing potential request handling.A simple logging interface abstracting logging APIs.
Handler which logs all commands
Generator for logical operators
Components should implement this interface to customize properties
in the Login and/or LoginFailed event
Exception thrown by
ResourceResolverFactory.getAdministrativeResourceResolver(java.util.Map)ResourceResolverFactory.getResourceResolver(java.util.Map)ResourceResolver.clone(java.util.Map)Helper class to help reduce log.info output.
Generator for long numeric operators
This
Command renders a sequence of commands repeatedly.This is the configuration for the main queue.
This is a helper class to parse manifest header entries.
A header can have several entries separated by comma.
Directives and attributes are simple name/value pairs.
Internal interface representing the additional methods
MapEntries needs from the ResourceResolverFactory.
Exposes low-level methods used for resource resolving and mapping
The
MapEntry class represents a mapping entry in the mapping
configuration tree at /etc/map.Defines a syntactical construction representing a map.
The
Mapping class conveys the mapping configuration used by the
ResourceResolverFactoryImpl.The
Mapping class defines the mapping of a service's name and
optional service information to a user name and optionally to a set of principal names.Indicates what type of content is being rendered.
Implementation for the markup handler
Utility methods related to markup
Facilitates parsing of the Accept HTTP request header.
Generates a merged validation model out of one base
ValidationModel and 1 or more models to merge.Utility for merging two models.
Options for specifying some parts of the merge operation.
A meter metric which measures mean throughput
MetricReporter is in charge of listening to TopologyEvents
(by virtue of being a TopologyEventListener) and exposing
metrics (via dropwizard).
The
MetricsService enables creation of various types of Metric.Utility that provides a MetricsService to any class that
has been loaded from an OSGi bundle.
The
MimeTypeProvider interface defines an API for services
which are asked for MIME type mappings for unknown MIME types or extensions.The
MimeTypeService defines the service applications can call to
resolve file names to MIME types and derive default file name extensions from
MIME types.Exception which is used whenever one element (field, method or constructor) could not be set.
Exception which is triggered whenever a Sling Model cannot be instantiated
due to some missing elements (i.e. required fields/methods/constructor parameters
could not be injected).
Mark a class as adaptable via Sling Models.
A model is the central object.
The model archive reader can be used to read an archive based on a model
The archive contains the model file and all artifacts.
The model archive writer can be used to create an archive based on a model
The archive contains the model file and all artifacts.
Exception which is triggered when the Model class could not be instantiated due to
not having a model annotation, some reflection error, invalid constructors or
because some exception within the post construct method was triggered.
Constants for the provisioning model.
SPI interface for model exporters.
The ModelFactory instantiates Sling Model classes similar to #adaptTo but will throw an exception in case
instantiation fails for some reason.
This class offers a method to read a model using a
Reader instance.Helper methods for resolving variables and artifact versions in models.
Model utility
Optional artifact dependency version resolver
Parameter builder class for
ModelUtility.getEffectiveModel(Model, ResolverOptions) method.Optional variable resolver
Simple writer for the a model
This is a modifiable thread pool configuration that can be instantiated
and then configured to create a new thread pool.
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.The
ModifyAce service api.
Sling Post Servlet implementation for modifying the ACEs for a principal on a JCR
resource.
Deprecated.
Use the
ResourceProviderThe
ModifyOperation class implements the default operation
called by the Sling default POST servlet if no operation is requested by the
client.The
ModifyPrincipalAce service api.
Sling Post Servlet implementation for modifying the principalbased ACE for a principal on a JCR
resource.
Extension interface which allows for plugging in Jackson Modules
into the Jackson Exporter
The
MoveOperation class implements the
move
operation for the Sling default POST servlet.The
MultipartRequestParameter represents a request parameter
from a multipart/form-data POST request.The
ResourceCollector class provides a single public method -
#getServlets(ResourceResolver) - which is used to find an ordered collection
of Resource instances which may be used to find a servlet or
script to handle a request to the given resource.Deprecated.
Per session namespace mapping is not supported anymore.
Resource implementation for nested property containers of Authorizable
ValueMap implementation for nested properties of Authorizable Resources
This component receives resource added events and sends a job
created event.
The
NoAuthenticationHandlerException is thrown to indicate that
the
Authenticator.login(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method could not find a way to authenticate the request user.Deprecated.
see
AuthenticatorFilter a String so that it can be used as a NodeName.
Service interface which allows for custom node name generation for * resources.
The
NodeTypeSupport contains utility methods to register node
types from a CND
nodetype definition file given as an URL or InputStream with the
repository.A
NodeVisitor represents the mechanism through which ExpressionNode entities are processed.Simple helper class representing nonexisting resources.
InstanceDescription which represents an instance that is explicitly
not local, ie isOwn==false.
The
NopOperation class implements no operation at all.Generator for the not operator
Utility class to represent a Null value while evaluating predicates
Defines the null literal.
A converter for Number
Defines a numeric constant expression (e.g. "42.1").
Generator for numeric value
The OakBacklogClusterSyncService will wait until all instances
in the local cluster are no longer in any backlog state.
Oak-based implementation of the ClusterViewService interface.
This implementation of the cross-cluster service uses the view manager
implementation for detecting changes in a cluster and only supports one
cluster (of which this instance is part of).
The OakViewChecker is taking care of checking the oak discovery-lite
descriptor when checking the local cluster view and passing that
on to the ViewStateManager which will then detect whether there was
any change or not.
Deprecated.
This class has been moved to
ObjectModel.The
ObjectModel class provides various static models for object conversion and object property resolution.A
ResourceProvider must use an observation reporter
to report changes to resources.A observer configuration describes active configurations from registered listeners.
Provides mappings from operators to generators
Helper class for operator generation
The
OptingServlet 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.Marker annotation for optional injections.
Options for the compilation process.
A class to hold all init parameters specific to the JSP engine.
Order for services being sorted by
ServiceUtil.getComparableForServiceRanking(java.util.Map, Order)
or RankedServices.Specific
JsonReader, OrderedJsonReader parse json document exactly the same,
but does specific look up for SLING:ordered : [{SLING:name: "first", ...},{SLING:name: "second", ...}]Marker class for using the OriginalResourceType @Via provider.
This
ViaProvider implements the counterpart of the ForcedResourceTypeViaProvider and the
ResourceSuperTypeViaProvider.The action class needs to be referred in external files hence adding a marker
class in public package which extends the internal class.
The action class needs to be referred in external files hence adding a marker
class in public package which extends the internal class.
Provides parameter override map from OSGi factory configuration.
Service for installing/updating/removing installable resources
InstallableResource in an OSGi framework.Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject an OSGi service
Deprecated.
Use
org.osgi.util.converter.Converters and ServiceUtil insteadThis
Command renders a variable's value.This
Command renders a text fragment.Package matcher - the topic must be in the same package.
Implementation of the PageContext class from the JSP spec.
A repository for various info about the translation unit under compilation.
The
ParameterMap TODODeprecated.
Use the
ResourceProviderParses path looking for semicolon-separated parameters.
This exception is thrown when parse errors are encountered.
Helper utilities for the ANTLR parser.
XML parsing utilities for processing web application deployment
descriptor and tag library descriptor files.
Simple helper class for path matching.
Provide path(s) on an @Inject.
The
PathBuilder offers a convenient way of creating a valid path from multiple fragmentsIterator that eliminates duplicate paths.
A path entry from the manifest for initial content.
Utility to generate all possible paths from segments (names)
Expands all paths from the iterator with their parent paths up to the given root paths.
Defines a segment of a path to be created,
with its name and an optional primary type and optional mixins
Simple helper class for path matching against a set of paths.
The
Patterns class provides various static methods that implement commonly used stream processing commands.Simple executor of a background job that periodically
invokes a particular runnable - catching RuntimeExceptions
that might throw - but not catching Errors (that terminates
the BackgroundJob).
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
PlainTextRendererServlet renders the current resource in
plain text on behalf of the
DefaultGetServlet.Common interface for plugins
Data related to a plugin call
General interface for plugin invocations.
Exception which is triggered, whenever the post-construct method has thrown an exception.
The
PostOperation interface defines the service API to be
implemented by service providers extending the Sling POST servlet.The
PostResponse interface defines the API of a response
container which can (and should) be used by PostOperation services to
prepare responses to be sent back to the client.Service interface which allows for alternate implementations of the
PostResponse interface to be created as needed.
Deprecated.
Indicates that the input does not meet necessary precondition.
Service interface which allows for filtering what characters are allowed
in a generated principal name
Service interface which allows for custom principal name generation
Default implementation that generates a principal name based on a set of
well-known request parameters
Resource implementation for Principal (SLING-11098)
Wrapper response to redirect the output into a specified print writer
Helper class to assist in the usage of access control from scripts.
Wrapper class that holds the set of Privileges that are granted
and/or denied for a specific principal.
This
Command allows defining a HTL template - the only functional construct of the language.Deprecated.
Use
org.osgi.util.converter.Converters insteadAdds further metadata for properties of context-aware configuration annotation classes.
Defines an expression in which an object is queried for a specific property (e.g.
A single "set property" line
Valid types for these properties
Defines a configuration property.
The
PropertyProvider service interface may be implemented by
components that wish to define properties on the local instance which then
are broadcast to the TopologyView instances.A JobFactory that instantiates the Job instance (using the default no-arg
constructor, or more specifically:
class.newInstance()), and
then attempts to set all values from the SchedulerContext and
the JobExecutionContext's merged JobDataMap onto
bean properties of the Job.Maps EL functions to their Java method counterparts.
This enumeration defines the context for executing XSS protection.
The provider context...
Provider context implementation
Manages resolve contexts for each resource provider including
authentication.
Result returned by a
UseProvider.ProxyAccessControlManager<T extends javax.jcr.security.AccessControlManager>
ProxyRepository<T extends javax.jcr.Repository>
ProxySession<T extends javax.jcr.Session>
ProxyWorkspace<T extends javax.jcr.Workspace>
A stream that can be written into.
Deprecated.
Use the
ResourceProviderThe 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 queue manager manages queue configurations.
The queue job cache caches jobs per queue based on the topics the queue is actively
processing.
Implementation of the queue manager.
An MBean that provides statistics from
The queue services class is a helper class containing all
services used by the queue implementations.
Helper class that collects all services registered via OSGi bind/unbind methods.
Notification for changes on services list.
A
Record is a key-value immutable object understood by the HTL runtime, used for abstracting complex objects like Sightly
templates (declared with the data-sly-template block element) or objects that need to be translated from Java to JavaScript
and back.The
RecursionTooDeepException is thrown by the Sling
implementation if to many recursive content inclusions take place.Takes a string representation of a node (either a path or a uuid) and tries to parse it.
Deprecated.
Use the
ResourceProviderRefresh a set of bundles.
Performs regular expressions validation on the supplied data with the help of the
Pattern class.A resource that's been registered in the OSGi controller.
An embedded block of text
Remove ACL statement that groups a set of AclLines that all refer to the same set of paths.
Remove ACL statement that groups a set of AclLines that all refer to the same set of principals.
Remove ACL statement that groups a set of AclLines that all refer to the same set of principals.
The
RenderContext defines the context for executing HTL scripts.Rendering context for HTL rendering units.
Basic unit of rendering.
Interprets identifiers as paths to other HTL templates
repoinit parser service interface
Deprecated.
No longer supported
Utilities for interacting with the RepositoryManagementMBean
A
RepositoryMount works similar to a resource provider and allows to
connect custom data.Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a
request attribute.
The
RequestData class provides access to objects which are set
on a Servlet Request wide basis such as the repository session, the
persistence manager, etc.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.Felix OSGi console plugin that displays info about recent requests processed
by Sling.
Information about a single request.
This service can be used to gather information about requests processed by the
engine.
Track requests.
The
RequestLocaleResolver service interface may be implemented by a
service registered under this name to allow the resolution of the request
Locale to apply.Deprecated.
Use the request progress tracker instead.
The
RequestLogger just registers RequestLoggerService
instance on behalf of the provided configuration.Record the starting time of the request and make it available to the request logger
The
RequestLoggerService is a factory component which gets
configuration to register loggers for the RequestLogger.The
RequestParameter class represents a single parameter sent
with the client request.The
RequestParameterMap encapsulates all request parameters of
a request.Contains a Lazy iterator of Parts from the request stream loaded as the request is streamed using the Commons FileUpload API.
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.This is the management interface for the SlingRequestProcessor.
The
RequestProgressTracker class provides the functionality to
track the progress of request processing.Filter that dumps the output of the RequestProgressTracker to the log after
processing the request.
Encapsulates all infos from the respective request parameters that are needed
to create the repository property
The
RequestSlingFilterChain implements the filter chain for
request scoped filters.Request related utility methods.
Deprecated.
Use
RequestUtilMarker annotation for required injections.
Cache for script resolution
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
A resource provides all relevant information about a registered
resource.
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.The
ResourceBundleProvider service interface defines the API
for a service, which is capable of returned ResourceBundle for
given any Locale.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.
OSGi Service listening for changes of resources.
Information about a resource change listener.
Tracker component for the resource change listeners.
The
ResourceCollector class provides a single public method -
#getServlets(ResourceResolver) - which is used to find an ordered
collection of Resource instances which may be used to find a
servlet or script to handle a request to the given resource.The resource context provides additional information for resource resolving.
Optional service to decorate
Resources returned by
the ResourceResolver.Helper class to track the resource decorators and keep them sorted by their
service ranking.
Iterator that eliminates duplicate resources (having same path).
This is a group of resources all pointing to the same artifact,
but maybe in different versions or locations.
Some helper methods surrounding resources
Resource iterator handling the decoration of resources.
An input stream that reads from a list of resources that can be adapted into input streams.
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.
Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a
resource by path(s).
Expected a list of iterators containing paths, where each path is a direct or indirect parent of the previous one
(= sorted by path hierarchy starting with the deepest path).
Iterate over the the HTTP request path by creating shorter segments of that
path using "." as a separator.
The resource plugin.
Service which provides the ability to convert a String into a
Predicate to match against Resource Objects
Provides a transitional state where multiple parameters can be applied before
creating the Predicate
Describes a
Resource property.Deprecated.
Use the
ResourceProviderAPI for providers of resources.
Represents a
org.apache.sling.spi.resource.provider.ResourceProvider.Deprecated.
Represents a failed
org.apache.sling.spi.resource.provider.ResourceProvider.Holder for a resource provider service.
Information about a registered resource provider
The resource provider storage contains all available handlers
and keeps a list of handlers for specific categories to avoid
iterating over all handlers for the different use cases.
Interface which allows access to a ResourceProviderStorage object.
This service keeps track of all resource providers.
Utility class which is used by the HTL engine & extensions to resolve resources.
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 resource resolver context.
This class takes a number of
AuthenticatedResourceProvider objects and
exposes it as one such object.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.Runtime support for including resources in a HTL script through
data-sly-resource.The state of a resource.
Utility to create a Stream of Resource objects from a managed
traversal of a Resource tree
Marker class for using the ResourceSuperType @Via provider.
A resource transformer transform a registered resource
before it can be installed.
The
ResourceType encapsulates details about a Sling resource type and provides methods for parsing resource type strings.A resource updater can be used if the processing of resources changes
with regards to the entity id and the alias.
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
Deprecated.
Use
ResponseUtilRestart all active bundles.
The
RestoreOperation class implements the
restore
operation for the Sling default POST servlet.Single restriction(name,values*)
The retry handler should be informed by external services
whenever something in the system changed which might make
it worth to retry a failed installed.
Configuration for the Reference Mapping Transformer
The
RhinoHostObjectProvider defines the service interface to
inject additional ECMAScript host objects as well as to make classes and
packages known.A run mode is a collection of
- artifacts (through start levels)
- configurations
- settings
Only if all run modes are active, this run mode is active.
Interface to add a method to get the scheduler expression for a runnable job
A
RuntimeCall is a special expression which provides access to utility functions from the runtime.Represents the resource resolver runtime
A
RuntimeExtension represents a HTL runtime construct that provides some processing capabilities for the various
data-sly-* block elements.Deprecated.
constants are available in
RuntimeCall
starting with version 1.2.0 of the org.apache.sling.scripting.sightly.compiler.expression.nodes API.The
RuntimeObjectModel provides various utility object inspection & conversion methods that can be applied to runtime
objects when executing HTL scripts.Runtime service providing introspection of the state of the resource resolver
and the resource providers.
A visitor which checks a stream for correct closing of things
The job schedule information.
Scheduler options provide an extensible way of defining how to schedule a job.
A scheduler to schedule time/cron based jobs.
Base class for Scriptable objects, uses the NativeJavaObject wrapper to provide
default wrapping of methods and properties (SLING-397)
The
ScriptableMap wrapper provides easier access to a map's values by setting the map's keys as properties to the JavaScript
object representing the Map.A wrapper for JCR nodes that exposes all properties and child nodes as
properties of a Javascript object.
Wrap a JCR Property as a Scriptable
Resource in JavaScript has following signature:
[String] getName()
[String] name
[Object] getResourceMetadata()
[Object] resourceMetadata
[String] getPath()
[String] path
[String] getResourceType()
[String] resourceType
[String] getResourceSuperType()
[String] resourceSuperType
[Resource] getParent()
[Resource] parent
[ResourceResolver] getResourceResolver()
[ResourceResolver] resourceResolver
[Resource] getChild(String)
[Resource[]] getChildren()
[Resource[]] listChildren()
[Boolean] isResourceType(String)
[Object] properties
Scriptable wrapper for the JCR Version class
Scriptable wrapper for the JCR VersionHistory class
The
ScriptCache service interface defines a cache for compiled scripts.The
ScriptEvaluationException is thrown by the
SlingScript.eval(SlingBindings) method if an error occurrs evaluating
the script.Simple script helper providing access to the (wrapped) response, the
on-demand writer and a simple API for request inclusion.
The
ScriptingResourceResolverProvider provides methods to obtain ResourceResolvers that can be used by scripting
bundles to perform their script resolution operations.Marker interface for various
Readers from which a script's name can be obtained.Use provider that interprets the identifier as a script path, and runs the respective script using a script engine that matches the
script extension.
Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a
script variable (from the org.apache.sling.api.scripting.SlingBindings)
An additional section in the provisioning model.
Static class used to preload java classes when using the
Java SecurityManager so that the defineClassInPackage
RuntimePermission does not trigger an AccessControlException.
Util class for Security related operations.
Annotation to be used on either methods, fields or constructor parameters to let Sling Models
inject the adaptable itself, or an object that can be adapted from it.
Injects the adaptable object itself.
Applies a list of transformations in sequence.
The
ServicePrincipalsValidator allows to implement validation of configured
service user mappings.The
ServiceUserMapped is a marker service that can be used to
ensure that there is an already registered mapping for a certain
service/subService.The
ServiceUserMapper service can be used to map a service
provided by a bundle to the ID of a user account used to access the
ResourceResolver used by the service to access its data.The
ServiceUserValidator allows to implement validation of configured
service user mappings.The
ServiceUtil is a utility class providing some
useful utility methods for service handling.The
SlingServletResolver resolves a
servlet for a request by implementing the ServletResolver interface.The
ServletResolver defines the API for a service capable of
resolving javax.servlet.Servlet instances to handle the
processing of a request or resource.Service registration properties and common values used for registering a Sling Servlet.
ServletResponseWrapper used by the JSP 'include' action.
This is what is used to generate servlets.
Set ACL statement that groups a set of AclLines
that all refer to the same set of paths.
Deprecated.
Use
EnsureAclPrincipalBased instead with stricter semanticsSet ACL statement that groups a set of AclLines
that all refer to the same set of principals.
Implementation for the
data-sly-set pluginExpression visitor which does not return anything for nodes; instead it performs specific side-effects depending on the expression
nodes types.
HTL specific
BindingsValuesProvider.
The
SightlyCompiler interprets a HTL script and transforms it internally into a CommandStream.Exception thrown by the
SightlyCompiler during various processing operations.Holds various HTL engine global configurations.
Exceptions caused by the HTL engine.
This class provides an empty implementation of
SightlyParserListener,
which can be extended to create a listener which only needs to handle a subset
of the available methods.The
SightlyParserErrorListener handles parsing error reporting by sending offending input to a logger.This interface defines a complete listener for a parse tree produced by
SightlyParser.The HTL Script engine
HTL template engine factory
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (without unicode processing).
DOM-based compiler implementation
Deprecated.
Use the
SlingAdaptable insteadThe
SlingAdaptable class is an (abstract) default implementation
of the Adaptable interface.Component Property Type (as defined by OSGi DS 1.4) for Sling Adapters.
Helper base class for data modifying Servlets used in Sling.
The
SlingBindings class is used to prepare global variables
for script execution.The
SlingComponentFilterChain implements the filter chain for
component scoped filters.The
SlingConstants interface provides some symbolic constants
for well known constant strings in Sling.The
SlingContext extends Context to overwrite the
SlingContext.initStandardObjects(ScriptableObject, boolean) method to add more
standard objects.The
SlingContextFactory extends the standard Rhino
ContextFactory to provide customized settings, such as having the dynamic
scope feature enabled by default.Custom util such that origin can be customized
CopyMoveManager service that uses a ServiceTracker to find available
CopyMoveHandler.
DavEx WebDav servlet which acquires a Repository instance via the OSGi
service registry.
DeleteManager service that uses a ServiceTracker to find available
DeleteHandler.
The
SlingException is the base exception used throughout the
Sling API.Handles file uploads.
The
SlingFilterChainHelper class is used by Sling to
support building lists of Filters.Class containing the TagLib Functions for Sling.
The
SlingGlobal class provides two interesting new global
functions which are not part of the ECMAScript standard but which are
available in the Rhino Shell and which may be of use by JavaScripts:
print(args, ...)
Prints the arguments args in a single message to the scripts
logger available as the global log variable.
load(args, ...)
Loads the scripts named as parameters into the current scope one, after
the other.IOManager service that uses a ServiceTracker to find available IOHandlers.
The
SlingHttpServletRequest defines the interface to provide
client request information to a servlet.Fluent helper for building a request.
The
SlingHttpServletRequestWrapper class is a default wrapper
class around a SlingHttpServletRequest 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.Fluent helper for building a response.
This is an extension of a
SlingHttpServletResponse to get the result from a processing operation.The
SlingHttpServletResponseWrapper class is a default wrapper
class around a SlingHttpServletResponse which may be extended to
amend the functionality of the original response object.A background task that cleans up garbage slingIds after topology changes.
The
SlingIOException is a runtime exception wrapper for the
Java IOException.IOManager service that uses a ServiceTracker to find available IOHandlers.
Injects common Sling objects that can be derived from either a SlingHttpServletRequest, a ResourceResolver or a
Resource.
Injects common Sling objects that can be derived from either a SlingHttpServletRequest, a ResourceResolver or a
Resource.
The
SlingPostConstants interface provides constants for well
known parameters of the core SlingPostServlet.Deprecated.
as of 2.0.8 (Bundle version 2.2.0) and replaced by
PostOperation.The
SlingPostProcessor interface defines a service API to be
implemented by service providers extending the Sling default POST servlet.PropertyManager service that uses a ServiceTracker to find available
PropertyHandler.
Sets a property on the given resource, in some cases with a specific type and
value.
The
SlingRepository extends the standard JCR repository
interface with two methods: SlingRepository.getDefaultWorkspace() and
SlingRepository.loginAdministrative(String).All active
SlingRepositoryInitializer services are called before
making the SlingRepository service available, and can perform
initializations on it, like creating service users, setting up initial access
control, migrating content in upgrades, etc.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.
Sling request URI parser that provides SlingRequestPathInfo for the
current request, based on the path of the Resource.
This class is not a "wrapper" per se, but computes the correct path info,
request URI, etc. for included requests.
The
SlingRequestProcessor interface defines the service which
may be called to handle HTTP requests.Custom class to allow the SlingLogPanel to differentiate between default
appenders and Sling Config based appenders
Helper base class for read-only Servlets used in Sling.
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
slingDeprecated.
The SlingScriptResolver interface is intended to be implemented
and also used by project specific code.
The
SlingServletContext class is the ServletContext
which is registered as a service usable by servlets and helpers inside Sling.The
SlingServletException is a runtime exception wrapper for
the Servlet API ServletException.Component Property Type (as defined by OSGi DS 1.4) for Sling Servlet Filters.
The possible scopes for the
SlingServletFilter.scope() annotation.Component Property Type (as defined by OSGi DS 1.4) for Sling Servlets.
Component Property Type (as defined by OSGi DS 1.4) for Sling Servlets.
Using this requires the SLING-8110 strict mode
The prefix/index to be used to register this servlet.
The
SlingServletRequestAdapter class is a
ComponentRequestWrapper which does not delegate to a wrapped
ComponentRequest but to a wrapped
HttpServletRequest.This is the management interface for the SlingServletResolver's cache.
Component Property Type (as defined by OSGi DS 1.4) for Sling Servlets.
The
SlingServletResponseAdapter class is a
ComponentResponseWrapper which does not delegate to a wrapped
ComponentResponse but to a wrapped
HttpServletResponse.The
SlingSessionProvider is a Jackrabbit WebDAV server
SessionProvider which returns the session stored as the
javax.jcr.Session request attribute.Deprecated.
Use the
SlingSettingsServiceThe
SlingSettingsService provides basic Sling settingsThe
SlingSimpleWebDavServlet extends the
JCR SimpleWebdavServlet with some
Sling-specific featuresCustom StatusPrinter similar to Logback StatusPrinter to account for changes required
for SLING-3410
Represents an immutable URI in the same way as java.net.URI but is extended with Sling-specific URI parts (e.g. selectors).
Builder for immutable
SlingUris.Exception that is thrown for Validator inconsistencies, e.g. if a mandatory parameter for a validator is missing.
The
SlingWebDavServlet implements the WebDAV protocol as a
default servlet for Sling handling all WebDAV methods.Wrapper with an additional methods to indicate the wrapped classes
Provides the
sightly namespace for usage in HTL & JS scripts called from SightlyRepresents a source map (SMAP), which serves to associate lines
of the input JSP file(s) to lines in the generated servlet in the
final .class file, according to the JSR-045 spec.
Represents the line and file mappings associated with a JSR-045
"stratum".
Represents a single LineSection in an SMAP, associated with
a particular stratum.
Contains static utilities for generating SMAP data based on the
current version of Jasper.
Implementation providing a sorted list of services
by service ranking.
Annotation which indicates the specific injector which will populate this injection.
Identifies a Java source file based on a
Resource.This service provides the standard instance properties (if available)
Used to provide the equivalent of an empty Node for GET requests to
*.something (SLING-344)
Variant of
IgnoreRange to be used in stateful visitors.This
CommandVisitor allows storing states for Command evaluation.Factory for
InjectAnnotationProcessor that is evaluated once
a sling model implementation class is registered.Implementation of the statistics.
The statistics manager keeps track of all statistics related tasks.
Supports streamed uploads including where the stream is made up of partial body parts.
Parses Content-Range headers according to spec https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html section 14.16
Content-Range = "Content-Range" ":" content-range-spec
content-range-spec = byte-content-range-spec
byte-content-range-spec = bytes-unit SP
byte-range-resp-spec "/"
( instance-length | "*" )
byte-range-resp-spec = (first-byte-pos "-" last-byte-pos)
| "*"
instance-length = 1*DIGIT
eg
bytes 0-1233/1234
bytes 500-1233/1234
bytes 500-1233/*
According to https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.12 "bytes" is the only valid range unit.
Performs a streamed modification of the content.
The
StreamRendererServlet streams the current resource to the
client on behalf of the
DefaultGetServlet.Utility functions for streams.
Interface for stream transformations.
Generator for strict equality
Defines a simple string constant (e.g.
A converter for any object based on toString()
This class provides placeholders for Sling configuration settings
that depend on the environment like host names / ports for dev, test,
qa, staging, prod systems
Placeholders are enclosed in Starting and Ending Delimiters (see PLACEHOLDER_START/END_TOKEN)
The name of the placeholder can contain any character except opening or closing
brackets (no nesting).
Implementation of a WhitelistEntry which accepts
cidr and ip mask notations.
Sub package matcher - the topic must be in the same package or a sub package.
This class is a symbol table implementation that guarantees that
strings used as identifiers are unique references.
This class is a symbol table entry.
HealthCheck that builds on-top of DocumentNodeStore's
determineServerTimeDifferenceMillis method which checks how much the local
time differs from the DocumentStore's time.
Implements the syncToken idea: each instance stores a key-value
pair with key=stringId and value=discoveryLiteSequenceNumber
under /var/discovery/oak/syncTokens - and then waits until it
sees the same token from all other instances in the cluster.
HTL Syntax specific elements.
This optimization handles variables initialized to map literals.
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.Update the system bundle from a RegisteredResource.
Provides parameter override map from system properties.
Helper for components that need to know the
UserManager resource paths
Pool of tag handlers that can be reused.
This interface is to be implemented by the plugin author, to supply
an alternate implementation of the tag handlers.
This interface allows the plugin author to make inqueries about the
properties of the current tag, and to use Jasper resources to generate
direct Java codes in place of tag handler invocations.
Manages tag plugin optimizations.
The
TagUtil class provides a series of utility methods which
may be used by tag library implementations to access Component API specific
objects and do other processing.Task in an event loop
A task resource is a registered resource which has been
processed by a
ResourceTransformer and is now
about to be processed by an InstallTask.This is a group of resources all pointing to the same artifact,
but maybe in different versions or locations.
Support class for the tasks.
The template parser parses an HTML document and returns a reusable tree
representation.
The template plugin
This exceptions indicates errors, which might be temporary and for which a retry
with the same parameters could work.
Defines the HTL ternary operator (e.g.
Implementation for the test plugin
The
data-sly-text plugin.The thread pool interface allows to start runnables by
getting threads from a managed pool.
The thread pool configuration.
The thread pool policies.
The
ThreadPoolManager manages thread pools.This is the management interface for a Sling Thread Pool.
A timer metric which aggregates timing durations and provides duration statistics.
A timing context.
Value provider for timing functions
Timing function for JS scripts that use async constructs
A container for all tag libraries that are defined "globally"
for the web application.
Describes the input token stream.
Token Manager Error.
The
TooManyCallsException is thrown by the Sling implementation
if to many inclusions have been called for during a single request.Deprecated.
Session pooling has been removed and thus this exception is not
used any more.
Interface for topic matchers
Implementation of the statistics.
The capabilities of a topology.
A topology connector client is used for sending (pinging) a remote topology
connector servlet and exchanging announcements with it
provides information about a topology connector client
Servlet which receives topology announcements at
/libs/sling/topology/connector*
without authorization (authorization is handled either via
hmac-signature with a shared key or via a flexible whitelist)
A topology event is sent whenever a change in the topology occurs.
The
TopologyEventListener service interface may be implemented by
components interested in being made aware of changes in the topology.This topology handler is handling the topology change events asynchronously
and processes them by queuing them.
We need a holder class to be able to put something into the queue to stop it.
Request Validator helper.
A topology view is a cross-cluster list of instances and clusters
that have announced themselves with the DiscoveryService.
Simple webconsole which gives an overview of the topology visible by the
discovery service
A traceable has an optional location.
Command visitor which tracks variables in commands.
A result of a
ResourceTransformer.Simplified implementation of a Node from a Document Object Model (DOM)
parse of an XML document.
Expression nodes with type information
A
TypeProvider keeps an association between a BundledRenderUnitCapability and the bundle that provides it.Reader for UCS-2 and UCS-4 encodings.
Unary callback function
Defines a unary operation (e.g.
Unary operators used in expressions.
Interface for generators of unary operators
This exception is thrown when the ClusterViewService
does not have a cluster view that is valid.
Abstract visitor that allows to skip processing some commands.
This iterator removes duplicated Resource entries.
This optimization removes variables which are bound but never used in the command stream.
The unwrapped plugin
This is a group of resources all pointing to the same artifact,
but maybe in different versions or locations.
The
UpdateGroup service api.
Sling Post Operation implementation for updating a group in the
jackrabbit UserManager.
An update handler is a service handling updates of resources through other ways
than the installer, e.g. handling a configuration change through the web console
or directly through the configuration admin API.
The update result is returned by an
UpdateHandler if
a resource could be persisted by the handler.The
UpdateUser service api.
Sling Post Operation implementation for updating a user in the jackrabbit UserManager.
Upgrade task
Upgrade jobs from earlier versions to the new format.
The interface for the URI(Uniform Resource Identifiers) version of RFC 2396.
The charset-changed normal operation to represent to be required to alert
to user the fact the default charset is changed.
A mapping to determine the (somewhat arbitrarily) preferred charset for a
given locale.
The URI parsing and escape encoding exception.
The
URIManipulationFilter provides support for Sightly's URI Manipulation options according to the
language specificationProvides 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
Use interface can be implemented by Java objects which are instantiated as part of processing data-sly-use
attributes.The JavaScript
use function
A
UseProvider instantiates objects for the Use-API.Runtime extension for the USE plugin
Util contains some often used consts, static methods and embedded class
to support the JSTL tag plugin.
Wraps responses to allow us to retrieve results as Strings.
Annotation processor that implements compile-time validation for Sling Models
Thrown in case an validation could not be performed for the given model.
A
ValidationModel defines the validation rules that a resource tree has to pass.Builder to instantiate a
ValidationModelAll providers of
ValidationModels must implement this interface.Retrieves the validation model.
A
ValidationResult contains validation information either from a single Validator or from multiple Validator invocations.The
ValidationService provides methods for finding ValidationModels and to trigger validations against those.Used by the
Model annotation.A
Validator is responsible for validating a single piece of information according to an internal constraint.Used as parameter for each call of
Validator.validate(Object, ValidatorContext, ValueMap)
Exposes additional information about the context in which the validation was called.Defines a specific validator invocation for a given property (without actually exposing a reference to the underlying
Validator).Provides detailed information about a given configuration value.
The
ValueMap is an easy way to access properties of a resource.This is copied from org.apache.sling.api.wrappers.ValueMapDectorator
to avoid dependency to latest Sling API.
Factory methods to create
ValueMaps.Annotation to be used on either methods, fields or constructor parameter to let Sling Models
inject a value from the ValueMap of the current resource.
Optimization interface for Injectors which wish to avoid repeated accessing of some object
based on the adaptable.
This
Command marks the binding of a variable.SideEffectVisitor which extracts all the variables from an expression.
Tracks information related to HTL variables, at different levels of the compiler.
Version object supporting Maven and OSGi versions.
Configuration to configure how version cleanup works on a per-path basis
Data structure to hold the various options associated with how versionable
nodes are handled in the post servlet.
Indicate that this injection point should be handled using some value
derived from the adaptable.
SPI interface for providers of the @Via annotation.
Marker interface for eligible @Via provider identifiers.
A ViewChecker is capable of issuing a heartbeat and
subsequently checking the resulting, current view
in the local cluster.
The ViewStateManager is at the core of managing TopologyEventListeners,
the 'view state' (changing vs changed) and sending out the appropriate
and according TopologyEvents to the registered listeners - depending
on the implementation it also supports the ClusterSyncService, which is
invoked on handleNewView.
Used to create an implementation classes of type ViewStateManager
(with the idea to be able to leave the implementation classes
as package-protected)
The ViewStateManager is at the core of managing TopologyEventListeners,
the 'view state' (changing vs changed) and sending out the appropriate
and according TopologyEvents to the registered listeners.
Delegates commands to a visitor.
Implementation of the bundle refresher based on framework wiring.
This is a configuration printer for the web console which
prints out the currently configured filter chains.
This is a web console plugin displaying the active queues, some statistics
and the configurations.
If the servlet request path ends with .json, the information is returned in JSON format.
A WhitelistEntry is capable of accepting certain requests
depending on a configuration.
Helper class for wildcards
Implementation of a WhitelistEntry which can accept
wildcards (* and ?)
This class defines the basic XML character properties.
This reader reads an xml file defining the content.
Utility class for dealing with attributes from KXmlParser.
Represents a reference to a file that is to be loaded into the repository.
The
XMLRendererServlet renders the current resource in XML
on behalf of the DefaultGetServlet.This class is used as a structure to pass text contained in the underlying
character buffer of the scanner.
XMLString is a structure used to pass character arrays.
A service providing validators and encoders for XSS protection during the composition of HTML
pages.
XSS filter implementation.
This service should be used to protect output against potential XSS attacks.
Runtime support for XSS filtering
The
XSSLibraryStatusService collects information about the way the XSS Protection API library is used.The
ZipReader TODO
AuthenticationHandlerimplementations should extendDefaultAuthenticationFeedbackHandlerdirectly and use the utility methods in theAuthUtilclass.