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

public abstract class CompositeConfiguration<T extends SecurityConfiguration>
extends java.lang.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 java.lang.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(java.lang.String name)
CompositeConfiguration(java.lang.String name, SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(T configuration)
void	addConfiguration(T configuration, ConfigurationParameters params)
java.util.List<? extends CommitHook>	getCommitHooks(java.lang.String workspaceName) Returns the list of commit hooks that need to be executed for the specified workspace name.
java.util.List<T>	getConfigurations()
java.util.List<ThreeWayConflictHandler>	getConflictHandlers() Returns the list of conflict handlers available for this security configuration.
Context	getContext()
T	getDefaultConfig()
java.lang.String	getName() Returns the name of this security configuration.
ConfigurationParameters	getParameters() Returns the configuration parameters associated with this security configuration instance.
java.util.List<ProtectedItemImporter>	getProtectedItemImporters()
RepositoryInitializer	getRepositoryInitializer() Returns a repository initializer for this security configuration.
java.util.List<? extends ValidatorProvider>	getValidators(java.lang.String workspaceName, java.util.Set<java.security.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.
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

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

Field Detail

PARAM_RANKING

public static final java.lang.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(java.lang.String name)

CompositeConfiguration

public CompositeConfiguration(java.lang.String name,
                              SecurityProvider securityProvider)

Method Detail

getDefaultConfig

public T getDefaultConfig()

setDefaultConfig

public void setDefaultConfig(T defaultConfig)

addConfiguration

public void addConfiguration(T configuration)

addConfiguration

public void addConfiguration(T configuration,
                             ConfigurationParameters params)

removeConfiguration

public void removeConfiguration(T configuration)

getConfigurations

public java.util.List<T> getConfigurations()

setSecurityProvider

public void setSecurityProvider(SecurityProvider securityProvider)

setRootProvider

public void setRootProvider(RootProvider rootProvider)

setTreeProvider

public void setTreeProvider(TreeProvider treeProvider)

getName

public java.lang.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

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

public 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

public 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

public java.util.List<? extends CommitHook> getCommitHooks(java.lang.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

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

public java.util.List<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

public java.util.List<ProtectedItemImporter> getProtectedItemImporters()

Specified by:

getProtectedItemImporters in interface SecurityConfiguration

Returns:

The list of protected item importers defined by this configuration.

getContext

public Context getContext()

Specified by:

getContext in interface SecurityConfiguration

Returns:

The context defined by this configuration.