|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
AbstractResource
is an abstract implementation of the
Resource
interface.AbstractResourceVisitor
helps in traversing a
resource tree by decoupling the actual traversal code
from application code.true
if this servlet is
willing to handle the request.
Adaptable
interface identifies objects which can be adapted
to other types or representations of the same object.AdapterFactory
interface defines the API for helpers which
may be provided to enhance the adaptability of adaptable objects.AdapterManager
defines the service interface for a manager
for object adaption.AdapterManager
to adapt this object to
the desired type
.
adaptTo
on the
wrapped resource
.
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").
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").
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").
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").
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").
Resource
underlying the Servlet
which included the servlet currently
being active (value is "org.apache.sling.api.include.resource").
RequestPathInfo
underlying the Servlet
which
included the servlet currently being active (value is
"org.apache.sling.api.include.request_path_info").
Servlet
which included the servlet currently being active (value is
"org.apache.sling.api.include.servlet").
ResourceResolver
which
has been used to resolve the script.
ResourceProvider
.Authenticator
interface defines the service interface which
may be used by applications to enforce requests to be authenticated (see
Authenticator.login(HttpServletRequest, HttpServletResponse)
) or to end enforced
authentication (see Authenticator.logout(HttpServletRequest, HttpServletResponse)
).ResourceResolver
instance based on the given
authenticationInfo
map and the original authentication info
used to create this instance.
SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to
handle an HTTP DELETE request.
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.
SlingSafeMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to
handle an HTTP GET request.
Allow
header on the response depending on the methods
declared in this class.
SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to
handle an HTTP POST request.
SlingAllMethodsServlet.mayService(SlingHttpServletRequest, SlingHttpServletResponse)
method to
handle an HTTP PUT request.
ResourceProviderFactory
.SlingScript
for the given name.
SlingScriptHelper.forward(String,RequestDispatcherOptions)
, but using
empty options.
path
and requestDispatcherOptions
.
path
and options
.
SlingScriptHelper.forward(Resource,RequestDispatcherOptions)
, but using
empty options.
resource
and requestDispatcherOptions
.
resource
and options
.
AdapterType
for
the given adaptable
object.
RequestDispatcherOptions.OPT_ADD_SELECTORS
option or null
if
not set.
ResourceProvider
instance with administrative
privileges with further configuration taken from the given authenticationInfo
map.
ResourceResolver
instance with administrative
privileges with further configuration taken from the given
authenticationInfo
map.
SlingSafeMethodsServlet.doOptions(SlingHttpServletRequest, SlingHttpServletResponse)
to calculate
the value of the Allow header sent as the response to the HTTP
OPTIONS request.
SlingSafeMethodsServlet.doOptions(SlingHttpServletRequest, SlingHttpServletResponse)
to calculate
the value of the Allow header sent as the response to the HTTP
OPTIONS request.
null
if the attribute is not set or not visible (as e.g. security
sensitive attributes).
null
if the attribute is not set (or not visible as is the
case of the ResourceResolverFactory.PASSWORD
or other security
sensitive attributes).
AttributableResourceProvider.getAttribute(ResourceResolver, String)
method.
ResourceResolver.getAttribute(String)
method.
ResourceMetadata.CHARACTER_ENCODING
property if not null
and a String
instance.
null
if no such child exists.
getChild
on the
wrapped resource
.
Iterable
of Resource
objects loaded from
the children of the given Resource
.
ResourceMetadata.CONTENT_LENGTH
property if not null
and a long
.
null
if
not defined.
ResourceMetadata.CONTENT_TYPE
property if not null
and
a String
instance.
null
if
no such cookie exists in the request.
ResourceMetadata.CREATION_TIME
property if not null
and a long
.
null
null
if the request
URL does not contain an extension.
SlingBindings.FLUSH
property if not null
and a
boolean
.
RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE
option or null
if not set.
SlingBindings.LOG
property if not null
and a
org.slf4j.Logger
instance.
Iterator
of tracking entries.
ResourceMetadata.MODIFICATION_TIME
property if not null
and a long
.
Resource.getName()
instead
path
, which is
normalized by ResourceUtil.normalize(String)
before resolving the name.
getName
on the
wrapped resource
.
SlingBindings.OUT
property if not null
and a
PrintWriter
instance.
null
if this resource
represents the root of the resource tree.
path
,
which is normalized by ResourceUtil.normalize(String)
before resolving the
parent.
level
relative to path
, which is normalized by ResourceUtil.normalize(String)
before resolving the ancestor.
Resource.getParent()
instead
getParent
on the
wrapped resource
.
getPath
on the
wrapped resource
.
null
if no such property exists or the property is not of
the requested type.
null
if no such property exists.
SlingBindings.READER
property if not null
and a
Reader
instance.
RequestDispatcherOptions.OPT_REPLACE_SELECTORS
option or null
if not set.
RequestDispatcherOptions.OPT_REPLACE_SUFFIX
option or null
if
not set.
SlingBindings.REQUEST
property if not null
and a
SlingHttpServletRequest
instance.
SlingHttpServletRequest
representing the input of the
request.
RequestDispatcher
object that acts as a wrapper
for the resource located at the given path.
RequestDispatcher
object that acts as a wrapper
for the resource located at the given resource.
SlingHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)
but using empty options.
RequestParameter
,
or null
if the parameter does not exist.
Map
of the parameters of this request.
RequestParameter
objects containing all of
the values the given request parameter has, or null
if the
parameter does not exist.
RequestPathInfo
pertaining to this request.
RequestProgressTracker
of this request.
ResourceMetadata.RESOLUTION_PATH
property if not null
and a String
instance.
ResourceMetadata.RESOLUTION_PATH_INFO
property if not
null
and a String
instance.
null
if
the resource provider cannot find it.
Resource
object for data located at the given path.
Resource
object for data located at the given path.
Resource
wrapped by this instance.
SlingBindings.RESOURCE
property if not null
and a
Resource
instance.
Resource
object on whose behalf the servlet acts.
getResourceMetadata
on the
wrapped resource
.
ResourceMetadata.RESOLUTION_PATH
property.
ResourceProvider
instance with further
configuration taken from the given authenticationInfo
map.
ResourceResolver
from which this resource has been
retrieved.
ResourceResolver
instance with further
configuration taken from the given authenticationInfo
map.
getResourceResolver
on the
wrapped resource
.
ResourceResolver
with which this synthetic resource
is related or null
if none.
ResourceResolver
which resolved the
resource
of this request.
null
if the Resource.getResourceType()
has no supertype.
getResourceSuperType
on the
wrapped resource
.
getResourceType
on the
wrapped resource
.
SlingBindings.RESPONSE
property if not null
and a
SlingHttpServletResponse
instance.
SlingHttpServletResponse
representing the output of
the request.
SlingScript
being called to handle the request.
ResourceResolver.getResource(String)
method
to search for resources by relative path.
ServletContext
ServletRequest
SlingBindings.SLING
property if not null
and a
SlingScriptHelper
instance.
SlingHttpServletRequest
object wrapped by
this.
SlingHttpServletResponse
object wrapped by
this.
null
if the request
URL does not contain a suffix.
ValueMap
object for the given
Resource
.
null
for almost all properties except the
HtmlResponse.isCreateRequest()
which defaults to false
.
SlingScriptHelper.include(String,RequestDispatcherOptions)
, but using
empty options.
path
and requestDispatcherOptions
.
path
and options
.
SlingScriptHelper.include(Resource,RequestDispatcherOptions)
, but using
empty options.
resource
and requestDispatcherOptions
.
resource
and options
.
true
if this was a create request.
true
if this resource provider has not been closed
yet and can still be used.
true
if this resource resolver has not been closed
yet.
true
if method
is not
null
and the method is not defined in the class named by
className
.
true
if the resource res
is a
non-existing resource.
true
if this resource is of the given resource type
or if any of the super resource types equals the given resource type.
true
if the resource type or any of the resource's
super type(s) equals the given resource type.
isResourceType
on the
wrapped resource
.
true
if the resource res
is a "star
resource".
true
if no error
is set and if
the status code
is one of the 2xx codes.
true
if the resource res
is a synthetic
resource.
Iterator
of Resource
objects loaded from
the children of the given Resource
.
Iterator
of Resource
objects loaded from
the children of the given Resource
.
Resource.listChildren()
instead
listChildren
on the
wrapped resource
.
MessageFormat
format evaluated using the given formatting
arguments.
Authenticator.login(HttpServletRequest, HttpServletResponse)
method to which resource access should actually be authenticated.
ResourceResolverFactory.getAdministrativeResourceResolver(java.util.Map)
,
ResourceResolverFactory.getResourceResolver(java.util.Map)
, and ResourceResolver.clone(java.util.Map)
if a resource
resolver cannot be created because the credential data is not valid.null
as its
detail message.
MessageFormat
pattern evaluated using the given arguments
and the number of milliseconds elapsed since the timer start.
ResourceResolver.resolve(String)
such that when the path is
given to the ResourceResolver.resolve(String)
method the same resource is
returned.
ResourceResolver.resolve(HttpServletRequest, String)
such
that when the path is given to the
ResourceResolver.resolve(HttpServletRequest, String)
method the same resource is
returned.
ModifiableValueMap
is an extension
of the ValueMap
which allows to modify and
persist properties.ModifiableValueMapDecorator
decorates another Map
to provide a basic implementation for the additional methods
of a ModifiableValueMap
.ResourceProviderFactory
.NoAuthenticationHandlerException
is thrown to indicate that
the
Authenticator.login(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method could not find a way to authenticate the request user.type
.
EventType
appearing during the dispatching of
a Sling request
RequestPathInfo
selectors.
Resource
.
RequestPathInfo
selectors by the value
provided by this option.
RequestPathInfo
suffix by the value
provided by this option
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.java.io.PrintWriter
object to return the response content
(value is "out").
Accept-*
header of the form:
Header = Token { "," Token } .
PersistableValueMap
, a
ModifiableValueMap#update()
or
the ResourceResolver
.SlingConstants.TOPIC_RESOURCE_CHANGED
event.
SlingConstants.TOPIC_RESOURCE_CHANGED
event.
SlingConstants.TOPIC_RESOURCE_CHANGED
event.
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.Reader
object (value is "reader").
RecursionTooDeepException
is thrown by the Sling
implementation if to many recursive content inclusions take place.SlingHttpServletRequest
object (value is
"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.options
string as follows:
If the string is empty or null
no options are set.
RequestParameter
class represents a single parameter sent
with the client request.RequestParameterMap
encapsulates all request parameters of
a request.RequestProgressTracker
class provides the functionality to
track the progress of request processing.absPath
optionally
taking HttpServletRequest
into account, such as the value of
the Host
request header.
ResourceResolver.resolve(HttpServletRequest, String)
instead.
javax.servlet.Servlet
whose
service
method may be used to handle the given
request
.
javax.servlet.Servlet
whose
service
method may be used to handle a request.
javax.servlet.Servlet
whose
service
method may be used to handle a request.
Resource
is also an Adaptable
to get adapters to
other types.Resource
object (value is
"resource").
ResourceProvider.listChildren(Resource)
method to enable traversing the
resource
tree down to a deeply nested provided resource which has no concrete
parent hierarchy (value is"sling:syntheticResourceProviderResource").
Resource
s returned by
the ResourceResolver
.ResourceMetadata
interface defines the API for the
metadata of a Sling Resource
.ResourceProviderFactory
defines the service API to get and
create ResourceProviders
s dynamically on a per usage base.ResourceResolver
defines the service API which may be used
to resolve Resource
objects.ResourceResolverFactory
defines the service API to get and
create ResourceResolver
s.Resource.getResourceType()
as a
relative path.
ResourceUtil
class provides helper methods dealing with
resources.ResourceWrapper
is a wrapper for any Resource
delegating all method calls to the wrapped resource by default.resource
.
SlingHttpServletResponse
object (value is
"response").
HashMap.put(Object, Object)
only if the value is not null.
ScriptEvaluationException
is thrown by the
SlingScript.eval(SlingBindings)
method if an error occurrs evaluating
the script.SlingSafeMethodsServlet.service(ServletRequest, ServletResponse)
method to
handle the HTTP request.
SlingSafeMethodsServlet.service(SlingHttpServletRequest, SlingHttpServletResponse)
method if the request is a HTTP request.
ServletResolver
defines the API for a service capable of
resolving javax.servlet.Servlet
instances to handle the
processing of a request or resource.AdapterManager
to be used by this class.
RequestDispatcherOptions.OPT_ADD_SELECTORS
option to the given
additionalSelectors
if not null
.
ResourceMetadata.CHARACTER_ENCODING
property to encoding
if not null
.
ResourceMetadata.CONTENT_LENGTH
property to contentType
if not null
.
ResourceMetadata.CONTENT_TYPE
property to contentType
if
not null
.
ResourceMetadata.CREATION_TIME
property to creationTime
if not negative.
SlingBindings.FLUSH
property to flush
.
RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE
option to the given
resourceType
if not null
.
SlingBindings.LOG
property to log
if not
null
.
ResourceMetadata.MODIFICATION_TIME
property to
modificationTime
if not negative.
SlingBindings.OUT
property to out
if not
null
.
SlingBindings.READER
property to reader
if not
null
.
RequestDispatcherOptions.OPT_REPLACE_SELECTORS
option to the given
replaceSelectors
if not null
.
RequestDispatcherOptions.OPT_REPLACE_SUFFIX
option to the given
replaceSuffix
if not null
.
SlingBindings.REQUEST
property to request
if not
null
.
ResourceMetadata.RESOLUTION_PATH
property to resolutionPath
if not null
.
ResourceMetadata.RESOLUTION_PATH_INFO
property to
resolutionPathInfo
if not null
.
SlingBindings.RESOURCE
property to resource
if not
null
.
SlingBindings.RESPONSE
property to response
if not
null
.
SlingBindings.SLING
property to sling
if not
null
.
SlingScriptHelper
for the request
(value is "sling").
SlingScriptConstants.ATTR_SCRIPT_RESOURCE_RESOLVER
.
SlingAdaptable
class is an (abstract) default implementation
of the Adaptable
interface.SlingBindings
class is used to prepare global variables
for script execution.SlingConstants
interface provides some symbolic constants
for well known constant strings in Sling.SlingException
is the base exception used throughout the
Sling API.SlingHttpServletRequest
defines the interface to provide
client request information to a servlet.SlingHttpServletRequestWrapper
class is a default wrapper
class around a SlingHttpServletRequest
which may be extended to amend
the functionality of the original request object.SlingHttpServletResponse
defines the interface to assist a
servlet in creating and sending a response to the client.SlingHttpServletResponseWrapper
class is a default wrapper
class around a SlingHttpServletResponse
which may be extended to
amend the functionality of the original response object.SlingIOException
is a runtime exception wrapper for the
Java IOException
.SlingScript
defines the API for objects which encapsulate
a script.SlingScriptHelper
interface defines the API of a helper
class which is provided to the scripts called from sling through the global
sling
variable.SlingServletException
is a runtime exception wrapper for
the Servlet API ServletException
.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.path
and
resourceType
.
ResourceMetadata
and resourceType
.
TooManyCallsException
is thrown by the Sling implementation
if to many inclusions have been called for during a single request.resource type
and
path
as well as the string representation of the
wrapped resource
.
AdapterManager
.
ResourceResolverFactory.getResourceResolver(Map)
and
ResourceResolverFactory.getAdministrativeResourceResolver(Map)
create resource
resolvers. on whose behalf the request is being handled.
ResourceResolverFactory.getResourceResolver(Map)
and
ResourceResolverFactory.getAdministrativeResourceResolver(Map)
methods to try to
impersonate the created resource resolver to the requested user and
return the impersonated resource resolver.
ResourceResolverFactory.USER_IMPERSONATION
property.
ValueMap
is an easy way to access properties of a resource.ValueMapDecorator
decorates another Map
to provide a basic implementation for the additional methods
of a ValueMap
.
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |