Package com.devonfw.module.security.common.base.accesscontrol

Class AbstractAccessControlProvider

java.lang.Object

com.devonfw.module.security.common.base.accesscontrol.AbstractAccessControlProvider

All Implemented Interfaces:

AccessControlProvider

Direct Known Subclasses:

AccessControlConfig, AccessControlProviderImpl

public abstract class AbstractAccessControlProvider
extends Object
implements AccessControlProvider

This is the abstract base implementation of AccessControlProvider.
ATTENTION:
You need to call initialize(AccessControlSchema) from the derived implementation.

Constructor Summary

Constructors

Constructor	Description
AbstractAccessControlProvider()	The constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addAccessControl(AccessControl accessControl)	Registers the given AccessControl and may be used for configuration of access controls during bootstrapping.
protected void	checkForCyclicDependencies(AccessControlGroup group, List<AccessControlGroup> groupList)	Checks that the given AccessControlGroup has no cyclic inheritance graph.
boolean	collectAccessControlIds(String groupId, Set<String> permissions)	This method collects the IDs of all AccessControlPermissions (or more precisely of all AccessControls) contained in the AccessControl identified by the given groupId.
protected void	collectAccessControls(AccessControlGroup group, Set<AccessControlGroup> toplevelGroups)	Called from initialize(AccessControlSchema) to collect all AccessControls recursively.
boolean	collectAccessControls(String groupId, Set<AccessControl> permissions)	This method collects the AccessControls contained in the AccessControl identified by the given groupId.
void	collectPermissionIds(AccessControlGroup group, Set<String> permissions)	Recursive implementation of collectAccessControlIds(String, Set) for AccessControlGroups.
void	collectPermissionNodes(AccessControlGroup group, Set<AccessControl> permissions)	Recursive implementation of collectAccessControls(String, Set) for AccessControlGroups.
AccessControl	getAccessControl(String nodeId)
protected void	initialize(AccessControlSchema config)	Performs the required initialization of this class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.devonfw.module.security.common.api.accesscontrol.AccessControlProvider

expandPermissions

Constructor Detail

AbstractAccessControlProvider

public AbstractAccessControlProvider()

The constructor.

Method Detail

initialize

protected void initialize(AccessControlSchema config)

Performs the required initialization of this class.

Parameters:

config - is the AccessControlSchema.

checkForCyclicDependencies

protected void checkForCyclicDependencies(AccessControlGroup group,
                                          List<AccessControlGroup> groupList)

Checks that the given AccessControlGroup has no cyclic inheritance graph.

Parameters:

group - is the AccessControlGroup to check.

groupList - the List of visited AccessControlGroups used to detect cycles.

collectAccessControls

protected void collectAccessControls(AccessControlGroup group,
                                     Set<AccessControlGroup> toplevelGroups)

Called from initialize(AccessControlSchema) to collect all AccessControls recursively.

Parameters:

group - the AccessControlGroup to traverse.

toplevelGroups - is the Set of all AccessControlGroups from AccessControlSchema.getGroups().

getAccessControl

public AccessControl getAccessControl(String nodeId)

Specified by:

getAccessControl in interface AccessControlProvider

Parameters:

nodeId - is the ID of the requested AccessControl.

Returns:

the requested AccessControl or null if not found.

addAccessControl

protected void addAccessControl(AccessControl accessControl)

Registers the given AccessControl and may be used for configuration of access controls during bootstrapping. This method should not be used after the application startup (bootstrapping) has completed.

Parameters:

accessControl - the AccessControl to register.

collectAccessControlIds

public boolean collectAccessControlIds(String groupId,
                                       Set<String> permissions)

Description copied from interface: AccessControlProvider

This method collects the IDs of all AccessControlPermissions (or more precisely of all AccessControls) contained in the AccessControl identified by the given groupId.

Specified by:

collectAccessControlIds in interface AccessControlProvider

Parameters:

groupId - is the ID of the AccessControl (typically an AccessControlGroup) to collect.

permissions - is the Set where to add the collected IDs. This will include the given groupId.

Returns:

true if the given groupId has been found, false otherwise.

See Also:

AccessControlProvider.collectAccessControls(String, Set)

collectPermissionIds

public void collectPermissionIds(AccessControlGroup group,
                                 Set<String> permissions)

Recursive implementation of collectAccessControlIds(String, Set) for AccessControlGroups.

Parameters:

group - is the AccessControlGroup to traverse.

permissions - is the Set used to collect.

collectAccessControls

public boolean collectAccessControls(String groupId,
                                     Set<AccessControl> permissions)

Description copied from interface: AccessControlProvider

This method collects the AccessControls contained in the AccessControl identified by the given groupId.

Specified by:

collectAccessControls in interface AccessControlProvider

Parameters:

groupId - is the ID of the AccessControl (typically an AccessControlGroup) to collect.

permissions - is the Set where to add the collected AccessControls. This will include the AccessControl identified by the given groupId.

Returns:

true if the given groupId has been found, false otherwise.

collectPermissionNodes

public void collectPermissionNodes(AccessControlGroup group,
                                   Set<AccessControl> permissions)

Recursive implementation of collectAccessControls(String, Set) for AccessControlGroups.

Parameters:

group - is the AccessControlGroup to traverse.

permissions - is the Set used to collect.