org.apache.sling.api.resource

Interface ResourceDecorator

@ConsumerType
public interface ResourceDecorator

Optional service to decorate Resources returned by the ResourceResolver. Typical use cases for a decorator are - overwrite resource type/resource super type (for example based on the resource path) - add metadata

Since:

2.1 (Sling API Bundle 2.1.0)

Method Summary

Methods

Modifier and Type	Method and Description
Resource	decorate(Resource resource) Decorate a resource.
Resource	decorate(Resource resource, javax.servlet.http.HttpServletRequest request) Deprecated. since 2.3.0 (and JCR Resource 2.1.0), this method will not be invoked.

Method Detail

decorate

@CheckForNull
Resource decorate(@Nonnull
                             Resource resource)

Decorate a resource. If the service decorates the resource it should return the new resource. If the service does not want to decorate the resource, it should return the original resource. Returning null is considered the same as returning the original resource.

Parameters:

resource - The resource to decorate

Returns:

The decorated resource, the original resource or null.

decorate

@Deprecated
@CheckForNull
Resource decorate(@Nonnull
                                        Resource resource,
                                        @Nonnull
                                        javax.servlet.http.HttpServletRequest request)

Deprecated. since 2.3.0 (and JCR Resource 2.1.0), this method will not be invoked.

Decorate a resource. If the service decorates the resource it should return the new resource. If the service does not want to decorate the resource, it should return the original resource. Returning null is considered the same as returning the original resource.

Parameters:

resource - The resource to decorate

request - The current request.

Returns:

The decorated resource, the original resource or null.