public final class AccessControlConfigManager extends Object implements AlertGenerator, ConfigurationChangeListener<AccessControlHandlerCfg>
When access control is disabled a default "permissive" access control implementation is used, which permits all operations regardless of the identity of the user.
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(AccessControlHandlerCfg configuration)
Applies the configuration changes to this change listener.
|
AccessControlHandler<?> |
getAccessControlHandler()
Get the active access control handler.
|
LinkedHashMap<String,String> |
getAlerts()
Retrieves information about the set of alerts that this generator
may produce.
|
String |
getClassName()
Retrieves the fully-qualified name of the Java class for this
alert generator implementation.
|
DN |
getComponentEntryDN()
Retrieves the DN of the configuration entry with which this alert
generator is associated.
|
static AccessControlConfigManager |
getInstance()
Get the single application-wide access control manager instance.
|
void |
initializeAccessControl(ServerContext serverContext)
Initializes the access control sub-system.
|
boolean |
isAccessControlEnabled()
Determine if access control is enabled according to the current
configuration.
|
boolean |
isConfigurationChangeAcceptable(AccessControlHandlerCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
public static AccessControlConfigManager getInstance()
public boolean isAccessControlEnabled()
true
if access control is enabled, false
otherwise.public AccessControlHandler<?> getAccessControlHandler()
When access control is disabled, this method returns a default access control implementation which permits all operations.
null
).public void initializeAccessControl(ServerContext serverContext) throws ConfigException, InitializationException
serverContext
- The server context.ConfigException
- If an access control configuration error is detected.InitializationException
- If a problem occurs while initializing the access control handler
that is not related to the Directory Server configuration.public boolean isConfigurationChangeAcceptable(AccessControlHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<AccessControlHandlerCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(AccessControlHandlerCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<AccessControlHandlerCfg>
configuration
- The new configuration containing the changes.public DN getComponentEntryDN()
AlertGenerator
getComponentEntryDN
in interface AlertGenerator
public String getClassName()
AlertGenerator
getClassName
in interface AlertGenerator
public LinkedHashMap<String,String> getAlerts()
AlertGenerator
getAlerts
in interface AlertGenerator
Copyright 2010-2017 ForgeRock AS.