org.opends.server.core

Class VirtualAttributeConfigManager

java.lang.Object

org.opends.server.core.VirtualAttributeConfigManager

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>, org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

public class VirtualAttributeConfigManager
extends Object
implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>, org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.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

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration)
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(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
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(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration,
                                            List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationAddAcceptable in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

applyConfigurationAdd

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

Specified by:

applyConfigurationAdd in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationDeleteAcceptable in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

applyConfigurationDelete

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

Specified by:

applyConfigurationDelete in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.VirtualAttributeCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

applyConfigurationChange

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

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.VirtualAttributeCfg>

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.