org.apache.jackrabbit.oak.spi.security.authorization.principalbased

Interface FilterProvider

All Known Implementing Classes:

FilterProviderImpl

@ProviderType
public interface FilterProvider

Interface that allows to define the principals for which principal based access control management and permission evaluation can be executed. For any other principals this module would never take effect.

Method Summary

Modifier and Type	Method and Description
@NotNull Filter	getFilter(@NotNull org.apache.jackrabbit.oak.spi.security.SecurityProvider securityProvider, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) Returns a Filter for the given parameters.
@NotNull java.lang.String	getFilterRoot() Returns the root path handled by the filer.
boolean	handlesPath(@NotNull java.lang.String oakPath) Reveals if the given implementation is able to handle access control at the tree defined by the given oakPath.

Method Detail

handlesPath

boolean handlesPath(@NotNull
                    @NotNull java.lang.String oakPath)

Reveals if the given implementation is able to handle access control at the tree defined by the given oakPath.

Parameters:

oakPath - The absolute oak path to be tested.

Returns:

true if the given path is supported by this implememntation, false otherwise.

getFilterRoot

@NotNull
@NotNull java.lang.String getFilterRoot()

Returns the root path handled by the filer. In case multiple paths are supported this method returns the common ancestor path.

Returns:

An absolute oak path.

getFilter

@NotNull
@NotNull Filter getFilter(@NotNull
                                   @NotNull org.apache.jackrabbit.oak.spi.security.SecurityProvider securityProvider,
                                   @NotNull
                                   @NotNull org.apache.jackrabbit.oak.api.Root root,
                                   @NotNull
                                   @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)

Returns a Filter for the given parameters.

Parameters:

securityProvider - The security provider.

root - The reading/editing root.

namePathMapper - The name path mapper.

Returns:

A new filter associated with the given parameters.