org.apache.jackrabbit.oak.spi.security

Class CompositeConfiguration<T extends SecurityConfiguration>

java.lang.Object

org.apache.jackrabbit.oak.spi.security.CompositeConfiguration<T>

All Implemented Interfaces:

SecurityConfiguration

Direct Known Subclasses:

CompositePrincipalConfiguration, CompositeTokenConfiguration

@ProviderType
public abstract class CompositeConfiguration<T extends SecurityConfiguration>
extends Object
implements SecurityConfiguration

Abstract base implementation for SecurityConfigurations that can combine different implementations.

Nested Class Summary

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

SecurityConfiguration.Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_RANKING Parameter used to define the ranking of a given configuration compared to other registered configuration in this aggregate.

Constructor Summary

Constructors

Constructor and Description
CompositeConfiguration(String name)
CompositeConfiguration(String name, SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(T configuration)
void	addConfiguration(T configuration, ConfigurationParameters params)
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<T>	getConfigurations()
List<org.apache.jackrabbit.oak.spi.commit.ThreeWayConflictHandler>	getConflictHandlers() Returns the list of conflict handlers available for this security configuration.
Context	getContext()
T	getDefaultConfig()
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.
protected RootProvider	getRootProvider()
protected SecurityProvider	getSecurityProvider()
protected TreeProvider	getTreeProvider()
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.
void	removeConfiguration(T configuration)
void	setDefaultConfig(T defaultConfig)
void	setRootProvider(RootProvider rootProvider)
void	setSecurityProvider(SecurityProvider securityProvider)
void	setTreeProvider(TreeProvider treeProvider)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_RANKING

public static final String PARAM_RANKING

Parameter used to define the ranking of a given configuration compared to other registered configuration in this aggregate. If the ranking parameter is missing a new configuration will be added at the end of the list.

See Also:

Constant Field Values

Constructor Detail

CompositeConfiguration

public CompositeConfiguration(@Nonnull
                              String name)

CompositeConfiguration

public CompositeConfiguration(@Nonnull
                              String name,
                              @Nonnull
                              SecurityProvider securityProvider)

Method Detail

getDefaultConfig

@CheckForNull
public T getDefaultConfig()

setDefaultConfig

public void setDefaultConfig(@Nonnull
                             T defaultConfig)

addConfiguration

public void addConfiguration(@Nonnull
                             T configuration)

addConfiguration

public void addConfiguration(@Nonnull
                             T configuration,
                             @Nonnull
                             ConfigurationParameters params)

removeConfiguration

public void removeConfiguration(@Nonnull
                                T configuration)

getConfigurations

@Nonnull
public List<T> getConfigurations()

setSecurityProvider

public void setSecurityProvider(@Nonnull
                                SecurityProvider securityProvider)

getSecurityProvider

@Nonnull
protected SecurityProvider getSecurityProvider()

setRootProvider

public void setRootProvider(@Nonnull
                            RootProvider rootProvider)

getRootProvider

@Nonnull
protected RootProvider getRootProvider()

setTreeProvider

public void setTreeProvider(@Nonnull
                            TreeProvider treeProvider)

getTreeProvider

@Nonnull
protected TreeProvider getTreeProvider()

getName

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public List<? extends org.apache.jackrabbit.oak.spi.commit.CommitHook> getCommitHooks(@Nonnull
                                                                                                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

@Nonnull
public 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)

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

@Nonnull
public 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

@Nonnull
public List<ProtectedItemImporter> getProtectedItemImporters()

Specified by:

getProtectedItemImporters in interface SecurityConfiguration

Returns:

The list of protected item importers defined by this configuration.

getContext

@Nonnull
public Context getContext()

Specified by:

getContext in interface SecurityConfiguration

Returns:

The context defined by this configuration.