A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractResource - Class in org.apache.sling.api.resource
-
The
AbstractResource
is an abstract implementation of theResource
interface. - AbstractResource() - Constructor for class org.apache.sling.api.resource.AbstractResource
- AbstractResourceVisitor - Class in org.apache.sling.api.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. - AbstractResourceVisitor() - Constructor for class org.apache.sling.api.resource.AbstractResourceVisitor
- accept(Resource) - Method in class org.apache.sling.api.resource.AbstractResourceVisitor
-
Visit the given resource and all its descendants.
- accepts(SlingHttpServletRequest) - Method in interface org.apache.sling.api.servlets.OptingServlet
-
Examines the request, and return
true
if this servlet is willing to handle the request. - AccessSecurityException - Exception in org.apache.sling.api.security
-
Exception thrown by methods of
ResourceAccessSecurity
This exception is used to catch unpredictable situations in methods ofResourceAccessSecurity
- AccessSecurityException() - Constructor for exception org.apache.sling.api.security.AccessSecurityException
-
Constructs a new instance of this class with
null
as its detail message. - AccessSecurityException(String) - Constructor for exception org.apache.sling.api.security.AccessSecurityException
-
Constructs a new instance of this class with the specified detail message.
- AccessSecurityException(String, Throwable) - Constructor for exception org.apache.sling.api.security.AccessSecurityException
-
Constructs a new instance of this class with the specified detail message and root cause.
- AccessSecurityException(Throwable) - Constructor for exception org.apache.sling.api.security.AccessSecurityException
-
Constructs a new instance of this class with the specified root cause.
- adaptable - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
Whether the resource provider supports adaptable.
- Adaptable - Interface in org.apache.sling.api.adapter
-
The
Adaptable
interface identifies objects which can be adapted to other types or representations of the same object. - ADAPTABLE_CLASSES - Static variable in interface org.apache.sling.api.adapter.AdapterFactory
-
The service registration property listing the fully qualified names of classes which can be adapted by this adapter factory (value is "adaptables").
- ADAPTER_CLASSES - Static variable in interface org.apache.sling.api.adapter.AdapterFactory
-
The service registration property listing the fully qualified names of classes to which this factory can adapt adaptables (value is "adapters").
- AdapterFactory - Interface in org.apache.sling.api.adapter
-
The
AdapterFactory
interface defines the API for helpers which may be provided to enhance the adaptability of adaptable objects. - AdapterManager - Interface in org.apache.sling.api.adapter
-
The
AdapterManager
defines the service interface for a manager for object adaption. - adaptTo(Class<AdapterType>) - Method in interface org.apache.sling.api.adapter.Adaptable
-
Adapts the adaptable to another type.
- adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
adaptTo
on thewrapped resource
. - adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- adaptTo(Iterator<Resource>, Class<T>) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Return an iterator for objects of the specified type.
- adaptTo(ResolveContext<T>, Class<AdapterType>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Adapts the provider to another type.
- adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.adapter.SlingAdaptable
-
Calls into the registered
AdapterManager
to adapt this object to the desiredtype
. - adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper
- ADDED - org.apache.sling.api.resource.observation.ResourceChange.ChangeType
- addQueryParameter(String, String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Add a query parameter to the query of the URI.
- addSelector(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Add a selector to the URI.
- adjust(Consumer<SlingUriBuilder>) - Method in interface org.apache.sling.api.uri.SlingUri
-
Shortcut to adjust Sling URIs, e.g.
- append(String) - Method in class org.apache.sling.api.resource.path.PathBuilder
-
Appends a new path fragment
- APPLICATION_CONTEXT - Static variable in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Allowed value for the
ResourceAccessSecurity.CONTEXT
service registration property. - ATTR_INCLUDE_CONTEXT_PATH - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
HttpServletRequest.getContextPath()
of the request which included the servlet currently being active underlying theServlet
which included the servlet currently being active (value is "javax.servlet.include.context_path"). - ATTR_INCLUDE_PATH_INFO - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
HttpServletRequest.getPathInfo()
of the request which included the servlet currently being active underlying theServlet
which included the servlet currently being active (value is "javax.servlet.include.path_info"). - ATTR_INCLUDE_QUERY_STRING - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
HttpServletRequest.getQueryString()
of the request which included the servlet currently being active underlying theServlet
which included the servlet currently being active (value is "javax.servlet.include.query_string"). - ATTR_INCLUDE_REQUEST_URI - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
HttpServletRequest.getRequestURI()
of the request which included the servlet currently being active underlying theServlet
which included the servlet currently being active (value is "javax.servlet.include.request_uri"). - ATTR_INCLUDE_SERVLET_PATH - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
HttpServletRequest.getServletPath()
of the request which included the servlet currently being active underlying theServlet
which included the servlet currently being active (value is "javax.servlet.include.servlet_path"). - ATTR_REQUEST_CONTENT - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
Resource
underlying theServlet
which included the servlet currently being active (value is "org.apache.sling.api.include.resource"). - ATTR_REQUEST_PATH_INFO - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
RequestPathInfo
underlying theServlet
which included the servlet currently being active (value is "org.apache.sling.api.include.request_path_info"). - ATTR_REQUEST_SERVLET - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the
Servlet
which included the servlet currently being active (value is "org.apache.sling.api.include.servlet"). - ATTR_SCRIPT_RESOURCE_RESOLVER - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The name of the script context attribute holding the
ResourceResolver
which has been used to resolve the script. - attributable - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
Whether the resource provider supports attributes.
- AttributableResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
- AUTH_ADMIN - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The authentication information property indicating to use an administrative login.
- AUTH_CLONE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The authentication information property indicating that an existing resource resolver is being cloned.
- AUTH_SERVICE_BUNDLE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The authentication information property referring to the bundle providing a service for which a resource provider is to be retrieved.
- authenticate(Map<String, Object>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Authenticate against the resource provider.
- AUTHENTICATE_LAZY - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Value for
ResourceProvider.PROPERTY_AUTHENTICATE
indicating authentication is needed and will be done on demand. - AUTHENTICATE_NO - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Default value for
ResourceProvider.PROPERTY_AUTHENTICATE
- AUTHENTICATE_REQUIRED - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Value for
ResourceProvider.PROPERTY_AUTHENTICATE
indicating authentication is required. - Authenticator - Interface in org.apache.sling.api.auth
-
The
Authenticator
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 - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
The auth handling for this provider.
- AuthType - Enum in org.apache.sling.api.resource.runtime.dto
-
Enumeration for the auth type of a resource provider.
B
- BatchResourceRemover(int) - Constructor for class org.apache.sling.api.resource.ResourceUtil.BatchResourceRemover
- build() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Builds the immutable SlingUri from this builder.
C
- cache(ValueMap) - Static method in class org.apache.sling.api.wrappers.ValueMapUtil
-
Decorates the given
ValueMap
with a caching layer. - CachingValueMap - Class in org.apache.sling.api.wrappers.impl
-
ValueMap decorator that caches key-value pairs that were accessed before.
- CachingValueMap(ValueMap) - Constructor for class org.apache.sling.api.wrappers.impl.CachingValueMap
- call(SlingBindings, String, Object...) - Method in interface org.apache.sling.api.scripting.SlingScript
-
Evaluates this script using the bound variables as global variables to the script and then calls the given method with the arguments.
- canCreate(String, ResourceResolver) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a resource can be created at the path.
- canDelete(Resource) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a resource can be deleted at the path.
- canDeleteValue(Resource, String) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a value can be deleted
- canExecute(Resource) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a resource can be executed at the path.
- canReadValue(Resource, String) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a value can be read
- canSetValue(Resource, String) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a value can be set
- canUpdate(Resource) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Check whether a resource can be updated at the path.
- CHANGE_ADDED - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
String constant for
ResourceChange.ChangeType.ADDED
. - CHANGE_CHANGED - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
String constant for
ResourceChange.ChangeType.CHANGED
. - CHANGE_PROVIDER_ADDED - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
String constant for
ResourceChange.ChangeType.PROVIDER_ADDED
. - CHANGE_PROVIDER_REMOVED - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
String constant for
ResourceChange.ChangeType.PROVIDER_REMOVED
. - CHANGE_REMOVED - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
String constant for
ResourceChange.ChangeType.REMOVED
. - CHANGED - org.apache.sling.api.resource.observation.ResourceChange.ChangeType
- CHANGES - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
Array of change types - optional.
- CHARACTER_ENCODING - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
The name of the optional property providing the character encoding of the resource if the resource is streamable and contains character data (value is "sling.characterEncoding").
- clear() - Method in class org.apache.sling.api.resource.ResourceMetadata
- clear() - Method in class org.apache.sling.api.scripting.LazyBindings
- clear() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- clear() - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- clear() - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- clear() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- clone() - Method in class org.apache.sling.api.resource.ResourceMetadata
- clone(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns a new
ResourceResolver
instance based on the givenauthenticationInfo
map and the original authentication info used to create this instance. - clone(Map<String, Object>) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
ResourceResolver
obtained by callingclone
on the wrapped resource resolver. - close() - Method in interface org.apache.sling.api.resource.DynamicResourceProvider
-
Deprecated.Close the resource provider.
- close() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Close this resource resolver.
- close() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- commit() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Persist all pending changes.
- commit() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- commit(ResolveContext<T>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Commit all transient changes: create, delete and updates
- commit(ResourceResolver) - Method in interface org.apache.sling.api.resource.ModifyingResourceProvider
-
Deprecated.Commit all transient changes: create, delete and updates
- compareTo(Path) - Method in class org.apache.sling.api.resource.path.Path
- compareTo(MediaRangeList.MediaRange) - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- CompositeValueMap - Class in org.apache.sling.api.wrappers
-
Deprecated.Use
ValueMapUtil.merge(ValueMap...)
instead. Note that it does not support the parametermerge = false
. However, this could easily be achieved with another decorator that restricts the set of allowed keys. - CompositeValueMap(ValueMap, ValueMap) - Constructor for class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.Constructor
- CompositeValueMap(ValueMap, ValueMap, boolean) - Constructor for class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.Constructor
- contains(String) - Method in class org.apache.sling.api.request.header.MediaRangeList
-
Determines if this MediaRangeList contains a given media type.
- containsKey(Object) - Method in class org.apache.sling.api.scripting.LazyBindings
- containsKey(Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- containsKey(Object) - Method in class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
- containsKey(Object) - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- containsKey(Object) - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- containsKey(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- containsValue(Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- containsValue(Object) - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- containsValue(Object) - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- containsValue(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- CONTENT_LENGTH - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
The name of the optional property providing the content length of the resource if the resource is streamable (value is "sling.contentLength").
- CONTENT_TYPE - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
The name of the optional property providing the content type of the resource if the resource is streamable (value is "sling.contentType").
- CONTEXT - Static variable in interface org.apache.sling.api.security.ResourceAccessSecurity
-
The name of the service registration property containing the context of this service.
- convert(Object, Class<T>) - Static method in class org.apache.sling.api.wrappers.impl.ObjectConverter
-
Converts the object to the given type.
- copy(ResolveContext<T>, String, String) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
This method copies the subgraph rooted at, and including, the resource at
srcAbsPath
to the new location atdestAbsPath
and adds it as a child node of the resource atdestAbsPath
. - copy(String, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
This method copies the subgraph rooted at, and including, the resource at
srcAbsPath
to the new location atdestAbsPath
and adds it as a child node of the resource atdestAbsPath
. - copy(String, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps the
Resource
obtained by callingcopy
on the wrapped resource resolver. - create() - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder without any URI parameters set.
- create(Resource, String, Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Add a child resource to the given parent resource The changes are transient and require a call to
ResourceResolver.commit()
for persisting. - create(Resource, String, Map<String, Object>) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps the
Resource
obtained by callingcreate
on the wrapped resource resolver. - create(ResolveContext<T>, String, Map<String, Object>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Create a new resource at the given path.
- create(ResourceResolver, String, Map<String, Object>) - Method in interface org.apache.sling.api.resource.ModifyingResourceProvider
-
Deprecated.Create a new resource at the given path.
- CREATE - org.apache.sling.api.resource.external.URIProvider.Operation
-
The URI may be used to create resources at the resource identified by the Resource.
- createFrom(URI, ResourceResolver) - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder from an arbitrary URI.
- createFrom(RequestPathInfo) - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder from a RequestPathInfo instance .
- createFrom(Resource) - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder from a resource (only taking the resource path into account).
- createFrom(SlingHttpServletRequest) - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder from a request.
- createFrom(SlingUri) - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder from another SlingUri (clone and modify use case).
- createUniqueChildName(Resource, String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Create a unique name for a child of the
parent
. - CREATION_TIME - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
Returns the creation time of this resource in the repository in milliseconds (value is "sling.creationTime").
D
- decorate(Resource) - Method in interface org.apache.sling.api.resource.ResourceDecorator
-
Decorate a resource.
- decorate(Resource, HttpServletRequest) - Method in interface org.apache.sling.api.resource.ResourceDecorator
-
Deprecated.since 2.3.0 (and JCR Resource 2.1.0), this method will not be invoked.
- DeepReadModifiableValueMapDecorator - Class in org.apache.sling.api.wrappers
-
A value map wrapper which implements deep reading of properties based on the resource tree and also supports
ModifiableValueMap
. - DeepReadModifiableValueMapDecorator(Resource, ValueMap) - Constructor for class org.apache.sling.api.wrappers.DeepReadModifiableValueMapDecorator
- DeepReadValueMapDecorator - Class in org.apache.sling.api.wrappers
-
A value map wrapper which implements deep reading of properties based on the resource tree.
- DeepReadValueMapDecorator(Resource, ValueMap) - Constructor for class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
- DEFAULT_ERROR_HANDLER_METHOD - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The HTTP "method" name of an error handler used as the default (value is "default").
- DEFAULT_ERROR_HANDLER_RESOURCE_TYPE - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The resource type used to select error handlers (value is "sling/servlet/errorhandler").
- DEFAULT_RESOURCE_TYPE - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The resource type of a registered servlet used as the default servlet if no other (more specific) servlet or script could be selected (value is "sling/servlet/default").
- delete(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Delete the resource Deleting a non existing resource leads to no operation nor exception.
- delete(Resource) - Method in class org.apache.sling.api.resource.ResourceUtil.BatchResourceRemover
- delete(Resource) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- delete(ResolveContext<T>, Resource) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Delete the resource at the given path.
- delete(ResourceResolver, String) - Method in interface org.apache.sling.api.resource.ModifyingResourceProvider
-
Deprecated.Delete the resource at the given path.
- DELETE - org.apache.sling.api.resource.external.URIProvider.Operation
-
The URI may be used to delete the resource.
- dispose() - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Deprecated.This method is deprecated since version 2.1 and will be removed. It should never be called by clients.
- doDelete(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Called by the
SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to handle an HTTP DELETE request. - doGeneric(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Called by the
SlingSafeMethodsServlet.service(SlingHttpServletRequest, SlingHttpServletResponse)
method to handle a request for an HTTP method, which is not known and handled by this class or its extension. - doGet(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Called by the
SlingSafeMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to handle an HTTP GET request. - doHead(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Handles the HEAD method.
- done() - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Call this when done processing the request - only the first call of this method is processed, all further calls to this method are ignored.
- doOptions(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Handles the OPTIONS method by setting the HTTP
Allow
header on the response depending on the methods declared in this class. - doPost(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Called by the
SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to handle an HTTP POST request. - doPut(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Called by the
SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to handle an HTTP PUT request. - doTrace(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Handles the TRACE method by just returning the list of all header values in the response body.
- dump(PrintWriter) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Dumps the process timer entries to the given writer, one entry per line.
- DynamicResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
E
- EMPTY - Static variable in interface org.apache.sling.api.resource.ValueMap
-
Empty immutable value map.
- EMPTY_CONTEXT - Static variable in interface org.apache.sling.spi.resource.provider.ResourceContext
-
"Empty" instance, not providing any additional information.
- EMPTY_SET - Static variable in class org.apache.sling.api.resource.path.PathSet
-
Empty path set.
- entrySet() - Method in class org.apache.sling.api.resource.ResourceMetadata
- entrySet() - Method in class org.apache.sling.api.scripting.LazyBindings
- entrySet() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- entrySet() - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- entrySet() - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- entrySet() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- equals(Object) - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- equals(Object) - Method in class org.apache.sling.api.resource.path.Path
- equals(Object) - Method in class org.apache.sling.api.resource.path.PathSet
- equals(Object) - Method in class org.apache.sling.api.scripting.LazyBindings
- equals(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- equals(String) - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- ERROR_EXCEPTION - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the exception thrown causing the error handler to be called (value is "javax.servlet.error.exception").
- ERROR_EXCEPTION_TYPE - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the fully qualified class name of the exception thrown causing the error handler to be called (value is "javax.servlet.error.exception_type").
- ERROR_MESSAGE - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the message of the error situation (value is "javax.servlet.error.message").
- ERROR_REQUEST_URI - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the URL requested by the client during whose processing the error handling was caused (value is "javax.servlet.error.request_uri").
- ERROR_SERVLET_NAME - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the name of the servlet which caused the error handling (value is "javax.servlet.error.servlet_name").
- ERROR_STATUS - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute containing the status code sent to the client (value is "javax.servlet.error.status_code").
- escapeXml(String) - Static method in class org.apache.sling.api.request.ResponseUtil
-
Escape XML text
- eval(SlingBindings) - Method in interface org.apache.sling.api.scripting.SlingScript
-
Evaluates this script using the bound variables as global variables to the script.
- EVENT_DESTROY - org.apache.sling.api.request.SlingRequestEvent.EventType
- EVENT_INIT - org.apache.sling.api.request.SlingRequestEvent.EventType
- EXCLUDED_PATHS_CHANGED - Static variable in interface org.apache.sling.spi.resource.provider.ProviderContext
-
This bit is set in
ResourceProvider.update(long)
if exclude paths changed. - EXTERNAL - org.apache.sling.api.resource.external.URIProvider.Scope
-
A External URI safe to be used by the requesting client in a external context.
- ExternalizableInputStream - Interface in org.apache.sling.api.resource.external
-
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 - Interface in org.apache.sling.api.resource.observation
-
This is a marker interface to receive external events.
F
- failedProviders - Variable in class org.apache.sling.api.resource.runtime.dto.RuntimeDTO
-
DTOs for all inactive/failed providers.
- FailureReason - Enum in org.apache.sling.api.resource.runtime.dto
-
Failure reason for a failed resource provider.
- findResources(String, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Searches for resources using the given query formulated in the given language.
- findResources(String, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Iterator
obtained by callingfindResources
on the wrapped resource resolver. - findResources(ResolveContext<T>, String, String) - Method in interface org.apache.sling.spi.resource.provider.QueryLanguageProvider
-
Searches for resources using the given query formulated in the given language.
- findResources(ResourceResolver, String, String) - Method in interface org.apache.sling.api.resource.QueriableResourceProvider
-
Deprecated.Searches for resources using the given query formulated in the given language.
- findResourceSuperType(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Deprecated.
- findScript(ResourceResolver, String) - Method in interface org.apache.sling.api.scripting.SlingScriptResolver
-
Deprecated.Finds the
SlingScript
for the given name. - FLUSH - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable indicating whether the output used by the script should be flushed after the script evaluation ended normally (value is "flush").
- forward(String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Same as
SlingScriptHelper.forward(String,RequestDispatcherOptions)
, but using empty options. - forward(String, String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to forward the request to a Servlet or script for the given
path
andrequestDispatcherOptions
. - forward(String, RequestDispatcherOptions) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to forward the request to a Servlet or script for the given
path
andoptions
. - forward(Resource) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Same as
SlingScriptHelper.forward(Resource,RequestDispatcherOptions)
, but using empty options. - forward(Resource, String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to forward the request to a Servlet or script for the given
resource
andrequestDispatcherOptions
. - forward(Resource, RequestDispatcherOptions) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to forward the request to a Servlet or script for the given
resource
andoptions
. - fromPathCollection(Collection<Path>) - Static method in class org.apache.sling.api.resource.path.PathSet
-
Create a path set from a collection of path objects
- fromPaths(Path...) - Static method in class org.apache.sling.api.resource.path.PathSet
-
Create a path set from a collection of path objects
- fromStringCollection(Collection<String>) - Static method in class org.apache.sling.api.resource.path.PathSet
-
Create a path set from a collection of strings
- fromStrings(String...) - Static method in class org.apache.sling.api.resource.path.PathSet
-
Create a path set from a collection of strings
G
- get() - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns the contents of the parameter as an array of bytes.
- get(String, Class<T>) - Method in interface org.apache.sling.api.resource.ValueMap
-
Get a named property and convert it into the given type.
- get(String, Class<T>) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.Get a named property and convert it into the given type.
- get(String, Class<T>) - Method in class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
- get(String, Class<T>) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
-
Get a named property and convert it into the given type.
- get(String, T) - Method in interface org.apache.sling.api.resource.ValueMap
-
Get a named property and convert it into the given type.
- get(String, T) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.Get a named property and convert it into the given type.
- get(String, T) - Method in class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
- get(String, T) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
-
Get a named property and convert it into the given type.
- get(Object) - Method in class org.apache.sling.api.scripting.LazyBindings
- get(Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- get(Object) - Method in class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
- get(Object) - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- get(Object) - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- get(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- get(String, Class<ObjectType>) - Method in class org.apache.sling.api.scripting.SlingBindings
-
Helper method to get an object with a given type from this map.
- getAdapter(Object, Class<AdapterType>) - Method in interface org.apache.sling.api.adapter.AdapterFactory
-
Adapt the given object to the adaptable type.
- getAdapter(Object, Class<AdapterType>) - Method in interface org.apache.sling.api.adapter.AdapterManager
-
Returns an adapter object of the requested
AdapterType
for the givenadaptable
object. - getAddedPropertyNames() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Deprecated.As there is no guarantee that this information is contained in the change event, this should not be used anymore.
- getAddSelectors() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Returns the
RequestDispatcherOptions.OPT_ADD_SELECTORS
option ornull
if not set. - getAdministrativeResourceProvider(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceProviderFactory
-
Deprecated.as of 2.4 (bundle version 2.5.0) because of inherent security issues. Implementations may implement this method at their discretion but must support the new service based resource provider generation in the
ResourceProviderFactory.getResourceProvider(Map)
method honoring theResourceProviderFactory.SERVICE_BUNDLE
andResourceResolverFactory.SUBSERVICE
properties. - getAdministrativeResourceResolver(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Deprecated.as of 2.4 (bundle version 2.5.0) because of inherent security issues. Services requiring specific permissions should use the
ResourceResolverFactory.getServiceResourceResolver(Map)
instead. - getAllMappings(String) - Method in interface org.apache.sling.api.resource.mapping.ResourceMapper
-
Returns all possible mappings for a given
resourcePath
as paths. - getAllMappings(String, HttpServletRequest) - Method in interface org.apache.sling.api.resource.mapping.ResourceMapper
-
Returns all possible mappings for a given
resourcePath
as URLs. - getAllowedRequestMethods(Map<String, Method>) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Helper method called by
SlingSafeMethodsServlet.doOptions(SlingHttpServletRequest, SlingHttpServletResponse)
to calculate the value of the Allow header sent as the response to the HTTP OPTIONS request. - getAllowedRequestMethods(Map<String, Method>) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Helper method called by
SlingSafeMethodsServlet.doOptions(SlingHttpServletRequest, SlingHttpServletResponse)
to calculate the value of the Allow header sent as the response to the HTTP OPTIONS request. - getAttribute(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the value of the given resource resolver attribute or
null
if the attribute is not set (or not visible as is the case of theResourceResolverFactory.PASSWORD
or other security sensitive attributes). - getAttribute(String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- getAttribute(ResolveContext<T>, String) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Returns the value of the given resource provider attribute or
null
if the attribute is not set or not visible (as e.g. - getAttribute(ResourceResolver, String) - Method in interface org.apache.sling.api.resource.AttributableResourceProvider
-
Deprecated.Returns the value of the given resource provider attribute or
null
if the attribute is not set or not visible (as e.g. - getAttributeNames() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns an iterator of attribute names whose value can be retrieved calling the
ResourceResolver.getAttribute(String)
method. - getAttributeNames() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- getAttributeNames(ResolveContext<T>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Returns a collection of attribute names whose value can be retrieved calling the
ResourceProvider.getAttribute(ResolveContext, String)
method. - getAttributeNames(ResourceResolver) - Method in interface org.apache.sling.api.resource.AttributableResourceProvider
-
Deprecated.Returns a collection of attribute names whose value can be retrieved calling the
AttributableResourceProvider.getAttribute(ResourceResolver, String)
method. - getBatchResourceRemover(int) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Create a batch resource remover.
- getChangedPropertyNames() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Deprecated.As there is no guarantee that this information is contained in the change event, this should not be used anymore.
- getChangeTypes() - Method in interface org.apache.sling.spi.resource.provider.ObserverConfiguration
-
The set of types listeners are interested in.
- getCharacterEncoding() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getChild(String) - Method in interface org.apache.sling.api.resource.Resource
-
Returns the child at the given relative path of this resource or
null
if no such child exists. - getChild(String) - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getChild
on thewrapped resource
. - getChild(String) - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns the indicated child of this resource.
- getChildren() - Method in class org.apache.sling.api.resource.AbstractResource
- getChildren() - Method in interface org.apache.sling.api.resource.Resource
-
Returns an iterable of the direct children of this resource.
- getChildren() - Method in class org.apache.sling.api.resource.ResourceWrapper
- getChildren(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
- getChildren(Resource) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Iterable
obtained by callinggetChildren
on the wrapped resource resolver. - getContentLength() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getContentType() - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns the content type passed by the browser or
null
if not defined. - getContentType() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getContextPath(HttpServletRequest) - Static method in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Return the context path for r, using the appropriate request attribute if the request is an included one.
- getCookie(String) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the named cookie from the HTTP request or
null
if no such cookie exists in the request. - getCookie(String) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getCreationTime() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getError() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns any recorded error or
null
- getExcludedPaths() - Method in interface org.apache.sling.spi.resource.provider.ObserverConfiguration
-
The set of excluded paths.
- getExcludedPaths() - Method in interface org.apache.sling.spi.resource.provider.ProviderContext
-
Set of paths which are "hidden" by other resource providers.
- getExtension() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the extension from the URL or
null
if the request URL does not contain an extension. - getExtension() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the extension.
- getExtension() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the extension.
- getFileName() - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
- getFilter() - Method in exception org.apache.sling.api.scripting.InvalidServiceFilterSyntaxException
- getFlush() - Method in class org.apache.sling.api.scripting.SlingBindings
- getForceResourceType() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Returns the
RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE
option ornull
if not set. - getFragment() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the fragment.
- getFragment() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the fragment.
- getHost() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the host.
- getHost() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the host.
- getInputStream() - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns an InputStream that can be used to retrieve the contents of the file.
- getLanguage() - Method in exception org.apache.sling.api.resource.QuerySyntaxException
- getLocation() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the location of the modification.
- getLog() - Method in class org.apache.sling.api.scripting.SlingBindings
- getMapping(String) - Method in interface org.apache.sling.api.resource.mapping.ResourceMapper
-
Returns a path mapped from the (resource) path applying the reverse mapping used by the
ResourceResolver.resolve(String)
such that when the path is given to theResourceResolver.resolve(String)
method the same resource is returned. - getMapping(String, HttpServletRequest) - Method in interface org.apache.sling.api.resource.mapping.ResourceMapper
-
Returns an URL mapped from the (resource) path applying the reverse mapping used by the
ResourceResolver.resolve(HttpServletRequest, String)
such that when the path is given to theResourceResolver.resolve(HttpServletRequest, String)
method the same resource is returned. - getMessages() - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Returns an
Iterator
of tracking entries. - getModificationTime() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getName() - Method in interface org.apache.sling.api.request.RequestParameter
- getName() - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns the name of this resource.
- getName() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the name of this resource.
- getName() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getName
on thewrapped resource
. - getName(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Utility method returns the name of the given
path
, which is normalized byResourceUtil.normalize(String)
before resolving the name. - getName(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Deprecated.since 2.1.0, use
Resource.getName()
instead - getObservationReporter() - Method in interface org.apache.sling.spi.resource.provider.ProviderContext
-
Get the observation reporter for this instance.
- getObserverConfigurations() - Method in interface org.apache.sling.spi.resource.provider.ObservationReporter
-
Get the list of observer configurations affecting the provider this reporter is bound to.
- getOrCreateResource(ResourceResolver, String, String, String, boolean) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Creates or gets the resource at the given path.
- getOrCreateResource(ResourceResolver, String, Map<String, Object>, String, boolean) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Creates or gets the resource at the given path.
- getOrDefault(Object, Object) - Method in class org.apache.sling.api.scripting.LazyBindings
- getOut() - Method in class org.apache.sling.api.scripting.SlingBindings
- getParameter(String) - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- getParameterMap() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getParameters() - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- getParent() - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns the parent resource of this resource.
- getParent() - Method in class org.apache.sling.api.resource.NonExistingResource
- getParent() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the parent resource or
null
if this resource represents the root of the resource tree. - getParent() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getParent
on thewrapped resource
. - getParent(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Utility method returns the parent path of the given
path
, which is normalized byResourceUtil.normalize(String)
before resolving the parent. - getParent(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the parent resource of this resource.
- getParent(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Deprecated.since 2.1.0, use
Resource.getParent()
instead - getParent(Resource) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Resource
obtained by callinggetParent
on the wrapped resource resolver. - getParent(ResolveContext<T>, Resource) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Returns the parent resource from this resource provider or
null
if the resource provider cannot find it. - getParent(String, int) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Utility method returns the ancestor's path at the given
level
relative topath
, which is normalized byResourceUtil.normalize(String)
before resolving the ancestor. - getParentLocation() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the parent location of the modification.
- getParentResolveContext() - Method in interface org.apache.sling.spi.resource.provider.ResolveContext
-
Return a resolve context for the parent resource provider.
- getParentResourceProvider() - Method in interface org.apache.sling.spi.resource.provider.ResolveContext
-
Return the parent resource provider.
- getParentResourceType(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the super type of the given resource type.
- getParentResourceType(String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- getParentResourceType(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the super type of the given resource.
- getParentResourceType(Resource) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- getPath() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Get the resource path.
- getPath() - Method in class org.apache.sling.api.resource.path.Path
-
Return the path if this
Path
object holds a path, returns the pattern otherwise. - getPath() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the absolute path of this resource in the resource tree.
- getPath() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getPath
on thewrapped resource
. - getPath() - Method in class org.apache.sling.api.resource.SyntheticResource
- getPath() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the absolute path of the item upon which the request operated.
- getPath() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the joint path of resource path, selectors, extension and suffix.
- getPath() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the joint path of resource path, selectors, extension and suffix.
- getPathInfo(HttpServletRequest) - Static method in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Return the context path for r, using the appropriate request attribute if the request is an included one.
- getPathParameters() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the path parameters.
- getPathParameters() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the path parameters.
- getPaths() - Method in interface org.apache.sling.spi.resource.provider.ObserverConfiguration
-
The set of paths this listener is interested in.
- getPort() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the port.
- getPort() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the port.
- getProperty(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the generic response property with the given name and type or
null
if no such property exists. - getProperty(String, Class<Type>) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the generic response property with the given name and type or
null
if no such property exists or the property is not of the requested type. - getPropertyName() - Method in exception org.apache.sling.api.resource.PersistenceException
-
Get the property name related to this exception.
- getPropertyNamesHint() - Method in interface org.apache.sling.spi.resource.provider.ObserverConfiguration
-
Set containing the set of property names which serves as an optional hint for the underlying to only report property changes enlisted, ie the underlying might ignore this.
- getProviderContext() - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Get the current provider context.
- getProviderState() - Method in interface org.apache.sling.spi.resource.provider.ResolveContext
-
This is the object returned by
ResourceProvider.authenticate(Map)
- getQ() - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
-
Get the value of the quality factor parameter (
q
). - getQuery() - Method in exception org.apache.sling.api.resource.QuerySyntaxException
- getQuery() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the query.
- getQuery() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the query.
- getQueryLanguageProvider() - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Get the optional query language provider.
- getQueryString(HttpServletRequest) - Static method in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Return the query string for r, using the appropriate request attribute if the request is an included one.
- getReadableResource(Resource) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
If supplied Resource can be read, return it (or a wrapped variant of it).
- getReader() - Method in class org.apache.sling.api.scripting.SlingBindings
- getReferer() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the referer as from the 'referer' request header.
- getRemovedPropertyNames() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Deprecated.As there is no guarantee that this information is contained in the change event, this should not be used anymore.
- getReplaceSelectors() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Returns the
RequestDispatcherOptions.OPT_REPLACE_SELECTORS
option ornull
if not set. - getReplaceSuffix() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Returns the
RequestDispatcherOptions.OPT_REPLACE_SUFFIX
option ornull
if not set. - getRequest() - Method in class org.apache.sling.api.scripting.SlingBindings
- getRequest() - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Returns the
SlingHttpServletRequest
representing the input of the request. - getRequestDispatcher(String, RequestDispatcherOptions) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns a
RequestDispatcher
object that acts as a wrapper for the resource located at the given path. - getRequestDispatcher(Resource) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Same as
SlingHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)
but using empty options. - getRequestDispatcher(Resource, RequestDispatcherOptions) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns a
RequestDispatcher
object that acts as a wrapper for the resource located at the given resource. - getRequestDispatcher(String, RequestDispatcherOptions) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestDispatcher(Resource) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestDispatcher(Resource, RequestDispatcherOptions) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestParameter(String) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the value of a request parameter as a
RequestParameter
, ornull
if the parameter does not exist. - getRequestParameter(String) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestParameterList() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the request parameters as instances of the
RequestParameter
interface in the order or the request where the query string parameters are first and the POST request parameters are second. - getRequestParameterList() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestParameterMap() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns a
Map
of the parameters of this request. - getRequestParameterMap() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestParameters(String) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns an array of
RequestParameter
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist. - getRequestParameters(String) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestPathInfo() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the
RequestPathInfo
pertaining to this request. - getRequestPathInfo() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestProgressTracker() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the
RequestProgressTracker
of this request. - getRequestProgressTracker() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRequestURI(HttpServletRequest) - Static method in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Return the request URI for r, using the appropriate request attribute if the request is an included one.
- getResolutionPath() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getResolutionPathInfo() - Method in class org.apache.sling.api.resource.ResourceMetadata
- getResolveParameters() - Method in interface org.apache.sling.spi.resource.provider.ResourceContext
-
Return optional parameters for resolving the resource.
- getResource() - Method in exception org.apache.sling.api.resource.ResourceNotFoundException
- getResource() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the
Resource
wrapped by this instance. - getResource() - Method in class org.apache.sling.api.scripting.SlingBindings
- getResource() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the
Resource
object on whose behalf the servlet acts. - getResource() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getResource(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns a
Resource
object for data located at the given path. - getResource(String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Resource
obtained by callinggetResource
on the wrapped resource resolver. - getResource(ResourceResolver, String) - Method in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.Returns a resource from this resource provider or
null
if the resource provider cannot find it. - getResource(ResourceResolver, String, Map<String, String>) - Method in interface org.apache.sling.api.resource.ParametrizableResourceProvider
-
Deprecated.Returns a resource from this resource provider or
null
if the resource provider cannot find it. - getResource(ResourceResolver, HttpServletRequest, String) - Method in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.since 2.2.0 (and JCR Resource 2.1.0), this method will not be invoked.
- getResource(ResolveContext<T>, String, ResourceContext, Resource) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Returns a resource from this resource provider or
null
if the resource provider cannot find it. - getResource(Resource, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns a
Resource
object for data located at the given path. - getResource(Resource, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Resource
obtained by callinggetResource
on the wrapped resource resolver. - getResourceBundle(String, Locale) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the resource bundle of the given base name for the given locale.
- getResourceBundle(String, Locale) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getResourceBundle(Locale) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the resource bundle for the given locale.
- getResourceBundle(Locale) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getResourceMetadata() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the meta data of this resource.
- getResourceMetadata() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getResourceMetadata
on thewrapped resource
. - getResourceMetadata() - Method in class org.apache.sling.api.resource.SyntheticResource
-
Returns a resource metadata object containing just the path of this resource as the
ResourceMetadata.RESOLUTION_PATH
property. - getResourcePath() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Return the "resource path" part of the URL, what comes before selectors, extension and suffix.
- getResourcePath() - Method in exception org.apache.sling.api.resource.PersistenceException
-
Get the resource path related to this exception.
- getResourcePath() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the resource path.
- getResourcePath() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the resource path.
- getResourceProvider(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceProviderFactory
-
Deprecated.Returns a new
ResourceProvider
instance with further configuration taken from the givenauthenticationInfo
map. - getResourceResolver() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the
ResourceResolver
from which this resource has been retrieved. - getResourceResolver() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getResourceResolver
on thewrapped resource
. - getResourceResolver() - Method in class org.apache.sling.api.resource.SyntheticResource
-
Returns the
ResourceResolver
with which this synthetic resource is related ornull
if none. - getResourceResolver() - Method in class org.apache.sling.api.scripting.SlingBindings
- getResourceResolver() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the
ResourceResolver
which resolved theresource
of this request. - getResourceResolver() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getResourceResolver() - Method in interface org.apache.sling.spi.resource.provider.ResolveContext
-
Get the current resource resolver.
- getResourceResolver(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Returns a new
ResourceResolver
instance with further configuration taken from the givenauthenticationInfo
map. - getResourceSuperType() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the super type of the resource if the resource defines its own super type.
- getResourceSuperType() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getResourceSuperType
on thewrapped resource
. - getResourceSuperType() - Method in class org.apache.sling.api.resource.SyntheticResource
-
Synthetic resources by default do not have a resource super type.
- getResourceSuperType(ResourceResolver, String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Deprecated.
- getResourceType() - Method in class org.apache.sling.api.resource.NonExistingResource
- getResourceType() - Method in interface org.apache.sling.api.resource.Resource
-
The resource type is meant to point to rendering/processing scripts, editing dialogs, etc.
- getResourceType() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
getResourceType
on thewrapped resource
. - getResourceType() - Method in class org.apache.sling.api.resource.SyntheticResource
- getResponse() - Method in class org.apache.sling.api.scripting.SlingBindings
- getResponse() - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Returns the
SlingHttpServletResponse
representing the output of the request. - getResponseContentType() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the framework preferred content type for the response.
- getResponseContentType() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getResponseContentTypes() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Gets a list of content types which the framework accepts for the response.
- getResponseContentTypes() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
- getRuntimeDTO() - Method in interface org.apache.sling.api.resource.runtime.RuntimeService
- getScheme() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the scheme.
- getScheme() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the scheme.
- getSchemeSpecificPart() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the scheme-specific part of the URI, compare with Javadoc of
URI
. - getSchemeSpecificPart() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the scheme-specific part of the URI, compare with Javadoc of
URI
. - getScript() - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Returns the
SlingScript
being called to handle the request. - getScriptName() - Method in exception org.apache.sling.api.scripting.ScriptEvaluationException
- getScriptResource() - Method in interface org.apache.sling.api.scripting.SlingScript
-
Returns the Resource providing the script source code.
- getSearchPath() - Method in interface org.apache.sling.api.resource.observation.ResourceChangeList
-
Returns the search path used by the resource resolving.
- getSearchPath() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the search path used by the
ResourceResolver.getResource(String)
method to search for resources by relative path. - getSearchPath() - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Returns the search path used by the resource resolvers to search for resources by relative path.
- getSearchPath() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- getSelectors() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the selectors decoded from the request URL as an array of strings.
- getSelectors() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the selectors array.
- getSelectors() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the selectors array.
- getSelectorString() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the selectors decoded from the request URL as string.
- getSelectorString() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the selector string.
- getSelectorString() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the selector string
- getService(Class<ServiceType>) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Lookup a single service.
- getServiceResourceResolver(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Returns a new
ResourceResolver
instance with privileges assigned to the service provided by the calling bundle. - getServices(Class<ServiceType>, String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Lookup one or several services.
- getServletContext() - Method in class org.apache.sling.api.request.SlingRequestEvent
-
Gets the actual servlet context object as
ServletContext
- getServletInfo() - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Returns the simple class name of this servlet class.
- getServletName(Servlet) - Static method in class org.apache.sling.api.request.RequestUtil
-
Utility method to return a name for the given servlet.
- getServletPath(HttpServletRequest) - Static method in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Return the servlet path for r, using the appropriate request attribute if the request is an included one.
- getServletRequest() - Method in class org.apache.sling.api.request.SlingRequestEvent
-
Gets the actual request object as
ServletRequest
- getSize() - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns the size in bytes of the parameter.
- getSling() - Method in class org.apache.sling.api.scripting.SlingBindings
- getSlingRequest() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
Return the original
SlingHttpServletRequest
object wrapped by this. - getSlingResponse() - Method in class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper
-
Return the original
SlingHttpServletResponse
object wrapped by this. - getStatusCode() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns the status code of this instance.
- getStatusMessage() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Get the status message
- getString() - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns the contents of the parameter as a String, using the default character encoding.
- getString(String) - Method in interface org.apache.sling.api.request.RequestParameter
-
Returns the contents of the parameter as a String, using the specified encoding.
- getSubset(String) - Method in class org.apache.sling.api.resource.path.PathSet
-
Generate a path set of paths from this set which are in the sub tree of the provided path
- getSubset(Path) - Method in class org.apache.sling.api.resource.path.PathSet
-
Generate a path set of paths from this set which are in the sub tree of the provided path
- getSubset(PathSet) - Method in class org.apache.sling.api.resource.path.PathSet
-
Generate a path set of paths from this set which are in at least one of the sub tree of the provided path set.
- getSubtype() - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- getSuffix() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the suffix part of the URL or
null
if the request URL does not contain a suffix. - getSuffix() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the suffix part of the URI
- getSuffix() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the suffix part of the URI
- getSuffixResource() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the resource addressed by the suffix or null if the request does not have a suffix or the suffix does not address an accessible resource.
- getSuffixResource() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the corresponding suffix resource or null if no resource resolver is available (depends on the create method used in SlingUriBuilder) the URI does not contain a suffix if the suffix resource could not be found
- getSuffixResource() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the corresponding suffix resource or null if no resource resolver is available (depends on the create method used in SlingUriBuilder) the URI does not contain a suffix if the suffix resource could not be found
- getSupertype() - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- getSupportedLanguages(ResolveContext<T>) - Method in interface org.apache.sling.spi.resource.provider.QueryLanguageProvider
-
The supported languages of the resource provider.
- getThreadResourceResolver() - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Returns the
ResourceResolver
for the current thread. - getType() - Method in class org.apache.sling.api.request.SlingRequestEvent
-
get the type of the event, eg.
- getType() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Get the type of change
- getURI() - Method in interface org.apache.sling.api.resource.external.ExternalizableInputStream
-
Get a URI that is specific to the current session, and may be used in any context internal or external.
- getUserId() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Get the user id of the user initiating the change
- getUserID() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Get the user ID, if any, associated with this resource resolver.
- getUserID() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- getUserInfo() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the user info.
- getUserInfo() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns the user info.
- getValue(String) - Method in interface org.apache.sling.api.request.RequestParameterMap
-
Returns the first value for the named parameter or null if none
- getValueMap() - Method in class org.apache.sling.api.resource.AbstractResource
-
This method calls
Adaptable.adaptTo(Class)
with theValueMap
class as an argument. - getValueMap() - Method in interface org.apache.sling.api.resource.Resource
-
Returns a value map for this resource.
- getValueMap() - Method in class org.apache.sling.api.resource.ResourceWrapper
- getValueMap(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns an
ValueMap
object for the givenResource
. - getValues(String) - Method in interface org.apache.sling.api.request.RequestParameterMap
-
Returns all values for the named parameter or null if none
- getXmlEscapingWriter(Writer) - Static method in class org.apache.sling.api.request.ResponseUtil
-
Return a Writer that writes escaped XML text to target
- GLOB_PREFIX - Static variable in class org.apache.sling.api.resource.path.Path
-
The prefix to be used for glob patterns
H
- handleIfModifiedSince(SlingHttpServletRequest, HttpServletResponse) - Static method in class org.apache.sling.api.request.RequestUtil
-
Checks if the request contains a if-last-modified-since header and if the the request's underlying resource has a jcr:lastModified property.
- handleMethodNotImplemented(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Helper method which causes an appropriate HTTP response to be sent for an unhandled HTTP request method.
- hasChanges() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Are there any pending changes?
- hasChanges() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- hasChanges(ResolveContext<T>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Are there any transient changes?
- hasChanges(ResourceResolver) - Method in interface org.apache.sling.api.resource.ModifyingResourceProvider
-
Deprecated.Are there any transient changes?
- hasChildren() - Method in class org.apache.sling.api.resource.AbstractResource
-
Checks to see if there are direct children of this resource by invoking
ResourceResolver.hasChildren(Resource)
. - hasChildren() - Method in interface org.apache.sling.api.resource.Resource
-
Checks if the resource has any child resources.
- hasChildren() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
hasChildren
on thewrapped resource
. - hasChildren(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Checks if the specified resource has any direct child resources.
- hasChildren(Resource) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- hashCode() - Method in class org.apache.sling.api.resource.path.Path
- hashCode() - Method in class org.apache.sling.api.resource.path.PathSet
- hashCode() - Method in class org.apache.sling.api.scripting.LazyBindings
- hashCode() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- hasNext() - Method in class org.apache.sling.api.wrappers.IteratorWrapper
- HEADER_ACCEPT - Static variable in class org.apache.sling.api.request.header.MediaRangeList
- HEADER_ACCEPT - Static variable in class org.apache.sling.api.servlets.HttpConstants
- HEADER_ETAG - Static variable in class org.apache.sling.api.servlets.HttpConstants
- HEADER_IF_MATCH - Static variable in class org.apache.sling.api.servlets.HttpConstants
- HEADER_IF_MODIFIED_SINCE - Static variable in class org.apache.sling.api.servlets.HttpConstants
- HEADER_LAST_MODIFIED - Static variable in class org.apache.sling.api.servlets.HttpConstants
- HtmlResponse - Class in org.apache.sling.api.servlets
-
Deprecated.use org.apache.sling.servlets.post.HtmlResponse instead.
- HtmlResponse() - Constructor for class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Creates a new html response with default settings, which is
null
for almost all properties except theHtmlResponse.isCreateRequest()
which defaults tofalse
. - HttpConstants - Class in org.apache.sling.api.servlets
-
HTTP-related constants
- HttpConstants() - Constructor for class org.apache.sling.api.servlets.HttpConstants
I
- include(String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Same as
SlingScriptHelper.include(String,RequestDispatcherOptions)
, but using empty options. - include(String, String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to include the result of processing the request for the given
path
andrequestDispatcherOptions
. - include(String, RequestDispatcherOptions) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to include the result of processing the request for the given
path
andoptions
. - include(Resource) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Same as
SlingScriptHelper.include(Resource,RequestDispatcherOptions)
, but using empty options. - include(Resource, String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to include the result of processing the request for the given
resource
andrequestDispatcherOptions
. - include(Resource, RequestDispatcherOptions) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
Helper method to include the result of processing the request for the given
resource
andoptions
. - INCLUDE_CONTEXT_PATH - Static variable in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Attribute name used by the RequestDispatcher to indicate the context path of the included request, as a String.
- INCLUDE_PATH_INFO - Static variable in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Attribute name used by the RequestDispatcher to indicate the path info of the included request, as a String.
- INCLUDE_QUERY_STRING - Static variable in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Attribute name used by the RequestDispatcher to indicate the query string of the included request, as a String.
- INCLUDE_REQUEST_URI - Static variable in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Attribute name used by the RequestDispatcher to indicate the request URI of the included request, as a String.
- INCLUDE_SERVLET_PATH - Static variable in class org.apache.sling.api.wrappers.SlingRequestPaths
-
Attribute name used by the RequestDispatcher to indicate the servlet path of the included request, as a String.
- includeExternal() - Method in interface org.apache.sling.spi.resource.provider.ObserverConfiguration
-
true
if a listener is interested in external events. - INTERNAL - org.apache.sling.api.resource.external.URIProvider.Scope
-
Internal URI only to be used by a client on an internal network and never leaked onto a public network.
- INTERNAL_CONTINUE_RESOLVING - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
Deprecated.This flag is not supported anymore when implementing the SPI based
org.apache.sling.spi.resource.provider.ResourceProvider
- internalPut(String, Object) - Method in class org.apache.sling.api.resource.ResourceMetadata
- invalid - org.apache.sling.api.resource.runtime.dto.FailureReason
- InvalidServiceFilterSyntaxException - Exception in org.apache.sling.api.scripting
-
Thrown when an invalid service filter is used
- InvalidServiceFilterSyntaxException(String, String) - Constructor for exception org.apache.sling.api.scripting.InvalidServiceFilterSyntaxException
- InvalidServiceFilterSyntaxException(String, String, Throwable) - Constructor for exception org.apache.sling.api.scripting.InvalidServiceFilterSyntaxException
- isA(Resource, String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Deprecated.
- isAbsolute() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns true the URI is an absolute URI.
- isAbsolute() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns true the URI is an absolute URI.
- isAbsolutePath() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns true if the URI has an absolute path starting with a slash ('/').
- isAbsolutePath() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns true if the URI has an absolute path starting with a slash ('/').
- isCreateRequest() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Returns
true
if this was a create request. - isEmpty() - Method in class org.apache.sling.api.scripting.LazyBindings
- isEmpty() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- isEmpty() - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- isEmpty() - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- isEmpty() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- isExternal() - Method in class org.apache.sling.api.resource.observation.ResourceChange
-
Is this an external event?
- isFormField() - Method in interface org.apache.sling.api.request.RequestParameter
-
Determines whether or not this instance represents a simple form field or an uploaded file.
- isIncluded(HttpServletRequest) - Static method in class org.apache.sling.api.wrappers.SlingRequestPaths
-
True if r is an included request, in which case it has the INCLUDE_REQUEST_URI attribute
- isLive() - Method in interface org.apache.sling.api.resource.DynamicResourceProvider
-
Deprecated.Returns
true
if this resource provider has not been closed yet and can still be used. - isLive() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns
true
if this resource resolver is still usable. - isLive() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- isLive(ResolveContext<T>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Returns
true
if this resource provider has not been closed yet and can still be used. - isMethodValid(Method, String) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Returns
true
ifmethod
is notnull
and the method is not defined in the class named byclassName
. - isNonExistingResource(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns
true
if the resourceres
is a non-existing resource. - isOpaque() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns true for opaque URIs like e.g.
- isOpaque() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns true for opaque URIs like e.g.
- isPath() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns true the URI is either a relative or absolute path (this is the case if scheme and host is empty and the URI path is set)
- isPath() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns true the URI is either a relative or absolute path (this is the case if scheme and host is empty and the URI path is set)
- isPattern() - Method in class org.apache.sling.api.resource.path.Path
-
Returns {code true} if this
Path
object is holding a pattern - isRelativePath() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns true if the URI is a relative path (no scheme and path does not start with '/').
- isRelativePath() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Returns true if the URI is a relative path (no scheme and path does not start with '/').
- isResourceType(String) - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns
true
if this resource is of the given resource type or if any of the super resource types equals the given resource type. - isResourceType(String) - Method in interface org.apache.sling.api.resource.Resource
-
Is just a shortcut for
getResourceResolver().isResourceType(this, resourceType)
. - isResourceType(String) - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
isResourceType
on thewrapped resource
. - isResourceType(Resource, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns
true
if the resource type or any of the resource's super type(s) equals the given resource type. - isResourceType(Resource, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- isStarResource(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns
true
if the resourceres
is a "star resource". - isSuccessful() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
- isSyntheticResource(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns
true
if the resourceres
is a synthetic resource. - iterator() - Method in class org.apache.sling.api.resource.path.PathSet
-
Return an unmodifiable iterator for the paths.
- IteratorWrapper<T> - Class in org.apache.sling.api.wrappers
-
Wrapper class for
Iterator
s, that forwards all method calls to the wrappedIterator
. - IteratorWrapper(Iterator<T>) - Constructor for class org.apache.sling.api.wrappers.IteratorWrapper
-
Creates a wrapping iterator, delegating all method calls to the given
wrappedIterator
.
J
- JcrRules - Class in org.apache.sling.api.wrappers.impl
K
- keySet() - Method in class org.apache.sling.api.resource.ResourceMetadata
- keySet() - Method in class org.apache.sling.api.scripting.LazyBindings
- keySet() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- keySet() - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- keySet() - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- keySet() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
L
- LANGUAGES - Static variable in interface org.apache.sling.api.resource.QueriableResourceProvider
-
Deprecated.The name of the service registration property containing the supported languages of the resource provider (value is "provider.query.languages").
- lazy - org.apache.sling.api.resource.runtime.dto.AuthType
- LazyBindings - Class in org.apache.sling.api.scripting
-
The
LazyBindings
wraps another map and dynamically provides entries for the wrapped map through a map ofLazyBindings.Supplier
s. - LazyBindings() - Constructor for class org.apache.sling.api.scripting.LazyBindings
- LazyBindings(Map<String, LazyBindings.Supplier>) - Constructor for class org.apache.sling.api.scripting.LazyBindings
- LazyBindings(Map<String, LazyBindings.Supplier>, Map<String, Object>) - Constructor for class org.apache.sling.api.scripting.LazyBindings
- LazyBindings.Supplier - Interface in org.apache.sling.api.scripting
-
This marker interface should be used for suppliers which should be unwrapped when used as values stored in a
LazyBindings
map. - listChildren() - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns an iterator on the direct child resources.
- listChildren() - Method in interface org.apache.sling.api.resource.Resource
-
Returns an iterator of the direct children of this resource.
- listChildren() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns the value of calling
listChildren
on thewrapped resource
. - listChildren(Resource) - Method in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.
- listChildren(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
- listChildren(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Deprecated.since 2.1.0, use
Resource.listChildren()
instead - listChildren(Resource) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Iterator
obtained by callinglistChildren
on the wrapped resource resolver. - listChildren(ResolveContext<T>, Resource) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
- lock() - Method in class org.apache.sling.api.resource.ResourceMetadata
-
Make this object read-only.
- log(String) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Creates an entry with the given message
- log(String, Object...) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Creates an entry with a message constructed from the given
MessageFormat
format evaluated using the given formatting arguments. - LOG - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing a logger which may be used for logging purposes (value is "log").
- login(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.api.auth.Authenticator
-
Tries to login a request user for the current request.
- LOGIN_RESOURCE - Static variable in interface org.apache.sling.api.auth.Authenticator
-
Name of the request attribute which may be set by the application to indicate to the
Authenticator.login(HttpServletRequest, HttpServletResponse)
method to which resource access should actually be authenticated. - LoginException - Exception in org.apache.sling.api.resource
-
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)
- LoginException() - Constructor for exception org.apache.sling.api.resource.LoginException
-
Constructs a new instance of this class with
null
as its detail message. - LoginException(String) - Constructor for exception org.apache.sling.api.resource.LoginException
-
Constructs a new instance of this class with the specified detail message.
- LoginException(String, Throwable) - Constructor for exception org.apache.sling.api.resource.LoginException
-
Constructs a new instance of this class with the specified detail message and root cause.
- LoginException(Throwable) - Constructor for exception org.apache.sling.api.resource.LoginException
-
Constructs a new instance of this class with the specified root cause.
- logout(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.api.auth.Authenticator
-
Logs out if the current request is authenticated.
- logout(T) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
If the provider requires authentication, this method is called with the state of the user returned by
ResourceProvider.authenticate(Map)
once the resource resolver is closed. - logTimer(String) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Logs an entry with the message set to the name of the timer and the number of milliseconds elapsed since the timer start.
- logTimer(String, String, Object...) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Logs an entry with the message constructed from the given
MessageFormat
pattern evaluated using the given arguments and the number of milliseconds elapsed since the timer start.
M
- map(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns a (request) path mapped from the (resource) path applying the reverse mapping used by the
ResourceResolver.resolve(String)
such that when the path is given to theResourceResolver.resolve(String)
method the same resource is returned. - map(String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- map(HttpServletRequest, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns an URL mapped from the (resource) path applying the reverse mapping used by the
ResourceResolver.resolve(HttpServletRequest, String)
such that when the path is given to theResourceResolver.resolve(HttpServletRequest, String)
method the same resource is returned. - map(HttpServletRequest, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- matches(String) - Method in class org.apache.sling.api.resource.path.Path
-
If this
Path
object holds a path (and not a pattern), this method checks whether the provided path is equal to this path or a sub path of it. - matches(String) - Method in class org.apache.sling.api.resource.path.PathSet
-
Check whether the provided path is in the sub tree of any of the paths in this set.
- matches(String) - Method in interface org.apache.sling.spi.resource.provider.ObserverConfiguration
-
Checks whether a path matches one of the paths of this configuration but is not in the excluded paths set.
- matchesAll() - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
-
Returns
true
if this is a catch-all media range (*/*
). - mayService(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Tries to handle the request by calling a Java method implemented for the respective HTTP request method.
- mayService(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Tries to handle the request by calling a Java method implemented for the respective HTTP request method.
- MediaRange(String) - Constructor for class org.apache.sling.api.request.header.MediaRangeList.MediaRange
-
Constructs a
MediaRange
from aString
expression. - MediaRangeList - Class in org.apache.sling.api.request.header
-
Facilitates parsing of the Accept HTTP request header.
- MediaRangeList(String) - Constructor for class org.apache.sling.api.request.header.MediaRangeList
-
Constructs a
MediaRangeList
using a list of media ranges specified in ajava.lang.String
. - MediaRangeList(HttpServletRequest) - Constructor for class org.apache.sling.api.request.header.MediaRangeList
-
Constructs a
MediaRangeList
using information from the suppliedHttpServletRequest
. - MediaRangeList.MediaRange - Class in org.apache.sling.api.request.header
-
A code
MediaRange
represents an entry in aMediaRangeList
. - merge(List<ValueMap>) - Static method in class org.apache.sling.api.wrappers.ValueMapUtil
-
Merge provided
ValueMaps
into a single viewValueMap
that aggregates all key-value pairs of the given maps. - merge(ValueMap...) - Static method in class org.apache.sling.api.wrappers.ValueMapUtil
-
A convenience method that turns the var-args into a
Collection
and delegates toValueMapUtil.merge(List)
. - mergeAndCache(List<ValueMap>) - Static method in class org.apache.sling.api.wrappers.ValueMapUtil
-
Convenience method that allows creating a merged
ValueMap
where accessed mappings are cached to optimize repeated lookups. - MergingValueMap - Class in org.apache.sling.api.wrappers.impl
-
Merge provided
ValueMaps
into a single viewValueMap
that aggregates all key-value pairs of the given maps. - MergingValueMap(List<ValueMap>) - Constructor for class org.apache.sling.api.wrappers.impl.MergingValueMap
-
Constructor that allows merging any number of
ValueMap
instances into a singleValueMap
view. - METHOD_CONNECT - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_DELETE - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_GET - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_HEAD - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_OPTIONS - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_POST - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_PUT - Static variable in class org.apache.sling.api.servlets.HttpConstants
- METHOD_TRACE - Static variable in class org.apache.sling.api.servlets.HttpConstants
- modifiable - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
Whether the resource provider supports modifications.
- ModifiableValueMap - Interface in org.apache.sling.api.resource
-
The
ModifiableValueMap
is an extension of theValueMap
which allows to modify and persist properties. - ModifiableValueMapDecorator - Class in org.apache.sling.api.wrappers
-
ModifiableValueMapDecorator
decorates anotherMap
to provide a basic implementation for the additional methods of aModifiableValueMap
. - ModifiableValueMapDecorator(Map<String, Object>) - Constructor for class org.apache.sling.api.wrappers.ModifiableValueMapDecorator
-
Creates a new wrapper around a given map.
- MODIFICATION_TIME - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
Returns the last modification time of this resource in the repository in milliseconds (value is "sling.modificationTime").
- ModifyingResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
- move(ResolveContext<T>, String, String) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
This method moves the subgraph rooted at, and including, the resource at
srcAbsPath
to the new location atdestAbsPath
and adds it as a child node of the resource atdestAbsPath
. - move(String, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
This method moves the subgraph rooted at, and including, the resource at
srcAbsPath
to the new location atdestAbsPath
and adds it as a child node of the resource atdestAbsPath
. - move(String, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps the
Resource
obtained by callingmove
on the wrapped resource resolver.
N
- name - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
The name of the resource provider.
- NAMESPACE_PREFIX - Static variable in class org.apache.sling.api.SlingConstants
-
The namespace prefix used throughout Sling (value is "sling").
- NAMESPACE_URI_ROOT - Static variable in class org.apache.sling.api.SlingConstants
-
The namespace URI prefix to be used by Sling projects to define namespaces (value is "http://sling.apache.org/").
- NEW_PASSWORD - Static variable in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Name of the authentication information property providing the new password of the user for which to create a resource resolver and change the password during login.
- next() - Method in class org.apache.sling.api.wrappers.IteratorWrapper
- no - org.apache.sling.api.resource.runtime.dto.AuthType
- NoAuthenticationHandlerException - Exception in org.apache.sling.api.auth
-
The
NoAuthenticationHandlerException
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. - NoAuthenticationHandlerException() - Constructor for exception org.apache.sling.api.auth.NoAuthenticationHandlerException
- NonExistingResource - Class in org.apache.sling.api.resource
-
Simple helper class representing nonexisting resources.
- NonExistingResource(ResourceResolver, String) - Constructor for class org.apache.sling.api.resource.NonExistingResource
-
Create a new non existing resource.
- normalize(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Resolves relative path segments '.' and '..' in the absolute path.
O
- ObjectConverter - Class in org.apache.sling.api.wrappers.impl
-
Converts objects to specific types.
- OBSERVATION_LISTENER_CHANGED - Static variable in interface org.apache.sling.spi.resource.provider.ProviderContext
-
This bit is set in
ResourceProvider.update(long)
if observation listeners changed. - ObservationReporter - Interface in org.apache.sling.spi.resource.provider
-
A
ResourceProvider
must use an observation reporter to report changes to resources. - ObserverConfiguration - Interface in org.apache.sling.spi.resource.provider
-
A observer configuration describes active configurations from registered listeners.
- onChange(List<ResourceChange>) - Method in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
Report resource changes based on the filter properties of this listener.
- onChange(String, String...) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Records a generic change of the given
type
. - onCopied(String, String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Records a 'copied' change.
- onCreated(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Records a 'created' change
- onDeleted(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Records a 'deleted' change
- onEvent(SlingRequestEvent) - Method in interface org.apache.sling.api.request.SlingRequestListener
-
This method is called from the Sling application for every
EventType
appearing during the dispatching of a Sling request - onModified(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Records a 'modified' change
- onMoved(String, String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Records a 'moved' change.
- OPT_ADD_SELECTORS - Static variable in class org.apache.sling.api.request.RequestDispatcherOptions
-
When dispatching, add the value provided by this option to the
RequestPathInfo
selectors. - OPT_FORCE_RESOURCE_TYPE - Static variable in class org.apache.sling.api.request.RequestDispatcherOptions
-
When dispatching, use the value provided by this option as the resource type, instead of the one defined by the
Resource
. - OPT_REPLACE_SELECTORS - Static variable in class org.apache.sling.api.request.RequestDispatcherOptions
-
When dispatching, replace
RequestPathInfo
selectors by the value provided by this option. - OPT_REPLACE_SUFFIX - Static variable in class org.apache.sling.api.request.RequestDispatcherOptions
-
When dispatching, replace the
RequestPathInfo
suffix by the value provided by this option - OptingServlet - Interface in org.apache.sling.api.servlets
-
The
OptingServlet
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. - org.apache.sling.api - package org.apache.sling.api
- org.apache.sling.api.adapter - package org.apache.sling.api.adapter
- org.apache.sling.api.auth - package org.apache.sling.api.auth
- org.apache.sling.api.request - package org.apache.sling.api.request
- org.apache.sling.api.request.header - package org.apache.sling.api.request.header
- org.apache.sling.api.resource - package org.apache.sling.api.resource
- org.apache.sling.api.resource.external - package org.apache.sling.api.resource.external
- org.apache.sling.api.resource.mapping - package org.apache.sling.api.resource.mapping
- org.apache.sling.api.resource.observation - package org.apache.sling.api.resource.observation
- org.apache.sling.api.resource.path - package org.apache.sling.api.resource.path
- org.apache.sling.api.resource.runtime - package org.apache.sling.api.resource.runtime
- org.apache.sling.api.resource.runtime.dto - package org.apache.sling.api.resource.runtime.dto
- org.apache.sling.api.scripting - package org.apache.sling.api.scripting
- org.apache.sling.api.security - package org.apache.sling.api.security
- org.apache.sling.api.servlets - package org.apache.sling.api.servlets
- org.apache.sling.api.uri - package org.apache.sling.api.uri
- org.apache.sling.api.wrappers - package org.apache.sling.api.wrappers
- org.apache.sling.api.wrappers.impl - package org.apache.sling.api.wrappers.impl
- org.apache.sling.spi.resource.provider - package org.apache.sling.spi.resource.provider
- OUT - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
java.io.PrintWriter
object to return the response content (value is "out"). - OWNS_ROOTS - Static variable in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.The name of the service registration property containing the a boolean flag whether this provider owns the tree registered by the roots.
P
- PARAM_ACCEPT - Static variable in class org.apache.sling.api.request.header.MediaRangeList
- PARAMETER_MAP - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
Returns a map containing parameters added to path after semicolon.
- ParametrizableResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
- parse(String, ResourceResolver) - Static method in class org.apache.sling.api.uri.SlingUriBuilder
-
Creates a builder from an arbitrary URI string.
- parserAcceptHeader(String) - Static method in class org.apache.sling.api.request.RequestUtil
-
Parses an
Accept-*
header of the form: - parserHeader(String) - Static method in class org.apache.sling.api.request.RequestUtil
-
Parses a header of the form:
- PASSWORD - Static variable in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Name of the authentication information property providing the password of the user for which to create a resource resolver.
- path - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
The path of the resource provider.
- Path - Class in org.apache.sling.api.resource.path
-
Simple helper class for path matching.
- Path(String) - Constructor for class org.apache.sling.api.resource.path.Path
-
Create a new path object either from a concrete path or from a glob pattern.
- PathBuilder - Class in org.apache.sling.api.resource.path
-
The
PathBuilder
offers a convenient way of creating a valid path from multiple fragments - PathBuilder(String) - Constructor for class org.apache.sling.api.resource.path.PathBuilder
-
Creates a new
PathBuilder
instance - PATHS - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
Array of paths or glob patterns - required.
- PathSet - Class in org.apache.sling.api.resource.path
-
Simple helper class for path matching against a set of paths.
- PersistableValueMap - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ModifiableValueMap
instead. - PersistenceException - Exception in org.apache.sling.api.resource
-
This exception will be thrown during the commit to persist changes to a
PersistableValueMap
, aModifiableValueMap
or theResourceResolver
. - PersistenceException() - Constructor for exception org.apache.sling.api.resource.PersistenceException
-
Create a new persistence exception.
- PersistenceException(String) - Constructor for exception org.apache.sling.api.resource.PersistenceException
-
Create a new persistence exception.
- PersistenceException(String, Throwable) - Constructor for exception org.apache.sling.api.resource.PersistenceException
-
Create a new persistence exception.
- PersistenceException(String, Throwable, String, String) - Constructor for exception org.apache.sling.api.resource.PersistenceException
-
Create a new persistence exception.
- PN_CHANGE_LOG - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.human readable changelog
- PN_ERROR - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.The Throwable caught while processing the request.
- PN_IS_CREATED - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Indicating whether request processing created new data.
- PN_LOCATION - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.externally mapped location url of the modified path
- PN_PARENT_LOCATION - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.externally mapped location url of the parent of the modified path
- PN_PATH - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.the path of the modified item.
- PN_REFERER - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.the referrer of the request
- PN_STATUS_CODE - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.status code.
- PN_STATUS_MESSAGE - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.some human readable status message
- PN_TITLE - Static variable in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.some human readable title like: 200 Created /foo/bar
- prefer(String...) - Method in class org.apache.sling.api.request.header.MediaRangeList
-
Determines which of the
mediaRanges
specifications is preferred by thisMediaRangeList
. - prefer(Set<MediaRangeList.MediaRange>) - Method in class org.apache.sling.api.request.header.MediaRangeList
-
Given a list of media types, returns the one is preferred by this
MediaRangeList
. - PROPERTY_ADAPTABLE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
If this flag is set to
true
, the resource resolver will use this provider for the adaptTo() operation. - PROPERTY_ADAPTABLE_CLASSES - Static variable in class org.apache.sling.api.SlingConstants
-
The event property listing the fully qualified names of classes which can be adapted by this adapter factory (value is "adaptables").
- PROPERTY_ADAPTER_CLASSES - Static variable in class org.apache.sling.api.SlingConstants
-
The event property listing the fully qualified names of classes to which this factory can adapt adaptables (value is "adapters").
- PROPERTY_ADDED_ATTRIBUTES - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the added attribute names of a resource for an
SlingConstants.TOPIC_RESOURCE_CHANGED
event. - PROPERTY_ATTRIBUTABLE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
If this flag is set to
true
, the resource resolver will try to get the attribute names and the attribute values from this provider. - PROPERTY_AUTHENTICATE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
If a resource provider needs the user to be authenticated this property must be set to either
ResourceProvider.AUTHENTICATE_LAZY
orResourceProvider.AUTHENTICATE_REQUIRED
. - PROPERTY_CHANGED_ATTRIBUTES - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the changed attribute names of a resource for an
SlingConstants.TOPIC_RESOURCE_CHANGED
event. - PROPERTY_MODIFIABLE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
A modifiable resource provider is capable of creating, changing and deleting resources.
- PROPERTY_NAME - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Optional service registration property setting a name for the provider.
- PROPERTY_NAMES_HINT - Static variable in interface org.apache.sling.api.resource.observation.ResourceChangeListener
-
An optional hint indicating to the underlying implementation that for changes regarding properties (added/removed/changed) the listener is only interested in those property names listed inhere.
- PROPERTY_PATH - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the resource path.
- PROPERTY_REFRESHABLE - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
If this flag is set to
true
, the resource resolver will callResourceProvider.refresh(ResolveContext)
when it's refreshed itself. - PROPERTY_REMOVED_ATTRIBUTES - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the removed attribute names of a resource for an
SlingConstants.TOPIC_RESOURCE_CHANGED
event. - PROPERTY_REQUIRED - Static variable in interface org.apache.sling.api.resource.ResourceProviderFactory
-
Deprecated.A required resource provider factory is accessed directly when a new resource resolver is created.
- PROPERTY_RESOURCE_SUPER_TYPE - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the resource super type.
- PROPERTY_RESOURCE_TYPE - Static variable in interface org.apache.sling.api.resource.ResourceResolver
-
This is the suggested property to be used for setting the resource type of a resource during either creation (
ResourceResolver.create(Resource, String, Map)
) or modifying (ModifiableValueMap
). - PROPERTY_RESOURCE_TYPE - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the resource type.
- PROPERTY_ROOT - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The name of the service registration property containing the root path of the resources provided by this provider.
- PROPERTY_SCRIPT_ENGINE_FACTORY_EXTENSIONS - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The event property listing the script engine factory extensions.
- PROPERTY_SCRIPT_ENGINE_FACTORY_LANGUAGE_NAME - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The event property listing the script engine factory language.
- PROPERTY_SCRIPT_ENGINE_FACTORY_LANGUAGE_VERSION - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The event property listing the script engine factory language version.
- PROPERTY_SCRIPT_ENGINE_FACTORY_MIME_TYPES - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The event property listing the script engine factory mime types.
- PROPERTY_SCRIPT_ENGINE_FACTORY_NAME - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The event property listing the script engine factory name.
- PROPERTY_SCRIPT_ENGINE_FACTORY_VERSION - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The event property listing the script engine factory name.
- PROPERTY_USE_RESOURCE_ACCESS_SECURITY - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The name of the service registration property containing a boolean flag indicating if the ResourceAccessSecurity service should be used for this provider or not.
- PROPERTY_USERID - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the userid.
- PROVIDER_ADDED - org.apache.sling.api.resource.observation.ResourceChange.ChangeType
- PROVIDER_CONTEXT - Static variable in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Allowed value for the
ResourceAccessSecurity.CONTEXT
service registration property. - PROVIDER_REMOVED - org.apache.sling.api.resource.observation.ResourceChange.ChangeType
- ProviderContext - Interface in org.apache.sling.spi.resource.provider
-
The provider context...
- providers - Variable in class org.apache.sling.api.resource.runtime.dto.RuntimeDTO
-
DTOs for all active providers.
- PUBLIC - org.apache.sling.api.resource.external.URIProvider.Scope
-
A URI that may be published to many client in public context.
- put(String, Object) - Method in class org.apache.sling.api.resource.ResourceMetadata
- put(String, Object) - Method in class org.apache.sling.api.scripting.LazyBindings
- put(String, Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- put(String, Object) - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- put(String, Object) - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- put(String, Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- putAll(Map<? extends String, ? extends Object>) - Method in class org.apache.sling.api.resource.ResourceMetadata
- putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.scripting.LazyBindings
- putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
Q
- QueriableResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
- QueryLanguageProvider<T> - Interface in org.apache.sling.spi.resource.provider
-
The JCR query provider supports querying based on the JCR spec.
- queryResources(String, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Queries the storage using the given query formulated in the given language.
- queryResources(String, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- queryResources(ResolveContext<T>, String, String) - Method in interface org.apache.sling.spi.resource.provider.QueryLanguageProvider
-
Queries the storage using the given query formulated in the given language.
- queryResources(ResourceResolver, String, String) - Method in interface org.apache.sling.api.resource.QueriableResourceProvider
-
Deprecated.Queries the storage using the given query formulated in the given language.
- QuerySyntaxException - Exception in org.apache.sling.api.resource
-
The
QuerySyntaxException
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. - QuerySyntaxException(String, String, String) - Constructor for exception org.apache.sling.api.resource.QuerySyntaxException
- QuerySyntaxException(String, String, String, Throwable) - Constructor for exception org.apache.sling.api.resource.QuerySyntaxException
R
- READ - org.apache.sling.api.resource.external.URIProvider.Operation
-
The URI may be used to read the resource.
- READER - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
Reader
object (value is "reader"). - reason - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderFailureDTO
-
The reason for the failure.
- rebaseResourcePath() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Will rebase the uri based on the underlying resource structure.
- RecursionTooDeepException - Exception in org.apache.sling.api.request
-
The
RecursionTooDeepException
is thrown by the Sling implementation if to many recursive content inclusions take place. - RecursionTooDeepException(String) - Constructor for exception org.apache.sling.api.request.RecursionTooDeepException
-
Creates a new instance of this class reporting the exception occurred while trying to include the output for rendering the resource at the given path.
- refresh() - Method in interface org.apache.sling.api.resource.RefreshableResourceProvider
-
Deprecated.The provider is updated to reflect the latest state.
- refresh() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
The resolver is updated to reflect the latest state.
- refresh() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- refresh(ResolveContext<T>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The provider is updated to reflect the latest state.
- refreshable - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
Whether the resource provider supports refreshing.
- RefreshableResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
- remove() - Method in class org.apache.sling.api.wrappers.IteratorWrapper
- remove(Object) - Method in class org.apache.sling.api.resource.ResourceMetadata
- remove(Object) - Method in class org.apache.sling.api.scripting.LazyBindings
- remove(Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- remove(Object) - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- remove(Object) - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- remove(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- REMOVED - org.apache.sling.api.resource.observation.ResourceChange.ChangeType
- removeSchemeAndAuthority() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Will remove scheme and authority (that is user info, host and port).
- reportChanges(Iterable<ResourceChange>, boolean) - Method in interface org.apache.sling.spi.resource.provider.ObservationReporter
-
A resource provider can inform about a list of changes.
- reportChanges(ObserverConfiguration, Iterable<ResourceChange>, boolean) - Method in interface org.apache.sling.spi.resource.provider.ObservationReporter
-
A resource provider can inform about a list of changes.
- REQUEST - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
SlingHttpServletRequest
object (value is "request"). - REQUEST_ATTR_WORKSPACE_INFO - Static variable in interface org.apache.sling.api.resource.ResourceResolver
-
Deprecated.
- RequestDispatcherOptions - Class in org.apache.sling.api.request
-
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. - RequestDispatcherOptions() - Constructor for class org.apache.sling.api.request.RequestDispatcherOptions
-
Creates an instance with no options set.
- RequestDispatcherOptions(String) - Constructor for class org.apache.sling.api.request.RequestDispatcherOptions
-
Creates a new instances setting options by parsing the given
options
string as follows: If the string is empty ornull
no options are set. If the string neither contains a comma nor an equals sign, the string is assumed to be a resource type. - RequestParameter - Interface in org.apache.sling.api.request
-
The
RequestParameter
class represents a single parameter sent with the client request. - RequestParameterMap - Interface in org.apache.sling.api.request
-
The
RequestParameterMap
encapsulates all request parameters of a request. - RequestPathInfo - Interface in org.apache.sling.api.request
-
Sling breaks the request URI into four parts: the path itself, optional dot-separated selectors and extension that follow it, and an optional path suffix.
- RequestProgressTracker - Interface in org.apache.sling.api.request
-
The
RequestProgressTracker
class provides the functionality to track the progress of request processing. - RequestUtil - Class in org.apache.sling.api.request
-
Request related utility methods.
- RequestUtil() - Constructor for class org.apache.sling.api.request.RequestUtil
- required - org.apache.sling.api.resource.runtime.dto.AuthType
- reset() - Method in interface org.apache.sling.api.resource.PersistableValueMap
-
Deprecated.Reset the changes.
- RESOLUTION_PATH - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
The name of the required property providing the part of the request URI which was used to the resolve the resource to which the meta data instance belongs (value is "sling.resolutionPath").
- RESOLUTION_PATH_INFO - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
The name of the required property providing the part of the request URI which was not used to the resolve the resource to which the meta data instance belongs (value is "sling.resolutionPathInfo").
- resolve(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Resolves the resource from the given absolute path.
- resolve(String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Resource
obtained by callingresolve
on the wrapped resource resolver. - resolve(HttpServletRequest) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Deprecated.as of 2.0.4, use
ResourceResolver.resolve(HttpServletRequest, String)
instead. - resolve(HttpServletRequest) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Resource
obtained by callingresolve
on the wrapped resource resolver. - resolve(HttpServletRequest, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Resolves the resource from the given
absPath
optionally takingHttpServletRequest
into account, such as the value of theHost
request header. - resolve(HttpServletRequest, String) - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Wraps and returns the
Resource
obtained by callingresolve
on the wrapped resource resolver. - ResolveContext<T> - Interface in org.apache.sling.spi.resource.provider
-
The resolve context is passed to most of the methods of the
ResourceProvider
to provide additional context information for the provider. - RESOLVER - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
ResourceResolver
object (value is "resolver"). - resolveServlet(Resource, String) - Method in interface org.apache.sling.api.servlets.ServletResolver
-
Resolves a
javax.servlet.Servlet
whoseservice
method may be used to handle a request. - resolveServlet(ResourceResolver, String) - Method in interface org.apache.sling.api.servlets.ServletResolver
-
Resolves a
javax.servlet.Servlet
whoseservice
method may be used to handle a request. - resolveServlet(SlingHttpServletRequest) - Method in interface org.apache.sling.api.servlets.ServletResolver
-
Resolves a
javax.servlet.Servlet
whoseservice
method may be used to handle the givenrequest
. - Resource - Interface in org.apache.sling.api.resource
-
Resources are pieces of content on which Sling acts
- RESOURCE - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
Resource
object (value is "resource"). - RESOURCE_TYPE_NON_EXISTING - Static variable in interface org.apache.sling.api.resource.Resource
-
The special resource type for resource instances representing nonexisting resources (value is "sling:nonexisting").
- RESOURCE_TYPE_SYNTHETIC - Static variable in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.The resource type be set on resources returned by the
ResourceProvider.listChildren(Resource)
method to enable traversing the resource tree down to a deeply nested provided resource which has no concrete parent hierarchy (value is"sling:syntheticResourceProviderResource"). - RESOURCE_TYPE_SYNTHETIC - Static variable in class org.apache.sling.spi.resource.provider.ResourceProvider
-
The resource type be set on resources returned by the
ResourceProvider.listChildren(ResolveContext, Resource)
method to enable traversing the resource tree down to a deeply nested provided resource which has no concrete parent hierarchy (value is"sling:syntheticResourceProviderResource"). - ResourceAccessSecurity - Interface in org.apache.sling.api.security
-
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. - ResourceChange - Class in org.apache.sling.api.resource.observation
-
A resource change event is immutable.
- ResourceChange(ResourceChange.ChangeType, String, boolean) - Constructor for class org.apache.sling.api.resource.observation.ResourceChange
-
Create a new change object
- ResourceChange(ResourceChange.ChangeType, String, boolean, Set<String>, Set<String>, Set<String>) - Constructor for class org.apache.sling.api.resource.observation.ResourceChange
-
Deprecated.The sets of property names are not supported anymore.
- ResourceChange.ChangeType - Enum in org.apache.sling.api.resource.observation
-
The type of the change
- ResourceChangeList - Interface in org.apache.sling.api.resource.observation
-
An instance of
ResourceChangeList
is passed toResourceChangeListener.onChange(List)
to pass in additional information like the search path. - ResourceChangeListener - Interface in org.apache.sling.api.resource.observation
-
Listener for resource change events.
- ResourceContext - Interface in org.apache.sling.spi.resource.provider
-
The resource context provides additional information for resource resolving.
- ResourceDecorator - Interface in org.apache.sling.api.resource
-
Optional service to decorate
Resource
s returned by theResourceResolver
. - ResourceMapper - Interface in org.apache.sling.api.resource.mapping
-
Allows access to resource mappings
- ResourceMetadata - Class in org.apache.sling.api.resource
-
The
ResourceMetadata
interface defines the API for the metadata of a SlingResource
. - ResourceMetadata() - Constructor for class org.apache.sling.api.resource.ResourceMetadata
- ResourceNotFoundException - Exception in org.apache.sling.api.resource
-
An Exception that causes Sling to return a 404 (NOT FOUND) status code.
- ResourceNotFoundException(String) - Constructor for exception org.apache.sling.api.resource.ResourceNotFoundException
- ResourceNotFoundException(String, String) - Constructor for exception org.apache.sling.api.resource.ResourceNotFoundException
- ResourceNotFoundException(String, String, Throwable) - Constructor for exception org.apache.sling.api.resource.ResourceNotFoundException
- ResourceNotFoundException(String, Throwable) - Constructor for exception org.apache.sling.api.resource.ResourceNotFoundException
- ResourceProvider<T> - Class in org.apache.sling.spi.resource.provider
-
API for providers of resources.
- ResourceProvider - Interface in org.apache.sling.api.resource
-
Deprecated.Use the
ResourceProvider
- ResourceProvider() - Constructor for class org.apache.sling.spi.resource.provider.ResourceProvider
- ResourceProviderDTO - Class in org.apache.sling.api.resource.runtime.dto
-
Represents a
org.apache.sling.spi.resource.provider.ResourceProvider
. - ResourceProviderDTO() - Constructor for class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
- ResourceProviderFactory - Interface in org.apache.sling.api.resource
-
Deprecated.
- ResourceProviderFailureDTO - Class in org.apache.sling.api.resource.runtime.dto
-
Represents a failed
org.apache.sling.spi.resource.provider.ResourceProvider
. - ResourceProviderFailureDTO() - Constructor for class org.apache.sling.api.resource.runtime.dto.ResourceProviderFailureDTO
- ResourceResolver - Interface in org.apache.sling.api.resource
-
The
ResourceResolver
defines the API which may be used to resolveResource
objects and work with such resources like creating, editing or updating them. - ResourceResolverFactory - Interface in org.apache.sling.api.resource
-
The
ResourceResolverFactory
defines the service API to get and createResourceResolver
s. - ResourceResolverWrapper - Class in org.apache.sling.api.wrappers
-
The
ResourceResolverWrapper
is a wrapper for anyResourceResolver
, delegating all method calls to the wrapped resource resolver by default. - ResourceResolverWrapper(ResourceResolver) - Constructor for class org.apache.sling.api.wrappers.ResourceResolverWrapper
-
Creates a new wrapper instance, delegating all calls to the given
resolver
. - resourceTypeToPath(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Helper method, which returns the given resource type as returned from the
Resource.getResourceType()
as a relative path. - ResourceUtil - Class in org.apache.sling.api.resource
-
The
ResourceUtil
class provides helper methods dealing with resources. - ResourceUtil() - Constructor for class org.apache.sling.api.resource.ResourceUtil
- ResourceUtil.BatchResourceRemover - Class in org.apache.sling.api.resource
-
A batch resource remover deletes resources in batches.
- ResourceWrapper - Class in org.apache.sling.api.resource
-
The
ResourceWrapper
is a wrapper for anyResource
delegating all method calls to the wrapped resource by default. - ResourceWrapper(Resource) - Constructor for class org.apache.sling.api.resource.ResourceWrapper
-
Creates a new wrapper instance delegating all method calls to the given
resource
. - RESPONSE - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
SlingHttpServletResponse
object (value is "response"). - ResponseUtil - Class in org.apache.sling.api.request
-
Response related utility methods
- ResponseUtil() - Constructor for class org.apache.sling.api.request.ResponseUtil
- revert() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Revert all pending changes.
- revert() - Method in class org.apache.sling.api.wrappers.ResourceResolverWrapper
- revert(ResolveContext<T>) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
Revert all transient changes: create, delete and updates.
- revert(ResourceResolver) - Method in interface org.apache.sling.api.resource.ModifyingResourceProvider
-
Deprecated.Revert all transient changes: create, delete and updates.
- ROOTS - Static variable in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.The name of the service registration property containing the root paths of the resources provided by this provider (value is "provider.roots").
- RuntimeDTO - Class in org.apache.sling.api.resource.runtime.dto
-
Represents the resource resolver runtime
- RuntimeDTO() - Constructor for class org.apache.sling.api.resource.runtime.dto.RuntimeDTO
- RuntimeService - Interface in org.apache.sling.api.resource.runtime
-
Runtime service providing introspection of the state of the resource resolver and the resource providers.
S
- safePut(String, Object) - Method in class org.apache.sling.api.scripting.SlingBindings
-
Helper method which invokes
HashMap.put(Object, Object)
only if the value is not null. - save() - Method in interface org.apache.sling.api.resource.PersistableValueMap
-
Deprecated.Persists the changes.
- ScriptEvaluationException - Exception in org.apache.sling.api.scripting
-
The
ScriptEvaluationException
is thrown by theSlingScript.eval(SlingBindings)
method if an error occurrs evaluating the script. - ScriptEvaluationException(String, String) - Constructor for exception org.apache.sling.api.scripting.ScriptEvaluationException
- ScriptEvaluationException(String, String, Throwable) - Constructor for exception org.apache.sling.api.scripting.ScriptEvaluationException
- send(HttpServletResponse, boolean) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Writes the response to the given writer and replaces all ${var} patterns by the value of the respective property.
- service(ServletRequest, ServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Forwards the request to the
SlingSafeMethodsServlet.service(SlingHttpServletRequest, SlingHttpServletResponse)
method if the request is a HTTP request. - service(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
Called by the
SlingSafeMethodsServlet.service(ServletRequest, ServletResponse)
method to handle the HTTP request. - SERVICE_BUNDLE - Static variable in interface org.apache.sling.api.resource.ResourceProviderFactory
-
Deprecated.The authentication information property referring to the bundle providing a service for which a resource provider is to be retrieved.
- SERVICE_NAME - Static variable in interface org.apache.sling.api.adapter.AdapterFactory
-
The service name to use when registering implementations of this interface as services.
- SERVICE_NAME - Static variable in interface org.apache.sling.api.adapter.AdapterManager
-
The name under which this service is registered with the OSGi service registry.
- SERVICE_NAME - Static variable in interface org.apache.sling.api.auth.Authenticator
-
The name under which this service is registered.
- SERVICE_NAME - Static variable in interface org.apache.sling.api.request.SlingRequestListener
- SERVICE_NAME - Static variable in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.The service name to use when registering implementations of this interface as services (value is "org.apache.sling.api.resource.ResourceProvider").
- service_not_gettable - org.apache.sling.api.resource.runtime.dto.FailureReason
- serviceId - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
The service id from the service registry.
- ServletResolver - Interface in org.apache.sling.api.servlets
-
The
ServletResolver
defines the API for a service capable of resolvingjavax.servlet.Servlet
instances to handle the processing of a request or resource. - ServletResolverConstants - Class in org.apache.sling.api.servlets
-
Service registration properties and common values used for registering a Sling Servlet.
- ServletResolverConstants() - Constructor for class org.apache.sling.api.servlets.ServletResolverConstants
- setAdapterManager(AdapterManager) - Static method in class org.apache.sling.api.adapter.SlingAdaptable
-
Sets the global
AdapterManager
to be used by this class. - setAddSelectors(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Sets the
RequestDispatcherOptions.OPT_ADD_SELECTORS
option to the givenadditionalSelectors
if notnull
. - setCharacterEncoding(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
- setContentLength(long) - Method in class org.apache.sling.api.resource.ResourceMetadata
- setContentType(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
- setCreateRequest(boolean) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Sets whether the request was a create request or not.
- setCreationTime(long) - Method in class org.apache.sling.api.resource.ResourceMetadata
-
Sets the
ResourceMetadata.CREATION_TIME
property tocreationTime
if not negative. - setError(Throwable) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Set the error
- setExtension(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the extension of the URI.
- setFlush(boolean) - Method in class org.apache.sling.api.scripting.SlingBindings
-
Sets the
SlingBindings.FLUSH
property toflush
. - setForceResourceType(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Sets the
RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE
option to the givenresourceType
if notnull
. - setFragment(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the fragment of the URI.
- setHost(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the host of the URI.
- setLocation(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Set the location
- setLog(Logger) - Method in class org.apache.sling.api.scripting.SlingBindings
- setModificationTime(long) - Method in class org.apache.sling.api.resource.ResourceMetadata
-
Sets the
ResourceMetadata.MODIFICATION_TIME
property tomodificationTime
if not negative. - setOut(PrintWriter) - Method in class org.apache.sling.api.scripting.SlingBindings
- setParameterMap(Map<String, String>) - Method in class org.apache.sling.api.resource.ResourceMetadata
- setParentLocation(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Set the parent location
- setPath(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the path of the URI that contains a resource path and optionally path parameters, selectors, an extension and a suffix.
- setPath(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Sets the absolute path of the item upon which the request operated.
- setPathParameter(String, String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set a path parameter to the URI.
- setPathParameters(Map<String, String>) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Replaces all path parameters in the URI.
- setPort(int) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the port of the URI.
- setProperty(String, Object) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Sets a generic response property with the given
- setQuery(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the query of the URI.
- setQueryParameters(Map<String, String>) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Replace all query parameters of the URL.
- setReader(Reader) - Method in class org.apache.sling.api.scripting.SlingBindings
- setReferer(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Sets the referer property
- setReplaceSelectors(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
Sets the
RequestDispatcherOptions.OPT_REPLACE_SELECTORS
option to the givenreplaceSelectors
if notnull
. - setReplaceSuffix(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
- setRequest(SlingHttpServletRequest) - Method in class org.apache.sling.api.scripting.SlingBindings
- setRequestAttribute(HttpServletRequest, String, Object) - Static method in class org.apache.sling.api.request.RequestUtil
-
Sets the named request attribute to the new value and returns the previous value.
- setResolutionPath(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
- setResolutionPathInfo(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
- setResource(Resource) - Method in class org.apache.sling.api.scripting.SlingBindings
- setResourcePath(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the resource path of the URI.
- setResourceResolver(ResourceResolver) - Method in class org.apache.sling.api.scripting.SlingBindings
- setResourceResolver(ResourceResolver) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Sets the resource resolver (required for
RequestPathInfo.getSuffixResource()
). - setResponse(SlingHttpServletResponse) - Method in class org.apache.sling.api.scripting.SlingBindings
- setScheme(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the scheme of the URI.
- setSchemeSpecificPart(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the scheme specific part of the URI.
- setSelectors(String[]) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the selectors of the URI.
- setSling(SlingScriptHelper) - Method in class org.apache.sling.api.scripting.SlingBindings
- setStatus(int, String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.sets the response status code properties
- setSuffix(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the suffix of the URI.
- setTitle(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.Sets the title of the response message
- setUserInfo(String) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Set the user info of the URI.
- shadowed - org.apache.sling.api.resource.runtime.dto.FailureReason
- size() - Method in class org.apache.sling.api.scripting.LazyBindings
- size() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- size() - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- size() - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- size() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- SLING - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
The name of the global scripting variable providing the
SlingScriptHelper
for the request (value is "sling"). - SLING_CURRENT_SERVLET_NAME - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the request attribute providing the name of the currently executing servlet (value is "sling.core.current.servletName").
- SLING_SCOPE - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The name of the script scope holding the
SlingScriptConstants.ATTR_SCRIPT_RESOURCE_RESOLVER
. - SLING_SERVLET_EXTENSIONS - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a servlet registered as a service containing the request URL extensions supported by the servlet for GET requests (value is "sling.servlet.extensions").
- SLING_SERVLET_METHODS - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a servlet registered as a service containing the request methods supported by the servlet (value is "sling.servlet.methods").
- SLING_SERVLET_NAME - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a Servlet registered as a service containing the name of the servlet (value is "sling.core.servletName").
- SLING_SERVLET_PATHS - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a servlet registered as a service providing the absolute paths under which the servlet is accessible as a resource (value is "sling.servlet.paths").
- SLING_SERVLET_PREFIX - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a servlet registered as a service providing the prefix/index to be used to register this servlet.
- SLING_SERVLET_RESOURCE_SUPER_TYPE - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a servlet registered as a service containing the resource super type supported by the servlet (value is "sling.servlet.resourceSuperType").
- SLING_SERVLET_RESOURCE_TYPES - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a servlet registered as a service containing the resource type(s) supported by the servlet (value is "sling.servlet.resourceTypes").
- SLING_SERVLET_SELECTORS - Static variable in class org.apache.sling.api.servlets.ServletResolverConstants
-
The name of the service registration property of a Servlet registered as a service containing the request URL selectors supported by the servlet (value is "sling.servlet.selectors").
- SlingAdaptable - Class in org.apache.sling.api.adapter
-
The
SlingAdaptable
class is an (abstract) default implementation of theAdaptable
interface. - SlingAdaptable() - Constructor for class org.apache.sling.api.adapter.SlingAdaptable
- SlingAllMethodsServlet - Class in org.apache.sling.api.servlets
-
Helper base class for data modifying Servlets used in Sling.
- SlingAllMethodsServlet() - Constructor for class org.apache.sling.api.servlets.SlingAllMethodsServlet
- SlingBindings - Class in org.apache.sling.api.scripting
-
The
SlingBindings
class is used to prepare global variables for script execution. - SlingBindings() - Constructor for class org.apache.sling.api.scripting.SlingBindings
- SlingConstants - Class in org.apache.sling.api
-
The
SlingConstants
interface provides some symbolic constants for well known constant strings in Sling. - SlingConstants() - Constructor for class org.apache.sling.api.SlingConstants
- SlingException - Exception in org.apache.sling.api
-
The
SlingException
is the base exception used throughout the Sling API. - SlingException() - Constructor for exception org.apache.sling.api.SlingException
-
Constructs a new Sling exception.
- SlingException(String) - Constructor for exception org.apache.sling.api.SlingException
-
Constructs a new Sling exception with the given text.
- SlingException(String, Throwable) - Constructor for exception org.apache.sling.api.SlingException
-
Constructs a new Sling exception when the Servlet needs to do the following: throw an exception include the "root cause" exception include a description message
- SlingException(Throwable) - Constructor for exception org.apache.sling.api.SlingException
-
Constructs a new Sling exception when the Servlet needs to throw an exception.
- SlingHttpServletRequest - Interface in org.apache.sling.api
-
The
SlingHttpServletRequest
defines the interface to provide client request information to a servlet. - SlingHttpServletRequestWrapper - Class in org.apache.sling.api.wrappers
-
The
SlingHttpServletRequestWrapper
class is a default wrapper class around aSlingHttpServletRequest
which may be extended to amend the functionality of the original request object. - SlingHttpServletRequestWrapper(SlingHttpServletRequest) - Constructor for class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
Create a wrapper for the supplied wrappedRequest
- SlingHttpServletResponse - Interface in org.apache.sling.api
-
The
SlingHttpServletResponse
defines the interface to assist a servlet in creating and sending a response to the client. - SlingHttpServletResponseWrapper - Class in org.apache.sling.api.wrappers
-
The
SlingHttpServletResponseWrapper
class is a default wrapper class around aSlingHttpServletResponse
which may be extended to amend the functionality of the original response object. - SlingHttpServletResponseWrapper(SlingHttpServletResponse) - Constructor for class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper
-
Create a wrapper for the supplied wrappedRequest
- SlingIOException - Exception in org.apache.sling.api
-
The
SlingIOException
is a runtime exception wrapper for the JavaIOException
. - SlingIOException(IOException) - Constructor for exception org.apache.sling.api.SlingIOException
- SlingRequestEvent - Class in org.apache.sling.api.request
-
represents an event published by the Sling engine while dispatching a request.
- SlingRequestEvent(ServletContext, ServletRequest, SlingRequestEvent.EventType) - Constructor for class org.apache.sling.api.request.SlingRequestEvent
- SlingRequestEvent.EventType - Enum in org.apache.sling.api.request
-
type of the event
- SlingRequestListener - Interface in org.apache.sling.api.request
-
Implementations of this service interface receive notifications about changes to Sling request of the Sling application they are part of.
- SlingRequestPaths - Class in org.apache.sling.api.wrappers
-
This class is not a "wrapper" per se, but computes the correct path info, request URI, etc.
- SlingRequestPaths() - Constructor for class org.apache.sling.api.wrappers.SlingRequestPaths
- SlingSafeMethodsServlet - Class in org.apache.sling.api.servlets
-
Helper base class for read-only Servlets used in Sling.
- SlingSafeMethodsServlet() - Constructor for class org.apache.sling.api.servlets.SlingSafeMethodsServlet
- SlingScript - Interface in org.apache.sling.api.scripting
-
The
SlingScript
defines the API for objects which encapsulate a script. - SlingScriptConstants - Class in org.apache.sling.api.scripting
-
Some constants for the scripting.
- SlingScriptConstants() - Constructor for class org.apache.sling.api.scripting.SlingScriptConstants
- SlingScriptHelper - Interface in org.apache.sling.api.scripting
-
The
SlingScriptHelper
interface defines the API of a helper class which is provided to the scripts called from sling through the global
variable.sling
- SlingScriptResolver - Interface in org.apache.sling.api.scripting
-
Deprecated.The SlingScriptResolver interface is intended to be implemented and also used by project specific code. To keep the API as clean as possible this interface was deprecated
- SlingServletException - Exception in org.apache.sling.api
-
The
SlingServletException
is a runtime exception wrapper for the Servlet APIServletException
. - SlingServletException(ServletException) - Constructor for exception org.apache.sling.api.SlingServletException
- SlingUri - Interface in org.apache.sling.api.uri
-
Represents an immutable URI in the same way as java.net.URI but is extended with Sling-specific URI parts (e.g.
- SlingUriBuilder - Class in org.apache.sling.api.uri
-
Builder for SlingUris that allows to set any properties of a
SlingUri
. - start(ProviderContext) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
With a call to this method, the provider implementation is notified that it is used in the resource tree.
- startTimer(String) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Starts a named timer.
- stop() - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
With a call to this method, the provider implementation is notified that it is not used anymore in the resource tree.
- SUBSERVICE - Static variable in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Name of the authentication information property providing the Subservice Name for the service requesting a resource resolver.
- supportsQueryLanguage - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
Whether the resource provider supports query languages.
- SyntheticResource - Class in org.apache.sling.api.resource
-
The
SyntheticResource
class is a simple implementation of theResource
interface which may be used to provide a resource object which has no actual resource data. - SyntheticResource(ResourceResolver, String, String) - Constructor for class org.apache.sling.api.resource.SyntheticResource
-
Creates a synthetic resource with the given
path
andresourceType
. - SyntheticResource(ResourceResolver, ResourceMetadata, String) - Constructor for class org.apache.sling.api.resource.SyntheticResource
-
Creates a synthetic resource with the given
ResourceMetadata
andresourceType
.
T
- TooManyCallsException - Exception in org.apache.sling.api.request
-
The
TooManyCallsException
is thrown by the Sling implementation if to many inclusions have been called for during a single request. - TooManyCallsException(String) - Constructor for exception org.apache.sling.api.request.TooManyCallsException
-
Creates an instance of this exception naming the Servlet (or Script) whose call caused this exception to be thrown.
- TOPIC_ADAPTER_FACTORY_ADDED - Static variable in class org.apache.sling.api.SlingConstants
-
The topic for the OSGi event which is sent when an adapter factory has been added.
- TOPIC_ADAPTER_FACTORY_REMOVED - Static variable in class org.apache.sling.api.SlingConstants
-
The topic for the OSGi event which is sent when an adapter factory has been removed.
- TOPIC_RESOURCE_ADDED - Static variable in class org.apache.sling.api.SlingConstants
-
Deprecated.Register a
ResourceChangeListener
instead - TOPIC_RESOURCE_CHANGED - Static variable in class org.apache.sling.api.SlingConstants
-
Deprecated.Register a
ResourceChangeListener
instead - TOPIC_RESOURCE_PROVIDER_ADDED - Static variable in class org.apache.sling.api.SlingConstants
-
The topic for the OSGi event which is sent when a resource provider has been added to the resource tree.
- TOPIC_RESOURCE_PROVIDER_REMOVED - Static variable in class org.apache.sling.api.SlingConstants
-
The topic for the OSGi event which is sent when a resource provider has been removed from the resource tree.
- TOPIC_RESOURCE_REMOVED - Static variable in class org.apache.sling.api.SlingConstants
-
Deprecated.Register a
ResourceChangeListener
instead - TOPIC_RESOURCE_RESOLVER_MAPPING_CHANGED - Static variable in class org.apache.sling.api.SlingConstants
-
The topic for the OSGi event which is sent when the resource mapping changes.
- TOPIC_SCRIPT_ENGINE_FACTORY_ADDED - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The topic for the OSGi event which is sent when a script engine factory has been added.
- TOPIC_SCRIPT_ENGINE_FACTORY_REMOVED - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The topic for the OSGi event which is sent when a script engine factory has been removed.
- TOPIC_SCRIPT_ENGINE_FACTORY_UPDATED - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
-
The topic for the OSGi event which is sent when a script engine factory has been updated.
- toString() - Method in class org.apache.sling.api.request.header.MediaRangeList.MediaRange
- toString() - Method in class org.apache.sling.api.resource.NonExistingResource
- toString() - Method in class org.apache.sling.api.resource.observation.ResourceChange
- toString() - Method in class org.apache.sling.api.resource.path.Path
- toString() - Method in class org.apache.sling.api.resource.path.PathBuilder
-
Returns the path
- toString() - Method in class org.apache.sling.api.resource.path.PathSet
- toString() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
Returns a string representation of this wrapper consisting of the class' simple name, the
resource type
andpath
as well as the string representation of thewrapped resource
. - toString() - Method in class org.apache.sling.api.resource.SyntheticResource
- toString() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the URI as String.
- toString() - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Builds the corresponding string URI for this builder.
- toString() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- toStringSet() - Method in class org.apache.sling.api.resource.path.PathSet
-
Create a unmodifiable set of strings
- toUri() - Method in interface org.apache.sling.api.uri.SlingUri
-
Returns the
URI
. - toURI(Resource, URIProvider.Scope, URIProvider.Operation) - Method in interface org.apache.sling.api.resource.external.URIProvider
-
Return a URI appicable to the defined scope.
- transformQuery(String, String, ResourceResolver) - Method in interface org.apache.sling.api.security.ResourceAccessSecurity
-
Optionally transform a query based on the current user's credentials.
- traverseChildren(Iterator<Resource>) - Method in class org.apache.sling.api.resource.AbstractResourceVisitor
-
Visit the given resources.
U
- unsetAdapterManager(AdapterManager) - Static method in class org.apache.sling.api.adapter.SlingAdaptable
-
Unsets the global
AdapterManager
. - unwrap(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Unwrap the resource and return the wrapped implementation.
- update(long) - Method in class org.apache.sling.spi.resource.provider.ResourceProvider
-
With a call to this method, the provider implementation is notified that any information regarding the registration of the provider has changed.
- UPDATE - org.apache.sling.api.resource.external.URIProvider.Operation
-
The URI may be used to update the resource.
- URIProvider - Interface in org.apache.sling.api.resource.external
-
Provides a URI in exchange for a Resource.
- URIProvider.Operation - Enum in org.apache.sling.api.resource.external
-
Defines which operatio the URI may be used to perform.
- URIProvider.Scope - Enum in org.apache.sling.api.resource.external
-
Defines the scope in which the URI may be used.
- USE_RESOURCE_ACCESS_SECURITY - Static variable in interface org.apache.sling.api.resource.ResourceProvider
-
Deprecated.The name of the service registration property containing the a boolean flag indicating if the ResourceAccessSecurity service should be used for this provider or not.
- USER - Static variable in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Name of the authentication information property providing the name of the user for which the
ResourceResolverFactory.getResourceResolver(Map)
method creates resource resolvers. - USER_IMPERSONATION - Static variable in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Name of the authentication information property causing the
ResourceResolverFactory.getResourceResolver(Map)
,ResourceResolverFactory.getAdministrativeResourceResolver(Map)
, andResourceResolverFactory.getServiceResourceResolver(Map)
methods to try to impersonate the created resource resolver to the requested user and return the impersonated resource resolver. - USER_IMPERSONATOR - Static variable in interface org.apache.sling.api.resource.ResourceResolver
-
The name of the resource resolver attribute which is set if the resource resolver has been impersonated as per the
ResourceResolverFactory.USER_IMPERSONATION
property. - useResourceAccessSecurity - Variable in class org.apache.sling.api.resource.runtime.dto.ResourceProviderDTO
-
Whether resource access security should be used.
- useSchemeAndAuthority(URI) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Will take over scheme and authority (user info, host and port) from provided URI.
- useSchemeAndAuthority(SlingUri) - Method in class org.apache.sling.api.uri.SlingUriBuilder
-
Will take over scheme and authority (user info, host and port) from provided slingUri.
V
- ValueMap - Interface in org.apache.sling.api.resource
-
The
ValueMap
is an easy way to access properties of a resource. - ValueMapDecorator - Class in org.apache.sling.api.wrappers
- ValueMapDecorator(Map<String, Object>) - Constructor for class org.apache.sling.api.wrappers.ValueMapDecorator
-
Creates a new wrapper around a given map.
- ValueMapUtil - Class in org.apache.sling.api.wrappers
-
Factory methods to create
ValueMap
s. - valueOf(String) - Static method in enum org.apache.sling.api.request.SlingRequestEvent.EventType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.sling.api.resource.external.URIProvider.Operation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.sling.api.resource.external.URIProvider.Scope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.sling.api.resource.observation.ResourceChange.ChangeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.sling.api.resource.runtime.dto.AuthType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.sling.api.resource.runtime.dto.FailureReason
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.sling.api.request.SlingRequestEvent.EventType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.sling.api.resource.external.URIProvider.Operation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.sling.api.resource.external.URIProvider.Scope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.sling.api.resource.observation.ResourceChange.ChangeType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class org.apache.sling.api.resource.ResourceMetadata
- values() - Static method in enum org.apache.sling.api.resource.runtime.dto.AuthType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.sling.api.resource.runtime.dto.FailureReason
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class org.apache.sling.api.scripting.LazyBindings
- values() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Deprecated.
- values() - Method in class org.apache.sling.api.wrappers.impl.CachingValueMap
- values() - Method in class org.apache.sling.api.wrappers.impl.MergingValueMap
- values() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- visit(Resource) - Method in class org.apache.sling.api.resource.AbstractResourceVisitor
-
Implement this method to do actual work on the resources.
W
- WILDCARD - Static variable in class org.apache.sling.api.request.header.MediaRangeList
All Classes All Packages