org.opends.server.core

Class VirtualAttributeConfigManager

java.lang.Object

org.opends.server.core.VirtualAttributeConfigManager

All Implemented Interfaces:

ConfigurationAddListener<VirtualAttributeCfg>, ConfigurationChangeListener<VirtualAttributeCfg>, ConfigurationDeleteListener<VirtualAttributeCfg>

public class VirtualAttributeConfigManager
extends Object
implements ConfigurationChangeListener<VirtualAttributeCfg>, ConfigurationAddListener<VirtualAttributeCfg>, ConfigurationDeleteListener<VirtualAttributeCfg>

This class defines a utility that will be used to manage the set of virtual attribute providers defined in the Directory Server. It will initialize the providers when the server starts, and then will manage any additions, removals, or modifications to any virtual attribute providers while the server is running.

Constructor Summary

Constructors

Constructor and Description
VirtualAttributeConfigManager(ServerContext serverContext) Creates a new instance of this virtual attribute config manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(VirtualAttributeCfg configuration) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(VirtualAttributeCfg configuration) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(VirtualAttributeCfg configuration) Deletes an existing configuration from this delete listener.
void	deregister(VirtualAttributeRule rule) Deregisters the provided virtual attribute rule.
Collection<VirtualAttributeRule>	getVirtualAttributes() Retrieves the collection of registered virtual attribute rules.
void	initializeVirtualAttributes() Initializes all virtual attribute providers currently defined in the Directory Server configuration.
boolean	isConfigurationAddAcceptable(VirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(VirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(VirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.
void	register(VirtualAttributeRule rule) Registers the provided virtual attribute rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualAttributeConfigManager

public VirtualAttributeConfigManager(ServerContext serverContext)

Creates a new instance of this virtual attribute config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeVirtualAttributes

public void initializeVirtualAttributes()
                                 throws org.forgerock.opendj.config.server.ConfigException,
                                        InitializationException

Initializes all virtual attribute providers currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem causes the virtual attribute provider initialization process to fail.

InitializationException - If a problem occurs while initializing the virtual attribute providers that is not related to the server configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(VirtualAttributeCfg configuration,
                                   List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<VirtualAttributeCfg>

Parameters:

configuration - The configuration that will be added.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed addition is acceptable, or false if it is not.

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(VirtualAttributeCfg configuration)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<VirtualAttributeCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(VirtualAttributeCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<VirtualAttributeCfg>

Parameters:

configuration - The configuration that will be deleted.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(VirtualAttributeCfg configuration)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<VirtualAttributeCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(VirtualAttributeCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<VirtualAttributeCfg>

Parameters:

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.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(VirtualAttributeCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<VirtualAttributeCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

getVirtualAttributes

public Collection<VirtualAttributeRule> getVirtualAttributes()

Retrieves the collection of registered virtual attribute rules.

Returns:

The collection of registered virtual attribute rules.

register

public void register(VirtualAttributeRule rule)

Registers the provided virtual attribute rule.

Parameters:

rule - The virtual attribute rule to be registered.

deregister

public void deregister(VirtualAttributeRule rule)

Deregisters the provided virtual attribute rule.

Parameters:

rule - The virtual attribute rule to be deregistered.