public interface ResourceManager
ResourceManager
defines the API which might be asked to find,
copy, move and delete specific resources
.
Implementors should ensure that a ResourceManager can be retrieved adapting a
SlingHttpServletRequest
by implementing an
AdapterFactory
.
Modifier and Type | Method and Description |
---|---|
boolean |
copy(Resource resource,
java.lang.String destUri,
int depth)
Copies all properties and resources of the implementor to the
destUri . |
java.util.List<Resource> |
find(Resource resource,
java.lang.String query)
Returns the query result from the provided
query statement as a
List . |
boolean |
move(Resource resource,
java.lang.String destUri)
Moves all properties and resources of the implementor to the
destUri . |
boolean copy(Resource resource, java.lang.String destUri, int depth) throws java.lang.UnsupportedOperationException, RequestException, RestException
destUri
. The method expects the destUri
to be a
non-remote URI, absolute, normalized and within the same name space as
the resource
.
The method should throw a RequestException
with a HTTP status 403
if the destination is not part of the resources ResourceProvider name
space. If the parent resource of the destination does not exist the
method should throw a RequestException
with the HTTP status code
412. In case an error occurs while copying one of the resources child
elements a RequestException
with HTTP status code 207 pointing to
the failing resource should be thrown.
resource
- Resource to copydestUri
- Destination URI to copy resource todepth
- Depth value indicating the depth of the copy. A value of -1
is equal to infinite, a value of 0 indicates that only the
resource itself and its properties should be copied but no
children.true
if destination has been created, false
if it
has been overwritten.java.lang.UnsupportedOperationException
- If the operation is not supported
for the resource
RequestException
- if a precondition for the operation is not metRestException
- if an error occurs during the operationboolean move(Resource resource, java.lang.String destUri) throws java.lang.UnsupportedOperationException, RequestException, RestException
destUri
. The method expects the destUri
to be a
non-remote URI, absolute, normalized and within the same name space as
the resource
. The method should throw a RequestException
with a HTTP status 403 if the destination is not part of the resources
ResourceProvider name space. If the parent resource of the destination
does not exist the method should throw a RequestException
with
the HTTP status code 412. In case an error occurs while copying one of
the resources child elements a RequestException
with HTTP status
code 207 pointing to the failing resource should be thrown.resource
- Resource to movedestUri
- Destination URI to move resource totrue
if destination has been created, false
if it
has been overwritten.java.lang.UnsupportedOperationException
- If the operation is not supported
for the resource
RequestException
- if a precondition for the operation is not metRestException
- if an error occurs during the operationjava.util.List<Resource> find(Resource resource, java.lang.String query) throws java.lang.UnsupportedOperationException, RequestException, RestException
query
statement as a
List
.resource
- Base resource. Is used as a starting point in the tree to
search from.query
- Query statementList
of resources
found matching the
queryjava.lang.UnsupportedOperationException
- If the operation is not supported
for the resource
RequestException
- if a precondition for the operation is not metRestException
- if an error occurs during the search"Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"