org.apache.jackrabbit.oak.spi.security.authorization.cug.impl

Class CugConfiguration

java.lang.Object

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

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

org.apache.jackrabbit.oak.spi.security.authorization.cug.impl.CugConfiguration

All Implemented Interfaces:

org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration, org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

@Service(value={org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration.class,org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.class})
 @Property(name="cugSupportedPaths",label="Supported Paths",description="Paths under which CUGs can be created and will be evaluated.",cardinality=2147483647) @Property(name="cugEnabled",label="CUG Evaluation Enabled",description="Flag to enable the evaluation of the configured CUG policies.",boolValue=false) @Property(name="configurationRanking",label="Ranking",description="Ranking of this configuration in a setup with multiple authorization configurations.",intValue=200) @Property(name="oak.security.name",propertyPrivate=true,value="org.apache.jackrabbit.oak.spi.security.authorization.cug.impl.CugConfiguration")
public class CugConfiguration
extends org.apache.jackrabbit.oak.spi.security.ConfigurationBase
implements org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIDDEN_NESTED_CUGS The name of the hidden property that stores information about nested CUG policy nodes.
static String	HIDDEN_TOP_CUG_CNT The name of the hidden property that stores information about the number of CUG roots located close to the root node.
static String	MIX_REP_CUG_MIXIN The name of the mixin type that defines the CUG policy node.
static String	NT_REP_CUG_POLICY The primary node type name of the CUG policy node.
static String	PARAM_CUG_ENABLED Name of the configuration option that specifies if CUG content must be respected for permission evaluation.
static String	PARAM_CUG_SUPPORTED_PATHS Name of the configuration option that specifies the subtrees that allow to define closed user groups.
static String	REP_CUG_POLICY The name of the CUG policy node.
static String	REP_PRINCIPAL_NAMES The name of the property that stores the principal names that are allowed to access the restricted area defined by the CUG (closed user group).

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration

NAME

Constructor Summary

Constructors

Constructor and Description
CugConfiguration()
CugConfiguration(@NotNull org.apache.jackrabbit.oak.spi.security.SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method and Description
protected void	activate(Map<String,Object> properties)
void	bindExclude(CugExclude exclude)
void	bindMountInfoProvider(org.apache.jackrabbit.oak.spi.mount.MountInfoProvider mountInfoProvider)
@NotNull javax.jcr.security.AccessControlManager	getAccessControlManager(@NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)
@NotNull List<? extends org.apache.jackrabbit.oak.spi.commit.CommitHook>	getCommitHooks(@NotNull String workspaceName)
@NotNull org.apache.jackrabbit.oak.spi.security.Context	getContext()
@NotNull String	getName()
@NotNull org.apache.jackrabbit.oak.spi.security.authorization.permission.PermissionProvider	getPermissionProvider(@NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull String workspaceName, @NotNull Set<Principal> principals)
@NotNull List<org.apache.jackrabbit.oak.spi.xml.ProtectedItemImporter>	getProtectedItemImporters()
@NotNull org.apache.jackrabbit.oak.spi.lifecycle.RepositoryInitializer	getRepositoryInitializer()
@NotNull org.apache.jackrabbit.oak.spi.security.authorization.restriction.RestrictionProvider	getRestrictionProvider()
@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)
protected void	modified(Map<String,Object> properties)
void	setParameters(@NotNull org.apache.jackrabbit.oak.spi.security.ConfigurationParameters config)
void	unbindExclude(CugExclude exclude)
void	unbindMountInfoProvider(org.apache.jackrabbit.oak.spi.mount.MountInfoProvider mountInfoProvider)

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

getParameters, getRootProvider, getSecurityProvider, getTreeProvider, setRootProvider, setSecurityProvider, setTreeProvider

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

getConflictHandlers, getWorkspaceInitializer

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

getConflictHandlers, getParameters, getWorkspaceInitializer

Field Detail

MIX_REP_CUG_MIXIN

public static final String MIX_REP_CUG_MIXIN

The name of the mixin type that defines the CUG policy node.

See Also:

Constant Field Values

NT_REP_CUG_POLICY

public static final String NT_REP_CUG_POLICY

The primary node type name of the CUG policy node.

See Also:

Constant Field Values

REP_CUG_POLICY

public static final String REP_CUG_POLICY

The name of the CUG policy node.

See Also:

Constant Field Values

