Uses of Interface
org.apache.sling.api.resource.Resource
Packages that use Resource
Package
Description
-
Uses of Resource in org.apache.sling.api
Methods in org.apache.sling.api that return ResourceModifier and TypeMethodDescription@NotNull Resource
SlingHttpServletRequest.getResource()
Deprecated.Returns theResource
object on whose behalf the servlet acts.@NotNull Resource
SlingJakartaHttpServletRequest.getResource()
Returns theResource
object on whose behalf the servlet acts.Methods in org.apache.sling.api with parameters of type ResourceModifier and TypeMethodDescription@Nullable javax.servlet.RequestDispatcher
SlingHttpServletRequest.getRequestDispatcher
(@NotNull Resource resource) Deprecated.Same asSlingHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)
but using empty options.@Nullable javax.servlet.RequestDispatcher
SlingHttpServletRequest.getRequestDispatcher
(@NotNull Resource resource, RequestDispatcherOptions options) Deprecated.Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given resource.@Nullable jakarta.servlet.RequestDispatcher
SlingJakartaHttpServletRequest.getRequestDispatcher
(@NotNull Resource resource) Same asSlingJakartaHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)
but using empty options.@Nullable jakarta.servlet.RequestDispatcher
SlingJakartaHttpServletRequest.getRequestDispatcher
(@NotNull Resource resource, RequestDispatcherOptions options) Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given resource. -
Uses of Resource in org.apache.sling.api.request
Methods in org.apache.sling.api.request that return ResourceModifier and TypeMethodDescription@Nullable Resource
RequestPathInfo.getSuffixResource()
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. -
Uses of Resource in org.apache.sling.api.request.builder
Methods in org.apache.sling.api.request.builder with parameters of type ResourceModifier and TypeMethodDescriptionstatic @NotNull SlingHttpServletRequestBuilder
Builders.newRequestBuilder
(@NotNull Resource resource) Creates a new request builder. -
Uses of Resource in org.apache.sling.api.resource
Classes in org.apache.sling.api.resource that implement ResourceModifier and TypeClassDescriptionclass
TheAbstractResource
is an abstract implementation of theResource
interface.final class
Simple helper class representing nonexisting resources.class
TheResourceWrapper
is a wrapper for anyResource
delegating all method calls to the wrapped resource by default.class
TheSyntheticResource
class is a simple implementation of theResource
interface which may be used to provide a resource object which has no actual resource data (except for the mandatory property "sling:resourceType").Methods in org.apache.sling.api.resource that return ResourceModifier and TypeMethodDescriptionThis method copies the subgraph rooted at, and including, the resource atsrcAbsPath
to the new location atdestAbsPath
and adds it as a child node of the resource atdestAbsPath
.ModifyingResourceProvider.create
(ResourceResolver resolver, String path, Map<String, Object> properties) Deprecated.Create a new resource at the given path.@NotNull Resource
ResourceResolver.create
(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Add a child resource to the given parent resource.@Nullable Resource
Decorate a resource.default @Nullable Resource
ResourceDecorator.decorate
(@NotNull Resource resource, @NotNull javax.servlet.http.HttpServletRequest request) Deprecated.since 2.3.0 (and JCR Resource 2.1.0), this method will not be invoked.Returns the indicated child of this resource.@Nullable Resource
Returns the child at the given relative path of this resource ornull
if no such child exists.Returns the value of callinggetChild
on thewrapped resource
.static @NotNull Resource
ResourceUtil.getOrCreateResource
(@NotNull ResourceResolver resolver, @NotNull String path, String resourceType, String intermediateResourceType, boolean autoCommit) Creates or gets the resource at the given path.static @NotNull Resource
ResourceUtil.getOrCreateResource
(@NotNull ResourceResolver resolver, @NotNull String path, Map<String, Object> resourceProperties, String intermediateResourceType, boolean autoCommit) Creates or gets the resource at the given path.AbstractResource.getParent()
Returns the parent resource of this resource.NonExistingResource.getParent()
@Nullable Resource
Resource.getParent()
Returns the parent resource ornull
if this resource represents the root of the resource tree.@Nullable Resource
Returns the parent resource of this resource.static @Nullable Resource
Deprecated.since 2.1.0, usegetParent()
insteadResourceWrapper.getParent()
Returns the value of callinggetParent
on thewrapped resource
.@Nullable Resource
ParametrizableResourceProvider.getResource
(@NotNull ResourceResolver resourceResolver, @NotNull String path, @NotNull Map<String, String> parameters) Deprecated.Returns a resource from this resource provider ornull
if the resource provider cannot find it.@Nullable Resource
ResourceProvider.getResource
(@NotNull ResourceResolver resourceResolver, @NotNull String path) Deprecated.Returns a resource from this resource provider ornull
if the resource provider cannot find it.@Nullable Resource
ResourceProvider.getResource
(@NotNull ResourceResolver resourceResolver, @NotNull javax.servlet.http.HttpServletRequest request, @NotNull String path) Deprecated.since 2.2.0 (and JCR Resource 2.1.0), this method will not be invoked.@Nullable Resource
ResourceResolver.getResource
(@NotNull String path) Returns aResource
object for data located at the given path.@Nullable Resource
ResourceResolver.getResource
(Resource base, @NotNull String path) Returns aResource
object for data located at the given path.@NotNull Resource
ResourceWrapper.getResource()
Returns theResource
wrapped by this instance.This method moves the subgraph rooted at, and including, the resource atsrcAbsPath
to the new location atdestAbsPath
and adds it as a child node of the resource atdestAbsPath
.@NotNull Resource
ResourceResolver.resolve
(@NotNull jakarta.servlet.http.HttpServletRequest request, @NotNull String absPath) Resolves the resource from the givenabsPath
optionally takingHttpServletRequest
into account, such as the value of theHost
request header.@NotNull Resource
Resolves the resource from the given absolute path.@NotNull Resource
ResourceResolver.resolve
(javax.servlet.http.HttpServletRequest request) Deprecated.as of 2.0.4, useResourceResolver.resolve(HttpServletRequest, String)
instead.@NotNull Resource
Deprecated.UseResourceResolver.resolve(HttpServletRequest, String)
instead.static @NotNull Resource
Unwrap the resource and return the wrapped implementation.Methods in org.apache.sling.api.resource that return types with arguments of type ResourceModifier and TypeMethodDescriptionQueriableResourceProvider.findResources
(ResourceResolver resolver, String query, String language) Deprecated.Searches for resources using the given query formulated in the given language.ResourceResolver.findResources
(@NotNull String query, String language) Searches for resources using the given query formulated in the given language.AbstractResource.getChildren()
Resource.getChildren()
Returns an iterable of the direct children of this resource.ResourceResolver.getChildren
(@NotNull Resource parent) ResourceWrapper.getChildren()
AbstractResource.listChildren()
Returns an iterator on the direct child resources.Resource.listChildren()
Returns an iterator of the direct children of this resource.ResourceProvider.listChildren
(@NotNull Resource parent) Deprecated.ResourceResolver.listChildren
(@NotNull Resource parent) ResourceUtil.listChildren
(@NotNull Resource parent) Deprecated.since 2.1.0, uselistChildren()
insteadResourceWrapper.listChildren()
Returns the value of callinglistChildren
on thewrapped resource
.Methods in org.apache.sling.api.resource with parameters of type ResourceModifier and TypeMethodDescriptionvoid
Visit the given resource and all its descendants.@NotNull Resource
ResourceResolver.create
(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Add a child resource to the given parent resource.static String
ResourceUtil.createUniqueChildName
(Resource parent, String name) Create a unique name for a child of theparent
.@Nullable Resource
Decorate a resource.default @Nullable Resource
ResourceDecorator.decorate
(@NotNull Resource resource, @NotNull javax.servlet.http.HttpServletRequest request) Deprecated.since 2.3.0 (and JCR Resource 2.1.0), this method will not be invoked.void
Delete the resource Deleting a non existing resource leads to no operation nor exception.void
static @Nullable String
ResourceUtil.findResourceSuperType
(@NotNull Resource resource) Deprecated.ResourceResolver.getChildren
(@NotNull Resource parent) static @NotNull String
Deprecated.since 2.1.0, usegetName()
instead@Nullable Resource
Returns the parent resource of this resource.static @Nullable Resource
Deprecated.since 2.1.0, usegetParent()
instead@Nullable String
ResourceResolver.getParentResourceType
(Resource resource) Returns the super type of the given resource.@Nullable Resource
ResourceResolver.getResource
(Resource base, @NotNull String path) Returns aResource
object for data located at the given path.static @NotNull ValueMap
ResourceUtil.getValueMap
(Resource res) Returns anValueMap
object for the givenResource
.boolean
ResourceResolver.hasChildren
(@NotNull Resource resource) Checks if the specified resource has any direct child resources.static boolean
Deprecated.static boolean
ResourceUtil.isNonExistingResource
(@NotNull Resource res) Returnstrue
if the resourceres
is a non-existing resource.boolean
ResourceResolver.isResourceType
(Resource resource, String resourceType) Returnstrue
if the resource type or any of the resource's super type(s) equals the given resource type.static boolean
ResourceUtil.isStarResource
(@NotNull Resource res) Returnstrue
if the resourceres
is a "star resource".static boolean
ResourceUtil.isSyntheticResource
(@NotNull Resource res) Returnstrue
if the resourceres
is a synthetic resource.ResourceProvider.listChildren
(@NotNull Resource parent) Deprecated.ResourceResolver.listChildren
(@NotNull Resource parent) ResourceUtil.listChildren
(@NotNull Resource parent) Deprecated.since 2.1.0, uselistChildren()
insteadboolean
ResourceResolver.orderBefore
(@NotNull Resource parent, @NotNull String name, @Nullable String followingSiblingName) Orders the child resources returned byResourceResolver.getChildren(Resource)
andResourceResolver.listChildren(Resource)
so that a given resource is listed before the given sibling resource.static @NotNull Resource
Unwrap the resource and return the wrapped implementation.protected abstract void
Implement this method to do actual work on the resources.Method parameters in org.apache.sling.api.resource with type arguments of type ResourceModifier and TypeMethodDescriptionstatic <T> @NotNull Iterator<T>
Return an iterator for objects of the specified type.protected void
AbstractResourceVisitor.traverseChildren
(@NotNull Iterator<Resource> children) Visit the given resources.Constructors in org.apache.sling.api.resource with parameters of type ResourceModifierConstructorDescriptionResourceWrapper
(@NotNull Resource resource) Creates a new wrapper instance delegating all method calls to the givenresource
. -
Uses of Resource in org.apache.sling.api.resource.external
Methods in org.apache.sling.api.resource.external with parameters of type ResourceModifier and TypeMethodDescription@NotNull URI
URIProvider.toURI
(@NotNull Resource resource, URIProvider.Scope scope, URIProvider.Operation operation) Return a URI applicable to the defined scope. -
Uses of Resource in org.apache.sling.api.scripting
Methods in org.apache.sling.api.scripting that return ResourceModifier and TypeMethodDescription@Nullable Resource
SlingBindings.getResource()
@NotNull Resource
SlingScript.getScriptResource()
Returns the Resource providing the script source code.Methods in org.apache.sling.api.scripting with parameters of type ResourceModifier and TypeMethodDescriptionvoid
Same asSlingScriptHelper.forward(Resource,RequestDispatcherOptions)
, but using empty options.void
Helper method to forward the request to a Servlet or script for the givenresource
andrequestDispatcherOptions
.void
SlingScriptHelper.forward
(@NotNull Resource resource, RequestDispatcherOptions options) Helper method to forward the request to a Servlet or script for the givenresource
andoptions
.void
Same asSlingScriptHelper.include(Resource,RequestDispatcherOptions)
, but using empty options.void
Helper method to include the result of processing the request for the givenresource
andrequestDispatcherOptions
.void
SlingScriptHelper.include
(@NotNull Resource resource, RequestDispatcherOptions options) Helper method to include the result of processing the request for the givenresource
andoptions
.void
SlingBindings.setResource
(Resource resource) -
Uses of Resource in org.apache.sling.api.security
Methods in org.apache.sling.api.security that return ResourceModifier and TypeMethodDescription@Nullable Resource
ResourceAccessSecurity.getReadableResource
(Resource resource) If supplied Resource can be read, return it (or a wrapped variant of it).Methods in org.apache.sling.api.security with parameters of type ResourceModifier and TypeMethodDescriptionboolean
Check whether a resource can be deleted at the path.boolean
ResourceAccessSecurity.canDeleteValue
(@NotNull Resource resource, @NotNull String valueName) Check whether a value can be deletedboolean
ResourceAccessSecurity.canExecute
(@NotNull Resource resource) Check whether a resource can be executed at the path.default boolean
ResourceAccessSecurity.canOrderChildren
(@NotNull Resource resource) Check whether child resources can be ordered.boolean
ResourceAccessSecurity.canReadValue
(@NotNull Resource resource, @NotNull String valueName) Check whether a value can be readboolean
ResourceAccessSecurity.canSetValue
(@NotNull Resource resource, @NotNull String valueName) Check whether a value can be setboolean
Check whether a resource can be updated at the path.@Nullable Resource
ResourceAccessSecurity.getReadableResource
(Resource resource) If supplied Resource can be read, return it (or a wrapped variant of it). -
Uses of Resource in org.apache.sling.api.servlets
Methods in org.apache.sling.api.servlets with parameters of type ResourceModifier and TypeMethodDescription@Nullable jakarta.servlet.Servlet
Resolves ajakarta.servlet.Servlet
whoseservice
method may be used to handle a request.javax.servlet.Servlet
ServletResolver.resolveServlet
(@NotNull Resource resource, @NotNull String scriptName) Deprecated.UseServletResolver.resolve(Resource, String)
instead. -
Uses of Resource in org.apache.sling.api.uri
Methods in org.apache.sling.api.uri that return ResourceModifier and TypeMethodDescription@Nullable Resource
SlingUri.getSuffixResource()
Returns the corresponding suffix resource or null if no resource resolver is available (depends on the create method used in SlingUriBuilder) the URI does not contain a suffix if the suffix resource could not be found@Nullable Resource
SlingUriBuilder.getSuffixResource()
Returns the corresponding suffix resource or null if no resource resolver is available (depends on the create method used in SlingUriBuilder) the URI does not contain a suffix if the suffix resource could not be foundMethods in org.apache.sling.api.uri with parameters of type ResourceModifier and TypeMethodDescriptionstatic @NotNull SlingUriBuilder
SlingUriBuilder.createFrom
(@NotNull Resource resource) Creates a builder from a resource (only taking the resource path into account). -
Uses of Resource in org.apache.sling.api.wrappers
Methods in org.apache.sling.api.wrappers that return ResourceModifier and TypeMethodDescriptionWraps theResource
obtained by callingcopy
on the wrapped resource resolver.@NotNull Resource
ResourceResolverWrapper.create
(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Wraps theResource
obtained by callingcreate
on the wrapped resource resolver.Wraps and returns theResource
obtained by callinggetParent
on the wrapped resource resolver.@NotNull Resource
JakartaToJavaxRequestWrapper.getResource()
@NotNull Resource
JavaxToJakartaRequestWrapper.getResource()
ResourceResolverWrapper.getResource
(@NotNull String path) Wraps and returns theResource
obtained by callinggetResource
on the wrapped resource resolver.ResourceResolverWrapper.getResource
(Resource base, @NotNull String path) Wraps and returns theResource
obtained by callinggetResource
on the wrapped resource resolver.SlingHttpServletRequestWrapper.getResource()
Deprecated.SlingJakartaHttpServletRequestWrapper.getResource()
@Nullable Resource
RequestPathInfoWrapper.getSuffixResource()
Wraps theResource
obtained by callingmove
on the wrapped resource resolver.@NotNull Resource
ResourceResolverWrapper.resolve
(@NotNull jakarta.servlet.http.HttpServletRequest request, @NotNull String absPath) Wraps and returns theResource
obtained by callingresolve
on the wrapped resource resolver.@NotNull Resource
Wraps and returns theResource
obtained by callingresolve
on the wrapped resource resolver.@NotNull Resource
ResourceResolverWrapper.resolve
(javax.servlet.http.HttpServletRequest request) Wraps and returns theResource
obtained by callingresolve
on the wrapped resource resolver.@NotNull Resource
ResourceResolverWrapper.resolve
(javax.servlet.http.HttpServletRequest request, @NotNull String absPath) Deprecated.Methods in org.apache.sling.api.wrappers that return types with arguments of type ResourceModifier and TypeMethodDescriptionResourceResolverWrapper.findResources
(@NotNull String query, String language) Wraps and returns theIterator
obtained by callingfindResources
on the wrapped resource resolver.ResourceResolverWrapper.getChildren
(@NotNull Resource parent) Wraps and returns theIterable
obtained by callinggetChildren
on the wrapped resource resolver.ResourceResolverWrapper.listChildren
(@NotNull Resource parent) Wraps and returns theIterator
obtained by callinglistChildren
on the wrapped resource resolver.Methods in org.apache.sling.api.wrappers with parameters of type ResourceModifier and TypeMethodDescription@NotNull Resource
ResourceResolverWrapper.create
(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Wraps theResource
obtained by callingcreate
on the wrapped resource resolver.void
ResourceResolverWrapper.getChildren
(@NotNull Resource parent) Wraps and returns theIterable
obtained by callinggetChildren
on the wrapped resource resolver.Wraps and returns theResource
obtained by callinggetParent
on the wrapped resource resolver.ResourceResolverWrapper.getParentResourceType
(Resource resource) @Nullable javax.servlet.RequestDispatcher
JakartaToJavaxRequestWrapper.getRequestDispatcher
(@NotNull Resource resource) @Nullable javax.servlet.RequestDispatcher
JakartaToJavaxRequestWrapper.getRequestDispatcher
(@NotNull Resource resource, RequestDispatcherOptions options) @Nullable jakarta.servlet.RequestDispatcher
JavaxToJakartaRequestWrapper.getRequestDispatcher
(@NotNull Resource resource) @Nullable jakarta.servlet.RequestDispatcher
JavaxToJakartaRequestWrapper.getRequestDispatcher
(@NotNull Resource resource, RequestDispatcherOptions options) javax.servlet.RequestDispatcher
SlingHttpServletRequestWrapper.getRequestDispatcher
(Resource resource) Deprecated.javax.servlet.RequestDispatcher
SlingHttpServletRequestWrapper.getRequestDispatcher
(Resource resource, RequestDispatcherOptions options) Deprecated.jakarta.servlet.RequestDispatcher
SlingJakartaHttpServletRequestWrapper.getRequestDispatcher
(Resource resource) jakarta.servlet.RequestDispatcher
SlingJakartaHttpServletRequestWrapper.getRequestDispatcher
(Resource resource, RequestDispatcherOptions options) ResourceResolverWrapper.getResource
(Resource base, @NotNull String path) Wraps and returns theResource
obtained by callinggetResource
on the wrapped resource resolver.boolean
ResourceResolverWrapper.hasChildren
(@NotNull Resource resource) boolean
ResourceResolverWrapper.isResourceType
(Resource resource, String resourceType) ResourceResolverWrapper.listChildren
(@NotNull Resource parent) Wraps and returns theIterator
obtained by callinglistChildren
on the wrapped resource resolver.boolean
ResourceResolverWrapper.orderBefore
(@NotNull Resource parent, @NotNull String name, @Nullable String followingSiblingName) Constructors in org.apache.sling.api.wrappers with parameters of type ResourceModifierConstructorDescriptionDeepReadModifiableValueMapDecorator
(Resource resource, ValueMap base) DeepReadValueMapDecorator
(Resource resource, ValueMap base) -
Uses of Resource in org.apache.sling.spi.resource.provider
Methods in org.apache.sling.spi.resource.provider that return ResourceModifier and TypeMethodDescription@NotNull Resource
Create a new resource at the given path.@Nullable Resource
ResourceProvider.getParent
(@NotNull ResolveContext<T> ctx, @NotNull Resource child) Returns the parent resource from this resource provider ornull
if the resource provider cannot find it.abstract @Nullable Resource
ResourceProvider.getResource
(@NotNull ResolveContext<T> ctx, @NotNull String path, @NotNull ResourceContext resourceContext, @Nullable Resource parent) Returns a resource from this resource provider ornull
if the resource provider cannot find it.Methods in org.apache.sling.spi.resource.provider that return types with arguments of type ResourceModifier and TypeMethodDescriptionQueryLanguageProvider.findResources
(@NotNull ResolveContext<T> ctx, String query, String language) Searches for resources using the given query formulated in the given language.ResourceProvider.listChildren
(@NotNull ResolveContext<T> ctx, @NotNull Resource parent) Methods in org.apache.sling.spi.resource.provider with parameters of type ResourceModifier and TypeMethodDescriptionvoid
ResourceProvider.delete
(@NotNull ResolveContext<T> ctx, @NotNull Resource resource) Delete the resource at the given path.@Nullable Resource
ResourceProvider.getParent
(@NotNull ResolveContext<T> ctx, @NotNull Resource child) Returns the parent resource from this resource provider ornull
if the resource provider cannot find it.abstract @Nullable Resource
ResourceProvider.getResource
(@NotNull ResolveContext<T> ctx, @NotNull String path, @NotNull ResourceContext resourceContext, @Nullable Resource parent) Returns a resource from this resource provider ornull
if the resource provider cannot find it.ResourceProvider.listChildren
(@NotNull ResolveContext<T> ctx, @NotNull Resource parent) boolean
ResourceProvider.orderBefore
(@NotNull ResolveContext<T> ctx, @NotNull Resource parent, @NotNull String name, @Nullable String followingSiblingName) Orders the child resources returned byResourceProvider.listChildren(ResolveContext, Resource)
so that a given resource is listed before the given sibling resource.