Package org.apache.sling.api.security

Interface ResourceAccessSecurity

@ProviderType
public interface ResourceAccessSecurity

The ResourceAccessSecurity defines a service API which is used in two different context: for securing resource providers which have no own access control and on the application level to further restrict the access to resources in general. A resource access security service is registered with the service property CONTEXT. Allowed values are APPLICATION_CONTEXT and PROVIDER_CONTEXT. If the value is missing or invalid, the service will be ignored. In the context of resource providers, this service might be used for implementations of resource providers where the underlying persistence layer does not implement access control. The goal is to make it easy to implement a lightweight access control for such providers. For example, a JCR resource providers should *not* use the provider context resource access security - in a JCR context, security is fully delegated to the underlying repository, and mixing security models would be a bad idea. In the context of the application, this service might be used to add additional or temporary constraints across the whole resource tree. It is expected to only have a single service per context in the framework/application (much like the OSGi LogService or ConfigurationAdmin Service). In the case of multiple services per context, the one with the highest service ranking is used.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	APPLICATION_CONTEXT	Allowed value for the CONTEXT service registration property.
static java.lang.String	CONTEXT	The name of the service registration property containing the context of this service.
static java.lang.String	PROVIDER_CONTEXT	Allowed value for the CONTEXT service registration property.

Method Summary

Modifier and Type	Method	Description
boolean	canCreate(@NotNull java.lang.String absPathName, @NotNull ResourceResolver resourceResolver)	Check whether a resource can be created at the path.
boolean	canDelete(@NotNull Resource resource)	Check whether a resource can be deleted at the path.
boolean	canDeleteValue(@NotNull Resource resource, @NotNull java.lang.String valueName)	Check whether a value can be deleted
boolean	canExecute(@NotNull Resource resource)	Check whether a resource can be executed at the path.
default boolean	canOrderChildren(@NotNull Resource resource)	Check whether child resources can be ordered.
boolean	canReadValue(@NotNull Resource resource, @NotNull java.lang.String valueName)	Check whether a value can be read
boolean	canSetValue(@NotNull Resource resource, @NotNull java.lang.String valueName)	Check whether a value can be set
boolean	canUpdate(@NotNull Resource resource)	Check whether a resource can be updated at the path.
@Nullable Resource	getReadableResource(Resource resource)	If supplied Resource can be read, return it (or a wrapped variant of it).
@NotNull java.lang.String	transformQuery(@NotNull java.lang.String query, @NotNull java.lang.String language, @NotNull ResourceResolver resourceResolver)	Optionally transform a query based on the current user's credentials.

Field Detail

CONTEXT

static final java.lang.String CONTEXT

The name of the service registration property containing the context of this service. Allowed values are APPLICATION_CONTEXT and PROVIDER_CONTEXT. This property is required and has no default value. (value is "access.context")

See Also:

Constant Field Values

APPLICATION_CONTEXT

static final java.lang.String APPLICATION_CONTEXT

Allowed value for the CONTEXT service registration property. Services marked with this context are applied to all resources.

See Also:

Constant Field Values

PROVIDER_CONTEXT

static final java.lang.String PROVIDER_CONTEXT

Allowed value for the CONTEXT service registration property. Services marked with this context are only applied to resource providers which indicate the additional checks with the ResourceProvider.USE_RESOURCE_ACCESS_SECURITY property.

See Also:

Constant Field Values

Method Detail

getReadableResource

@Nullable
@Nullable Resource getReadableResource(Resource resource)

If supplied Resource can be read, return it (or a wrapped variant of it). The returned Resource should then be used instead of the one that was passed into the method.

Parameters:

resource - The resource to test.

Returns:

null if Resource cannot be read

canCreate

boolean canCreate(@NotNull
                  @NotNull java.lang.String absPathName,
                  @NotNull
                  @NotNull ResourceResolver resourceResolver)

Check whether a resource can be created at the path.

Parameters:

absPathName - The path to create

resourceResolver - The resource resolver

Returns:

true if a Resource can be created at the supplied absolute path.

canOrderChildren

default boolean canOrderChildren(@NotNull
                                 @NotNull Resource resource)

Check whether child resources can be ordered.

Parameters:

resource - The resource to test.

Returns:

true if child resources can be ordered below the supplied resource

Since:

1.1.0 (Sling API Bundle 2.24.0)

canUpdate

boolean canUpdate(@NotNull
                  @NotNull Resource resource)

Check whether a resource can be updated at the path.

Parameters:

resource - The resource to test.

Returns:

true if supplied Resource can be updated

canDelete

boolean canDelete(@NotNull
                  @NotNull Resource resource)

Check whether a resource can be deleted at the path.

Parameters:

resource - The resource to test.

Returns:

true if supplied Resource can be deleted

canExecute

boolean canExecute(@NotNull
                   @NotNull Resource resource)

Check whether a resource can be executed at the path.

Parameters:

resource - The resource to test.

Returns:

true if supplied Resource can be executed as a script

canReadValue

boolean canReadValue(@NotNull
                     @NotNull Resource resource,
                     @NotNull
                     @NotNull java.lang.String valueName)

Check whether a value can be read

Parameters:

resource - The resource to test.

valueName - The name of the value

Returns:

true if the "valueName" value of supplied Resource can be read

canSetValue

boolean canSetValue(@NotNull
                    @NotNull Resource resource,
                    @NotNull
                    @NotNull java.lang.String valueName)

Check whether a value can be set

Parameters:

resource - The resource to test.

valueName - The name of the value

Returns:

true if the "valueName" value of supplied Resource can be set

canDeleteValue

boolean canDeleteValue(@NotNull
                       @NotNull Resource resource,
                       @NotNull
                       @NotNull java.lang.String valueName)

Check whether a value can be deleted

Parameters:

resource - The resource to test.

valueName - The name of the value

Returns:

true if the "valueName" value of supplied Resource can be deleted

transformQuery

@NotNull
@NotNull java.lang.String transformQuery(@NotNull
                                         @NotNull java.lang.String query,
                                         @NotNull
                                         @NotNull java.lang.String language,
                                         @NotNull
                                         @NotNull ResourceResolver resourceResolver)
                                  throws AccessSecurityException

Optionally transform a query based on the current user's credentials. Can be used to narrow down queries to omit results that the current user is not allowed to see anyway, to speed up downstream access control. Query transformations are not critical with respect to access control as results are filtered downstream using the canRead.. methods.

Parameters:

query - the query

language - the language in which the query is expressed

resourceResolver - the resource resolver which resolves the query

Returns:

the transformed query

Throws:

AccessSecurityException - If access is denied