Package org.apache.jackrabbit.oak.security.user

Class UserConfigurationImpl

java.lang.Object

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

org.apache.jackrabbit.oak.spi.security.ConfigurationBase

org.apache.jackrabbit.oak.security.user.UserConfigurationImpl

All Implemented Interfaces:

SecurityConfiguration, UserConfiguration

public class UserConfigurationImpl
extends ConfigurationBase
implements UserConfiguration, SecurityConfiguration

Default implementation of the UserConfiguration.

Nested Class Summary

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

SecurityConfiguration.Default

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.user.UserConfiguration

NAME

Constructor Summary

Constructors

Constructor	Description
UserConfigurationImpl()
UserConfigurationImpl(SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method	Description
CachedMembershipReader	getCachedMembershipReader(@NotNull Root root, @NotNull CachePrincipalFactory cachePrincipalFactory, @NotNull String propName, @NotNull String expirationPropName)	Optional method that allows a given user management implementation to provide a specific and optimized implementation of the CachedMembershipReader interface for the principals represented by the user/groups known to this implementation.
@NotNull List<ThreeWayConflictHandler>	getConflictHandlers()	Returns the list of conflict handlers available for this security configuration.
@NotNull Context	getContext()
static UserAuthenticationFactory	getDefaultAuthenticationFactory()
@NotNull Iterable<Monitor<?>>	getMonitors(@NotNull StatisticsProvider statisticsProvider)
@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 UserManager	getUserManager(Root root, NamePathMapper namePathMapper)	Create a new UserManager instance
@Nullable PrincipalProvider	getUserPrincipalProvider(@NotNull Root root, @NotNull NamePathMapper namePathMapper)	Optional method that allows a given user management implementation to provide a specific and optimized implementation of the PrincipalProvider interface for the principals represented by the user/groups known to this implementation.
@NotNull List<? extends ValidatorProvider>	getValidators(@NotNull String workspaceName, @NotNull Set<Principal> principals, @NotNull MoveTracker moveTracker)	Returns the list of validators that need to be executed for the specified workspace name.
@NotNull WorkspaceInitializer	getWorkspaceInitializer()	Returns a workspace initializer for this security configuration.

Methods inherited from class org.apache.jackrabbit.oak.spi.security.ConfigurationBase

getRootProvider, getSecurityProvider, getTreeProvider, setParameters, setRootProvider, setSecurityProvider, setTreeProvider

Methods inherited from class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

getCommitHooks, getRepositoryInitializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

getCommitHooks, getRepositoryInitializer

Methods inherited from interface org.apache.jackrabbit.oak.spi.security.user.UserConfiguration

getCachedMembershipReader

Constructor Detail

UserConfigurationImpl

public UserConfigurationImpl()

UserConfigurationImpl

public UserConfigurationImpl(SecurityProvider securityProvider)

Method Detail

getDefaultAuthenticationFactory

public static UserAuthenticationFactory getDefaultAuthenticationFactory()

getName

@NotNull
public @NotNull String getName()

Description copied from interface: SecurityConfiguration

Returns the name of this security configuration.

Specified by:

getName in interface SecurityConfiguration

Overrides:

getName in class SecurityConfiguration.Default

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

Overrides:

getParameters in class ConfigurationBase

Returns:

The configuration parameters.

getWorkspaceInitializer

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

Overrides:

getWorkspaceInitializer in class SecurityConfiguration.Default

Returns:

An instance of WorkspaceInitializer.

getValidators

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

Overrides:

getValidators in class SecurityConfiguration.Default

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<ThreeWayConflictHandler> getConflictHandlers()

Description copied from interface: SecurityConfiguration

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

Specified by:

getConflictHandlers in interface SecurityConfiguration

Overrides:

getConflictHandlers in class SecurityConfiguration.Default

Returns:

A list of ThreeWayConflictHandler.

getProtectedItemImporters

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

Specified by:

getProtectedItemImporters in interface SecurityConfiguration

Overrides:

getProtectedItemImporters in class SecurityConfiguration.Default

Returns:

The list of protected item importers defined by this configuration.

getContext

@NotNull
public @NotNull Context getContext()

Specified by:

getContext in interface SecurityConfiguration

Overrides:

getContext in class SecurityConfiguration.Default

Returns:

The context defined by this configuration.

getMonitors

@NotNull
public @NotNull Iterable<Monitor<?>> getMonitors(@NotNull
                                                 @NotNull StatisticsProvider statisticsProvider)

Specified by:

getMonitors in interface SecurityConfiguration

getUserManager

@NotNull
public @NotNull UserManager getUserManager(Root root,
                                           NamePathMapper namePathMapper)

Description copied from interface: UserConfiguration

Create a new UserManager instance

Specified by:

getUserManager in interface UserConfiguration

Parameters:

root - The root associated with the user manager.

namePathMapper - A name path mapper used for conversion of jcr/oak names/paths.

Returns:

a new instance of UserManager

getUserPrincipalProvider

@Nullable
public @Nullable PrincipalProvider getUserPrincipalProvider(@NotNull
                                                            @NotNull Root root,
                                                            @NotNull
                                                            @NotNull NamePathMapper namePathMapper)

Description copied from interface: UserConfiguration

Optional method that allows a given user management implementation to provide a specific and optimized implementation of the PrincipalProvider interface for the principals represented by the user/groups known to this implementation. If this method returns null the security setup will by default use a basic PrincipalProvider implementation based on public user management API or a combination of other PrincipalProviders as configured with the repository setup.

Specified by:

getUserPrincipalProvider in interface UserConfiguration

Parameters:

root - The root used to read the principal information from.

namePathMapper - The NamePathMapper to convert oak paths to JCR paths.

Returns:

An implementation of PrincipalProvider or null if principal discovery is provided by other means of if the default principal provider implementation should be used that acts on public user management API.

See Also:

PrincipalConfiguration

getCachedMembershipReader

public CachedMembershipReader getCachedMembershipReader(@NotNull
                                                        @NotNull Root root,
                                                        @NotNull
                                                        @NotNull CachePrincipalFactory cachePrincipalFactory,
                                                        @NotNull
                                                        @NotNull String propName,
                                                        @NotNull
                                                        @NotNull String expirationPropName)

Description copied from interface: UserConfiguration

Optional method that allows a given user management implementation to provide a specific and optimized implementation of the CachedMembershipReader interface for the principals represented by the user/groups known to this implementation. If this method returns null the security setup won't, by default, use a cached membership reader.

Specified by:

getCachedMembershipReader in interface UserConfiguration

Parameters:

root - The root used to read the principal information from.

cachePrincipalFactory - The factory to create the principal from the cache.

propName - The name of the property that contains the cache.

expirationPropName - The name of the property that contains cache expiration time.

Returns:

An implementation of CachedMembershipReader or null if the UserConfiguration implementation does not provide a cached membership reader.