HIDDEN_NESTED_CUGS

public static final String HIDDEN_NESTED_CUGS

The name of the hidden property that stores information about nested CUG policy nodes.

See Also:

Constant Field Values

HIDDEN_TOP_CUG_CNT

public static final String HIDDEN_TOP_CUG_CNT

The name of the hidden property that stores information about the number of CUG roots located close to the root node.

See Also:

Constant Field Values

REP_PRINCIPAL_NAMES

public static final String REP_PRINCIPAL_NAMES

The name of the property that stores the principal names that are allowed to access the restricted area defined by the CUG (closed user group).

See Also:

Constant Field Values

PARAM_CUG_SUPPORTED_PATHS

public static final String PARAM_CUG_SUPPORTED_PATHS

Name of the configuration option that specifies the subtrees that allow to define closed user groups.

• Value Type: String
• Default: -
• Multiple: true

See Also:

Constant Field Values

PARAM_CUG_ENABLED

public static final String PARAM_CUG_ENABLED

Name of the configuration option that specifies if CUG content must be respected for permission evaluation.

• Value Type: boolean
• Default: false
• Multiple: false

See Also:

Constant Field Values

Constructor Detail

CugConfiguration

public CugConfiguration()

CugConfiguration

public CugConfiguration(@NotNull
                        @NotNull org.apache.jackrabbit.oak.spi.security.SecurityProvider securityProvider)

Method Detail

getAccessControlManager

@NotNull
public @NotNull javax.jcr.security.AccessControlManager getAccessControlManager(@NotNull
                                                                                         @NotNull org.apache.jackrabbit.oak.api.Root root,
                                                                                         @NotNull
                                                                                         @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)

Specified by:

getAccessControlManager in interface org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration

getRestrictionProvider

@NotNull
public @NotNull org.apache.jackrabbit.oak.spi.security.authorization.restriction.RestrictionProvider getRestrictionProvider()

Specified by:

getRestrictionProvider in interface org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration

getPermissionProvider

@NotNull
public @NotNull org.apache.jackrabbit.oak.spi.security.authorization.permission.PermissionProvider getPermissionProvider(@NotNull
                                                                                                                                  @NotNull org.apache.jackrabbit.oak.api.Root root,
                                                                                                                                  @NotNull
                                                                                                                                  @NotNull String workspaceName,
                                                                                                                                  @NotNull
                                                                                                                                  @NotNull Set<Principal> principals)

Specified by:

getPermissionProvider in interface org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration

getName

@NotNull
public @NotNull String getName()

Specified by:

getName in interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

Overrides:

getName in class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

getRepositoryInitializer

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

Specified by:

getRepositoryInitializer in interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

Overrides:

getRepositoryInitializer in class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

getCommitHooks

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

Specified by:

getCommitHooks in interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

Overrides:

getCommitHooks in class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

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)

Specified by:

getValidators in interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

Overrides:

getValidators in class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

getProtectedItemImporters

@NotNull
public @NotNull List<org.apache.jackrabbit.oak.spi.xml.ProtectedItemImporter> getProtectedItemImporters()

Specified by:

getProtectedItemImporters in interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

Overrides:

getProtectedItemImporters in class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

getContext

@NotNull
public @NotNull org.apache.jackrabbit.oak.spi.security.Context getContext()

Specified by:

getContext in interface org.apache.jackrabbit.oak.spi.security.SecurityConfiguration

Overrides:

getContext in class org.apache.jackrabbit.oak.spi.security.SecurityConfiguration.Default

setParameters

public void setParameters(@NotNull
                          @NotNull org.apache.jackrabbit.oak.spi.security.ConfigurationParameters config)

Overrides:

setParameters in class org.apache.jackrabbit.oak.spi.security.ConfigurationBase

activate

@Activate
protected void activate(Map<String,Object> properties)

modified

@Modified
protected void modified(Map<String,Object> properties)

bindMountInfoProvider

public void bindMountInfoProvider(org.apache.jackrabbit.oak.spi.mount.MountInfoProvider mountInfoProvider)

unbindMountInfoProvider

public void unbindMountInfoProvider(org.apache.jackrabbit.oak.spi.mount.MountInfoProvider mountInfoProvider)

bindExclude

public void bindExclude(CugExclude exclude)

unbindExclude

public void unbindExclude(CugExclude exclude)