Package org.apache.sling.resourceresolver.impl.providers.stateful

Class AuthenticatedResourceProvider

java.lang.Object

org.apache.sling.resourceresolver.impl.providers.stateful.AuthenticatedResourceProvider

public class AuthenticatedResourceProvider
extends Object

This AuthenticatedResourceProvider implementation keeps a resource provider and the authentication information (through the ResolveContext). The methods are similar to those of ResourceProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static final AuthenticatedResourceProvider	UNAUTHENTICATED_PROVIDER

Constructor Summary

Constructors

Constructor	Description
AuthenticatedResourceProvider(@NotNull ResourceProviderHandler providerHandler, boolean useRAS, @NotNull ResolveContext<Object> resolveContext, @NotNull org.apache.sling.resourceresolver.impl.ResourceAccessSecurityTracker tracker)	Constructor

Method Summary

Modifier and Type	Method	Description
<AdapterType> AdapterType	adaptTo(Class<AdapterType> type)
void	commit()
boolean	copy(String srcAbsPath, String destAbsPath)
Resource	create(ResourceResolver resolver, String path, Map<String,Object> properties)
void	delete(Resource resource)
Iterator<Resource>	findResources(String query, String language)
Object	getAttribute(String name)
void	getAttributeNames(Set<String> attributeNames)
Resource	getParent(Resource child)	Get the parent resource
@NotNull ResolveContext<Object>	getResolveContext()	Get the resolve context.
Resource	getResource(String path, Resource parent, Map<String,String> parameters)
String[]	getSupportedLanguages()
boolean	hasChanges()
boolean	isLive()	Check if the provider is live
Iterator<Resource>	listChildren(Resource parent)
boolean	move(String srcAbsPath, String destAbsPath)
boolean	orderBefore(@NotNull Resource parent, @NotNull String name, @Nullable String followingSiblingName)
Iterator<Map<String,Object>>	queryResources(String query, String language)
void	refresh()
void	revert()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

UNAUTHENTICATED_PROVIDER

public static final AuthenticatedResourceProvider UNAUTHENTICATED_PROVIDER

Constructor Details

AuthenticatedResourceProvider

public AuthenticatedResourceProvider(@NotNull
 @NotNull ResourceProviderHandler providerHandler,
 boolean useRAS,
 @NotNull
 @NotNull ResolveContext<Object> resolveContext,
 @NotNull
 @NotNull org.apache.sling.resourceresolver.impl.ResourceAccessSecurityTracker tracker)

Constructor

Parameters:

providerHandler - the providerHandler

useRAS - useRAS

resolveContext - resolveContext

tracker - tracker

Method Details

getResolveContext

@NotNull
public @NotNull ResolveContext<Object> getResolveContext()

Get the resolve context.

Returns:

The resolve context

refresh

public void refresh()

See Also:

• ResourceProvider.refresh(ResolveContext)

isLive

public boolean isLive()

Check if the provider is live

Returns:

true If live

See Also:

• ResourceProvider.isLive(ResolveContext)

getParent

public Resource getParent(Resource child)

Get the parent resource

Parameters:

child - The child

Returns:

The parent

See Also:

• ResourceProvider.getParent(ResolveContext, Resource)

getResource

public Resource getResource(String path,
 Resource parent,
 Map<String,String> parameters)

Parameters:

path - the path

parent - parent

parameters - parameters

Returns:

the resource

See Also:

• ResourceProvider.getResource(ResolveContext, String, ResourceContext, Resource)

listChildren

public Iterator<Resource> listChildren(Resource parent)

Parameters:

parent - parent

Returns:

the iterator

See Also:

• ResourceProvider.listChildren(ResolveContext, Resource)

getAttributeNames

public void getAttributeNames(Set<String> attributeNames)

Parameters:

attributeNames - attributeNames

See Also:

• ResourceProvider.getAttributeNames(ResolveContext)

getAttribute

public Object getAttribute(String name)

Parameters:

name - name

Returns:

the attribute

See Also:

• ResourceProvider.getAttribute(ResolveContext, String)

create

public Resource create(ResourceResolver resolver,
 String path,
 Map<String,Object> properties)
                throws PersistenceException

Parameters:

resolver - the resolver

path - path

properties - properties

Returns:

the resource

Throws:

PersistenceException - in case of problems

See Also:

• ResourceProvider.create(ResolveContext, String, Map)

orderBefore

public boolean orderBefore(@NotNull
 @NotNull Resource parent,
 @NotNull
 @NotNull String name,
 @Nullable
 @Nullable String followingSiblingName)
                    throws PersistenceException

Parameters:

parent - parent

name - name

followingSiblingName - followingSiblingName

Returns:

true if the order was changed, false if the order was correct already before

Throws:

PersistenceException - in case of problems

See Also:

• ResourceProvider.orderBefore(ResolveContext, Resource, String, String)

delete

public void delete(Resource resource)
            throws PersistenceException

Parameters:

resource - resource

Throws:

PersistenceException - in case of problems

See Also:

• ResourceProvider.delete(ResolveContext, Resource)

revert

public void revert()

See Also:

• ResourceProvider.revert(ResolveContext)

commit

public void commit()
            throws PersistenceException

Throws:

PersistenceException - in case of problems

See Also:

• ResourceProvider.commit(ResolveContext)

hasChanges

public boolean hasChanges()

Returns:

true if there are transient changes

See Also:

• ResourceProvider.hasChanges(ResolveContext)

getSupportedLanguages

public String[] getSupportedLanguages()

Returns:

array with the support query languages

See Also:

• QueryLanguageProvider.getSupportedLanguages(ResolveContext)

findResources

public Iterator<Resource> findResources(String query,
 String language)

Parameters:

query - the query

language - the language of the query

Returns:

an iterator covering the found resources

See Also:

• QueryLanguageProvider.findResources(ResolveContext, String, String)

queryResources

public Iterator<Map<String,Object>> queryResources(String query,
 String language)

Parameters:

query - the query

language - the language of the query

Returns:

a map with the result

See Also:

• QueryLanguageProvider.queryResources(ResolveContext, String, String)

adaptTo

public <AdapterType> AdapterType adaptTo(Class<AdapterType> type)

Type Parameters:

AdapterType - the adapter target

Parameters:

type - the type to convert to

Returns:

the adapter target or {code}null{code} if the adaption failed

See Also:

• ResourceProvider.adaptTo(ResolveContext, Class)

copy

public boolean copy(String srcAbsPath,
 String destAbsPath)
             throws PersistenceException

Parameters:

srcAbsPath - the absolute source path

destAbsPath - the absolute target path

Returns:

true if the copy succeeded, false otherwise

Throws:

PersistenceException - in case of problems

See Also:

• ResourceProvider.copy(ResolveContext, String, String)

move

public boolean move(String srcAbsPath,
 String destAbsPath)
             throws PersistenceException

Parameters:

srcAbsPath - the absolute source path

destAbsPath - the absolute target path

Returns:

true if the move succeeded, false otherwise

Throws:

PersistenceException - in case of problems

See Also:

• ResourceProvider.move(ResolveContext, String, String)

toString

public String toString()

Overrides:

toString in class Object