Uses of Interface
org.apache.sling.api.resource.Resource
Packages that use Resource
Package
Description
API for accessing context-aware configuration.
Management API of the Context-Aware configuration implementation.
Multiplexer services provide aggregated access to all implementations of the related SPI interface.
API for accessing context-aware configuration resources.
SPI for applications hooking into the configuration resource infrastructure for parameterizing and customizing.
SPI for applications hooking into the configuration infrastructure for parameterizing and customizing.
Provides topology announcement implementations for discovery
implementors that choose to extend from discovery.base
Provides some static helpers for providers of the Discovery API.
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.
-
Uses of Resource in org.apache.sling.api
Methods in org.apache.sling.api that return ResourceModifier and TypeMethodDescription@NotNull ResourceSlingHttpServletRequest.getResource()Deprecated.Returns theResourceobject on whose behalf the servlet acts.@NotNull ResourceSlingJakartaHttpServletRequest.getResource()Returns theResourceobject on whose behalf the servlet acts.Methods in org.apache.sling.api with parameters of type ResourceModifier and TypeMethodDescription@Nullable javax.servlet.RequestDispatcherSlingHttpServletRequest.getRequestDispatcher(@NotNull Resource resource) Deprecated.Same asSlingHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)but using empty options.@Nullable javax.servlet.RequestDispatcherSlingHttpServletRequest.getRequestDispatcher(@NotNull Resource resource, RequestDispatcherOptions options) Deprecated.Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given resource.@Nullable jakarta.servlet.RequestDispatcherSlingJakartaHttpServletRequest.getRequestDispatcher(@NotNull Resource resource) Same asSlingJakartaHttpServletRequest.getRequestDispatcher(Resource,RequestDispatcherOptions)but using empty options.@Nullable jakarta.servlet.RequestDispatcherSlingJakartaHttpServletRequest.getRequestDispatcher(@NotNull Resource resource, RequestDispatcherOptions options) Returns aRequestDispatcherobject 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 ResourceRequestPathInfo.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 SlingHttpServletRequestBuilderBuilders.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 TypeClassDescriptionclassTheAbstractResourceis an abstract implementation of theResourceinterface.final classSimple helper class representing nonexisting resources.classTheResourceWrapperis a wrapper for anyResourcedelegating all method calls to the wrapped resource by default.classTheSyntheticResourceclass is a simple implementation of theResourceinterface 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 atsrcAbsPathto the new location atdestAbsPathand 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 ResourceResourceResolver.create(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Add a child resource to the given parent resource.@Nullable ResourceDecorate a resource.default @Nullable ResourceResourceDecorator.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 ResourceReturns the child at the given relative path of this resource ornullif no such child exists.Returns the value of callinggetChildon thewrapped resource.static @NotNull ResourceResourceUtil.getOrCreateResource(@NotNull ResourceResolver resolver, @NotNull String path, String resourceType, String intermediateResourceType, boolean autoCommit) Creates or gets the resource at the given path.static @NotNull ResourceResourceUtil.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 ResourceResource.getParent()Returns the parent resource ornullif this resource represents the root of the resource tree.@Nullable ResourceReturns the parent resource of this resource.static @Nullable ResourceDeprecated.since 2.1.0, usegetParent()insteadResourceWrapper.getParent()Returns the value of callinggetParenton thewrapped resource.@Nullable ResourceParametrizableResourceProvider.getResource(@NotNull ResourceResolver resourceResolver, @NotNull String path, @NotNull Map<String, String> parameters) Deprecated.Returns a resource from this resource provider ornullif the resource provider cannot find it.@Nullable ResourceResourceProvider.getResource(@NotNull ResourceResolver resourceResolver, @NotNull String path) Deprecated.Returns a resource from this resource provider ornullif the resource provider cannot find it.@Nullable ResourceResourceProvider.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 ResourceResourceResolver.getResource(@NotNull String path) Returns aResourceobject for data located at the given path.@Nullable ResourceResourceResolver.getResource(Resource base, @NotNull String path) Returns aResourceobject for data located at the given path.@NotNull ResourceResourceWrapper.getResource()Returns theResourcewrapped by this instance.This method moves the subgraph rooted at, and including, the resource atsrcAbsPathto the new location atdestAbsPathand adds it as a child node of the resource atdestAbsPath.@NotNull ResourceResourceResolver.resolve(@NotNull jakarta.servlet.http.HttpServletRequest request, @NotNull String absPath) Resolves the resource from the givenabsPathoptionally takingHttpServletRequestinto account, such as the value of theHostrequest header.@NotNull ResourceResolves the resource from the given absolute path.@NotNull ResourceResourceResolver.resolve(javax.servlet.http.HttpServletRequest request) Deprecated.as of 2.0.4, useResourceResolver.resolve(HttpServletRequest, String)instead.@NotNull ResourceDeprecated.UseResourceResolver.resolve(HttpServletRequest, String)instead.static @NotNull ResourceUnwrap 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 callinglistChildrenon thewrapped resource.Methods in org.apache.sling.api.resource with parameters of type ResourceModifier and TypeMethodDescriptionvoidVisit the given resource and all its descendants.@NotNull ResourceResourceResolver.create(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Add a child resource to the given parent resource.static StringResourceUtil.createUniqueChildName(Resource parent, String name) Create a unique name for a child of theparent.@Nullable ResourceDecorate a resource.default @Nullable ResourceResourceDecorator.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.voidDelete the resource Deleting a non existing resource leads to no operation nor exception.voidstatic @Nullable StringResourceUtil.findResourceSuperType(@NotNull Resource resource) Deprecated.ResourceResolver.getChildren(@NotNull Resource parent) static @NotNull StringDeprecated.since 2.1.0, usegetName()instead@Nullable ResourceReturns the parent resource of this resource.static @Nullable ResourceDeprecated.since 2.1.0, usegetParent()instead@Nullable StringResourceResolver.getParentResourceType(Resource resource) Returns the super type of the given resource.@Nullable ResourceResourceResolver.getResource(Resource base, @NotNull String path) Returns aResourceobject for data located at the given path.static @NotNull ValueMapResourceUtil.getValueMap(Resource res) Returns anValueMapobject for the givenResource.booleanResourceResolver.hasChildren(@NotNull Resource resource) Checks if the specified resource has any direct child resources.static booleanDeprecated.static booleanResourceUtil.isNonExistingResource(@NotNull Resource res) Returnstrueif the resourceresis a non-existing resource.booleanResourceResolver.isResourceType(Resource resource, String resourceType) Returnstrueif the resource type or any of the resource's super type(s) equals the given resource type.static booleanResourceUtil.isStarResource(@NotNull Resource res) Returnstrueif the resourceresis a "star resource".static booleanResourceUtil.isSyntheticResource(@NotNull Resource res) Returnstrueif the resourceresis 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()insteadbooleanResourceResolver.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 ResourceUnwrap the resource and return the wrapped implementation.protected abstract voidImplement 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 voidAbstractResourceVisitor.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 URIURIProvider.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 ResourceSlingBindings.getResource()@NotNull ResourceSlingScript.getScriptResource()Returns the Resource providing the script source code.Methods in org.apache.sling.api.scripting with parameters of type ResourceModifier and TypeMethodDescriptionvoidSame asSlingScriptHelper.forward(Resource,RequestDispatcherOptions), but using empty options.voidHelper method to forward the request to a Servlet or script for the givenresourceandrequestDispatcherOptions.voidSlingScriptHelper.forward(@NotNull Resource resource, RequestDispatcherOptions options) Helper method to forward the request to a Servlet or script for the givenresourceandoptions.voidSame asSlingScriptHelper.include(Resource,RequestDispatcherOptions), but using empty options.voidHelper method to include the result of processing the request for the givenresourceandrequestDispatcherOptions.voidSlingScriptHelper.include(@NotNull Resource resource, RequestDispatcherOptions options) Helper method to include the result of processing the request for the givenresourceandoptions.voidSlingBindings.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 ResourceResourceAccessSecurity.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 TypeMethodDescriptionbooleanCheck whether a resource can be deleted at the path.booleanResourceAccessSecurity.canDeleteValue(@NotNull Resource resource, @NotNull String valueName) Check whether a value can be deletedbooleanResourceAccessSecurity.canExecute(@NotNull Resource resource) Check whether a resource can be executed at the path.default booleanResourceAccessSecurity.canOrderChildren(@NotNull Resource resource) Check whether child resources can be ordered.booleanResourceAccessSecurity.canReadValue(@NotNull Resource resource, @NotNull String valueName) Check whether a value can be readbooleanResourceAccessSecurity.canSetValue(@NotNull Resource resource, @NotNull String valueName) Check whether a value can be setbooleanCheck whether a resource can be updated at the path.@Nullable ResourceResourceAccessSecurity.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.ServletResolves ajakarta.servlet.Servletwhoseservicemethod may be used to handle a request.javax.servlet.ServletServletResolver.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 ResourceSlingUri.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 ResourceSlingUriBuilder.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 SlingUriBuilderSlingUriBuilder.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 theResourceobtained by callingcopyon the wrapped resource resolver.@NotNull ResourceResourceResolverWrapper.create(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Wraps theResourceobtained by callingcreateon the wrapped resource resolver.Wraps and returns theResourceobtained by callinggetParenton the wrapped resource resolver.@NotNull ResourceJakartaToJavaxRequestWrapper.getResource()@NotNull ResourceJavaxToJakartaRequestWrapper.getResource()ResourceResolverWrapper.getResource(@NotNull String path) Wraps and returns theResourceobtained by callinggetResourceon the wrapped resource resolver.ResourceResolverWrapper.getResource(Resource base, @NotNull String path) Wraps and returns theResourceobtained by callinggetResourceon the wrapped resource resolver.SlingHttpServletRequestWrapper.getResource()Deprecated.SlingJakartaHttpServletRequestWrapper.getResource()@Nullable ResourceRequestPathInfoWrapper.getSuffixResource()Wraps theResourceobtained by callingmoveon the wrapped resource resolver.@NotNull ResourceResourceResolverWrapper.resolve(@NotNull jakarta.servlet.http.HttpServletRequest request, @NotNull String absPath) Wraps and returns theResourceobtained by callingresolveon the wrapped resource resolver.@NotNull ResourceWraps and returns theResourceobtained by callingresolveon the wrapped resource resolver.@NotNull ResourceResourceResolverWrapper.resolve(javax.servlet.http.HttpServletRequest request) Wraps and returns theResourceobtained by callingresolveon the wrapped resource resolver.@NotNull ResourceResourceResolverWrapper.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 theIteratorobtained by callingfindResourceson the wrapped resource resolver.ResourceResolverWrapper.getChildren(@NotNull Resource parent) Wraps and returns theIterableobtained by callinggetChildrenon the wrapped resource resolver.ResourceResolverWrapper.listChildren(@NotNull Resource parent) Wraps and returns theIteratorobtained by callinglistChildrenon the wrapped resource resolver.Methods in org.apache.sling.api.wrappers with parameters of type ResourceModifier and TypeMethodDescription@NotNull ResourceResourceResolverWrapper.create(@NotNull Resource parent, @NotNull String name, Map<String, Object> properties) Wraps theResourceobtained by callingcreateon the wrapped resource resolver.voidResourceResolverWrapper.getChildren(@NotNull Resource parent) Wraps and returns theIterableobtained by callinggetChildrenon the wrapped resource resolver.Wraps and returns theResourceobtained by callinggetParenton the wrapped resource resolver.ResourceResolverWrapper.getParentResourceType(Resource resource) @Nullable javax.servlet.RequestDispatcherJakartaToJavaxRequestWrapper.getRequestDispatcher(@NotNull Resource resource) @Nullable javax.servlet.RequestDispatcherJakartaToJavaxRequestWrapper.getRequestDispatcher(@NotNull Resource resource, RequestDispatcherOptions options) @Nullable jakarta.servlet.RequestDispatcherJavaxToJakartaRequestWrapper.getRequestDispatcher(@NotNull Resource resource) @Nullable jakarta.servlet.RequestDispatcherJavaxToJakartaRequestWrapper.getRequestDispatcher(@NotNull Resource resource, RequestDispatcherOptions options) javax.servlet.RequestDispatcherSlingHttpServletRequestWrapper.getRequestDispatcher(Resource resource) Deprecated.javax.servlet.RequestDispatcherSlingHttpServletRequestWrapper.getRequestDispatcher(Resource resource, RequestDispatcherOptions options) Deprecated.jakarta.servlet.RequestDispatcherSlingJakartaHttpServletRequestWrapper.getRequestDispatcher(Resource resource) jakarta.servlet.RequestDispatcherSlingJakartaHttpServletRequestWrapper.getRequestDispatcher(Resource resource, RequestDispatcherOptions options) ResourceResolverWrapper.getResource(Resource base, @NotNull String path) Wraps and returns theResourceobtained by callinggetResourceon the wrapped resource resolver.booleanResourceResolverWrapper.hasChildren(@NotNull Resource resource) booleanResourceResolverWrapper.isResourceType(Resource resource, String resourceType) ResourceResolverWrapper.listChildren(@NotNull Resource parent) Wraps and returns theIteratorobtained by callinglistChildrenon the wrapped resource resolver.booleanResourceResolverWrapper.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.caconfig
Methods in org.apache.sling.caconfig with parameters of type ResourceModifier and TypeMethodDescription@NotNull ConfigurationBuilderGet configuration for given resource. -
Uses of Resource in org.apache.sling.caconfig.management
Methods in org.apache.sling.caconfig.management with parameters of type ResourceModifier and TypeMethodDescriptionvoidConfigurationManager.deleteConfiguration(@NotNull Resource resource, @NotNull String configName) Delete configuration or configuration collection data from repository using the inner-most context path as reference.@Nullable ConfigurationDataConfigurationManager.getConfiguration(@NotNull Resource resource, @NotNull String configName) Get configuration data for the given context resource and configuration name.@NotNull ConfigurationCollectionDataConfigurationManager.getConfigurationCollection(@NotNull Resource resource, @NotNull String configName) Get configuration data collection for the given context resource and configuration name.@Nullable ConfigurationDataConfigurationManager.newCollectionItem(@NotNull Resource resource, @NotNull String configName) Creates a new empty configuration data item for a configuration data collection for the given configuration name.voidConfigurationManager.persistConfiguration(@NotNull Resource resource, @NotNull String configName, @NotNull ConfigurationPersistData data) Write configuration data to repository using the inner-most context path as reference.voidConfigurationManager.persistConfigurationCollection(@NotNull Resource resource, @NotNull String configName, @NotNull ConfigurationCollectionPersistData data) Write configuration data collection using the inner-most context path as reference. -
Uses of Resource in org.apache.sling.caconfig.management.multiplexer
Methods in org.apache.sling.caconfig.management.multiplexer that return ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationOverrideMultiplexer.overrideProperties(@NotNull String contextPath, @NotNull String configName, @Nullable Resource configResource) Deprecated.@Nullable ResourceConfigurationOverrideMultiplexer.overrideProperties(@NotNull String contextPath, @NotNull String configName, @Nullable Resource configResource, @NotNull ResourceResolver resourceResolver) Override properties in given configuration resource (if any overrides are defined).Methods in org.apache.sling.caconfig.management.multiplexer with parameters of type ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationOverrideMultiplexer.overrideProperties(@NotNull String contextPath, @NotNull String configName, @Nullable Resource configResource) Deprecated.@Nullable ResourceConfigurationOverrideMultiplexer.overrideProperties(@NotNull String contextPath, @NotNull String configName, @Nullable Resource configResource, @NotNull ResourceResolver resourceResolver) Override properties in given configuration resource (if any overrides are defined). -
Uses of Resource in org.apache.sling.caconfig.resource
Methods in org.apache.sling.caconfig.resource that return ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationResourceResolver.getResource(@NotNull Resource resource, @NotNull String bucketName, @NotNull String configName) Get a context-aware singleton configuration resource defined by the given configuration name.Methods in org.apache.sling.caconfig.resource that return types with arguments of type ResourceModifier and TypeMethodDescription@NotNull Collection<Resource> ConfigurationResourceResolver.getResourceCollection(@NotNull Resource resource, @NotNull String bucketName, @NotNull String configName) Get a collection of context-aware configuration resources defined by the given configuration name.Methods in org.apache.sling.caconfig.resource with parameters of type ResourceModifier and TypeMethodDescription@NotNull Collection<String> ConfigurationResourceResolver.getAllContextPaths(@NotNull Resource resource) Get all context paths for which context-aware configurations could be defined.ConfigurationResourceResolver.getContextPath(@NotNull Resource resource) Get the inner-most context path (deepest path) returned byConfigurationResourceResolver.getAllContextPaths(Resource).@Nullable ResourceConfigurationResourceResolver.getResource(@NotNull Resource resource, @NotNull String bucketName, @NotNull String configName) Get a context-aware singleton configuration resource defined by the given configuration name.@NotNull Collection<Resource> ConfigurationResourceResolver.getResourceCollection(@NotNull Resource resource, @NotNull String bucketName, @NotNull String configName) Get a collection of context-aware configuration resources defined by the given configuration name. -
Uses of Resource in org.apache.sling.caconfig.resource.spi
Methods in org.apache.sling.caconfig.resource.spi that return ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationResourceResolvingStrategy.getResource(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a context-aware singleton configuration resource defined by the given configuration name.@NotNull ResourceContextResource.getResource()Methods in org.apache.sling.caconfig.resource.spi that return types with arguments of type ResourceModifier and TypeMethodDescription@Nullable Collection<Resource> ConfigurationResourceResolvingStrategy.getResourceCollection(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a collection of context-aware configuration resources defined by the given configuration name.@Nullable Collection<Iterator<Resource>> ConfigurationResourceResolvingStrategy.getResourceCollectionInheritanceChain(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a collection of context-aware configuration resource inheritance chains defined by the given configuration name.ConfigurationResourceResolvingStrategy.getResourceInheritanceChain(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a context-aware singleton configuration resource inheritance chain defined by the given configuration name.Methods in org.apache.sling.caconfig.resource.spi with parameters of type ResourceModifier and TypeMethodDescription@Nullable InheritanceDecisionDecide whether the provided resource should be included in the collection.@NotNull Iterator<ContextResource> ContextPathStrategy.findContextResources(@NotNull Resource resource) Finds context paths for the given resource.@Nullable ResourceConfigurationResourceResolvingStrategy.getResource(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a context-aware singleton configuration resource defined by the given configuration name.@Nullable Collection<Resource> ConfigurationResourceResolvingStrategy.getResourceCollection(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a collection of context-aware configuration resources defined by the given configuration name.@Nullable Collection<Iterator<Resource>> ConfigurationResourceResolvingStrategy.getResourceCollectionInheritanceChain(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a collection of context-aware configuration resource inheritance chains defined by the given configuration name.@Nullable StringConfigurationResourceResolvingStrategy.getResourceCollectionParentPath(@NotNull Resource resource, @NotNull String bucketName, @NotNull String configName) Get the configuration resource collection parent path for storing configuration data for the given context resource and configuration name.ConfigurationResourceResolvingStrategy.getResourceInheritanceChain(@NotNull Resource resource, @NotNull Collection<String> bucketNames, @NotNull String configName) Get a context-aware singleton configuration resource inheritance chain defined by the given configuration name.@Nullable StringConfigurationResourceResolvingStrategy.getResourcePath(@NotNull Resource resource, @NotNull String bucketName, @NotNull String configName) Get the configuration resource path for storing configuration data for the given context resource and configuration name.Constructors in org.apache.sling.caconfig.resource.spi with parameters of type ResourceModifierConstructorDescriptionContextResource(@NotNull Resource resource, String configRef) Deprecated.ContextResource(@NotNull Resource resource, String configRef, int serviceRanking) -
Uses of Resource in org.apache.sling.caconfig.spi
Methods in org.apache.sling.caconfig.spi that return ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationInjectResourceDetectionStrategy.detectResource(@NotNull SlingHttpServletRequest request) Detects the resource that is associated with the given request.@Nullable ResourceConfigurationPersistenceStrategy2.getCollectionItemResource(@NotNull Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.@Nullable ResourceConfigurationPersistenceStrategy2.getCollectionParentResource(@NotNull Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.@Nullable ResourceConfigurationInheritanceStrategy.getResource(@NotNull Iterator<Resource> configResources) Pick or merge resources for inheritance.@Nullable ResourceConfigurationPersistenceStrategy.getResource(@NotNull Resource resource) Deprecated.Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.@Nullable ResourceConfigurationPersistenceStrategy2.getResource(@NotNull Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.Methods in org.apache.sling.caconfig.spi with parameters of type ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationPersistenceStrategy2.getCollectionItemResource(@NotNull Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.@Nullable ResourceConfigurationPersistenceStrategy2.getCollectionParentResource(@NotNull Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.@Nullable ResourceConfigurationPersistenceStrategy.getResource(@NotNull Resource resource) Deprecated.Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.@Nullable ResourceConfigurationPersistenceStrategy2.getResource(@NotNull Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.Method parameters in org.apache.sling.caconfig.spi with type arguments of type ResourceModifier and TypeMethodDescription@Nullable ResourceConfigurationInheritanceStrategy.getResource(@NotNull Iterator<Resource> configResources) Pick or merge resources for inheritance. -
Uses of Resource in org.apache.sling.discovery.base.connectors.announcement
Methods in org.apache.sling.discovery.base.connectors.announcement with parameters of type Resource -
Uses of Resource in org.apache.sling.discovery.commons.providers.util
Methods in org.apache.sling.discovery.commons.providers.util that return ResourceModifier and TypeMethodDescriptionstatic ResourceResourceHelper.getOrCreateResource(ResourceResolver resourceResolver, String path) Methods in org.apache.sling.discovery.commons.providers.util with parameters of type ResourceModifier and TypeMethodDescriptionstatic StringBuilderResourceHelper.getPropertiesForLogging(Resource resource) Compile a string builder containing the properties of a resource - used for loggingstatic voidResourceHelper.moveResource(Resource res, String path) Move resource to given path. -
Uses of Resource in org.apache.sling.jackrabbit.usermanager
Methods in org.apache.sling.jackrabbit.usermanager with parameters of type ResourceModifier and TypeMethodDescriptionvoidDeleteAuthorizables.deleteAuthorizables(javax.jcr.Session jcrSession, Resource baseResource, String[] paths, List<Modification> changes) Deletes one or more users or groups from the repository -
Uses of Resource in org.apache.sling.models.factory
Methods in org.apache.sling.models.factory with parameters of type ResourceModifier and TypeMethodDescription<T> TModelFactory.createModelFromWrappedRequest(@NotNull SlingJakartaHttpServletRequest request, @NotNull Resource resource, @NotNull Class<T> targetClass) Create a wrapped request object with the specified resource and instantiates the given Sling Model class from that wrapped request.<T> TModelFactory.createModelFromWrappedRequest(SlingHttpServletRequest request, @NotNull Resource resource, @NotNull Class<T> targetClass) Deprecated.<T> TModelFactory.exportModelForResource(@NotNull Resource resource, @NotNull String exporterName, @NotNull Class<T> targetClass, @NotNull Map<String, String> options) Export the model object registered to the resource's type using the defined target class using the named exporter.@NotNull ObjectModelFactory.getModelFromResource(@NotNull Resource resource) Obtain an adapted model class based on the resource type of the provided resource.<T> TModelFactory.getModelFromWrappedRequest(@NotNull SlingJakartaHttpServletRequest request, @NotNull Resource resource, @NotNull Class<T> targetClass) Create a wrapped request object with the specified resource and (try to) adapt the request object into the specified class.<T> TModelFactory.getModelFromWrappedRequest(SlingHttpServletRequest request, @NotNull Resource resource, @NotNull Class<T> targetClass) Deprecated.booleanModelFactory.isModelAvailableForResource(@NotNull Resource resource) Determine is a model class is available for the resource's resource type. -
Uses of Resource in org.apache.sling.resource.filter
Fields in org.apache.sling.resource.filter declared as ResourceMethods in org.apache.sling.resource.filter that return types with arguments of type ResourceModifier and TypeMethodDescriptionResourceStream.listChildren(Predicate<Resource> childSelector) Provides a stream of the child resources of the base resource.Creates a Predicate<Resource> based on the provided scriptCreates a Predicate<Resource> based on the provided scriptResourceFilterStream.stream()Stream<Resource> which uses the branchSelector as the basis of the traversal and then filters the resources based on the childSelector that was providedProvides a depth firstStream<Resource>traversal of the resource tree starting with the current resource.Method parameters in org.apache.sling.resource.filter with type arguments of type ResourceModifier and TypeMethodDescriptionResourceStream.listChildren(Predicate<Resource> childSelector) Provides a stream of the child resources of the base resource.Provides a depth firstStream<Resource>traversal of the resource tree starting with the current resource.Constructors in org.apache.sling.resource.filter with parameters of type ResourceModifierConstructorDescriptionResourceFilterStream(Resource resource, ResourcePredicates filter) ResourceStream(Resource resource) -
Uses of Resource in org.apache.sling.scripting.core
Methods in org.apache.sling.scripting.core with parameters of type ResourceModifier and TypeMethodDescriptionvoidvoidvoidScriptHelper.forward(Resource resource, RequestDispatcherOptions options) voidvoidvoidScriptHelper.include(Resource resource, RequestDispatcherOptions options) -
Uses of Resource in org.apache.sling.scripting.javascript.wrapper
Methods in org.apache.sling.scripting.javascript.wrapper with parameters of type ResourceConstructors in org.apache.sling.scripting.javascript.wrapper with parameters of type Resource -
Uses of Resource in org.apache.sling.scripting.jsp.taglib
Methods in org.apache.sling.scripting.jsp.taglib that return ResourceModifier and TypeMethodDescriptionstatic final ResourceSlingFunctions.getAbsoluteParent(Resource current, String level) Method for retrieving an absolute parent resource.GetResourceTag.getBase()Gets the base resource.static final ResourceSlingFunctions.getCAConfigResource(Resource resource, String bucket, String name) Method for retrieving the CA Config resource for a specified resourcestatic ResourceSlingFunctions.getRelativeResource(Resource base, String path) Gets the resource at the relative path to the provided resource.AbstractCATag.getResource()GetParentsTag.getResource()Gets the resource.GetParentTag.getResource()Gets the resource.ListChildrenTag.getResource()Gets the resource of which to list the children.static final ResourceSlingFunctions.getResource(ResourceResolver resolver, String path) Method allow for the retrieval of resources.Methods in org.apache.sling.scripting.jsp.taglib that return types with arguments of type ResourceModifier and TypeMethodDescriptionSlingFunctions.findResources(ResourceResolver resourceResolver, String query, String language) Searches for resources using the given query formulated in the given language.SlingFunctions.getCAConfigResources(Resource resource, String bucket, String name) Method for retrieving the CA Config resources for a specified resourceSlingFunctions.getParents(Resource current, String startDepth) Function for retrieving all of the parent resources of a specified resource, returning them in hierarchy order.SlingFunctions.listChildren(Resource resource) Method for allowing the invocation of the Sling Resource listChildren method.Methods in org.apache.sling.scripting.jsp.taglib with parameters of type ResourceModifier and TypeMethodDescriptionstatic final ResourceSlingFunctions.getAbsoluteParent(Resource current, String level) Method for retrieving an absolute parent resource.static final ResourceSlingFunctions.getCAConfigResource(Resource resource, String bucket, String name) Method for retrieving the CA Config resource for a specified resourceSlingFunctions.getCAConfigResources(Resource resource, String bucket, String name) Method for retrieving the CA Config resources for a specified resourceSlingFunctions.getParents(Resource current, String startDepth) Function for retrieving all of the parent resources of a specified resource, returning them in hierarchy order.static ResourceSlingFunctions.getRelativeResource(Resource base, String path) Gets the resource at the relative path to the provided resource.static final booleanSlingFunctions.hasChildren(Resource resource) Method for checking whether or not a resource has child resources.SlingFunctions.listChildren(Resource resource) Method for allowing the invocation of the Sling Resource listChildren method.voidSets the base resource.voidAbstractCATag.setResource(Resource resource) voidAbstractDispatcherTagHandler.setResource(Resource rsrc) voidEvalTagHandler.setResource(Resource rsrc) voidGetParentsTag.setResource(Resource resource) Sets the resource.voidGetParentTag.setResource(Resource resource) Sets the resource.voidListChildrenTag.setResource(Resource resource) Sets the resource of which to list the children. -
Uses of Resource in org.apache.sling.scripting.sightly.engine
Methods in org.apache.sling.scripting.sightly.engine that return ResourceModifier and TypeMethodDescriptionstatic @Nullable ResourceResourceResolution.getResourceForJakartaRequest(@Nullable ResourceResolver resolver, @Nullable SlingJakartaHttpServletRequest request) Resolves the resource accessed by arequest.static @Nullable ResourceResourceResolution.getResourceForRequest(@Nullable ResourceResolver resolver, SlingHttpServletRequest request) static @Nullable ResourceResourceResolution.getResourceFromSearchPath(@Nullable Resource base, @Nullable String path) Resolves a resource from the search path relative to thebaseresource by traversing thesling:resourceSuperTypechain.Methods in org.apache.sling.scripting.sightly.engine with parameters of type ResourceModifier and TypeMethodDescriptionstatic @Nullable ResourceResourceResolution.getResourceFromSearchPath(@Nullable Resource base, @Nullable String path) Resolves a resource from the search path relative to thebaseresource by traversing thesling:resourceSuperTypechain. -
Uses of Resource in org.apache.sling.scripting.thymeleaf
Methods in org.apache.sling.scripting.thymeleaf with parameters of type ResourceModifier and TypeMethodDescription@Nullable org.thymeleaf.templatemode.TemplateModeTemplateModeProvider.provideTemplateMode(@NotNull Resource resource) -
Uses of Resource in org.apache.sling.servlets.post
Methods in org.apache.sling.servlets.post that return types with arguments of type ResourceModifier and TypeMethodDescriptionAbstractPostOperation.getApplyToResources(SlingHttpServletRequest request) Deprecated.Returns an iterator onResourceinstances addressed in theSlingPostConstants.RP_APPLY_TOrequest parameter. -
Uses of Resource in org.apache.sling.spi.resource.provider
Methods in org.apache.sling.spi.resource.provider that return ResourceModifier and TypeMethodDescription@NotNull ResourceCreate a new resource at the given path.@Nullable ResourceResourceProvider.getParent(@NotNull ResolveContext<T> ctx, @NotNull Resource child) Returns the parent resource from this resource provider ornullif the resource provider cannot find it.abstract @Nullable ResourceResourceProvider.getResource(@NotNull ResolveContext<T> ctx, @NotNull String path, @NotNull ResourceContext resourceContext, @Nullable Resource parent) Returns a resource from this resource provider ornullif 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 TypeMethodDescriptionvoidResourceProvider.delete(@NotNull ResolveContext<T> ctx, @NotNull Resource resource) Delete the resource at the given path.@Nullable ResourceResourceProvider.getParent(@NotNull ResolveContext<T> ctx, @NotNull Resource child) Returns the parent resource from this resource provider ornullif the resource provider cannot find it.abstract @Nullable ResourceResourceProvider.getResource(@NotNull ResolveContext<T> ctx, @NotNull String path, @NotNull ResourceContext resourceContext, @Nullable Resource parent) Returns a resource from this resource provider ornullif the resource provider cannot find it.ResourceProvider.listChildren(@NotNull ResolveContext<T> ctx, @NotNull Resource parent) booleanResourceProvider.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. -
Uses of Resource in org.apache.sling.validation
Methods in org.apache.sling.validation with parameters of type ResourceModifier and TypeMethodDescription@Nullable ValidationModelValidationService.getValidationModel(@NotNull Resource resource, boolean considerResourceSuperTypeModels) Tries to obtain aValidationModelthat is able to validate the givenresource.@NotNull ValidationResultValidationService.validate(@NotNull Resource resource, @NotNull ValidationModel model) Validates aResourceusing a specificValidationModel.@NotNull ValidationResultValidationService.validateResourceRecursively(@NotNull Resource resource, boolean enforceValidation, Predicate<Resource> filter, boolean considerResourceSuperTypeModels) Validates aResourceand all child resources recursively by traversing through the resource tree starting from the given resource.Method parameters in org.apache.sling.validation with type arguments of type ResourceModifier and TypeMethodDescription@NotNull ValidationResultValidationService.validateResourceRecursively(@NotNull Resource resource, boolean enforceValidation, Predicate<Resource> filter, boolean considerResourceSuperTypeModels) Validates aResourceand all child resources recursively by traversing through the resource tree starting from the given resource. -
Uses of Resource in org.apache.sling.validation.spi
Methods in org.apache.sling.validation.spi that return Resource