org.apache.jackrabbit.oak.spi.security

Interface SecurityConfiguration

All Known Subinterfaces:

AuthenticationConfiguration, AuthorizationConfiguration, PrincipalConfiguration, PrivilegeConfiguration, TokenConfiguration, UserConfiguration

All Known Implementing Classes:

CompositeConfiguration, CompositePrincipalConfiguration, CompositeTokenConfiguration, ConfigurationBase, OpenAuthenticationConfiguration, OpenAuthorizationConfiguration, SecurityConfiguration.Default

@ProviderType
public interface SecurityConfiguration

Base interface for all security related configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecurityConfiguration.Default Default implementation that provides empty initializers, validators, commit hooks and parameters.

Method Summary

Modifier and Type	Method and Description
List<? extends org.apache.jackrabbit.oak.spi.commit.CommitHook>	getCommitHooks(String workspaceName) Returns the list of commit hooks that need to be executed for the specified workspace name.
List<org.apache.jackrabbit.oak.spi.commit.ThreeWayConflictHandler>	getConflictHandlers() Returns the list of conflict handlers available for this security configuration.
Context	getContext()
String	getName() Returns the name of this security configuration.
ConfigurationParameters	getParameters() Returns the configuration parameters associated with this security configuration instance.
List<ProtectedItemImporter>	getProtectedItemImporters()
org.apache.jackrabbit.oak.spi.lifecycle.RepositoryInitializer	getRepositoryInitializer() Returns a repository initializer for this security configuration.
List<? extends org.apache.jackrabbit.oak.spi.commit.ValidatorProvider>	getValidators(String workspaceName, Set<Principal> principals, org.apache.jackrabbit.oak.spi.commit.MoveTracker moveTracker) Returns the list of validators that need to be executed for the specified workspace name.
org.apache.jackrabbit.oak.spi.lifecycle.WorkspaceInitializer	getWorkspaceInitializer() Returns a workspace initializer for this security configuration.

Method Detail

getName

@Nonnull
String getName()

Returns the name of this security configuration.

Returns:

The name of this configuration.

getParameters

@Nonnull
ConfigurationParameters getParameters()

Returns the configuration parameters associated with this security configuration instance. If no parameters are present ConfigurationParameters.EMPTY should be returned.

Returns:

The configuration parameters.

getWorkspaceInitializer

@Nonnull
org.apache.jackrabbit.oak.spi.lifecycle.WorkspaceInitializer getWorkspaceInitializer()

Returns a workspace initializer for this security configuration. If this configuration doesn't require any specific workspace initialization WorkspaceInitializer.DEFAULT should be returned.

Returns:

An instance of WorkspaceInitializer.

getRepositoryInitializer

@Nonnull
org.apache.jackrabbit.oak.spi.lifecycle.RepositoryInitializer getRepositoryInitializer()

Returns a repository initializer for this security configuration. If this configuration doesn't require any specific repository initialization RepositoryInitializer.DEFAULT should be returned.

Returns:

An instance of RepositoryInitializer.

getCommitHooks

@Nonnull
List<? extends org.apache.jackrabbit.oak.spi.commit.CommitHook> getCommitHooks(@Nonnull
                                                                                         String workspaceName)

Returns the list of commit hooks that need to be executed for the specified workspace name.

Parameters:

workspaceName - The name of the workspace.

Returns:

A list of commit hooks.

getValidators

@Nonnull
List<? extends org.apache.jackrabbit.oak.spi.commit.ValidatorProvider> getValidators(@Nonnull
                                                                                               String workspaceName,
                                                                                               @Nonnull
                                                                                               Set<Principal> principals,
                                                                                               @Nonnull
                                                                                               org.apache.jackrabbit.oak.spi.commit.MoveTracker moveTracker)

Returns the list of validators that need to be executed for the specified workspace name.

Parameters:

workspaceName - The name of the workspace.

principals - The set of principals associated with the subject that is committing modifications.

moveTracker - The move tracker associated with the commit.

Returns:

A list of validators.

getConflictHandlers

@Nonnull
List<org.apache.jackrabbit.oak.spi.commit.ThreeWayConflictHandler> getConflictHandlers()

Returns the list of conflict handlers available for this security configuration.

Returns:

A list of ThreeWayConflictHandler.

getProtectedItemImporters

@Nonnull
List<ProtectedItemImporter> getProtectedItemImporters()

Returns:

The list of protected item importers defined by this configuration.

getContext

@Nonnull
Context getContext()

Returns:

The context defined by this configuration.