- AbstractResource - Class in org.apache.sling.api.resource
-
The
AbstractResource
is an abstract implementation of the
Resource
interface.
- AbstractResource() - Constructor for class org.apache.sling.api.resource.AbstractResource
-
- AbstractResourceVisitor - Class in org.apache.sling.api.resource
-
The AbstractResourceVisitor
helps in traversing a
resource tree by decoupling the actual traversal code
from application code.
- 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
-
- 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 - 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.adapter.SlingAdaptable
-
Calls into the registered
AdapterManager
to adapt this object to
the desired
type
.
- 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(Class<AdapterType>) - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper
-
- APPLICATION_CONTEXT - Static variable in interface org.apache.sling.api.security.ResourceAccessSecurity
-
- 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 the
Servlet
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 the
Servlet
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 the
Servlet
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 the
Servlet
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 the
Servlet
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 the Servlet
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 the Servlet
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.
- AttributableResourceProvider - Interface in org.apache.sling.api.resource
-
- Authenticator - Interface in org.apache.sling.api.auth
-
- 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, T) - Method in interface org.apache.sling.api.resource.ValueMap
-
Get a named property and convert it into the given type.
- 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.
- get(String, Class<T>) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Get a named property and convert it into the given type.
- get(String, T) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
-
Get a named property and convert it into the given type.
- get(Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
- get(String, Class<T>) - Method in class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
-
- get(String, T) - Method in class org.apache.sling.api.wrappers.DeepReadValueMapDecorator
-
- get(Object) - 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 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.wrappers.ValueMapDecorator
- 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 given adaptable
object.
- getAddSelectors() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
- getAdministrativeResourceProvider(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceProviderFactory
-
- getAdministrativeResourceResolver(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
- getAllowedRequestMethods(Map<String, Method>) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
- getAllowedRequestMethods(Map<String, Method>) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
- getAttribute(ResourceResolver, String) - Method in interface org.apache.sling.api.resource.AttributableResourceProvider
-
Returns the value of the given resource provider attribute or null
if the attribute is not set or not visible (as e.g. security
sensitive attributes).
- 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 the
ResourceResolverFactory.PASSWORD
or other security
sensitive attributes).
- getAttributeNames(ResourceResolver) - Method in interface org.apache.sling.api.resource.AttributableResourceProvider
-
- getAttributeNames() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
- getBatchResourceRemover(int) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Create a batch resource remover.
- getCharacterEncoding() - Method in class org.apache.sling.api.resource.ResourceMetadata
-
- getChild(String) - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns the indicated child of this resource.
- 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
-
- 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(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns an
Iterable
of
Resource
objects loaded from
the children of the given
Resource
.
- getChildren() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- 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
- 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.
- 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
-
- 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. this is the externalized form
of the current path.
- getLog() - Method in class org.apache.sling.api.scripting.SlingBindings
-
- 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(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
- getName(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
- getName() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- 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.
- getOut() - Method in class org.apache.sling.api.scripting.SlingBindings
-
- getParameterMap() - Method in class org.apache.sling.api.resource.ResourceMetadata
-
- getParent() - Method in class org.apache.sling.api.resource.AbstractResource
-
Returns the parent resource of this resource.
- 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(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
- 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 to
path
, which is normalized by
ResourceUtil.normalize(String)
before resolving the ancestor.
- getParent(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
- getParent() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- getParentLocation() - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
Returns the parent location of the modification. this is the externalized
form of the parent node of the current path.
- getParentResourceType(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the super type of the given resource.
- getParentResourceType(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Returns the super type of the given resource type.
- 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
-
- 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.
- 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.
- 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.
- 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.
- getPropertyName() - Method in exception org.apache.sling.api.resource.PersistenceException
-
Get the property name related to this exception.
- getQuery() - Method in exception org.apache.sling.api.resource.QuerySyntaxException
-
- 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.
- getReplaceSelectors() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
- getReplaceSuffix() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
- getRequest() - Method in class org.apache.sling.api.scripting.SlingBindings
-
- getRequest() - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
- 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, 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(Resource) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
- getRequestDispatcher(Resource) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- getRequestDispatcher(Resource, RequestDispatcherOptions) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- getRequestDispatcher(String, 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
,
or
null
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, or
null
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
-
- getRequestPathInfo() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- getRequestProgressTracker() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
- 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
-
- getResource(ResourceResolver, String, Map<String, String>) - Method in interface org.apache.sling.api.resource.ParametrizableResourceProvider
-
Returns a resource from this resource provider or null
if
the resource provider cannot find it.
- getResource() - Method in exception org.apache.sling.api.resource.ResourceNotFoundException
-
- 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(ResourceResolver, String) - Method in interface org.apache.sling.api.resource.ResourceProvider
-
Returns a resource from this resource provider or null
if
the resource provider cannot find it.
- getResource(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 interface org.apache.sling.api.resource.ResourceResolver
-
Returns a
Resource
object for data located at the given path.
- 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
-
- getResourceBundle(Locale) - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
Returns the resource bundle for the given locale.
- 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(Locale) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- getResourceBundle(String, Locale) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- getResourceMetadata() - Method in interface org.apache.sling.api.resource.Resource
-
Returns the metadata of this resource.
- getResourceMetadata() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- getResourceMetadata() - Method in class org.apache.sling.api.resource.SyntheticResource
-
- 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.
- getResourceProvider(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceProviderFactory
-
Returns a new
ResourceProvider
instance with further
configuration taken from the given
authenticationInfo
map.
- getResourceResolver() - Method in interface org.apache.sling.api.resource.Resource
-
- getResourceResolver(Map<String, Object>) - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
Returns a new
ResourceResolver
instance with further
configuration taken from the given
authenticationInfo
map.
- getResourceResolver() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- getResourceResolver() - Method in class org.apache.sling.api.resource.SyntheticResource
-
Returns the
ResourceResolver
with which this synthetic resource
is related or
null
if none.
- getResourceResolver() - Method in interface org.apache.sling.api.SlingHttpServletRequest
-
- getResourceResolver() - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
-
- 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(ResourceResolver, String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
- getResourceSuperType() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- getResourceSuperType() - Method in class org.apache.sling.api.resource.SyntheticResource
-
Synthetic resources by default do not have a resource super type.
- 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
-
- 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
-
- 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
-
- 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.ResourceResolver
-
- getSelectors() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the selectors decoded from the request URL as an array of
strings.
- getSelectorString() - Method in interface org.apache.sling.api.request.RequestPathInfo
-
Returns the selectors decoded from the request URL as 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
-
- getSlingResponse() - Method in class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper
-
- 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.
- 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.
- 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.
- 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.
- getThreadResourceResolver() - Method in interface org.apache.sling.api.resource.ResourceResolverFactory
-
- getType() - Method in class org.apache.sling.api.request.SlingRequestEvent
-
get the type of the event, eg.
- getUserID() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Get the user ID, if any, associated with this resource resolver.
- 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
-
- getValueMap() - Method in interface org.apache.sling.api.resource.Resource
-
Returns a value map for this resource.
- getValueMap(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns an ValueMap
object for the given
Resource
.
- getValueMap() - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- 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
- include(String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
- 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
and requestDispatcherOptions
.
- 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
and options
.
- include(Resource) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
-
- 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
and requestDispatcherOptions
.
- 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
and options
.
- 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.
- INTERNAL_CONTINUE_RESOLVING - Static variable in class org.apache.sling.api.resource.ResourceMetadata
-
Returns whether the resource resolver should continue to search for a
resource.
- internalPut(String, Object) - Method in class org.apache.sling.api.resource.ResourceMetadata
-
- 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
-
- 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.wrappers.CompositeValueMap
- isEmpty() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- 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
-
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 has not been closed
yet.
- isMethodValid(Method, String) - Method in class org.apache.sling.api.servlets.SlingAllMethodsServlet
-
Returns true
if method
is not
null
and the method is not defined in the class named by
className
.
- isNonExistingResource(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns true
if the resource res
is a
non-existing resource.
- 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
-
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 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(String) - Method in class org.apache.sling.api.resource.ResourceWrapper
-
- isStarResource(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
Returns true
if the resource res
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 resource res
is a synthetic
resource.
- 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
-
This extension allows resource provider implementations to support
semicolon-separated parameters added to the URI, eg.: /content/test;v='1.0'
.
- parserAcceptHeader(String) - Static method in class org.apache.sling.api.request.RequestUtil
-
Parses an Accept-*
header of the form:
Header = Token { "," Token } .
- parserHeader(String) - Static method in class org.apache.sling.api.request.RequestUtil
-
Parses a header of the form:
Header = Token { "," Token } .
- 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.
- PersistableValueMap - Interface in org.apache.sling.api.resource
-
- PersistenceException - Exception in org.apache.sling.api.resource
-
- 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. this is usually the addressed resource or
in case of a creation request (eg: /foo/*) the path of the newly created
node.
- 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. more or less http response status codes
- 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
- 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
-
- PROPERTY_CHANGED_ATTRIBUTES - Static variable in class org.apache.sling.api.SlingConstants
-
- PROPERTY_PATH - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the resource path.
- PROPERTY_REMOVED_ATTRIBUTES - Static variable in class org.apache.sling.api.SlingConstants
-
- PROPERTY_REQUIRED - Static variable in interface org.apache.sling.api.resource.ResourceProviderFactory
-
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
-
- PROPERTY_RESOURCE_TYPE - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the resource type.
- 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_USERID - Static variable in class org.apache.sling.api.SlingConstants
-
The name of the event property holding the userid.
- PROVIDER_CONTEXT - Static variable in interface org.apache.sling.api.security.ResourceAccessSecurity
-
- put(String, Object) - Method in class org.apache.sling.api.resource.ResourceMetadata
-
- put(String, Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
- put(String, Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- 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.wrappers.CompositeValueMap
- putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- 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").
- 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
-
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.
- RefreshableResourceProvider - Interface in org.apache.sling.api.resource
-
A resource provider might return the state when it was created and not
update to the latest state.
- remove(Object) - Method in class org.apache.sling.api.resource.ResourceMetadata
-
- remove(Object) - Method in class org.apache.sling.api.wrappers.CompositeValueMap
- remove(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
- REQUEST - Static variable in class org.apache.sling.api.scripting.SlingBindings
-
- REQUEST_ATTR_WORKSPACE_INFO - Static variable in interface org.apache.sling.api.resource.ResourceResolver
-
Deprecated.
- RequestDispatcherOptions - Class in org.apache.sling.api.request
-
- 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 or null
no options are set.
- 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
-
- 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(HttpServletRequest, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Resolves the resource from the given absPath
optionally
taking HttpServletRequest
into account, such as the value of
the Host
request header.
- resolve(String) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Resolves the resource from the given absolute path.
- resolve(HttpServletRequest) - Method in interface org.apache.sling.api.resource.ResourceResolver
-
- resolveServlet(SlingHttpServletRequest) - Method in interface org.apache.sling.api.servlets.ServletResolver
-
Resolves a javax.servlet.Servlet
whose
service
method may be used to handle the given
request
.
- resolveServlet(Resource, String) - Method in interface org.apache.sling.api.servlets.ServletResolver
-
Resolves a javax.servlet.Servlet
whose
service
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
whose
service
method may be used to handle a request.
- Resource - Interface in org.apache.sling.api.resource
-
Resources are pieces of content on which Sling acts
The
Resource
is also an
Adaptable
to get adapters to
other types.
- 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
-
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").
- 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.
- ResourceDecorator - Interface in org.apache.sling.api.resource
-
- ResourceMetadata - Class in org.apache.sling.api.resource
-
The
ResourceMetadata
interface defines the API for the
metadata of a Sling
Resource
.
- 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, Throwable) - Constructor for exception org.apache.sling.api.resource.ResourceNotFoundException
-
- ResourceNotFoundException(String, String, Throwable) - Constructor for exception org.apache.sling.api.resource.ResourceNotFoundException
-
- ResourceProvider - Interface in org.apache.sling.api.resource
-
API for providers of resources.
- ResourceProviderFactory - Interface in org.apache.sling.api.resource
-
The ResourceProviderFactory
defines the service API to get and
create ResourceProviders
s dynamically on a per usage base.
- ResourceResolver - Interface in org.apache.sling.api.resource
-
The
ResourceResolver
defines the service API which may be used
to resolve
Resource
objects.
- ResourceResolverFactory - Interface in org.apache.sling.api.resource
-
The ResourceResolverFactory
defines the service API to get and
create ResourceResolver
s.
- resourceTypeToPath(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
-
- 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.
- ResourceUtil.BatchResourceRemover(int) - Constructor for class org.apache.sling.api.resource.ResourceUtil.BatchResourceRemover
-
- ResourceWrapper - Class in org.apache.sling.api.resource
-
The ResourceWrapper
is a wrapper for any Resource
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
-
- ResponseUtil - Class in org.apache.sling.api.request
-
Response related utility methods
This class is not intended to be extended or instantiated because it just
provides static utility methods not intended to be overwritten.
- ResponseUtil() - Constructor for class org.apache.sling.api.request.ResponseUtil
-
- revert(ResourceResolver) - Method in interface org.apache.sling.api.resource.ModifyingResourceProvider
-
Revert all transient changes: create, delete and updates.
- revert() - Method in interface org.apache.sling.api.resource.ResourceResolver
-
Revert all pending changes.
- ROOTS - Static variable in interface org.apache.sling.api.resource.ResourceProvider
-
The name of the service registration property containing the root paths
of the resources provided by this provider (value is "provider.roots").
- safePut(String, Object) - Method in class org.apache.sling.api.scripting.SlingBindings
-
- save() - Method in interface org.apache.sling.api.resource.PersistableValueMap
-
Deprecated.
Persists the changes.
- ScriptEvaluationException - Exception in org.apache.sling.api.scripting
-
- 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. if the property is not defined
the pattern is not modified.
- service(SlingHttpServletRequest, SlingHttpServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
- service(ServletRequest, ServletResponse) - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
-
- SERVICE_BUNDLE - Static variable in interface org.apache.sling.api.resource.ResourceProviderFactory
-
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
-
The service name to use when registering implementations of this
interface as services (value is
"org.apache.sling.api.resource.ResourceProvider").
- ServletResolver - Interface in org.apache.sling.api.servlets
-
The ServletResolver
defines the API for a service capable of
resolving javax.servlet.Servlet
instances to handle the
processing of a request or resource.
- setAdapterManager(AdapterManager) - Static method in class org.apache.sling.api.adapter.SlingAdaptable
-
- setAddSelectors(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
- 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
-
- setError(Throwable) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
- setFlush(boolean) - Method in class org.apache.sling.api.scripting.SlingBindings
-
- setForceResourceType(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
-
- setLocation(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
- setLog(Logger) - Method in class org.apache.sling.api.scripting.SlingBindings
-
- setModificationTime(long) - Method in class org.apache.sling.api.resource.ResourceMetadata
-
- 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.
- setPath(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
Sets the absolute path of the item upon which the request operated.
- setProperty(String, Object) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
Sets a generic response property with the given
- 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
-
- 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
-
- setResponse(SlingHttpServletResponse) - Method in class org.apache.sling.api.scripting.SlingBindings
-
- 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
- setTitle(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
-
Deprecated.
Sets the title of the response message
- size() - Method in class org.apache.sling.api.wrappers.CompositeValueMap
- 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
-
- SlingAdaptable - Class in org.apache.sling.api.adapter
-
The SlingAdaptable
class is an (abstract) default implementation
of the Adaptable
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 a
SlingHttpServletRequest
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 a
SlingHttpServletResponse
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
Java IOException
.
- 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. for included requests.
- 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
sling
variable.
- 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 API ServletException
.
- SlingServletException(ServletException) - Constructor for exception org.apache.sling.api.SlingServletException
-
- startTimer(String) - Method in interface org.apache.sling.api.request.RequestProgressTracker
-
Starts a named timer.
- 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.
- SyntheticResource - Class in org.apache.sling.api.resource
-
The SyntheticResource
class is a simple implementation of the
Resource
interface which may be used to provide a resource
object which has no actual resource data.
- SyntheticResource(ResourceResolver, String, String) - Constructor for class org.apache.sling.api.resource.SyntheticResource
-
Creates a synthetic resource with the given path
and
resourceType
.
- SyntheticResource(ResourceResolver, ResourceMetadata, String) - Constructor for class org.apache.sling.api.resource.SyntheticResource
-
Creates a synthetic resource with the given ResourceMetadata
and resourceType
.