Package org.apache.jackrabbit.oak.spi.security

Class SecurityConfiguration.Default

java.lang.Object

org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

All Implemented Interfaces:

SecurityConfiguration

Direct Known Subclasses:

ConfigurationBase, OpenAuthenticationConfiguration, OpenAuthorizationConfiguration

Enclosing interface:

SecurityConfiguration

public static class SecurityConfiguration.Default
extends Object
implements SecurityConfiguration

Default implementation that provides empty initializers, validators, commit hooks and parameters.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

SecurityConfiguration.Default

Constructor Summary

Constructors

Constructor	Description
Default()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Default

public Default()

Method Detail

getName

@NotNull
public @NotNull String getName()

Description copied from interface: SecurityConfiguration

Returns the name of this security configuration.

Specified by:

getName in interface SecurityConfiguration

Returns:

The name of this configuration.

getParameters

@NotNull
public @NotNull ConfigurationParameters getParameters()

Description copied from interface: SecurityConfiguration

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

Specified by:

getParameters in interface SecurityConfiguration

Returns:

The configuration parameters.

getWorkspaceInitializer

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

Description copied from interface: SecurityConfiguration

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

Specified by:

getWorkspaceInitializer in interface SecurityConfiguration

Returns:

An instance of WorkspaceInitializer.

getRepositoryInitializer

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

Description copied from interface: SecurityConfiguration

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

Specified by:

getRepositoryInitializer in interface SecurityConfiguration

Returns:

An instance of RepositoryInitializer.

getCommitHooks

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

Description copied from interface: SecurityConfiguration

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

Specified by:

getCommitHooks in interface SecurityConfiguration

Parameters:

workspaceName - The name of the workspace.

Returns:

A list of commit hooks.

getValidators

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

Description copied from interface: SecurityConfiguration

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

Specified by:

getValidators in interface SecurityConfiguration

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

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

Description copied from interface: SecurityConfiguration

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

Specified by:

getConflictHandlers in interface SecurityConfiguration

Returns:

A list of ThreeWayConflictHandler.

getProtectedItemImporters

@NotNull
public @NotNull List<ProtectedItemImporter> getProtectedItemImporters()

Specified by:

getProtectedItemImporters in interface SecurityConfiguration

Returns:

The list of protected item importers defined by this configuration.

getContext

@NotNull
public @NotNull Context getContext()

Specified by:

getContext in interface SecurityConfiguration

Returns:

The context defined by this configuration.