org.apache.sling.spi.resource.provider

Interface ResolveContext<T>

@ProviderType
public interface ResolveContext<T>

The resolve context is passed to most of the methods of the ResourceProvider to provide additional context information for the provider. If the provider requires authentication, the object returned by ResourceProvider.authenticate(Map) is returned in getProviderState().

Since:

1.0.0 (Sling API Bundle 2.11.0)

Method Summary

Modifier and Type	Method and Description
ResolveContext<?>	getParentResolveContext() Return a resolve context for the parent resource provider.
ResourceProvider<?>	getParentResourceProvider() Return the parent resource provider.
T	getProviderState() This is the object returned by ResourceProvider.authenticate(Map)
ResourceResolver	getResourceResolver() Get the current resource resolver.

Method Detail

getResourceResolver

@Nonnull
ResourceResolver getResourceResolver()

Get the current resource resolver.

Returns:

The resource resolver.

getProviderState

@CheckForNull
T getProviderState()

This is the object returned by ResourceProvider.authenticate(Map)

Returns:

The data object or null

getParentResolveContext

@CheckForNull
ResolveContext<?> getParentResolveContext()

Return a resolve context for the parent resource provider.

Returns:

A resolve context or null if there is no parent.

See Also:

getParentResourceProvider()

getParentResourceProvider

@CheckForNull
ResourceProvider<?> getParentResourceProvider()

Return the parent resource provider. If the parent should be used for resolving, a context created with getParentResolveContext() should be passed to that instance.

Returns:

The parent provider or null if there is no parent.