From f3fd0028d33d63cab849b1b5f70c1479dc37bee3 Mon Sep 17 00:00:00 2001
From: Gaetan Boismal <gaetan.boismal@forgerock.com>
Date: Tue, 07 Apr 2015 11:06:44 +0000
Subject: [PATCH] OPENDJ-1714: Creates class to manage backend type
---
opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/BackendTypeHelper.java | 161 ++++++++++++++++++++++++++++++++
opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDS.java | 117 ++---------------------
opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureDS.java | 5
3 files changed, 176 insertions(+), 107 deletions(-)
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/BackendTypeHelper.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/BackendTypeHelper.java
new file mode 100644
index 0000000..9dbf94b
--- /dev/null
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/BackendTypeHelper.java
@@ -0,0 +1,161 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License, Version 1.0 only
+ * (the "License"). You may not use this file except in compliance
+ * with the License.
+ *
+ * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
+ * or http://forgerock.org/license/CDDLv1.0.html.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at legal-notices/CDDLv1_0.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information:
+ * Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ *
+ *
+ * Copyright 2015 ForgeRock AS
+ */
+package org.opends.server.tools;
+
+import java.util.LinkedList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.forgerock.i18n.LocalizableMessage;
+import org.forgerock.i18n.slf4j.LocalizedLogger;
+import org.forgerock.opendj.config.AbstractManagedObjectDefinition;
+import org.forgerock.opendj.config.ConfigurationFramework;
+import org.forgerock.opendj.config.ManagedObjectDefinition;
+import org.forgerock.opendj.config.server.ConfigException;
+import org.forgerock.opendj.server.config.client.BackendCfgClient;
+import org.forgerock.opendj.server.config.meta.LocalDBBackendCfgDefn;
+import org.forgerock.opendj.server.config.meta.PluggableBackendCfgDefn;
+import org.forgerock.opendj.server.config.server.BackendCfg;
+
+/**
+ * Helper class for setup applications.
+ *
+ * It helps applications to provide a backend type choice to the user.
+ */
+public class BackendTypeHelper
+{
+ private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
+
+ private List<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>> backends;
+
+ /** Creates a new backend type helper. */
+ public BackendTypeHelper()
+ {
+ initializeConfigurationFramework();
+ createAvailableBackendsList();
+ }
+
+ private void initializeConfigurationFramework()
+ {
+ if (!ConfigurationFramework.getInstance().isInitialized())
+ {
+ try
+ {
+ ConfigurationFramework.getInstance().initialize();
+ }
+ catch (ConfigException e)
+ {
+ final LocalizableMessage message = LocalizableMessage.raw(
+ "Error occured while loading the configuration framework: " + e.getLocalizedMessage());
+ logger.error(message);
+ throw new RuntimeException(message.toString());
+ }
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ private void createAvailableBackendsList()
+ {
+ backends = new LinkedList<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>>();
+ backends.add(LocalDBBackendCfgDefn.getInstance());
+
+ for (AbstractManagedObjectDefinition<?, ?> backendType : PluggableBackendCfgDefn.getInstance().getAllChildren())
+ {
+ // Filtering out only the non-abstract backends to avoid users attempt to create abstract ones
+ if (backendType instanceof ManagedObjectDefinition)
+ {
+ backends.add((ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>) backendType);
+ }
+ }
+ }
+
+ ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg> retrieveBackendTypeFromName(
+ final String backendTypeStr)
+ {
+ for (ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg> backendType : getBackendTypes())
+ {
+ final String name = backendType.getName();
+ if (backendTypeStr.equalsIgnoreCase(name)
+ || backendTypeStr.equalsIgnoreCase(filterSchemaBackendName(name)))
+ {
+ return backendType;
+ }
+ }
+
+ return null;
+ }
+
+ List<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>> getBackendTypes()
+ {
+ return backends;
+ }
+
+
+ String getPrintableBackendTypeNames()
+ {
+ String backendTypeNames = "";
+ for (final String backendName : getBackendTypeNames())
+ {
+ backendTypeNames += backendName + ", ";
+ }
+
+ if (backendTypeNames.isEmpty())
+ {
+ return "Impossible to retrieve supported backend type list";
+ }
+
+ return backendTypeNames.substring(0, backendTypeNames.length() - 2);
+ }
+
+ /**
+ * Return a list of all available backend type printable names.
+ *
+ * @return A list of all available backend type printable names.
+ */
+ public List<String> getBackendTypeNames()
+ {
+ final List<String> backendTypeNames = new LinkedList<String>();
+ for (ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg> backendType : backends)
+ {
+ backendTypeNames.add(filterSchemaBackendName(backendType.getName()));
+ }
+
+ return backendTypeNames;
+ }
+
+ String filterSchemaBackendName(final String dsCfgBackendName)
+ {
+ final String cfgNameRegExp = "(.*)-backend.*";
+ final Matcher regExpMatcher = Pattern.compile(cfgNameRegExp, Pattern.CASE_INSENSITIVE).matcher(dsCfgBackendName);
+ if (regExpMatcher.matches())
+ {
+ return regExpMatcher.group(1);
+ }
+
+ return dsCfgBackendName;
+ }
+}
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureDS.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureDS.java
index 22484b7..fef439b 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureDS.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureDS.java
@@ -805,11 +805,12 @@
if (!baseDNs.isEmpty())
{
final String backendTypeName = backendType.getValue();
- final ManagedObjectDefinition<?, ?> backend = InstallDS.retrieveBackendTypeFromName(backendTypeName);
+ final BackendTypeHelper backendTypeHelper = new BackendTypeHelper();
+ final ManagedObjectDefinition<?, ?> backend = backendTypeHelper.retrieveBackendTypeFromName(backendTypeName);
if (backend == null)
{
throw new ConfigureDSException(
- ERR_CONFIGDS_BACKEND_TYPE_UNKNOWN.get(backendTypeName, InstallDS.getBackendTypeNames()));
+ ERR_CONFIGDS_BACKEND_TYPE_UNKNOWN.get(backendTypeName, backendTypeHelper.getBackendTypeNames()));
}
BufferedReader configReader = null;
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDS.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDS.java
index 4c42af9..8a8da17 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDS.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDS.java
@@ -50,8 +50,6 @@
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
import javax.naming.ldap.LdapName;
@@ -59,14 +57,6 @@
import org.forgerock.i18n.LocalizableMessageDescriptor.Arg0;
import org.forgerock.i18n.LocalizableMessageDescriptor.Arg1;
import org.forgerock.i18n.slf4j.LocalizedLogger;
-import org.forgerock.opendj.config.AbstractManagedObjectDefinition;
-import org.forgerock.opendj.config.ConfigurationFramework;
-import org.forgerock.opendj.config.ManagedObjectDefinition;
-import org.forgerock.opendj.config.server.ConfigException;
-import org.forgerock.opendj.server.config.client.BackendCfgClient;
-import org.forgerock.opendj.server.config.meta.LocalDBBackendCfgDefn;
-import org.forgerock.opendj.server.config.meta.PluggableBackendCfgDefn;
-import org.forgerock.opendj.server.config.server.BackendCfg;
import org.opends.messages.QuickSetupMessages;
import org.opends.messages.ToolMessages;
import org.opends.quicksetup.ApplicationException;
@@ -215,6 +205,8 @@
*/
public static final int LIMIT_KEYSTORE_PASSWORD_PROMPT = 7;
+ private final BackendTypeHelper backendTypeHelper = new BackendTypeHelper();
+
/** Different variables we use when the user decides to provide data again. */
private NewSuffixOptions.Type lastResetPopulateOption;
private String lastResetBackendType;
@@ -233,8 +225,6 @@
private Boolean lastResetEnableWindowsService;
private Boolean lastResetStartServer;
- private List<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>> availableBackendTypes;
-
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
/** The argument parser. */
@@ -379,9 +369,6 @@
return InstallReturnCode.ERROR_LICENSE_NOT_ACCEPTED.getReturnCode();
}
- initializeConfigurationFramework();
- availableBackendTypes = getBackendTypes();
-
final UserData uData = new UserData();
InstallReturnCode fillUserDataRC;
try
@@ -426,24 +413,6 @@
return InstallReturnCode.SUCCESSFUL.getReturnCode();
}
- private void initializeConfigurationFramework()
- {
- if (!ConfigurationFramework.getInstance().isInitialized())
- {
- try
- {
- ConfigurationFramework.getInstance().initialize();
- }
- catch (ConfigException e)
- {
- final LocalizableMessage message = LocalizableMessage.raw(
- "Error occured while loading the configuration framework: " + e.getLocalizedMessage());
- logger.error(message);
- throw new RuntimeException(message.toString());
- }
- }
- }
-
private InstallReturnCode fillUserData(UserData uData, String[] args) throws UserDataException
{
if (!isInteractive())
@@ -736,13 +705,14 @@
private void setBackendType(final UserData uData, final List<LocalizableMessage> errorMessages)
{
final String filledBackendType = argParser.backendTypeArg.getValue();
- if (retrieveBackendTypeFromName(filledBackendType) != null)
+ if (backendTypeHelper.retrieveBackendTypeFromName(filledBackendType) != null)
{
uData.setBackendType(filledBackendType);
}
else
{
- errorMessages.add(ERR_INSTALLDS_NO_SUCH_BACKEND_TYPE.get(filledBackendType, getBackendTypeNames()));
+ errorMessages.add(
+ ERR_INSTALLDS_NO_SUCH_BACKEND_TYPE.get(filledBackendType, backendTypeHelper.getBackendTypeNames()));
}
}
@@ -1310,12 +1280,13 @@
{
if (argParser.backendTypeArg.isPresent())
{
- if (retrieveBackendTypeFromName(argParser.backendTypeArg.getValue().toLowerCase()) != null)
+ if (backendTypeHelper.retrieveBackendTypeFromName(argParser.backendTypeArg.getValue().toLowerCase()) != null)
{
return argParser.backendTypeArg.getValue();
}
println();
- println(ERR_INSTALLDS_NO_SUCH_BACKEND_TYPE.get(argParser.backendTypeArg.getValue(), getBackendTypeNames()));
+ println(ERR_INSTALLDS_NO_SUCH_BACKEND_TYPE.get(
+ argParser.backendTypeArg.getValue(), backendTypeHelper.getPrintableBackendTypeNames()));
}
int backendTypeIndex = 1;
@@ -1332,7 +1303,7 @@
logger.warn(LocalizableMessage.raw("Error reading input: " + ce, ce));
}
- return availableBackendTypes.get(backendTypeIndex - 1).getName();
+ return backendTypeHelper.getBackendTypeNames().get(backendTypeIndex - 1);
}
private Menu<Integer> getBackendTypeMenu()
@@ -1340,10 +1311,9 @@
final MenuBuilder<Integer> builder = new MenuBuilder<Integer>(this);
builder.setPrompt(INFO_INSTALLDS_PROMPT_BACKEND_TYPE.get());
int index = 1;
- for (AbstractManagedObjectDefinition<?, ?> backendType : availableBackendTypes)
+ for (final String backendTypeName : backendTypeHelper.getBackendTypeNames())
{
- final String printableBackendName = filterSchemaBackendName(backendType.getName());
- builder.addNumberedOption(LocalizableMessage.raw(printableBackendName), MenuResult.success(index++));
+ builder.addNumberedOption(LocalizableMessage.raw(backendTypeName), MenuResult.success(index++));
}
final int printableIndex = getPromptedBackendTypeIndex();
@@ -1356,8 +1326,7 @@
{
if (lastResetBackendType != null)
{
- ManagedObjectDefinition<?, ?> backend = InstallDS.retrieveBackendTypeFromName(lastResetBackendType);
- return availableBackendTypes.indexOf(backend) + 1;
+ return backendTypeHelper.getBackendTypeNames().indexOf(lastResetBackendType) + 1;
}
return 1;
@@ -2661,66 +2630,4 @@
return argParser.getConnectTimeout();
}
- static ManagedObjectDefinition<?, ?> retrieveBackendTypeFromName(final String backendTypeStr)
- {
- for (ManagedObjectDefinition<?, ?> backendType : getBackendTypes())
- {
- final String name = backendType.getName();
- if (backendTypeStr.equalsIgnoreCase(name)
- || backendTypeStr.equalsIgnoreCase(filterSchemaBackendName(name)))
- {
- return backendType;
- }
- }
-
- return null;
- }
-
- @SuppressWarnings("unchecked")
- static List<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>> getBackendTypes()
- {
- final List<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>> backendTypes =
- new LinkedList<ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>>();
- backendTypes.add(LocalDBBackendCfgDefn.getInstance());
-
- for (AbstractManagedObjectDefinition<?, ?> backendType : PluggableBackendCfgDefn.getInstance().getAllChildren())
- {
- // Filtering out only the non-abstract backends to avoid users attempt to create abstract ones
- if (backendType instanceof ManagedObjectDefinition)
- {
- backendTypes.add((ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg>) backendType);
- }
- }
-
- return backendTypes;
- }
-
- static String getBackendTypeNames()
- {
- String backendTypeNames = "";
- for (ManagedObjectDefinition<? extends BackendCfgClient, ? extends BackendCfg> backendType : getBackendTypes())
- {
- backendTypeNames += filterSchemaBackendName(backendType.getName()) + ", ";
- }
-
- if (backendTypeNames.isEmpty())
- {
- return "Impossible to retrieve supported backend type list";
- }
-
- return backendTypeNames.substring(0, backendTypeNames.length() - 2);
- }
-
- static String filterSchemaBackendName(final String dsCfgBackendName)
- {
- final String cfgNameRegExp = "(.*)-backend.*";
- final Matcher regExpMatcher = Pattern.compile(cfgNameRegExp, Pattern.CASE_INSENSITIVE).matcher(dsCfgBackendName);
- if (regExpMatcher.matches())
- {
- return regExpMatcher.group(1);
- }
-
- return dsCfgBackendName;
- }
-
}
--
Gitblit v1.10.0