Package org.apache.sling.resourceresolver.impl.legacy

Class LegacyResourceProviderFactoryAdapter

java.lang.Object

org.apache.sling.spi.resource.provider.ResourceProvider<LegacyResourceProviderAdapter>

org.apache.sling.resourceresolver.impl.legacy.LegacyResourceProviderFactoryAdapter

public class LegacyResourceProviderFactoryAdapter
extends ResourceProvider<LegacyResourceProviderAdapter>

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

Constructor	Description
LegacyResourceProviderFactoryAdapter(ResourceProviderFactory rpFactory, String[] languages, boolean ownsRoot)

Method Summary

Modifier and Type	Method	Description
<AdapterType> AdapterType	adaptTo(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx, @NotNull Class<AdapterType> type)	Adapts the provider to another type.
@NotNull LegacyResourceProviderAdapter	authenticate(@NotNull Map<String,Object> authenticationInfo)	Authenticate against the resource provider.
void	commit(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)	Commit all transient changes: create, delete and updates
Resource	create(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx, String path, Map<String,Object> properties)	Create a new resource at the given path.
void	delete(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx, @NotNull Resource resource)	Delete the resource at the given path.
Object	getAttribute(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx, @NotNull String name)	Returns the value of the given resource provider attribute or null if the attribute is not set or not visible (as e.g. security sensitive attributes).
Collection<String>	getAttributeNames(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)	Returns a collection of attribute names whose value can be retrieved calling the ResourceProvider.getAttribute(ResolveContext, String) method.
@Nullable QueryLanguageProvider<LegacyResourceProviderAdapter>	getQueryLanguageProvider()	Get the optional query language provider.
Resource	getResource(ResolveContext<LegacyResourceProviderAdapter> ctx, String path, ResourceContext resourceContext, Resource parent)	Returns a resource from this resource provider or null if the resource provider cannot find it.
boolean	hasChanges(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)	Are there any transient changes?
boolean	isLive(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)	Returns true if this resource provider has not been closed yet and can still be used.
Iterator<Resource>	listChildren(ResolveContext<LegacyResourceProviderAdapter> ctx, Resource parent)	Returns an Iterator of Resource objects loaded from the children of the given Resource.
void	logout(@NotNull LegacyResourceProviderAdapter state)	If the provider requires authentication, this method is called with the state of the user returned by ResourceProvider.authenticate(Map) once the resource resolver is closed.
void	refresh(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)	The provider is updated to reflect the latest state.
void	revert(@NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)	Revert all transient changes: create, delete and updates.

Methods inherited from class org.apache.sling.spi.resource.provider.ResourceProvider

copy, getParent, getProviderContext, move, orderBefore, start, stop, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LegacyResourceProviderFactoryAdapter

public LegacyResourceProviderFactoryAdapter(ResourceProviderFactory rpFactory,
 String[] languages,
 boolean ownsRoot)

Method Details

authenticate

@NotNull
public @NotNull LegacyResourceProviderAdapter authenticate(@NotNull
 @NotNull Map<String,Object> authenticationInfo)
                                                    throws LoginException

Description copied from class: ResourceProvider

Authenticate against the resource provider.

Returns a provider context object if authentication is successful. The context object is passed to the resource provider in all messages through the ResourceContext. A valid implementation might return null as the context information.

If authentication fails a LoginException must be thrown.

The returned context object grants access to the provided resources with privileges assigned to the service provided by the calling bundle.

The authenticationInfo map will in general contain the same information as provided to the respective ResourceResolver method. For

The provided authenticationInfo map may be used to provide additional information such as the ResourceProvider.AUTH_SERVICE_BUNDLE. If this property is provided, additional information like ResourceResolverFactory.SUBSERVICE might be provided, but the ResourceResolverFactory.USER and ResourceResolverFactory.PASSWORD properties provided in the map must be ignored.

The ResourceResolverFactory.USER_IMPERSONATION property is obeyed but requires that the authenticated user has permission to impersonate as the requested user. If such permission is missing, a LoginException is thrown.

The resource resolver implementation will call the ResourceProvider.logout(Object) method once the resource resolver is closed. However, if the resource provider is already unregistered when the resource resolver is closed, logout can't be called. Therefore the returned state object might implement Closeable. In this case close is called on the state object.

