A C D E F G H I K L M N O P Q R S T U V

A

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.
Adaptable - Interface in org.apache.sling.api.adapter
 
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.
AdapterSupport - Class in org.apache.sling.api.adapter
 
AdapterSupport() - Constructor for class org.apache.sling.api.adapter.AdapterSupport
 
adaptTo(Class<AdapterType>) - Method in interface org.apache.sling.api.adapter.Adaptable
Adapts the adaptable to another type.
adaptTo(Iterator<Resource>, Class<T>) - Static method in class org.apache.sling.api.resource.ResourceUtil
 
adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.resource.ResourceWrapper
 
adaptTo(Class<Type>) - Method in class org.apache.sling.api.resource.SyntheticResource
If a adapter manager has been set through SyntheticResource.setAdapterManager(AdapterManager) this adapter manager is used to adapt the resource to the given class.
adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper
 
adaptTo(Class<AdapterType>) - Method in class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper
 
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_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.

C

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.
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.wrappers.ValueMapDecorator
containsKey(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
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").
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

dispose() - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
Dispose the helper.
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 - all calls except the first one 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.

E

EMPTY - Static variable in interface org.apache.sling.api.resource.ValueMap
Empty immutable value map.
entrySet() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
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").
eval(SlingBindings) - Method in interface org.apache.sling.api.scripting.SlingScript
Evaluates this script using the bound variables as global variables to the script.

F

findResources(String, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
Searches for resources using the given query formulated in the given language.
findResourceSuperType(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
Returns the super type of the given resource.
findScript(ResourceResolver, String) - Method in interface org.apache.sling.api.scripting.SlingScriptResolver
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 and requestDispatcherOptions.
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 and options.

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, 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.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
Returns the RequestDispatcherOptions.OPT_ADD_SELECTORS option or null if not set.
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.
getCharacterEncoding() - Method in class org.apache.sling.api.resource.ResourceMetadata
Returns the ResourceMetadata.CHARACTER_ENCODING property if not null and a String instance.
getContentLength() - Method in class org.apache.sling.api.resource.ResourceMetadata
Returns the ResourceMetadata.CONTENT_LENGTH property if not null and a long.
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
Returns the ResourceMetadata.CONTENT_TYPE property if not null and a String instance.
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
Returns the ResourceMetadata.CREATION_TIME property if not null and a long.
getError() - Method in class org.apache.sling.api.servlets.HtmlResponse
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
Returns the SlingBindings.FLUSH property if not null and a boolean.
getForceResourceType() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Returns the RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE option or null if not set.
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
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
Returns the SlingBindings.LOG property if not null and a org.slf4j.Logger instance.
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
Returns the ResourceMetadata.MODIFICATION_TIME property if not null and a long.
getName(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
Utility method returns the parent resource of the 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 by ResourceUtil.normalize(String) before resolving the name.
getOut() - Method in class org.apache.sling.api.scripting.SlingBindings
Returns the SlingBindings.OUT property if not null and a PrintWriter instance.
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 by ResourceUtil.normalize(String) before resolving the parent.
getParent(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
Utility method returns the parent resource of the resource.
getParentLocation() - Method in class org.apache.sling.api.servlets.HtmlResponse
Returns the parent location of the modification. this is the externalized form of the parent node of the current path.
getPath() - Method in interface org.apache.sling.api.resource.Resource
This resource's path - for now that could be a JCR path.
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
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
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
Returns the generic response property with the given name and type or null if no such property exists.
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.
getReader() - Method in class org.apache.sling.api.scripting.SlingBindings
Returns the SlingBindings.READER property if not null and a Reader instance.
getReferer() - Method in class org.apache.sling.api.servlets.HtmlResponse
Returns the referer as from the 'referer' request header.
getReplaceSelectors() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Returns the RequestDispatcherOptions.OPT_REPLACE_SELECTORS option or null if not set.
getReplaceSuffix() - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Returns the RequestDispatcherOptions.OPT_REPLACE_SUFFIX option or null if not set.
getRequest() - Method in class org.apache.sling.api.scripting.SlingBindings
Returns the SlingBindings.REQUEST property if not null and a SlingHttpServletRequest instance.
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, 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
Same as SlingHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions) but using empty options.
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
 
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
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
Returns the ResourceMetadata.RESOLUTION_PATH property if not null and a String instance.
getResolutionPathInfo() - Method in class org.apache.sling.api.resource.ResourceMetadata
Returns the ResourceMetadata.RESOLUTION_PATH_INFO property if not null and a String instance.
getResource() - Method in exception org.apache.sling.api.resource.ResourceNotFoundException
 
getResource(ResourceResolver, HttpServletRequest, 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(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
Returns the SlingBindings.RESOURCE property if not null and a Resource instance.
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
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.
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
 
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
Returns the ResourceResolver which resolved the resource of this request.
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 type of the resource or null if the Resource.getResourceType() has no supertype.
getResourceSuperType(ResourceResolver, String) - Static method in class org.apache.sling.api.resource.ResourceUtil
Returns the super type of the given resource type.
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
Returns the SlingBindings.RESPONSE property if not null and a SlingHttpServletResponse instance.
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
 
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
Returns the search path used by the ResourceResolver.getResource(String) method to search for resources by relative path.
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
getServices(Class<ServiceType>, String) - Method in interface org.apache.sling.api.scripting.SlingScriptHelper
Lookup one or several services
getServletInfo() - Method in class org.apache.sling.api.servlets.SlingSafeMethodsServlet
Returns the simple class name of this servlet class.
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.
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
Returns the SlingBindings.SLING property if not null and a SlingScriptHelper instance.
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
Returns the status code of this instance.
getStatusMessage() - Method in class org.apache.sling.api.servlets.HtmlResponse
 
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.
getValue(String) - Method in interface org.apache.sling.api.request.RequestParameterMap
Returns the first value for the named parameter or null if none
getValueMap(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
Returns an ValueMap object for the given Resource.
getValues(String) - Method in interface org.apache.sling.api.request.RequestParameterMap
Returns all values for the named parameter or null if none

H

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.
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
Generator for a HTML status response that displays the changes made in a post request. see HtmlResponse.html for the format.
HtmlResponse() - Constructor for class org.apache.sling.api.servlets.HtmlResponse
Creates a new html response with default settings, which is null for almost all properties except the HtmlResponse.isCreateRequest() which defaults to false.
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 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_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.
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
Check if the resource is of the given type.
isCreateRequest() - Method in class org.apache.sling.api.servlets.HtmlResponse
Returns true if this was a create request.
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
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.
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
Returns true if no error is set and if the status code is one of the 2xx codes.
isSyntheticResource(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
Returns true if the resource res is a synthetic resource.

K

keySet() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator

L

listChildren(Resource) - Method in interface org.apache.sling.api.resource.ResourceProvider
Returns an Iterator of Resource objects loaded from the children of the given Resource.
listChildren(Resource) - Method in interface org.apache.sling.api.resource.ResourceResolver
Returns an Iterator of Resource objects loaded from the children of the given Resource.
listChildren(Resource) - Static method in class org.apache.sling.api.resource.ResourceUtil
Returns an Iterator of Resource objects loaded from the children of the given Resource.
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").
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 path mapped from the (resource) path applying the reverse mapping used by the ResourceResolver.resolve(String) such that when the path is given to the ResourceResolver.resolve(String) method the same resource is returned.
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 the ResourceResolver.resolve(HttpServletRequest, String) method the same resource is returned.
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.
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
 
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").

N

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/").
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
 
normalize(String) - Static method in class org.apache.sling.api.resource.ResourceUtil
Resolves relative path segments '.' and '..' in the absolute path.

O

onChange(String, String...) - Method in class org.apache.sling.api.servlets.HtmlResponse
Records a generic change of the given type.
onCopied(String, String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Records a 'copied' change.
onCreated(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Records a 'created' change
onDeleted(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Records a 'deleted' change
onModified(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Records a 'modified' change
onMoved(String, String) - Method in class org.apache.sling.api.servlets.HtmlResponse
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 by Servlets 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.request - package org.apache.sling.api.request
 
org.apache.sling.api.resource - package org.apache.sling.api.resource
 
org.apache.sling.api.scripting - package org.apache.sling.api.scripting
 
org.apache.sling.api.servlets - package org.apache.sling.api.servlets
 
org.apache.sling.api.wrappers - package org.apache.sling.api.wrappers
 
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").

P

PersistableValueMap - Interface in org.apache.sling.api.resource
The PersistableValueMap is an extension of the ValueMap which allows to modify and persist the properties.
PersistenceException - Exception in org.apache.sling.api.resource
This exception will be thrown during the try to persists changes to a PersistableValueMap.
PersistenceException() - Constructor for exception org.apache.sling.api.resource.PersistenceException
 
PersistenceException(String) - Constructor for exception org.apache.sling.api.resource.PersistenceException
 
PersistenceException(String, Throwable) - Constructor for exception org.apache.sling.api.resource.PersistenceException
 
PN_CHANGE_LOG - Static variable in class org.apache.sling.api.servlets.HtmlResponse
human readable changelog
PN_ERROR - Static variable in class org.apache.sling.api.servlets.HtmlResponse
The Throwable caught while processing the request.
PN_IS_CREATED - Static variable in class org.apache.sling.api.servlets.HtmlResponse
Indicating whether request processing created new data.
PN_LOCATION - Static variable in class org.apache.sling.api.servlets.HtmlResponse
externally mapped location url of the modified path
PN_PARENT_LOCATION - Static variable in class org.apache.sling.api.servlets.HtmlResponse
externally mapped location url of the parent of the modified path
PN_PATH - Static variable in class org.apache.sling.api.servlets.HtmlResponse
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
the referrer of the request
PN_STATUS_CODE - Static variable in class org.apache.sling.api.servlets.HtmlResponse
status code. more or less http response status codes
PN_STATUS_MESSAGE - Static variable in class org.apache.sling.api.servlets.HtmlResponse
some human readable status message
PN_TITLE - Static variable in class org.apache.sling.api.servlets.HtmlResponse
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_PATH - Static variable in class org.apache.sling.api.SlingConstants
The name of the event property holding the resource path.
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 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.
put(String, Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
putAll(Map<? extends String, ?>) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator

Q

queryResources(String, String) - Method in interface org.apache.sling.api.resource.ResourceResolver
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 the ResourceResolver.findResources(String, String) and ResourceResolver.queryResources(String, String) methods if the query syntax is wrong or the requested query language is not available.
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

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.
remove(Object) - Method in class org.apache.sling.api.wrappers.ValueMapDecorator
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").
RequestDispatcherOptions - Class in org.apache.sling.api.request
RequestDispatcherOptions are used in the SlingHttpServletRequest.getRequestDispatcher(org.apache.sling.api.resource.Resource, RequestDispatcherOptions) method, to give more control on some aspects of the include/forward mechanism.
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.
reset() - Method in interface org.apache.sling.api.resource.PersistableValueMap
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
Deprecated. as of 2.0.4, use ResourceResolver.resolve(HttpServletRequest, String) instead.
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.
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").
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.
ResourceResolver - Interface in org.apache.sling.api.resource
The ResourceResolver defines the service API which may be used to resolve Resource objects.
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
 
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
The name of the global scripting variable providing the SlingHttpServletResponse object (value is "response").
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").

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
Persists the changes.
ScriptEvaluationException - Exception in org.apache.sling.api.scripting
The ScriptEvaluationException is thrown by the SlingScript.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
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
Called by the SlingSafeMethodsServlet.service(ServletRequest, ServletResponse) method to handle the HTTP request.
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_NAME - Static variable in interface org.apache.sling.api.adapter.AdapterFactory
The service name to use when registering implementations of this interface as services (value is "org.apache.sling.osgi.commons.AdapterFactory").
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.resource.SyntheticResource
Set the adapter manager to be used by a synthetic resource.
setAddSelectors(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Sets the RequestDispatcherOptions.OPT_ADD_SELECTORS option to the given additionalSelectors if not null.
setCharacterEncoding(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
Sets the ResourceMetadata.CHARACTER_ENCODING property to encoding if not null.
setContentLength(long) - Method in class org.apache.sling.api.resource.ResourceMetadata
Sets the ResourceMetadata.CONTENT_LENGTH property to contentType if not null.
setContentType(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
Sets the ResourceMetadata.CONTENT_TYPE property to contentType if not null.
setCreateRequest(boolean) - Method in class org.apache.sling.api.servlets.HtmlResponse
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 to creationTime if not negative.
setError(Throwable) - Method in class org.apache.sling.api.servlets.HtmlResponse
 
setFlush(boolean) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.FLUSH property to flush.
setForceResourceType(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Sets the RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE option to the given resourceType if not null.
setLocation(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
 
setLog(Logger) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.LOG property to log if not null.
setModificationTime(long) - Method in class org.apache.sling.api.resource.ResourceMetadata
Sets the ResourceMetadata.MODIFICATION_TIME property to modificationTime if not negative.
setOut(PrintWriter) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.OUT property to out if not null.
setParentLocation(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
 
setPath(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Sets the absolute path of the item upon which the request operated.
setProperty(String, Object) - Method in class org.apache.sling.api.servlets.HtmlResponse
Sets a generic response property with the given
setReader(Reader) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.READER property to reader if not null.
setReferer(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Sets the referer property
setReplaceSelectors(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Sets the RequestDispatcherOptions.OPT_REPLACE_SELECTORS option to the given replaceSelectors if not null.
setReplaceSuffix(String) - Method in class org.apache.sling.api.request.RequestDispatcherOptions
Sets the RequestDispatcherOptions.OPT_REPLACE_SUFFIX option to the given replaceSuffix if not null.
setRequest(SlingHttpServletRequest) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.REQUEST property to request if not null.
setResolutionPath(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
Sets the ResourceMetadata.RESOLUTION_PATH property to resolutionPath if not null.
setResolutionPathInfo(String) - Method in class org.apache.sling.api.resource.ResourceMetadata
Sets the ResourceMetadata.RESOLUTION_PATH_INFO property to resolutionPathInfo if not null.
setResource(Resource) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.RESOURCE property to resource if not null.
setResourceType(String) - Method in class org.apache.sling.api.resource.SyntheticResource
Deprecated. The resource type should be set through the constructor.
setResponse(SlingHttpServletResponse) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.RESPONSE property to response if not null.
setSling(SlingScriptHelper) - Method in class org.apache.sling.api.scripting.SlingBindings
Sets the SlingBindings.SLING property to sling if not null.
setStatus(int, String) - Method in class org.apache.sling.api.servlets.HtmlResponse
sets the response status code properties
setTitle(String) - Method in class org.apache.sling.api.servlets.HtmlResponse
Sets the title of the response message
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_SCOPE - Static variable in class org.apache.sling.api.scripting.SlingScriptConstants
The name of the script scope holding the SlingScriptConstants.ATTR_SCRIPT_RESOURCE_RESOLVER.
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
 
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 resolved by the SlingScriptResolver.
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
The ScriptResolver interface defines the API for a service capable of locating scripts.
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.
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.

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
The topic for the OSGi event which is sent when a resource has been added to the resource tree.
TOPIC_RESOURCE_CHANGED - Static variable in class org.apache.sling.api.SlingConstants
The topic for the OSGi event which is sent when a resource has been changed in the resource tree.
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
The topic for the OSGi event which is sent when a resource has been removed from the resource tree.
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.
toString() - Method in class org.apache.sling.api.resource.NonExistingResource
 
toString() - Method in class org.apache.sling.api.resource.ResourceWrapper
 
toString() - Method in class org.apache.sling.api.resource.SyntheticResource
 

U

unsetAdapterManager(AdapterManager) - Static method in class org.apache.sling.api.resource.SyntheticResource
Unset an adapter manager previously set with SyntheticResource.setAdapterManager(AdapterManager)

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 decorates another Map to provide a basic implementation for the additional methods of a ValueMap.
ValueMapDecorator(Map<String, Object>) - Constructor for class org.apache.sling.api.wrappers.ValueMapDecorator
Creates a new wrapper around a given map.
values() - Method in class org.apache.sling.api.wrappers.ValueMapDecorator

A C D E F G H I K L M N O P Q R S T U V

Copyright © 2007-2009 The Apache Software Foundation. All Rights Reserved.