org.apache.jackrabbit.oak.spi.security.principal

Class CompositePrincipalConfiguration

java.lang.Object

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

org.apache.jackrabbit.oak.spi.security.principal.CompositePrincipalConfiguration

All Implemented Interfaces:

PrincipalConfiguration, SecurityConfiguration

public class CompositePrincipalConfiguration
extends CompositeConfiguration<PrincipalConfiguration>
implements PrincipalConfiguration

PrincipalConfiguration that combines different principal provider implementations that share a common principal manager implementation.

Nested Class Summary

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

SecurityConfiguration.Default

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.spi.security.CompositeConfiguration

PARAM_RANKING

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.principal.PrincipalConfiguration

NAME

Constructor Summary

Constructors

Constructor and Description
CompositePrincipalConfiguration()
CompositePrincipalConfiguration(@NotNull SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method and Description
@NotNull PrincipalManager	getPrincipalManager(Root root, NamePathMapper namePathMapper) Returns an instance of PrincipalManager that can be used to query and retrieve principals such as needed for JCR access control management.
@NotNull PrincipalProvider	getPrincipalProvider(Root root, NamePathMapper namePathMapper) Returns an instance of the OAK PrincipalProvider.

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

addConfiguration, addConfiguration, getCommitHooks, getConfigurations, getConflictHandlers, getContext, getDefaultConfig, getName, getParameters, getProtectedItemImporters, getRepositoryInitializer, getRootProvider, getSecurityProvider, getTreeProvider, getValidators, getWorkspaceInitializer, removeConfiguration, setDefaultConfig, setRootProvider, setSecurityProvider, setTreeProvider

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, getConflictHandlers, getContext, getName, getParameters, getProtectedItemImporters, getRepositoryInitializer, getValidators, getWorkspaceInitializer

Constructor Detail

CompositePrincipalConfiguration

public CompositePrincipalConfiguration()

CompositePrincipalConfiguration

public CompositePrincipalConfiguration(@NotNull
                                       @NotNull SecurityProvider securityProvider)

Method Detail

getPrincipalManager

@NotNull
public @NotNull PrincipalManager getPrincipalManager(Root root,
                                                              NamePathMapper namePathMapper)

Description copied from interface: PrincipalConfiguration

Returns an instance of PrincipalManager that can be used to query and retrieve principals such as needed for JCR access control management.

Specified by:

getPrincipalManager in interface PrincipalConfiguration

Parameters:

root - The target root.

namePathMapper - The NamePathMapper to be used.

Returns:

An instance of PrincipalManager.

See Also:

JackrabbitSession.getPrincipalManager()

getPrincipalProvider

@NotNull
public @NotNull PrincipalProvider getPrincipalProvider(Root root,
                                                                NamePathMapper namePathMapper)

Description copied from interface: PrincipalConfiguration

Returns an instance of the OAK PrincipalProvider.

Backwards compatibility with Jackrabbit 2.x

Configuration of Principal Providers

In Jackrabbit 2.x the configuration of principal providers was tied to the LoginModule configuration and thus mixing authentication concerns with the principal management. Since OAK makes the PrincipalProvider a public interface of the SPI, it's configuration goes along with the configuration of the JCR level PrincipalManager. The authentication setup may have access to the principal configuration if the SecurityProvider is made available in the AuthenticationConfiguration.

Multiple Sources for Principals

In Jackrabbit 2.x it was possible to configure multiple principal providers. As of OAK there is only one single principal provider implementation responsible for a given workspace. If principals originate from different sources it is recommended to use the CompositePrincipalProvider to combine the different sources.

Specified by:

getPrincipalProvider in interface PrincipalConfiguration

Parameters:

root - The target Root.

namePathMapper - The NamePathMapper to be used.

Returns:

An instance of PrincipalProvider.