Class JcrResourceProvider
-
Field Summary
Fields inherited from class org.apache.sling.spi.resource.provider.ResourceProvider
AUTH_ADMIN, AUTH_CLONE, AUTH_SERVICE_BUNDLE, AUTHENTICATE_LAZY, AUTHENTICATE_NO, AUTHENTICATE_REQUIRED, MODE_OVERLAY, MODE_PASSTHROUGH, PROPERTY_ADAPTABLE, PROPERTY_ATTRIBUTABLE, PROPERTY_AUTHENTICATE, PROPERTY_MODE, PROPERTY_MODIFIABLE, PROPERTY_NAME, PROPERTY_REFRESHABLE, PROPERTY_ROOT, PROPERTY_USE_RESOURCE_ACCESS_SECURITY, RESOURCE_TYPE_SYNTHETIC
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
activate
(org.osgi.service.component.ComponentContext context, org.apache.sling.jcr.resource.internal.helper.jcr.JcrResourceProvider.Configuration configuration) <AdapterType>
AdapterTypeadaptTo
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull Class<AdapterType> type) Adapts the provider to another type.@NotNull org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState
authenticate
(@NotNull Map<String, Object> authenticationInfo) Create a new ResourceResolver wrapping a Session object.protected void
bindDynamicClassLoaderManager
(DynamicClassLoaderManager dynamicClassLoaderManager) void
commit
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Commit all transient changes: create, delete and updatesboolean
copy
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull String srcAbsPath, @NotNull String destAbsPath) This 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
.@NotNull Resource
create
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @Nullable String path, @Nullable Map<String, Object> properties) Create a new resource at the given path.protected void
void
delete
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull Resource resource) Delete the resource at the given path.@Nullable Object
getAttribute
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull String name) Returns the value of the given resource provider attribute ornull
if the attribute is not set or not visible (as e.g. security sensitive attributes).@NotNull Collection<String>
getAttributeNames
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Returns a collection of attribute names whose value can be retrieved calling theResourceProvider.getAttribute(ResolveContext, String)
method.protected static @Nullable String
getNodeType
(@Nullable Map<String, Object> properties, @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) @Nullable Resource
getParent
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull Resource child) Returns the parent resource from this resource provider ornull
if the resource provider cannot find it.@Nullable QueryLanguageProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
Get the optional query language provider.@Nullable Resource
getResource
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull String path, @NotNull ResourceContext rCtx, @Nullable Resource parent) Returns a resource from this resource provider ornull
if the resource provider cannot find it.boolean
hasChanges
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Are there any transient changes?static boolean
Check if ID addressing is enabled.boolean
isLive
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Returnstrue
if this resource provider has not been closed yet and can still be used.listChildren
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull Resource parent) void
logout
(@Nullable org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState state) If the provider requires authentication, this method is called with the state of the user returned byResourceProvider.authenticate(Map)
once the resource resolver is closed.boolean
move
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull String srcAbsPath, @NotNull String destAbsPath) 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
.boolean
orderBefore
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> 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.void
refresh
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) The provider is updated to reflect the latest state.void
revert
(@NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Revert all transient changes: create, delete and updates.void
start
(@NotNull ProviderContext ctx) With a call to this method, the provider implementation is notified that it is used in the resource tree.void
stop()
With a call to this method, the provider implementation is notified that it is not used anymore in the resource tree.protected void
unbindDynamicClassLoaderManager
(DynamicClassLoaderManager dynamicClassLoaderManager) void
update
(long changeSet) With a call to this method, the provider implementation is notified that any information regarding the registration of the provider has changed.Methods inherited from class org.apache.sling.spi.resource.provider.ResourceProvider
getProviderContext
-
Constructor Details
-
JcrResourceProvider
public JcrResourceProvider()
-
-
Method Details
-
activate
protected void activate(org.osgi.service.component.ComponentContext context, org.apache.sling.jcr.resource.internal.helper.jcr.JcrResourceProvider.Configuration configuration) -
deactivate
protected void deactivate() -
bindDynamicClassLoaderManager
-
unbindDynamicClassLoaderManager
-
start
Description copied from class:ResourceProvider
With a call to this method, the provider implementation is notified that it is used in the resource tree.- Overrides:
start
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- The context for this provider.
-
stop
public void stop()Description copied from class:ResourceProvider
With a call to this method, the provider implementation is notified that it is not used anymore in the resource tree.- Overrides:
stop
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
-
update
public void update(long changeSet) Description copied from class:ResourceProvider
With a call to this method, the provider implementation is notified that any information regarding the registration of the provider has changed. For example, observation listeners might have changed. This method is only called while the provider is used in the resource tree.- Overrides:
update
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
changeSet
- A bit set of provider info that has changed.- See Also:
-
isIdAddressingEnabled
public static boolean isIdAddressingEnabled()Check if ID addressing is enabled.- Returns:
true
if ID addressing is enabled,false
otherwise.
-
authenticate
@NotNull public @NotNull org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState authenticate(@NotNull @NotNull Map<String, Object> authenticationInfo) throws LoginExceptionCreate a new ResourceResolver wrapping a Session object. Carries map of authentication info in order to create a new resolver as needed.- Overrides:
authenticate
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
authenticationInfo
- A map of further credential information which may be used by the implementation to parameterize how the resource resolver is created.- Returns:
- A context data object according to the
authenticationInfo
. - Throws:
LoginException
- If an error occurs authenticating with the provided credential data.- See Also:
-
logout
public void logout(@Nullable @Nullable org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState state) Description copied from class:ResourceProvider
If the provider requires authentication, this method is called with the state of the user returned byResourceProvider.authenticate(Map)
once the resource resolver is closed.- Overrides:
logout
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
state
- The provider state returned byResourceProvider.authenticate(Map)
.
-
isLive
public boolean isLive(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Description copied from class:ResourceProvider
Returnstrue
if this resource provider has not been closed yet and can still be used.This method will never throw an exception even after the resource provider has been closed
This method is only called for resource providers which have a state and require authentication.
- Overrides:
isLive
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.- Returns:
true
if the resource provider has not been closed yet and is still active.. Once the resource provider has been closed or is not active anymore, this method returnsfalse
.
-
getResource
@Nullable public @Nullable Resource getResource(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull String path, @NotNull @NotNull ResourceContext rCtx, @Nullable @Nullable Resource parent) Description copied from class:ResourceProvider
Returns a resource from this resource provider ornull
if the resource provider cannot find it. The path must have theResourceProvider.PROPERTY_ROOT
strings as its prefix. The resource provider must not return cached instances for a resource as the resource resolver will update the resource meta data of the resource at the end of the resolution process and this meta data might be different depending on the full path of resource resolution passed into the resource resolver.- Specified by:
getResource
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.path
- The full path of the resource.rCtx
- Additional information for resolving the resourceparent
- Optional parent resource- Returns:
null
If this provider does not have a resource for the path.
-
listChildren
@Nullable public @Nullable Iterator<Resource> listChildren(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull Resource parent) Description copied from class:ResourceProvider
Returns anIterator
ofResource
objects loaded from the children of the givenResource
. The returnedResource
instances are attached to the sameResourceResolver
as the givenparent
resource.This method may be called for resource providers whose root path list contains a path such that the resource path is a prefix of the list entry. This allows for the enumeration of deeply nested provided resources for which no actual parent hierarchy exists.
The returned iterator may in turn contain resources which do not actually exist but are required to traverse the resource tree. Such resources SHOULD be
SyntheticResource
objects whose resource type MUST be set toResourceProvider.RESOURCE_TYPE_SYNTHETIC
. As withResourceProvider.getResource(ResolveContext, String, ResourceContext, Resource)
the returned Resource objects must not be cached objects.- Specified by:
listChildren
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.parent
- TheResource
whose children are requested.- Returns:
- An
Iterator
ofResource
objects ornull
if the resource provider has no children for the given resource.
-
getParent
@Nullable public @Nullable Resource getParent(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull Resource child) Description copied from class:ResourceProvider
Returns the parent resource from this resource provider ornull
if the resource provider cannot find it. The resource provider must not return cached instances for a resource as the resource resolver will update the resource meta data of the resource at the end of the resolution process and this meta data might be different depending on the full path of resource resolution passed into the resource resolver.- Overrides:
getParent
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.child
- The child resource.- Returns:
null
if this provider does not have a resource for the parent.
-
getAttributeNames
@NotNull public @NotNull Collection<String> getAttributeNames(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Description copied from class:ResourceProvider
Returns a collection of attribute names whose value can be retrieved calling theResourceProvider.getAttribute(ResolveContext, String)
method.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_ATTRIBUTABLE
to the valuetrue
.- Overrides:
getAttributeNames
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.- Returns:
- A collection of attribute names or
null
-
getAttribute
@Nullable public @Nullable Object getAttribute(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull String name) Description copied from class:ResourceProvider
Returns the value of the given resource provider attribute ornull
if the attribute is not set or not visible (as e.g. security sensitive attributes).This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_ATTRIBUTABLE
to the valuetrue
.- Overrides:
getAttribute
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.name
- The name of the attribute to access- Returns:
- The value of the attribute or
null
if the attribute is not set or not accessible.
-
create
@NotNull public @NotNull Resource create(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @Nullable @Nullable String path, @Nullable @Nullable Map<String, Object> properties) throws PersistenceExceptionDescription copied from class:ResourceProvider
Create a new resource at the given path. The new resource is put into the transient space of this provider untilResourceProvider.commit(ResolveContext)
is called.A resource provider must value
ResourceResolver.PROPERTY_RESOURCE_TYPE
to set the resource type of a resource.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
create
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.path
- The resource path.properties
- Optional properties- Returns:
- The new resource.
- Throws:
PersistenceException
- If anything fails
-
getNodeType
@Nullable protected static @Nullable String getNodeType(@Nullable @Nullable Map<String, Object> properties, @NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) -
orderBefore
public boolean orderBefore(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull Resource parent, @NotNull @NotNull String name, @Nullable @Nullable String followingSiblingName) throws PersistenceException Description copied from class:ResourceProvider
Orders the child resources returned byResourceProvider.listChildren(ResolveContext, Resource)
so that a given resource is listed before the given sibling resource. The changes are transient untilResourceProvider.commit(ResolveContext)
is called..- Overrides:
orderBefore
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.parent
- the parent resource containing the child resources to order.name
- the name of the child resource inparent
to order. Must be an existing child name.followingSiblingName
- the name of the resource child inparent
which should come after the reordered resource. Ifnull
is given the resource is ordered as last among all sibling resources.- Returns:
true
in case the order of the child resources inparent
has been changed,false
if the given resource were already in the desired order.- Throws:
PersistenceException
- If the operation fails in the underlying resource provider, e.g. in case the parent resource does not support orderable children.- See Also:
-
delete
public void delete(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull Resource resource) throws PersistenceException Description copied from class:ResourceProvider
Delete the resource at the given path. This change is kept in the transient space of this provider untilResourceProvider.commit(ResolveContext)
is called.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
delete
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.resource
- The resource to delete.- Throws:
PersistenceException
- If anything fails
-
revert
public void revert(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Description copied from class:ResourceProvider
Revert all transient changes: create, delete and updates.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
revert
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.
-
commit
public void commit(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) throws PersistenceException Description copied from class:ResourceProvider
Commit all transient changes: create, delete and updatesThis method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
commit
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.- Throws:
PersistenceException
- If anything fails
-
hasChanges
public boolean hasChanges(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Description copied from class:ResourceProvider
Are there any transient changes?This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
hasChanges
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.- Returns:
true
if there are pending changes.
-
refresh
public void refresh(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx) Description copied from class:ResourceProvider
The provider is updated to reflect the latest state. Resources which have changes pending are not discarded.ResourceProvider.revert(ResolveContext)
can be called to discard changes.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_REFRESHABLE
to the valuetrue
.- Overrides:
refresh
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.
-
adaptTo
@Nullable public <AdapterType> AdapterType adaptTo(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull Class<AdapterType> type) Description copied from class:ResourceProvider
Adapts the provider to another type.Please not that it is explicitly left as an implementation detail whether each call to this method with the same
type
yields the same object or a new object on each call.Implementations of this method should document their adapted types as well as their behavior with respect to returning newly created or not instance on each call.
This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_ADAPTABLE
to the valuetrue
.- Overrides:
adaptTo
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Type Parameters:
AdapterType
- The generic type to which this resource is adapted to.- Parameters:
ctx
- TheResolveContext
.type
- The generic type to which this resource is adapted to.- Returns:
- The adapter target or
null
if the provider cannot be adapt to the requested type.
-
copy
public boolean copy(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull String srcAbsPath, @NotNull @NotNull String destAbsPath) Description copied from class:ResourceProvider
This 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
.Both resources are resources from this provider and the full tree is provided by this provider as well.
The resource at
destAbsPath
needs to exist, if not aPersistenceException
is thrown. If a child resource with the same name already exists atdestAbsPath
aPersistenceException
is thrown.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
copy
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.srcAbsPath
- the path of the resource to be copied.destAbsPath
- the location to which the resource atsrcAbsPath
is to be copied.- Returns:
true
if the provider can perform the copy
-
move
public boolean move(@NotNull @NotNull ResolveContext<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> ctx, @NotNull @NotNull String srcAbsPath, @NotNull @NotNull String destAbsPath) throws PersistenceException Description copied from class:ResourceProvider
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
.Both resources are resources from this provider and the full tree is provided by this provider as well.
The resource at
destAbsPath
needs to exist, if not aPersistenceException
is thrown. If a child resource with the same name already exists atdestAbsPath
aPersistenceException
is thrown.This method is only called if the provider supports this and indicates it by setting the
ResourceProvider.PROPERTY_MODIFIABLE
to the valuetrue
.- Overrides:
move
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Parameters:
ctx
- TheResolveContext
.srcAbsPath
- the path of the resource to be copied.destAbsPath
- the location to which the resource atsrcAbsPath
is to be moved.- Returns:
true
if the provider can perform the move- Throws:
PersistenceException
- If an error occurs.
-
getQueryLanguageProvider
@Nullable public @Nullable QueryLanguageProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState> getQueryLanguageProvider()Description copied from class:ResourceProvider
Get the optional query language provider. If the provider supports this kind of query, it must return a query provider implementation if the provider is active. It should not return a query provider if it is not active. This method is called for each query, therefore the provider implementation might cache the provider object.- Overrides:
getQueryLanguageProvider
in classResourceProvider<org.apache.sling.jcr.resource.internal.helper.jcr.JcrProviderState>
- Returns:
- A query language provider if this resource provider supports this type of querying.
-