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

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

Methods

Modifier and Type	Method and Description
List<? extends CommitHook>	getCommitHooks(String workspaceName) Returns the list of commit hooks that need to be executed for the specified workspace name.
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()
RepositoryInitializer	getRepositoryInitializer() Returns a repository initializer for this security configuration.
List<? extends ValidatorProvider>	getValidators(String workspaceName, Set<Principal> principals, MoveTracker moveTracker) Returns the list of validators that need to be executed for the specified workspace name.
WorkspaceInitializer	getWorkspaceInitializer() Returns a workspace initializer for this security configuration.

Method Detail

getName

String getName()

Returns the name of this security configuration.

Returns:

The name of this configuration.

getParameters

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

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

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

List<? extends CommitHook> getCommitHooks(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

List<? extends ValidatorProvider> getValidators(String workspaceName,
                                              Set<Principal> principals,
                                              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.

getProtectedItemImporters

List<ProtectedItemImporter> getProtectedItemImporters()

Returns:

The list of protected item importers defined by this configuration.

getContext

Context getContext()

Returns:

The context defined by this configuration.