From bff247202b2e096249150884a93601b19e836c9a Mon Sep 17 00:00:00 2001
From: jdemendi <jdemendi@localhost>
Date: Wed, 02 May 2007 08:29:33 +0000
Subject: [PATCH] Issue #1560 - Migrate some objects to the new admin framework: - Entry Cache - Account Status Notification Handler - Password Storage Scheme
---
opends/src/server/org/opends/server/core/AccountStatusNotificationHandlerConfigManager.java | 1083 +++++++++++++++-----------------------------------------
1 files changed, 294 insertions(+), 789 deletions(-)
diff --git a/opends/src/server/org/opends/server/core/AccountStatusNotificationHandlerConfigManager.java b/opends/src/server/org/opends/server/core/AccountStatusNotificationHandlerConfigManager.java
index 3b2d68d..bde3356 100644
--- a/opends/src/server/org/opends/server/core/AccountStatusNotificationHandlerConfigManager.java
+++ b/opends/src/server/org/opends/server/core/AccountStatusNotificationHandlerConfigManager.java
@@ -28,38 +28,30 @@
+import static org.opends.server.messages.ConfigMessages.*;
+import static org.opends.server.messages.MessageHandler.getMessage;
+import static org.opends.server.util.StaticUtils.stackTraceToSingleLineString;
+
+import java.lang.reflect.Method;
import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
+import org.opends.server.admin.ClassPropertyDefinition;
+import org.opends.server.admin.server.ConfigurationAddListener;
+import org.opends.server.admin.server.ConfigurationChangeListener;
+import org.opends.server.admin.server.ConfigurationDeleteListener;
+import org.opends.server.admin.server.ServerManagementContext;
+import org.opends.server.admin.std.meta.AccountStatusNotificationHandlerCfgDefn;
+import org.opends.server.admin.std.server.AccountStatusNotificationHandlerCfg;
+import org.opends.server.admin.std.server.RootCfg;
import org.opends.server.api.AccountStatusNotificationHandler;
-import org.opends.server.api.ConfigAddListener;
-import org.opends.server.api.ConfigChangeListener;
-import org.opends.server.api.ConfigDeleteListener;
-import org.opends.server.api.ConfigHandler;
-import org.opends.server.api.ConfigurableComponent;
-import org.opends.server.config.BooleanConfigAttribute;
-import org.opends.server.config.ConfigEntry;
import org.opends.server.config.ConfigException;
-import org.opends.server.config.StringConfigAttribute;
import org.opends.server.types.ConfigChangeResult;
import org.opends.server.types.DN;
-import org.opends.server.types.ErrorLogCategory;
-import org.opends.server.types.ErrorLogSeverity;
import org.opends.server.types.InitializationException;
import org.opends.server.types.ResultCode;
-import static org.opends.server.config.ConfigConstants.*;
-import static org.opends.server.loggers.debug.DebugLogger.debugCaught;
-import static org.opends.server.loggers.debug.DebugLogger.debugEnabled;
-import org.opends.server.types.DebugLogLevel;
-import static org.opends.server.loggers.Error.*;
-import static org.opends.server.messages.ConfigMessages.*;
-import static org.opends.server.messages.MessageHandler.*;
-import static org.opends.server.util.ServerConstants.*;
-
/**
@@ -70,19 +62,16 @@
* server is running.
*/
public class AccountStatusNotificationHandlerConfigManager
- implements ConfigChangeListener, ConfigAddListener, ConfigDeleteListener
+ implements
+ ConfigurationChangeListener <AccountStatusNotificationHandlerCfg>,
+ ConfigurationAddListener <AccountStatusNotificationHandlerCfg>,
+ ConfigurationDeleteListener <AccountStatusNotificationHandlerCfg>
{
-
-
// A mapping between the DNs of the config entries and the associated
// notification handlers.
private ConcurrentHashMap<DN,AccountStatusNotificationHandler>
- notificationHandlers;
-
- // The configuration handler for the Directory Server.
- private ConfigHandler configHandler;
-
+ notificationHandlers;
/**
@@ -91,7 +80,6 @@
*/
public AccountStatusNotificationHandlerConfigManager()
{
- configHandler = DirectoryServer.getConfigHandler();
notificationHandlers =
new ConcurrentHashMap<DN,AccountStatusNotificationHandler>();
}
@@ -115,823 +103,228 @@
public void initializeNotificationHandlers()
throws ConfigException, InitializationException
{
- // First, get the configuration base entry.
- ConfigEntry baseEntry;
- try
+ // Get the root configuration object.
+ ServerManagementContext managementContext =
+ ServerManagementContext.getInstance();
+ RootCfg rootConfiguration =
+ managementContext.getRootConfiguration();
+
+ // Register as an add and delete listener with the root configuration so
+ // we can be notified if any account status notification handler entry
+ // is added or removed.
+ rootConfiguration.addAccountStatusNotificationHandlerAddListener (this);
+ rootConfiguration.addAccountStatusNotificationHandlerDeleteListener (this);
+
+ // Initialize existing account status notification handlers.
+ for (String handlerName:
+ rootConfiguration.listAccountStatusNotificationHandlers())
{
- DN handlerBase = DN.decode(DN_ACCT_NOTIFICATION_HANDLER_CONFIG_BASE);
- baseEntry = configHandler.getConfigEntry(handlerBase);
- }
- catch (Exception e)
- {
- if (debugEnabled())
+ // Get the account status notification handler's configuration.
+ AccountStatusNotificationHandlerCfg config =
+ rootConfiguration.getAccountStatusNotificationHandler (handlerName);
+
+ // Register as a change listener for this notification handler
+ // entry so that we will be notified of any changes that may be
+ // made to it.
+ config.addChangeListener (this);
+
+ // Ignore this notification handler if it is disabled.
+ if (config.isEnabled())
{
- debugCaught(DebugLogLevel.ERROR, e);
+ // Load the notification handler implementation class.
+ String className = config.getNotificationHandlerClass();
+ loadAndInstallNotificationHandler (className, config);
}
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_CANNOT_GET_BASE;
- String message = getMessage(msgID, String.valueOf(e));
- throw new ConfigException(msgID, message, e);
}
+ }
- if (baseEntry == null)
+
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean isConfigurationChangeAcceptable(
+ AccountStatusNotificationHandlerCfg configuration,
+ List<String> unacceptableReasons
+ )
+ {
+ // returned status -- all is fine by default
+ boolean status = true;
+
+ if (configuration.isEnabled())
{
- // The notification handler base entry does not exist. This is not
- // acceptable, so throw an exception.
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_BASE_DOES_NOT_EXIST;
- String message = getMessage(msgID);
- throw new ConfigException(msgID, message);
- }
-
-
- // Register add and delete listeners with the notification handler base
- // entry. We don't care about modifications to it.
- baseEntry.registerAddListener(this);
- baseEntry.registerDeleteListener(this);
-
-
- // See if the base entry has any children. If not, then we don't need to do
- // anything else.
- if (! baseEntry.hasChildren())
- {
- return;
- }
-
-
- // Iterate through the child entries and process them as account status
- // notification handler configuration entries.
- for (ConfigEntry childEntry : baseEntry.getChildren().values())
- {
- childEntry.registerChangeListener(this);
-
- StringBuilder unacceptableReason = new StringBuilder();
- if (! configAddIsAcceptable(childEntry, unacceptableReason))
- {
- logError(ErrorLogCategory.CONFIGURATION, ErrorLogSeverity.SEVERE_ERROR,
- MSGID_CONFIG_ACCTNOTHANDLER_ENTRY_UNACCEPTABLE,
- childEntry.getDN().toString(), unacceptableReason.toString());
- continue;
- }
-
+ // Get the name of the class and make sure we can instantiate it as an
+ // entry cache.
+ String className = configuration.getNotificationHandlerClass();
try
{
- ConfigChangeResult result = applyConfigurationAdd(childEntry);
- if (result.getResultCode() != ResultCode.SUCCESS)
- {
- StringBuilder buffer = new StringBuilder();
-
- List<String> resultMessages = result.getMessages();
- if ((resultMessages == null) || (resultMessages.isEmpty()))
- {
- buffer.append(getMessage(MSGID_CONFIG_UNKNOWN_UNACCEPTABLE_REASON));
- }
- else
- {
- Iterator<String> iterator = resultMessages.iterator();
-
- buffer.append(iterator.next());
- while (iterator.hasNext())
- {
- buffer.append(EOL);
- buffer.append(iterator.next());
- }
- }
-
- logError(ErrorLogCategory.CONFIGURATION,
- ErrorLogSeverity.SEVERE_ERROR,
- MSGID_CONFIG_ACCTNOTHANDLER_CANNOT_CREATE_HANDLER,
- childEntry.getDN().toString(), buffer.toString());
- }
+ // Load the class but don't initialize it.
+ loadNotificationHandler(className, null);
}
- catch (Exception e)
+ catch (InitializationException ie)
{
- logError(ErrorLogCategory.CONFIGURATION, ErrorLogSeverity.SEVERE_ERROR,
- MSGID_CONFIG_ACCTNOTHANDLER_CANNOT_CREATE_HANDLER,
- childEntry.getDN().toString(), String.valueOf(e));
+ unacceptableReasons.add(ie.getMessage());
+ status = false;
}
}
+
+ return status;
}
/**
- * Indicates whether the configuration entry that will result from a proposed
- * modification is acceptable to this change listener.
- *
- * @param configEntry The configuration entry that will result from
- * the requested update.
- * @param unacceptableReason A buffer to which this method can append a
- * human-readable message explaining why the
- * proposed change is not acceptable.
- *
- * @return <CODE>true</CODE> if the proposed entry contains an acceptable
- * configuration, or <CODE>false</CODE> if it does not.
+ * {@inheritDoc}
*/
- public boolean configChangeIsAcceptable(ConfigEntry configEntry,
- StringBuilder unacceptableReason)
+ public ConfigChangeResult applyConfigurationChange(
+ AccountStatusNotificationHandlerCfg configuration
+ )
{
- // Make sure that the entry has an appropriate objectclass for an account
- // status notification handler.
- if (! configEntry.hasObjectClass(OC_ACCT_NOTIFICATION_HANDLER))
+ // Returned result.
+ ConfigChangeResult changeResult = new ConfigChangeResult(
+ ResultCode.SUCCESS, false, new ArrayList<String>()
+ );
+
+ // Get the configuration entry DN and the associated handler class.
+ DN configEntryDN = configuration.dn();
+ AccountStatusNotificationHandler handler = notificationHandlers.get(
+ configEntryDN
+ );
+
+ // If the new configuration has the notification handler disabled,
+ // then remove it from the mapping list and clean it.
+ if (! configuration.isEnabled())
{
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_OBJECTCLASS;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
-
-
- // Make sure that the entry specifies the notification handler class name.
- StringConfigAttribute classNameAttr;
- try
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_CLASS_NAME;
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_CLASS,
- getMessage(msgID), true, false, true);
- classNameAttr = (StringConfigAttribute)
- configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
+ if (handler != null)
{
- msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
+ uninstallNotificationHandler (configEntryDN);
}
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
+ return changeResult;
}
- Class handlerClass;
- try
- {
- handlerClass = DirectoryServer.loadClass(classNameAttr.pendingValue());
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
- try
- {
- AccountStatusNotificationHandler handler =
- (AccountStatusNotificationHandler) handlerClass.newInstance();
- }
- catch(Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS;
- String message = getMessage(msgID, handlerClass.getName(),
- String.valueOf(configEntry.getDN()),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // See if this account status notification handler should be enabled.
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_ENABLED,
- getMessage(MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_ENABLED_ATTR;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_ENABLED_VALUE;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // If we've gotten here then the notification handler entry appears to be
- // acceptable.
- return true;
- }
-
-
-
- /**
- * Attempts to apply a new configuration to this Directory Server component
- * based on the provided changed entry.
- *
- * @param configEntry The configuration entry that containing the updated
- * configuration for this component.
- *
- * @return Information about the result of processing the configuration
- * change.
- */
- public ConfigChangeResult applyConfigurationChange(ConfigEntry configEntry)
- {
- DN configEntryDN = configEntry.getDN();
- ResultCode resultCode = ResultCode.SUCCESS;
- boolean adminActionRequired = false;
- ArrayList<String> messages = new ArrayList<String>();
-
-
- // Make sure that the entry has an appropriate objectclass for an account
- // status notification handler.
- if (! configEntry.hasObjectClass(OC_ACCT_NOTIFICATION_HANDLER))
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_OBJECTCLASS;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.UNWILLING_TO_PERFORM;
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // Get the corresponding notification handler if it is active.
- AccountStatusNotificationHandler handler =
- notificationHandlers.get(configEntryDN);
-
-
- // See if this handler should be enabled or disabled.
- boolean needsEnabled = false;
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_ENABLED,
- getMessage(MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_ENABLED_ATTR;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.UNWILLING_TO_PERFORM;
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
-
- if (enabledAttr.activeValue())
- {
- if (handler == null)
- {
- needsEnabled = true;
- }
- else
- {
- // The handler is already active, so no action is required.
- }
- }
- else
- {
- if (handler == null)
- {
- // The handler is already disabled, so no action is required and we
- // can short-circuit out of this processing.
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
- else
- {
- // The handler is active, so it needs to be disabled. Do this and
- // return that we were successful.
- notificationHandlers.remove(configEntryDN);
- handler.finalizeStatusNotificationHandler();
-
- DirectoryServer.deregisterAccountStatusNotificationHandler(
- configEntryDN);
-
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
- }
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_ENABLED_VALUE;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // Make sure that the entry specifies the notification handler class name.
- // If it has changed, then we will not try to dynamically apply it.
- String className;
- try
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_CLASS_NAME;
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_CLASS,
- getMessage(msgID), true, false, true);
- StringConfigAttribute classNameAttr =
- (StringConfigAttribute) configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
- {
- msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_CLASS_NAME;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.OBJECTCLASS_VIOLATION;
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
-
- className = classNameAttr.pendingValue();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS_NAME;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- boolean classChanged = false;
- String oldClassName = null;
+ // At this point, new configuration is enabled...
+ // If the current notification handler is already enabled then we
+ // don't do anything unless the class has changed in which case we
+ // should indicate that administrative action is required.
+ String newClassName = configuration.getNotificationHandlerClass();
if (handler != null)
{
- oldClassName = handler.getClass().getName();
- classChanged = (! className.equals(oldClassName));
+ String curClassName = handler.getClass().getName();
+ boolean classIsNew = (! newClassName.equals (curClassName));
+ if (classIsNew)
+ {
+ changeResult.setAdminActionRequired (true);
+ }
+ return changeResult;
}
-
- if (classChanged)
+ // New entry cache is enabled and there were no previous one.
+ // Instantiate the new class and initalize it.
+ try
{
- // This will not be applied dynamically. Add a message to the response
- // and indicate that admin action is required.
- adminActionRequired = true;
- messages.add(getMessage(MSGID_CONFIG_ACCTNOTHANDLER_CLASS_ACTION_REQUIRED,
- String.valueOf(oldClassName),
- String.valueOf(className),
- String.valueOf(configEntryDN)));
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
+ loadAndInstallNotificationHandler (newClassName, configuration);
}
-
-
- if (needsEnabled)
+ catch (InitializationException ie)
{
- try
- {
- Class handlerClass = DirectoryServer.loadClass(className);
- handler = (AccountStatusNotificationHandler) handlerClass.newInstance();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS;
- messages.add(getMessage(msgID, className,
- String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
-
- try
- {
- handler.initializeStatusNotificationHandler(configEntry);
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INITIALIZATION_FAILED;
- messages.add(getMessage(msgID, className,
- String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
-
-
- notificationHandlers.put(configEntryDN, handler);
- DirectoryServer.registerAccountStatusNotificationHandler(configEntryDN,
- handler);
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
+ changeResult.addMessage (ie.getMessage());
+ changeResult.setResultCode (DirectoryServer.getServerErrorResultCode());
+ return changeResult;
}
-
- // If we've gotten here, then there haven't been any changes to anything
- // that we care about.
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
+ return changeResult;
}
/**
- * Indicates whether the configuration entry that will result from a proposed
- * add is acceptable to this add listener.
- *
- * @param configEntry The configuration entry that will result from
- * the requested add.
- * @param unacceptableReason A buffer to which this method can append a
- * human-readable message explaining why the
- * proposed entry is not acceptable.
- *
- * @return <CODE>true</CODE> if the proposed entry contains an acceptable
- * configuration, or <CODE>false</CODE> if it does not.
+ * {@inheritDoc}
*/
- public boolean configAddIsAcceptable(ConfigEntry configEntry,
- StringBuilder unacceptableReason)
+ public boolean isConfigurationAddAcceptable(
+ AccountStatusNotificationHandlerCfg configuration,
+ List<String> unacceptableReasons
+ )
{
+ // returned status -- all is fine by default
+ boolean status = true;
+
// Make sure that no entry already exists with the specified DN.
- DN configEntryDN = configEntry.getDN();
+ DN configEntryDN = configuration.dn();
if (notificationHandlers.containsKey(configEntryDN))
{
int msgID = MSGID_CONFIG_ACCTNOTHANDLER_EXISTS;
String message = getMessage(msgID, String.valueOf(configEntryDN));
- unacceptableReason.append(message);
- return false;
+ unacceptableReasons.add (message);
+ status = false;
}
-
-
- // Make sure that the entry has an appropriate objectclass for an account
- // status notification handler.
- if (! configEntry.hasObjectClass(OC_ACCT_NOTIFICATION_HANDLER))
+ // If configuration is enabled then check that notification class
+ // can be instantiated.
+ else if (configuration.isEnabled())
{
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_OBJECTCLASS;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
-
-
- // Make sure that the entry specifies the handler class.
- StringConfigAttribute classNameAttr;
- try
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_CLASS_NAME;
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_CLASS,
- getMessage(msgID), true, false, true);
- classNameAttr = (StringConfigAttribute)
- configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
+ // Get the name of the class and make sure we can instantiate it as
+ // an entry cache.
+ String className = configuration.getNotificationHandlerClass();
+ try
{
- msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
+ // Load the class but don't initialize it.
+ loadNotificationHandler (className, null);
}
- }
- catch (Exception e)
- {
- if (debugEnabled())
+ catch (InitializationException ie)
{
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
- Class handlerClass;
- try
- {
- handlerClass = DirectoryServer.loadClass(classNameAttr.pendingValue());
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
- AccountStatusNotificationHandler handler;
- try
- {
- handler = (AccountStatusNotificationHandler) handlerClass.newInstance();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS;
- String message = getMessage(msgID, handlerClass.getName(),
- String.valueOf(configEntryDN),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // If the notofication handler is a configurable component, then make sure
- // that its configuration is valid.
- if (handler instanceof ConfigurableComponent)
- {
- ConfigurableComponent cc = (ConfigurableComponent) handler;
- LinkedList<String> errorMessages = new LinkedList<String>();
- if (! cc.hasAcceptableConfiguration(configEntry, errorMessages))
- {
- if (errorMessages.isEmpty())
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_UNACCEPTABLE_CONFIG;
- unacceptableReason.append(getMessage(msgID,
- String.valueOf(configEntryDN)));
- }
- else
- {
- Iterator<String> iterator = errorMessages.iterator();
- unacceptableReason.append(iterator.next());
- while (iterator.hasNext())
- {
- unacceptableReason.append(" ");
- unacceptableReason.append(iterator.next());
- }
- }
-
- return false;
+ unacceptableReasons.add (ie.getMessage());
+ status = false;
}
}
-
- // See if this notification handler should be enabled.
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_ENABLED,
- getMessage(MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_ENABLED_ATTR;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_ENABLED_VALUE;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // If we've gotten here then the notification handler entry appears to be
- // acceptable.
- return true;
+ return status;
}
/**
- * Attempts to apply a new configuration based on the provided added entry.
- *
- * @param configEntry The new configuration entry that contains the
- * configuration to apply.
- *
- * @return Information about the result of processing the configuration
- * change.
+ * {@inheritDoc}
*/
- public ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry)
+ public ConfigChangeResult applyConfigurationAdd(
+ AccountStatusNotificationHandlerCfg configuration
+ )
{
- DN configEntryDN = configEntry.getDN();
- ResultCode resultCode = ResultCode.SUCCESS;
- boolean adminActionRequired = false;
- ArrayList<String> messages = new ArrayList<String>();
+ // Returned result.
+ ConfigChangeResult changeResult = new ConfigChangeResult(
+ ResultCode.SUCCESS, false, new ArrayList<String>()
+ );
+ // Register a change listener with it so we can be notified of changes
+ // to it over time.
+ configuration.addChangeListener(this);
- // Make sure that the entry has an appropriate objectclass for an account
- // status notification handler.
- if (! configEntry.hasObjectClass(OC_ACCT_NOTIFICATION_HANDLER))
+ if (configuration.isEnabled())
{
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_OBJECTCLASS;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.UNWILLING_TO_PERFORM;
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // See if this notification handler should be enabled or disabled.
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_ENABLED,
- getMessage(MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
+ // Instantiate the class as an entry cache and initialize it.
+ String className = configuration.getNotificationHandlerClass();
+ try
{
- // The attribute doesn't exist, so it will be disabled by default.
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_ENABLED_ATTR;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.SUCCESS;
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
+ loadAndInstallNotificationHandler (className, configuration);
}
- else if (! enabledAttr.activeValue())
+ catch (InitializationException ie)
{
- // It is explicitly configured as disabled, so we don't need to do
- // anything.
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
+ changeResult.addMessage (ie.getMessage());
+ changeResult.setResultCode (DirectoryServer.getServerErrorResultCode());
+ return changeResult;
}
}
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_ENABLED_VALUE;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // Make sure that the entry specifies the handler class name.
- String className;
- try
- {
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_DESCRIPTION_CLASS_NAME;
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_ACCT_NOTIFICATION_HANDLER_CLASS,
- getMessage(msgID), true, false, true);
- StringConfigAttribute classNameAttr =
- (StringConfigAttribute) configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
- {
- msgID = MSGID_CONFIG_ACCTNOTHANDLER_NO_CLASS_NAME;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.OBJECTCLASS_VIOLATION;
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
-
- className = classNameAttr.pendingValue();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS_NAME;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // Load and initialize the notificationhandler class, and register it with
- // the Directory Server.
- AccountStatusNotificationHandler handler;
- try
- {
- Class handlerClass = DirectoryServer.loadClass(className);
- handler = (AccountStatusNotificationHandler) handlerClass.newInstance();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INVALID_CLASS;
- messages.add(getMessage(msgID, className, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
- try
- {
- handler.initializeStatusNotificationHandler(configEntry);
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INITIALIZATION_FAILED;
- messages.add(getMessage(msgID, className, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- notificationHandlers.put(configEntryDN, handler);
- DirectoryServer.registerAccountStatusNotificationHandler(configEntryDN,
- handler);
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
+ return changeResult;
}
/**
- * Indicates whether it is acceptable to remove the provided configuration
- * entry.
- *
- * @param configEntry The configuration entry that will be removed
- * from the configuration.
- * @param unacceptableReason A buffer to which this method can append a
- * human-readable message explaining why the
- * proposed delete is not acceptable.
- *
- * @return <CODE>true</CODE> if the proposed entry may be removed from the
- * configuration, or <CODE>false</CODE> if not.
+ * {@inheritDoc}
*/
- public boolean configDeleteIsAcceptable(ConfigEntry configEntry,
- StringBuilder unacceptableReason)
+ public boolean isConfigurationDeleteAcceptable(
+ AccountStatusNotificationHandlerCfg configuration,
+ List<String> unacceptableReasons
+ )
{
// A delete should always be acceptable, so just return true.
return true;
@@ -940,33 +333,145 @@
/**
- * Attempts to apply a new configuration based on the provided deleted entry.
- *
- * @param configEntry The new configuration entry that has been deleted.
- *
- * @return Information about the result of processing the configuration
- * change.
+ * {@inheritDoc}
*/
- public ConfigChangeResult applyConfigurationDelete(ConfigEntry configEntry)
+ public ConfigChangeResult applyConfigurationDelete(
+ AccountStatusNotificationHandlerCfg configuration
+ )
{
- DN configEntryDN = configEntry.getDN();
- ResultCode resultCode = ResultCode.SUCCESS;
- boolean adminActionRequired = false;
+ // Returned result.
+ ConfigChangeResult changeResult = new ConfigChangeResult(
+ ResultCode.SUCCESS, false, new ArrayList<String>()
+ );
+
+ uninstallNotificationHandler (configuration.dn());
+
+ return changeResult;
+ }
- // See if the entry is registered as an account status notification handler.
- // If so, deregister it and stop the handler.
+ /**
+ * Loads the specified class, instantiates it as a notification handler,
+ * and optionally initializes that instance. Any initialized notification
+ * handler is registered in the server.
+ *
+ * @param className The fully-qualified name of the notification handler
+ * class to load, instantiate, and initialize.
+ * @param configuration The configuration to use to initialize the
+ * notification handler, or {@code null} if the
+ * notification handler should not be initialized.
+ *
+ * @throws InitializationException If a problem occurred while attempting
+ * to initialize the notification handler.
+ */
+ private void loadAndInstallNotificationHandler(
+ String className,
+ AccountStatusNotificationHandlerCfg configuration
+ )
+ throws InitializationException
+ {
+ // Load the notification handler class...
+ AccountStatusNotificationHandler
+ <? extends AccountStatusNotificationHandlerCfg> handlerClass;
+ handlerClass = loadNotificationHandler (className, configuration);
+
+ // ... and install the entry cache in the server.
+ DN configEntryDN = configuration.dn();
+ notificationHandlers.put (configEntryDN, handlerClass);
+ DirectoryServer.registerAccountStatusNotificationHandler(
+ configEntryDN,
+ handlerClass
+ );
+ }
+
+
+ /**
+ * Loads the specified class, instantiates it as a notification handler,
+ * and optionally initializes that instance.
+ *
+ * @param className The fully-qualified name of the notification handler
+ * class to load, instantiate, and initialize.
+ * @param configuration The configuration to use to initialize the
+ * notification handler, or {@code null} if the
+ * notification handler should not be initialized.
+ *
+ * @return The possibly initialized notification handler.
+ *
+ * @throws InitializationException If a problem occurred while attempting
+ * to initialize the notification handler.
+ */
+ private
+ AccountStatusNotificationHandler
+ <? extends AccountStatusNotificationHandlerCfg>
+ loadNotificationHandler(
+ String className,
+ AccountStatusNotificationHandlerCfg configuration
+ )
+ throws InitializationException
+ {
+ try
+ {
+ AccountStatusNotificationHandlerCfgDefn definition;
+ ClassPropertyDefinition propertyDefinition;
+ Class<? extends AccountStatusNotificationHandler> handlerClass;
+ AccountStatusNotificationHandler
+ <? extends AccountStatusNotificationHandlerCfg> notificationHandler;
+
+ definition = AccountStatusNotificationHandlerCfgDefn.getInstance();
+ propertyDefinition =
+ definition.getNotificationHandlerClassPropertyDefinition();
+ handlerClass = propertyDefinition.loadClass(
+ className,
+ AccountStatusNotificationHandler.class
+ );
+ notificationHandler =
+ (AccountStatusNotificationHandler
+ <? extends AccountStatusNotificationHandlerCfg>)
+ handlerClass.newInstance();
+
+ if (configuration != null)
+ {
+ Method method = notificationHandler.getClass().getMethod(
+ "initializeStatusNotificationHandler",
+ configuration.definition().getServerConfigurationClass()
+ );
+ method.invoke(notificationHandler, configuration);
+ }
+
+ return notificationHandler;
+ }
+ catch (Exception e)
+ {
+ int msgID = MSGID_CONFIG_ACCTNOTHANDLER_INITIALIZATION_FAILED;
+ String message = getMessage(
+ msgID, className,
+ String.valueOf(configuration.dn()),
+ stackTraceToSingleLineString(e)
+ );
+ throw new InitializationException(msgID, message, e);
+ }
+ }
+
+
+ /**
+ * Remove a notification handler that has been installed in the server.
+ *
+ * @param configEntryDN the DN of the configuration enry associated to
+ * the notification handler to remove
+ */
+ private void uninstallNotificationHandler(
+ DN configEntryDN
+ )
+ {
AccountStatusNotificationHandler handler =
- notificationHandlers.remove(configEntryDN);
+ notificationHandlers.remove (configEntryDN);
if (handler != null)
{
- DirectoryServer.deregisterAccountStatusNotificationHandler(configEntryDN);
-
+ DirectoryServer.deregisterAccountStatusNotificationHandler (
+ configEntryDN
+ );
handler.finalizeStatusNotificationHandler();
}
-
-
- return new ConfigChangeResult(resultCode, adminActionRequired);
}
}
--
Gitblit v1.10.0