From 1b6f7a88d7bc5853b912689f0ba437ed5bd0bef6 Mon Sep 17 00:00:00 2001
From: coulbeck <coulbeck@localhost>
Date: Mon, 09 Apr 2007 18:52:45 +0000
Subject: [PATCH] Migrate the ExtendedOperationConfigManager to the new configuration framework.
---
opends/src/server/org/opends/server/core/ExtendedOperationConfigManager.java | 1120 ++++++++++++++--------------------------------------------
1 files changed, 271 insertions(+), 849 deletions(-)
diff --git a/opends/src/server/org/opends/server/core/ExtendedOperationConfigManager.java b/opends/src/server/org/opends/server/core/ExtendedOperationConfigManager.java
index 2b71695..4351d91 100644
--- a/opends/src/server/org/opends/server/core/ExtendedOperationConfigManager.java
+++ b/opends/src/server/org/opends/server/core/ExtendedOperationConfigManager.java
@@ -29,39 +29,31 @@
import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.LinkedList;
import java.util.List;
-import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
+import java.lang.reflect.Method;
-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.api.ExtendedOperationHandler;
-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.*;
-import static org.opends.server.util.StaticUtils.*;
-
+import static org.opends.server.messages.MessageHandler.getMessage;
+import org.opends.server.admin.server.ConfigurationChangeListener;
+import org.opends.server.admin.server.ConfigurationAddListener;
+import org.opends.server.admin.server.ConfigurationDeleteListener;
+import org.opends.server.admin.server.ServerManagementContext;
+import org.opends.server.admin.std.server.ExtendedOperationHandlerCfg;
+import org.opends.server.admin.std.server.RootCfg;
+import org.opends.server.admin.std.meta.ExtendedOperationHandlerCfgDefn;
+import org.opends.server.admin.ClassPropertyDefinition;
+import static org.opends.server.util.StaticUtils.stackTraceToSingleLineString;
/**
@@ -71,8 +63,10 @@
* removals, or modifications of any extended operation handlers while the
* server is running.
*/
-public class ExtendedOperationConfigManager
- implements ConfigChangeListener, ConfigAddListener, ConfigDeleteListener
+public class ExtendedOperationConfigManager implements
+ ConfigurationChangeListener<ExtendedOperationHandlerCfg>,
+ ConfigurationAddListener<ExtendedOperationHandlerCfg>,
+ ConfigurationDeleteListener<ExtendedOperationHandlerCfg>
{
@@ -81,9 +75,6 @@
// operation handlers.
private ConcurrentHashMap<DN,ExtendedOperationHandler> handlers;
- // The configuration handler for the Directory Server.
- private ConfigHandler configHandler;
-
/**
@@ -91,7 +82,6 @@
*/
public ExtendedOperationConfigManager()
{
- configHandler = DirectoryServer.getConfigHandler();
handlers = new ConcurrentHashMap<DN,ExtendedOperationHandler>();
}
@@ -112,432 +102,199 @@
public void initializeExtendedOperationHandlers()
throws ConfigException, InitializationException
{
- // First, get the configuration base entry.
- ConfigEntry baseEntry;
- try
+ // Create an internal server management context and retrieve
+ // the root configuration which has the extended operation handler relation.
+ ServerManagementContext context = ServerManagementContext.getInstance();
+ RootCfg root = context.getRootConfiguration();
+
+ // Register add and delete listeners.
+ root.addExtendedOperationHandlerAddListener(this);
+ root.addExtendedOperationHandlerDeleteListener(this);
+
+ // Initialize existing handlers.
+ for (String name : root.listExtendedOperationHandlers())
{
- DN extendedOpBaseDN = DN.decode(DN_EXTENDED_OP_CONFIG_BASE);
- baseEntry = configHandler.getConfigEntry(extendedOpBaseDN);
- }
- catch (Exception e)
- {
- if (debugEnabled())
+ // Get the handler's configuration.
+ // This will decode and validate its properties.
+ ExtendedOperationHandlerCfg config =
+ root.getExtendedOperationHandler(name);
+
+ // Register as a change listener for this handler so that we can be
+ // notified when it is disabled or enabled.
+ config.addChangeListener(this);
+
+ // Ignore this handler if it is disabled.
+ if (config.isEnabled())
{
- debugCaught(DebugLogLevel.ERROR, e);
- }
+ // Load the handler's implementation class and initialize it.
+ ExtendedOperationHandler handler = getHandler(config);
- int msgID = MSGID_CONFIG_EXTOP_CANNOT_GET_BASE;
- String message = getMessage(msgID, String.valueOf(e));
- throw new ConfigException(msgID, message, e);
- }
-
- if (baseEntry == null)
- {
- // The extended operation handler base entry does not exist. This is not
- // acceptable, so throw an exception.
- int msgID = MSGID_CONFIG_EXTOP_BASE_DOES_NOT_EXIST;
- String message = getMessage(msgID);
- throw new ConfigException(msgID, message);
- }
-
-
- // Register add and delete listeners with the extended operation 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 extended operation
- // 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_EXTOP_ENTRY_UNACCEPTABLE,
- childEntry.getDN().toString(), unacceptableReason.toString());
- continue;
- }
-
- 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_EXTOP_CANNOT_CREATE_HANDLER,
- childEntry.getDN().toString(), buffer.toString());
- }
- }
- catch (Exception e)
- {
- logError(ErrorLogCategory.CONFIGURATION, ErrorLogSeverity.SEVERE_ERROR,
- MSGID_CONFIG_EXTOP_CANNOT_CREATE_HANDLER,
- childEntry.getDN().toString(), String.valueOf(e));
+ // Put this handler in the hash map so that we will be able to find
+ // it if it is deleted or disabled.
+ handlers.put(config.dn(), handler);
}
}
}
-
-
/**
- * 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 applyConfigurationDelete(
+ ExtendedOperationHandlerCfg configuration)
{
- // Make sure that the entry has an appropriate objectclass for an extended
- // operation handler.
- if (! configEntry.hasObjectClass(OC_EXTENDED_OPERATION_HANDLER))
- {
- int msgID = MSGID_CONFIG_EXTOP_INVALID_OBJECTCLASS;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
+ ResultCode resultCode = ResultCode.SUCCESS;
+ boolean adminActionRequired = false;
- // Make sure that the entry specifies the handler class name.
- StringConfigAttribute classNameAttr;
- try
- {
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_EXTOP_CLASS,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_CLASS_NAME),
- true, false, true);
- classNameAttr = (StringConfigAttribute)
- configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_NO_CLASS_NAME;
- 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_EXTOP_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_EXTOP_INVALID_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
- try
- {
- ExtendedOperationHandler handler =
- (ExtendedOperationHandler) handlerClass.newInstance();
- }
- catch(Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_EXTOP_INVALID_CLASS;
- String message = getMessage(msgID, handlerClass.getName(),
- String.valueOf(configEntry.getDN()),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // See if this extended operation handler should be enabled.
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_EXTOP_ENABLED,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_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_EXTOP_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 extended operation 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 extended
- // operation handler.
- if (! configEntry.hasObjectClass(OC_EXTENDED_OPERATION_HANDLER))
- {
- int msgID = MSGID_CONFIG_EXTOP_INVALID_OBJECTCLASS;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.UNWILLING_TO_PERFORM;
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // Get the corresponding extended operation handler if it is active.
- ExtendedOperationHandler handler = handlers.get(configEntryDN);
-
-
- // See if this handler should be enabled or disabled.
- boolean needsEnabled = false;
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_EXTOP_ENABLED,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_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.
- handlers.remove(configEntryDN);
- handler.finalizeExtendedOperationHandler();
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
- }
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_EXTOP_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. If it has
- // changed, then we will not try to dynamically apply it.
- String className;
- try
- {
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_EXTOP_CLASS,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_CLASS_NAME),
- true, false, true);
- StringConfigAttribute classNameAttr =
- (StringConfigAttribute) configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_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_EXTOP_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;
+ // See if the entry is registered as an extended operation handler. If so,
+ // deregister it and finalize the handler.
+ ExtendedOperationHandler handler = handlers.remove(configuration.dn());
if (handler != null)
{
- oldClassName = handler.getClass().getName();
- classChanged = (! className.equals(oldClassName));
+ handler.finalizeExtendedOperationHandler();
}
- if (classChanged)
- {
- // 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_EXTOP_CLASS_ACTION_REQUIRED,
- String.valueOf(oldClassName),
- String.valueOf(className),
- String.valueOf(configEntryDN)));
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
+ return new ConfigChangeResult(resultCode, adminActionRequired);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean isConfigurationChangeAcceptable(
+ ExtendedOperationHandlerCfg configuration,
+ List<String> unacceptableReasons)
+ {
+ if (configuration.isEnabled()) {
+ // It's enabled so always validate the class.
+ return isJavaClassAcceptable(configuration, unacceptableReasons);
+ } else {
+ // It's disabled so ignore it.
+ return true;
}
+ }
+ /**
+ * {@inheritDoc}
+ */
+ public ConfigChangeResult applyConfigurationChange(
+ ExtendedOperationHandlerCfg configuration)
+ {
+ // Attempt to get the existing handler. This will only
+ // succeed if it was enabled.
+ DN dn = configuration.dn();
+ ExtendedOperationHandler handler = handlers.get(dn);
- if (needsEnabled)
- {
- try
- {
- Class handlerClass = DirectoryServer.loadClass(className);
- handler = (ExtendedOperationHandler) handlerClass.newInstance();
+ // Default result code.
+ ResultCode resultCode = ResultCode.SUCCESS;
+ boolean adminActionRequired = false;
+ ArrayList<String> messages = new ArrayList<String>();
+
+ // See whether the handler should be enabled.
+ if (handler == null) {
+ if (configuration.isEnabled()) {
+ // The handler needs to be enabled.
+ try {
+ handler = getHandler(configuration);
+
+ // Put this handler in the hash so that we will
+ // be able to find it if it is altered.
+ handlers.put(dn, handler);
+
+ } catch (ConfigException e) {
+ if (debugEnabled())
+ {
+ debugCaught(DebugLogLevel.ERROR, e);
+ }
+
+ messages.add(e.getMessage());
+ resultCode = DirectoryServer.getServerErrorResultCode();
+ } catch (Exception e) {
+ if (debugEnabled())
+ {
+ debugCaught(DebugLogLevel.ERROR, e);
+ }
+
+ int msgID = MSGID_CONFIG_EXTOP_INITIALIZATION_FAILED;
+ messages.add(getMessage(msgID, String.valueOf(configuration
+ .getJavaImplementationClass()), String.valueOf(dn),
+ stackTraceToSingleLineString(e)));
+ resultCode = DirectoryServer.getServerErrorResultCode();
+ }
}
- catch (Exception e)
+ } else {
+ if (configuration.isEnabled()) {
+ // The handler is currently active, so we don't
+ // need to do anything. Changes to the class name cannot be
+ // applied dynamically, so if the class name did change then
+ // indicate that administrative action is required for that
+ // change to take effect.
+ String className = configuration.getJavaImplementationClass();
+ if (!className.equals(handler.getClass().getName())) {
+ adminActionRequired = true;
+ }
+ } else {
+ // We need to disable the connection handler.
+
+ handlers.remove(dn);
+
+ handler.finalizeExtendedOperationHandler();
+ }
+ }
+
+ // Return the configuration result.
+ return new ConfigChangeResult(resultCode, adminActionRequired,
+ messages);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean isConfigurationAddAcceptable(
+ ExtendedOperationHandlerCfg configuration,
+ List<String> unacceptableReasons)
+ {
+ return isConfigurationChangeAcceptable(configuration, unacceptableReasons);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public ConfigChangeResult applyConfigurationAdd(
+ ExtendedOperationHandlerCfg configuration)
+ {
+ // Default result code.
+ ResultCode resultCode = ResultCode.SUCCESS;
+ boolean adminActionRequired = false;
+ ArrayList<String> messages = new ArrayList<String>();
+
+ // Register as a change listener for this connection handler entry
+ // so that we will be notified of any changes that may be made to
+ // it.
+ configuration.addChangeListener(this);
+
+ // Ignore this connection handler if it is disabled.
+ if (configuration.isEnabled())
+ {
+ // The connection handler needs to be enabled.
+ DN dn = configuration.dn();
+ try {
+ ExtendedOperationHandler handler = getHandler(configuration);
+
+ // Put this connection handler in the hash so that we will be
+ // able to find it if it is altered.
+ handlers.put(dn, handler);
+
+ }
+ catch (ConfigException e)
{
if (debugEnabled())
{
debugCaught(DebugLogLevel.ERROR, e);
}
- int msgID = MSGID_CONFIG_EXTOP_INVALID_CLASS;
- messages.add(getMessage(msgID, className,
- String.valueOf(configEntryDN),
- String.valueOf(e)));
+ messages.add(e.getMessage());
resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
-
- try
- {
- handler.initializeExtendedOperationHandler(configEntry);
}
catch (Exception e)
{
@@ -547,452 +304,117 @@
}
int msgID = MSGID_CONFIG_EXTOP_INITIALIZATION_FAILED;
- messages.add(getMessage(msgID, className,
- String.valueOf(configEntryDN),
- String.valueOf(e)));
+ messages.add(getMessage(msgID, String.valueOf(configuration
+ .getJavaImplementationClass()), String.valueOf(dn),
+ stackTraceToSingleLineString(e)));
resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
}
-
-
- // If the extended operation handler defines any supported controls and/or
- // features, then register them with the server.
- Set<String> controlOIDs = handler.getSupportedControls();
- if (controlOIDs != null)
- {
- for (String oid : controlOIDs)
- {
- DirectoryServer.registerSupportedControl(oid);
- }
- }
-
- Set<String> featureOIDs = handler.getSupportedFeatures();
- if (featureOIDs != null)
- {
- for (String oid : featureOIDs)
- {
- DirectoryServer.registerSupportedFeature(oid);
- }
- }
-
-
- handlers.put(configEntryDN, handler);
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
}
-
- // 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 the configuration result.
+ return new ConfigChangeResult(resultCode, adminActionRequired,
+ messages);
}
-
-
/**
- * 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)
- {
- // Make sure that no entry already exists with the specified DN.
- DN configEntryDN = configEntry.getDN();
- if (handlers.containsKey(configEntryDN))
- {
- int msgID = MSGID_CONFIG_EXTOP_EXISTS;
- String message = getMessage(msgID, String.valueOf(configEntryDN));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // Make sure that the entry has an appropriate objectclass for an extended
- // operation handler.
- if (! configEntry.hasObjectClass(OC_EXTENDED_OPERATION_HANDLER))
- {
- int msgID = MSGID_CONFIG_EXTOP_INVALID_OBJECTCLASS;
- String message = getMessage(msgID, configEntry.getDN().toString());
- unacceptableReason.append(message);
- return false;
- }
-
-
- // Make sure that the entry specifies the extended operation handler class.
- StringConfigAttribute classNameAttr;
- try
- {
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_EXTOP_CLASS,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_CLASS_NAME),
- true, false, true);
- classNameAttr = (StringConfigAttribute)
- configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_NO_CLASS_NAME;
- 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_EXTOP_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_EXTOP_INVALID_CLASS_NAME;
- String message = getMessage(msgID, configEntry.getDN().toString(),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
- ExtendedOperationHandler handler;
- try
- {
- handler = (ExtendedOperationHandler) handlerClass.newInstance();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_EXTOP_INVALID_CLASS;
- String message = getMessage(msgID, handlerClass.getName(),
- String.valueOf(configEntryDN),
- String.valueOf(e));
- unacceptableReason.append(message);
- return false;
- }
-
-
- // If the 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_EXTOP_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;
- }
- }
-
-
- // See if this handler should be enabled.
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_EXTOP_ENABLED,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_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_EXTOP_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 handler entry appears to be acceptable.
- return true;
- }
-
-
-
- /**
- * 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.
- */
- public ConfigChangeResult applyConfigurationAdd(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 extended
- // operation handler.
- if (! configEntry.hasObjectClass(OC_EXTENDED_OPERATION_HANDLER))
- {
- int msgID = MSGID_CONFIG_EXTOP_INVALID_OBJECTCLASS;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.UNWILLING_TO_PERFORM;
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // See if this handler should be enabled or disabled.
- BooleanConfigAttribute enabledAttr;
- try
- {
- BooleanConfigAttribute enabledStub =
- new BooleanConfigAttribute(ATTR_EXTOP_ENABLED,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_ENABLED),
- false);
- enabledAttr = (BooleanConfigAttribute)
- configEntry.getConfigAttribute(enabledStub);
-
- if (enabledAttr == null)
- {
- // The attribute doesn't exist, so it will be disabled by default.
- int msgID = MSGID_CONFIG_EXTOP_NO_ENABLED_ATTR;
- messages.add(getMessage(msgID, String.valueOf(configEntryDN)));
- resultCode = ResultCode.SUCCESS;
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
- else if (! enabledAttr.activeValue())
- {
- // It is explicitly configured as disabled, so we don't need to do
- // anything.
- return new ConfigChangeResult(resultCode, adminActionRequired,
- messages);
- }
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_EXTOP_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
- {
- StringConfigAttribute classStub =
- new StringConfigAttribute(ATTR_EXTOP_CLASS,
- getMessage(MSGID_CONFIG_EXTOP_DESCRIPTION_CLASS_NAME),
- true, false, true);
- StringConfigAttribute classNameAttr =
- (StringConfigAttribute) configEntry.getConfigAttribute(classStub);
-
- if (classNameAttr == null)
- {
- int msgID = MSGID_CONFIG_EXTOP_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_EXTOP_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 handler class, and register it with the Directory
- // Server.
- ExtendedOperationHandler handler;
- try
- {
- Class handlerClass = DirectoryServer.loadClass(className);
- handler = (ExtendedOperationHandler) handlerClass.newInstance();
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_EXTOP_INVALID_CLASS;
- messages.add(getMessage(msgID, className, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
- try
- {
- handler.initializeExtendedOperationHandler(configEntry);
- }
- catch (Exception e)
- {
- if (debugEnabled())
- {
- debugCaught(DebugLogLevel.ERROR, e);
- }
-
- int msgID = MSGID_CONFIG_EXTOP_INITIALIZATION_FAILED;
- messages.add(getMessage(msgID, className, String.valueOf(configEntryDN),
- String.valueOf(e)));
- resultCode = DirectoryServer.getServerErrorResultCode();
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
- // If the extended operation handler defines any supported controls and/or
- // features, then register them with the server.
- Set<String> controlOIDs = handler.getSupportedControls();
- if (controlOIDs != null)
- {
- for (String oid : controlOIDs)
- {
- DirectoryServer.registerSupportedControl(oid);
- }
- }
-
- Set<String> featureOIDs = handler.getSupportedFeatures();
- if (featureOIDs != null)
- {
- for (String oid : featureOIDs)
- {
- DirectoryServer.registerSupportedFeature(oid);
- }
- }
-
-
- handlers.put(configEntryDN, handler);
- return new ConfigChangeResult(resultCode, adminActionRequired, messages);
- }
-
-
-
- /**
- * 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.
- */
- public boolean configDeleteIsAcceptable(ConfigEntry configEntry,
- StringBuilder unacceptableReason)
+ public boolean isConfigurationDeleteAcceptable(
+ ExtendedOperationHandlerCfg configuration,
+ List<String> unacceptableReasons)
{
// A delete should always be acceptable, so just return true.
return true;
}
-
-
- /**
- * 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.
- */
- public ConfigChangeResult applyConfigurationDelete(ConfigEntry configEntry)
+ // Load and initialize the handler named in the config.
+ private ExtendedOperationHandler getHandler(
+ ExtendedOperationHandlerCfg config) throws ConfigException
{
- DN configEntryDN = configEntry.getDN();
- ResultCode resultCode = ResultCode.SUCCESS;
- boolean adminActionRequired = false;
+ String className = config.getJavaImplementationClass();
+ ExtendedOperationHandlerCfgDefn d =
+ ExtendedOperationHandlerCfgDefn.getInstance();
+ ClassPropertyDefinition pd = d
+ .getJavaImplementationClassPropertyDefinition();
+ // Load the class and cast it to an extended operation handler.
+ Class<? extends ExtendedOperationHandler> theClass;
+ ExtendedOperationHandler extendedOperationHandler;
- // See if the entry is registered as an extended operation handler. If so,
- // deregister it and stop the handler.
- ExtendedOperationHandler handler = handlers.remove(configEntryDN);
- if (handler != null)
+ try
{
- handler.finalizeExtendedOperationHandler();
+ theClass = pd.loadClass(className, ExtendedOperationHandler.class);
+ extendedOperationHandler = theClass.newInstance();
+
+ // Determine the initialization method to use: it must take a
+ // single parameter which is the exact type of the configuration
+ // object.
+ Method method = theClass.getMethod(
+ "initializeExtendedOperationHandler",
+ config.definition().getServerConfigurationClass());
+
+ method.invoke(extendedOperationHandler, config);
+ }
+ catch (Exception e)
+ {
+ if (debugEnabled())
+ {
+ debugCaught(DebugLogLevel.ERROR, e);
+ }
+
+ int msgID = MSGID_CONFIG_EXTOP_INVALID_CLASS;
+ String message = getMessage(msgID, String.valueOf(className),
+ String.valueOf(config.dn()),
+ String.valueOf(e));
+ throw new ConfigException(msgID, message, e);
}
+ // The handler has been successfully initialized.
+ return extendedOperationHandler;
+ }
- return new ConfigChangeResult(resultCode, adminActionRequired);
+
+
+ // Determines whether or not the new configuration's implementation
+ // class is acceptable.
+ private boolean isJavaClassAcceptable(
+ ExtendedOperationHandlerCfg config,
+ List<String> unacceptableReasons)
+ {
+ String className = config.getJavaImplementationClass();
+ ExtendedOperationHandlerCfgDefn d =
+ ExtendedOperationHandlerCfgDefn.getInstance();
+ ClassPropertyDefinition pd = d
+ .getJavaImplementationClassPropertyDefinition();
+
+ // Load the class and cast it to an extended operation handler.
+ Class<? extends ExtendedOperationHandler> theClass;
+ try {
+ theClass = pd.loadClass(className, ExtendedOperationHandler.class);
+ theClass.newInstance();
+
+ // Determine the initialization method to use: it must take a
+ // single parameter which is the exact type of the configuration
+ // object.
+ theClass.getMethod("initializeExtendedOperationHandler",
+ config.definition().getServerConfigurationClass());
+ }
+ catch (Exception e)
+ {
+ if (debugEnabled())
+ {
+ debugCaught(DebugLogLevel.ERROR, e);
+ }
+
+ int msgID = MSGID_CONFIG_EXTOP_INVALID_CLASS;
+ unacceptableReasons.add(getMessage(msgID, className,
+ String.valueOf(config.dn()),
+ String.valueOf(e)));
+ return false;
+ }
+
+ // The class is valid as far as we can tell.
+ return true;
}
}
--
Gitblit v1.10.0