From f6cd63ffc28006e05d3a7c90025f1430732949a9 Mon Sep 17 00:00:00 2001
From: Jean-Noël Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 19 Apr 2016 08:16:29 +0000
Subject: [PATCH] Code cleanup
---
opendj-server-legacy/src/main/java/org/opends/server/tools/EncodePassword.java | 23 ++--
opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java | 224 ++++++++++++++------------------------------
opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java | 17 --
opendj-server-legacy/src/test/java/org/opends/server/protocols/ldap/TestBindRequestProtocolOp.java | 21 ++--
4 files changed, 98 insertions(+), 187 deletions(-)
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java b/opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java
index f70d0f6..25b5177 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java
@@ -78,7 +78,6 @@
*/
public class BackUpDB extends TaskTool
{
-
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
/**
@@ -154,7 +153,6 @@
INFO_BACKUPDB_TOOL_DESCRIPTION.get());
argParser.setShortToolDescription(REF_SHORT_DESC_BACKUP.get());
-
// Initialize all the command-line argument types and register them with the parser.
try
{
@@ -254,7 +252,6 @@
return 1;
}
-
// If we should just display usage or version information,
// then print it and exit.
if (argParser.usageOrVersionDisplayed())
@@ -328,7 +325,6 @@
return 1;
}
-
// Checks the version - if upgrade required, the tool is unusable
try
{
@@ -341,10 +337,8 @@
}
return process(argParser, initializeServer, out, err);
-
}
- /** {@inheritDoc} */
@Override
public void addTaskAttributes(List<RawAttribute> attributes)
{
@@ -379,24 +373,20 @@
&& !arg.getValue().equals(arg.getDefaultValue());
}
- /** {@inheritDoc} */
@Override
public String getTaskObjectclass() {
return "ds-task-backup";
}
- /** {@inheritDoc} */
@Override
public Class<?> getTaskClass() {
return BackupTask.class;
}
- /** {@inheritDoc} */
@Override
protected int processLocal(boolean initializeServer,
PrintStream out,
PrintStream err) {
-
// Make sure that the backup directory exists. If not, then create it.
File backupDirFile = new File(backupDirectory.getValue());
if (! backupDirFile.exists())
@@ -503,16 +493,16 @@
Backend<?> b = backendList.get(i);
if (requestedBackends.contains(b.getBackendID()))
{
- if (!b.supports(BackendOperation.BACKUP))
- {
- logger.warn(WARN_BACKUPDB_BACKUP_NOT_SUPPORTED, b.getBackendID());
- }
- else
+ if (b.supports(BackendOperation.BACKUP))
{
backendsToArchive.add(b);
configEntries.put(b.getBackendID(), entryList.get(i));
requestedBackends.remove(b.getBackendID());
}
+ else
+ {
+ logger.warn(WARN_BACKUPDB_BACKUP_NOT_SUPPORTED, b.getBackendID());
+ }
}
}
@@ -526,12 +516,10 @@
return 1;
}
-
// See if there are multiple backends to archive.
multiple = backendsToArchive.size() > 1;
}
-
// If there are no backends to archive, then print an error and exit.
if (backendsToArchive.isEmpty())
{
@@ -539,38 +527,21 @@
return 1;
}
-
// Iterate through the backends to archive and back them up individually.
boolean errorsEncountered = false;
for (Backend<?> b : backendsToArchive)
{
- // Acquire a shared lock for this backend.
- try
+ if (!acquireSharedLock(b))
{
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.acquireSharedLock(lockFile, failureReason))
- {
- logger.error(ERR_BACKUPDB_CANNOT_LOCK_BACKEND, b.getBackendID(), failureReason);
- errorsEncountered = true;
- continue;
- }
- }
- catch (Exception e)
- {
- logger.error(ERR_BACKUPDB_CANNOT_LOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
errorsEncountered = true;
continue;
}
-
logger.info(NOTE_BACKUPDB_STARTING_BACKUP, b.getBackendID());
-
// Get the config entry for this backend.
BackendCfg configEntry = configEntries.get(b.getBackendID());
-
// Get the path to the directory to use for this backup. If we will be
// backing up multiple backends (or if we are backing up all backends,
// even if there's only one of them), then create a subdirectory for each
@@ -586,7 +557,6 @@
backupDirPath = backupDirectory.getValue();
}
-
// If the directory doesn't exist, then create it. If it does exist, then
// see if it has a backup descriptor file.
BackupDirectory backupDir;
@@ -607,42 +577,14 @@
{
logger.error(ERR_BACKUPDB_CANNOT_PARSE_BACKUP_DESCRIPTOR, descriptorPath, ce.getMessage());
errorsEncountered = true;
-
- try
- {
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- }
- }
- catch (Exception e)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
- }
-
+ releaseSharedLock(b);
continue;
}
catch (Exception e)
{
logger.error(ERR_BACKUPDB_CANNOT_PARSE_BACKUP_DESCRIPTOR, descriptorPath, getExceptionMessage(e));
errorsEncountered = true;
-
- try
- {
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- }
- }
- catch (Exception e2)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e2));
- }
-
+ releaseSharedLock(b);
continue;
}
}
@@ -661,28 +603,13 @@
{
logger.error(ERR_BACKUPDB_CANNOT_CREATE_BACKUP_DIR, backupDirPath, getExceptionMessage(e));
errorsEncountered = true;
-
- try
- {
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- }
- }
- catch (Exception e2)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e2));
- }
-
+ releaseSharedLock(b);
continue;
}
backupDir = new BackupDirectory(backupDirPath, configEntry.dn());
}
-
// Create a backup configuration and determine whether the requested
// backup can be performed using the selected backend.
BackupConfig backupConfig = new BackupConfig(backupDir, backupID,
@@ -697,25 +624,10 @@
{
logger.error(ERR_BACKUPDB_CANNOT_BACKUP, b.getBackendID());
errorsEncountered = true;
-
- try
- {
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- }
- }
- catch (Exception e2)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e2));
- }
-
+ unlockBackend(b);
continue;
}
-
// Perform the backup.
try
{
@@ -725,81 +637,91 @@
{
logger.error(ERR_BACKUPDB_ERROR_DURING_BACKUP, b.getBackendID(), de.getMessageObject());
errorsEncountered = true;
-
- try
- {
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- }
- }
- catch (Exception e)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
- }
-
+ unlockBackend(b);
continue;
}
catch (Exception e)
{
logger.error(ERR_BACKUPDB_ERROR_DURING_BACKUP, b.getBackendID(), getExceptionMessage(e));
errorsEncountered = true;
-
- try
- {
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- }
- }
- catch (Exception e2)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e2));
- }
-
+ unlockBackend(b);
continue;
}
-
- // Release the shared lock for the backend.
- try
+ if (!releaseSharedLock(b))
{
- String lockFile = LockFileManager.getBackendLockFileName(b);
- StringBuilder failureReason = new StringBuilder();
- if (! LockFileManager.releaseLock(lockFile, failureReason))
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
- errorsEncountered = true;
- }
- }
- catch (Exception e)
- {
- logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
errorsEncountered = true;
}
}
-
// Print a final completed message, indicating whether there were any errors
// in the process.
- int ret = 0;
if (errorsEncountered)
{
logger.info(NOTE_BACKUPDB_COMPLETED_WITH_ERRORS);
- ret = 1;
+ return 1;
}
- else
- {
- logger.info(NOTE_BACKUPDB_COMPLETED_SUCCESSFULLY);
- }
- return ret;
+ logger.info(NOTE_BACKUPDB_COMPLETED_SUCCESSFULLY);
+ return 0;
}
- /** {@inheritDoc} */
+ private boolean acquireSharedLock(Backend<?> b)
+ {
+ try
+ {
+ String lockFile = LockFileManager.getBackendLockFileName(b);
+ StringBuilder failureReason = new StringBuilder();
+ if (!LockFileManager.acquireSharedLock(lockFile, failureReason))
+ {
+ logger.error(ERR_BACKUPDB_CANNOT_LOCK_BACKEND, b.getBackendID(), failureReason);
+ return false;
+ }
+ return true;
+ }
+ catch (Exception e)
+ {
+ logger.error(ERR_BACKUPDB_CANNOT_LOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
+ return false;
+ }
+ }
+
+ private boolean releaseSharedLock(Backend<?> b)
+ {
+ try
+ {
+ String lockFile = LockFileManager.getBackendLockFileName(b);
+ StringBuilder failureReason = new StringBuilder();
+ if (!LockFileManager.releaseLock(lockFile, failureReason))
+ {
+ logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
+ return false;
+ }
+ return true;
+ }
+ catch (Exception e)
+ {
+ logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
+ return false;
+ }
+ }
+
+ private void unlockBackend(Backend<?> b)
+ {
+ try
+ {
+ String lockFile = LockFileManager.getBackendLockFileName(b);
+ StringBuilder failureReason = new StringBuilder();
+ if (!LockFileManager.releaseLock(lockFile, failureReason))
+ {
+ logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), failureReason);
+ }
+ }
+ catch (Exception e)
+ {
+ logger.warn(WARN_BACKUPDB_CANNOT_UNLOCK_BACKEND, b.getBackendID(), getExceptionMessage(e));
+ }
+ }
+
@Override
public String getTaskId() {
return backupIDString != null ? backupIDString.getValue() : null;
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/tools/EncodePassword.java b/opendj-server-legacy/src/main/java/org/opends/server/tools/EncodePassword.java
index 00eb257..a3d2afa 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/tools/EncodePassword.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/tools/EncodePassword.java
@@ -17,10 +17,12 @@
package org.opends.server.tools;
import static com.forgerock.opendj.cli.CliMessages.INFO_FILE_PLACEHOLDER;
-import static com.forgerock.opendj.cli.Utils.*;
import static com.forgerock.opendj.cli.CommonArguments.*;
+import static com.forgerock.opendj.cli.Utils.*;
import static org.opends.messages.ToolMessages.*;
+import static org.opends.messages.ToolMessages.INFO_CONFIGFILE_PLACEHOLDER;
+import static org.opends.messages.ToolMessages.INFO_DESCRIPTION_CONFIG_FILE;
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.util.StaticUtils.*;
@@ -40,7 +42,9 @@
import org.opends.server.loggers.JDKLogging;
import org.opends.server.schema.AuthPasswordSyntax;
import org.opends.server.schema.UserPasswordSyntax;
-import org.opends.server.types.*;
+import org.opends.server.types.DirectoryException;
+import org.opends.server.types.InitializationException;
+import org.opends.server.types.NullOutputStream;
import org.opends.server.util.BuildVersion;
import com.forgerock.opendj.cli.ArgumentException;
@@ -355,8 +359,7 @@
if (clearPW == null)
{
- clearPW = getClearPW(out, err, argParser, clearPassword,
- clearPasswordFile, interactivePassword);
+ clearPW = getClearPW(err, argParser, clearPassword, clearPasswordFile, interactivePassword);
if (clearPW == null)
{
return OPERATIONS_ERROR;
@@ -424,8 +427,7 @@
if (clearPW == null)
{
- clearPW = getClearPW(out, err, argParser, clearPassword,
- clearPasswordFile, interactivePassword);
+ clearPW = getClearPW(err, argParser, clearPassword, clearPasswordFile, interactivePassword);
if (clearPW == null)
{
return OPERATIONS_ERROR;
@@ -473,8 +475,7 @@
{
if (clearPW == null)
{
- clearPW = getClearPW(out, err, argParser, clearPassword,
- clearPasswordFile, interactivePassword);
+ clearPW = getClearPW(err, argParser, clearPassword, clearPasswordFile, interactivePassword);
if (clearPW == null)
{
return OPERATIONS_ERROR;
@@ -502,8 +503,7 @@
{
if (clearPW == null)
{
- clearPW = getClearPW(out, err, argParser, clearPassword,
- clearPasswordFile, interactivePassword);
+ clearPW = getClearPW(err, argParser, clearPassword, clearPasswordFile, interactivePassword);
if (clearPW == null)
{
return OPERATIONS_ERROR;
@@ -571,7 +571,6 @@
/**
* Get the clear password.
- * @param out The output to ask password.
* @param err The error output.
* @param argParser The argument parser.
* @param clearPassword the clear password
@@ -580,7 +579,7 @@
* interactively.
* @return the password or null if an error occurs.
*/
- private static ByteString getClearPW(PrintStream out, PrintStream err,
+ private static ByteString getClearPW(PrintStream err,
ArgumentParser argParser, StringArgument clearPassword,
FileBasedArgument clearPasswordFile, BooleanArgument interactivePassword)
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java b/opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java
index 73001e1..65d36a2 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java
@@ -28,14 +28,14 @@
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.Iterator;
import java.util.List;
+import java.util.Set;
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.i18n.slf4j.LocalizedLogger;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.server.config.server.BackendCfg;
+import org.forgerock.util.Utils;
import org.opends.server.api.Backend;
import org.opends.server.api.Backend.BackendOperation;
import org.opends.server.core.DirectoryServer;
@@ -346,27 +346,18 @@
out.println(message);
byte[] hash = backupInfo.getUnsignedHash();
-
message = INFO_RESTOREDB_LIST_HASHED.get(hash != null);
out.println(message);
byte[] signature = backupInfo.getSignedHash();
-
message = INFO_RESTOREDB_LIST_SIGNED.get(signature != null);
out.println(message);
StringBuilder dependencyList = new StringBuilder();
- HashSet<String> dependencyIDs = backupInfo.getDependencies();
+ Set<String> dependencyIDs = backupInfo.getDependencies();
if (! dependencyIDs.isEmpty())
{
- Iterator<String> iterator = dependencyIDs.iterator();
- dependencyList.append(iterator.next());
-
- while (iterator.hasNext())
- {
- dependencyList.append(", ");
- dependencyList.append(iterator.next());
- }
+ Utils.joinAsString(dependencyList, ", ", dependencyIDs);
}
else
{
diff --git a/opendj-server-legacy/src/test/java/org/opends/server/protocols/ldap/TestBindRequestProtocolOp.java b/opendj-server-legacy/src/test/java/org/opends/server/protocols/ldap/TestBindRequestProtocolOp.java
index 6357ef0..1b3107c 100644
--- a/opendj-server-legacy/src/test/java/org/opends/server/protocols/ldap/TestBindRequestProtocolOp.java
+++ b/opendj-server-legacy/src/test/java/org/opends/server/protocols/ldap/TestBindRequestProtocolOp.java
@@ -12,27 +12,26 @@
* information: "Portions Copyright [year] [name of copyright owner]".
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014-2015 ForgeRock AS.
+ * Portions Copyright 2014-2016 ForgeRock AS.
*/
package org.opends.server.protocols.ldap;
-import org.opends.server.types.LDAPException;
-import org.forgerock.opendj.ldap.ByteString;
-import org.forgerock.opendj.ldap.ByteStringBuilder;
-import org.testng.annotations.Test;
import static org.opends.server.protocols.ldap.LDAPConstants.*;
-import org.forgerock.opendj.io.ASN1;
-import org.forgerock.opendj.io.ASN1Reader;
-import org.forgerock.opendj.io.ASN1Writer;
import static org.opends.server.util.ServerConstants.*;
import static org.testng.Assert.*;
+import org.forgerock.opendj.io.ASN1;
+import org.forgerock.opendj.io.ASN1Reader;
+import org.forgerock.opendj.io.ASN1Writer;
+import org.forgerock.opendj.ldap.ByteString;
+import org.forgerock.opendj.ldap.ByteStringBuilder;
+import org.opends.server.types.LDAPException;
+import org.testng.annotations.Test;
+
+@SuppressWarnings("javadoc")
public class TestBindRequestProtocolOp extends LdapTestCase {
private static String dn="cn=some dn, dc=example, dc=com";
private static String pwd="password";
- private static String newPwd="newpassword";
- private static String newDn="cn=new dn, dc=example,dc=com";
- private static String creds="some creds";
@Test
public void testBindRequestEncodeDecode() throws Exception {
--
Gitblit v1.10.0