Overrides:

authenticate in class ResourceProvider<LegacyResourceProviderAdapter>

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:

• Service Authentication

logout

public void logout(@NotNull
 @NotNull LegacyResourceProviderAdapter state)

Description copied from class: ResourceProvider

If the provider requires authentication, this method is called with the state of the user returned by ResourceProvider.authenticate(Map) once the resource resolver is closed.

Overrides:

logout in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

state - The provider state returned by ResourceProvider.authenticate(Map).

getResource

public Resource getResource(ResolveContext<LegacyResourceProviderAdapter> ctx,
 String path,
 ResourceContext resourceContext,
 Resource parent)

Description copied from class: ResourceProvider

Returns a resource from this resource provider or null if the resource provider cannot find it. The path must have the ResourceProvider.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 class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

path - The full path of the resource.

resourceContext - Additional information for resolving the resource

parent - Optional parent resource

Returns:

null If this provider does not have a resource for the path.

listChildren

public Iterator<Resource> listChildren(ResolveContext<LegacyResourceProviderAdapter> ctx,
 Resource parent)

Description copied from class: ResourceProvider

Returns an Iterator of Resource objects loaded from the children of the given Resource. The returned Resource instances are attached to the same ResourceResolver as the given parent 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 to ResourceProvider.RESOURCE_TYPE_SYNTHETIC. As with ResourceProvider.getResource(ResolveContext, String, ResourceContext, Resource) the returned Resource objects must not be cached objects.

Specified by:

listChildren in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

parent - The Resource whose children are requested.

Returns:

An Iterator of Resource objects or null if the resource provider has no children for the given resource.

refresh

public void refresh(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> 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 value true.

Overrides:

refresh in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

getQueryLanguageProvider

@Nullable
public @Nullable QueryLanguageProvider<LegacyResourceProviderAdapter> 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 class ResourceProvider<LegacyResourceProviderAdapter>

Returns:

A query language provider if this resource provider supports this type of querying.

getAttributeNames

public Collection<String> getAttributeNames(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)

Description copied from class: ResourceProvider

Returns a collection of attribute names whose value can be retrieved calling the ResourceProvider.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 value true.

Overrides:

getAttributeNames in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

Returns:

A collection of attribute names or null

getAttribute

public Object getAttribute(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> ctx,
 @NotNull
 @NotNull String name)

Description copied from class: ResourceProvider

Returns the value of the given resource provider attribute or null 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 value true.

Overrides:

getAttribute in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

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.

isLive

public boolean isLive(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)

Description copied from class: ResourceProvider

Returns true 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 class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

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 returns false.

create

public Resource create(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> ctx,
 String path,
 Map<String,Object> properties)
                throws PersistenceException

Description copied from class: ResourceProvider

Create a new resource at the given path. The new resource is put into the transient space of this provider until ResourceProvider.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 value true.

Overrides:

create in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

path - The resource path.

properties - Optional properties

Returns:

The new resource.

Throws:

PersistenceException - If anything fails

delete

public void delete(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> 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 until ResourceProvider.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 value true.

Overrides:

delete in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

resource - The resource to delete.

Throws:

PersistenceException - If anything fails

revert

public void revert(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> 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 value true.

Overrides:

revert in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

commit

public void commit(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> ctx)
            throws PersistenceException

Description copied from class: ResourceProvider

Commit 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 value true.

Overrides:

commit in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

Throws:

PersistenceException - If anything fails

hasChanges

public boolean hasChanges(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> 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 value true.

Overrides:

hasChanges in class ResourceProvider<LegacyResourceProviderAdapter>

Parameters:

ctx - The ResolveContext.

Returns:

true if there are pending changes.

adaptTo

public <AdapterType> AdapterType adaptTo(@NotNull
 @NotNull ResolveContext<LegacyResourceProviderAdapter> 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 value true.

Overrides:

adaptTo in class ResourceProvider<LegacyResourceProviderAdapter>

Type Parameters:

AdapterType - The generic type to which this resource is adapted to.

Parameters:

ctx - The ResolveContext.

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.