/*
|
* 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 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2012-2013 ForgeRock AS
|
*/
|
package org.opends.server.tools;
|
import org.opends.messages.Message;
|
|
|
|
import java.io.OutputStream;
|
import java.io.PrintStream;
|
import java.util.Iterator;
|
import java.util.LinkedList;
|
import java.util.TreeMap;
|
import java.util.TreeSet;
|
|
import org.opends.server.config.ConfigEntry;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.config.DNConfigAttribute;
|
import org.opends.server.config.StringConfigAttribute;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.extensions.ConfigFileHandler;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.DN;
|
import org.opends.server.types.InitializationException;
|
import org.opends.server.types.NullOutputStream;
|
import org.opends.server.util.BuildVersion;
|
import org.opends.server.util.args.ArgumentException;
|
import org.opends.server.util.args.ArgumentParser;
|
import org.opends.server.util.args.BooleanArgument;
|
import org.opends.server.util.args.StringArgument;
|
import org.opends.server.util.table.TableBuilder;
|
import org.opends.server.util.table.TextTablePrinter;
|
|
import static org.opends.server.config.ConfigConstants.*;
|
import static org.opends.messages.ConfigMessages.*;
|
import static org.opends.messages.ToolMessages.*;
|
import static org.opends.server.util.ServerConstants.*;
|
import static org.opends.server.util.StaticUtils.*;
|
import static org.opends.server.tools.ToolConstants.*;
|
|
|
|
|
/**
|
* This program provides a utility that may be used to list the backends in the
|
* server, as well as to determine which backend holds a given entry.
|
*/
|
public class ListBackends
|
{
|
/**
|
* Parses the provided command-line arguments and uses that information to
|
* list the backend information.
|
*
|
* @param args The command-line arguments provided to this program.
|
*/
|
public static void main(String[] args)
|
{
|
int retCode = listBackends(args, true, System.out, System.err);
|
|
if(retCode != 0)
|
{
|
System.exit(filterExitCode(retCode));
|
}
|
}
|
|
|
|
/**
|
* Parses the provided command-line arguments and uses that information to
|
* list the backend information.
|
*
|
* @param args The command-line arguments provided to this program.
|
*
|
* @return A return code indicating whether the processing was successful.
|
*/
|
public static int listBackends(String[] args)
|
{
|
return listBackends(args, true, System.out, System.err);
|
}
|
|
|
|
/**
|
* Parses the provided command-line arguments and uses that information to
|
* list the backend information.
|
*
|
* @param args The command-line arguments provided to this
|
* program.
|
* @param initializeServer Indicates whether to initialize the server.
|
* @param outStream The output stream to use for standard output, or
|
* <CODE>null</CODE> if standard output is not
|
* needed.
|
* @param errStream The output stream to use for standard error, or
|
* <CODE>null</CODE> if standard error is not
|
* needed.
|
*
|
* @return A return code indicating whether the processing was successful.
|
*/
|
public static int listBackends(String[] args, boolean initializeServer,
|
OutputStream outStream, OutputStream errStream)
|
{
|
PrintStream out = NullOutputStream.wrapOrNullStream(outStream);
|
PrintStream err = NullOutputStream.wrapOrNullStream(errStream);
|
|
// Define the command-line arguments that may be used with this program.
|
BooleanArgument displayUsage = null;
|
StringArgument backendID = null;
|
StringArgument baseDN = null;
|
StringArgument configClass = null;
|
StringArgument configFile = null;
|
|
|
// Create the command-line argument parser for use with this program.
|
Message toolDescription = INFO_LISTBACKENDS_TOOL_DESCRIPTION.get();
|
ArgumentParser argParser =
|
new ArgumentParser("org.opends.server.tools.ListBackends",
|
toolDescription, false);
|
|
|
// Initialize all the command-line argument types and register them with the
|
// parser.
|
try
|
{
|
configClass =
|
new StringArgument("configclass", OPTION_SHORT_CONFIG_CLASS,
|
OPTION_LONG_CONFIG_CLASS, true, false,
|
true, INFO_CONFIGCLASS_PLACEHOLDER.get(),
|
ConfigFileHandler.class.getName(), null,
|
INFO_DESCRIPTION_CONFIG_CLASS.get());
|
configClass.setHidden(true);
|
argParser.addArgument(configClass);
|
|
|
configFile =
|
new StringArgument("configfile", 'f', "configFile", true, false,
|
true, INFO_CONFIGFILE_PLACEHOLDER.get(), null,
|
null,
|
INFO_DESCRIPTION_CONFIG_FILE.get());
|
configFile.setHidden(true);
|
argParser.addArgument(configFile);
|
|
|
backendID = new StringArgument(
|
"backendid", 'n', "backendID", false,
|
true, true, INFO_BACKENDNAME_PLACEHOLDER.get(), null, null,
|
INFO_LISTBACKENDS_DESCRIPTION_BACKEND_ID.get());
|
argParser.addArgument(backendID);
|
|
|
baseDN = new StringArgument(
|
"basedn", OPTION_SHORT_BASEDN,
|
OPTION_LONG_BASEDN, false, true, true,
|
INFO_BASEDN_PLACEHOLDER.get(), null, null,
|
INFO_LISTBACKENDS_DESCRIPTION_BASE_DN.get());
|
argParser.addArgument(baseDN);
|
|
|
displayUsage = new BooleanArgument(
|
"help", OPTION_SHORT_HELP,
|
OPTION_LONG_HELP,
|
INFO_LISTBACKENDS_DESCRIPTION_HELP.get());
|
argParser.addArgument(displayUsage);
|
argParser.setUsageArgument(displayUsage, out);
|
}
|
catch (ArgumentException ae)
|
{
|
Message message = ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage());
|
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
|
// Parse the command-line arguments provided to this program.
|
try
|
{
|
argParser.parseArguments(args);
|
}
|
catch (ArgumentException ae)
|
{
|
Message message = ERR_ERROR_PARSING_ARGS.get(ae.getMessage());
|
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
err.println(argParser.getUsage());
|
return 1;
|
}
|
|
|
// If we should just display usage or version information,
|
// then it's already been done so just return.
|
if (argParser.usageOrVersionDisplayed())
|
{
|
return 0;
|
}
|
|
|
// Make sure that the user did not provide both the backend ID and base DN
|
// arguments.
|
if (backendID.isPresent() && baseDN.isPresent())
|
{
|
Message message = ERR_TOOL_CONFLICTING_ARGS.get(
|
backendID.getLongIdentifier(),
|
baseDN.getLongIdentifier());
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
// Checks the version - if upgrade required, the tool is unusable
|
try
|
{
|
BuildVersion.checkVersionMismatch();
|
}
|
catch (InitializationException e)
|
{
|
err.println(wrapText(e.getMessage(), MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
// Perform the initial bootstrap of the Directory Server and process the
|
// configuration.
|
DirectoryServer directoryServer = DirectoryServer.getInstance();
|
|
if (initializeServer)
|
{
|
try
|
{
|
DirectoryServer.bootstrapClient();
|
DirectoryServer.initializeJMX();
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_SERVER_BOOTSTRAP_ERROR.get(
|
getExceptionMessage(e));
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
try
|
{
|
directoryServer.initializeConfiguration(configClass.getValue(),
|
configFile.getValue());
|
}
|
catch (InitializationException ie)
|
{
|
Message message = ERR_CANNOT_LOAD_CONFIG.get(ie.getMessage());
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_CANNOT_LOAD_CONFIG.get(getExceptionMessage(e));
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
|
|
// Initialize the Directory Server schema elements.
|
try
|
{
|
directoryServer.initializeSchema();
|
}
|
catch (ConfigException ce)
|
{
|
Message message = ERR_CANNOT_LOAD_SCHEMA.get(ce.getMessage());
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
catch (InitializationException ie)
|
{
|
Message message = ERR_CANNOT_LOAD_SCHEMA.get(ie.getMessage());
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_CANNOT_LOAD_SCHEMA.get(getExceptionMessage(e));
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
}
|
|
|
// Retrieve a list of the backkends defined in the server.
|
TreeMap<String,TreeSet<DN>> backends;
|
try
|
{
|
backends = getBackends();
|
}
|
catch (ConfigException ce)
|
{
|
Message message = ERR_LISTBACKENDS_CANNOT_GET_BACKENDS.get(
|
ce.getMessage());
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_LISTBACKENDS_CANNOT_GET_BACKENDS.get(
|
getExceptionMessage(e));
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
|
// See what action we need to take based on the arguments provided. If the
|
// backend ID argument was present, then list the base DNs for that backend.
|
// If the base DN argument was present, then list the backend for that base
|
// DN. If no arguments were provided, then list all backends and base DNs.
|
boolean invalidDn = false;
|
if (baseDN.isPresent())
|
{
|
// Create a map from the base DNs of the backends to the corresponding
|
// backend ID.
|
TreeMap<DN,String> baseToIDMap = new TreeMap<DN,String>();
|
for (String id : backends.keySet())
|
{
|
for (DN dn : backends.get(id))
|
{
|
baseToIDMap.put(dn, id);
|
}
|
}
|
|
|
// Iterate through the base DN values specified by the user. Determine
|
// the backend for that entry, and whether the provided DN is a base DN
|
// for that backend.
|
for (String dnStr : baseDN.getValues())
|
{
|
DN dn;
|
try
|
{
|
dn = DN.decode(dnStr);
|
}
|
catch (DirectoryException de)
|
{
|
Message message = ERR_LISTBACKENDS_INVALID_DN.get(
|
dnStr, de.getMessage());
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_LISTBACKENDS_INVALID_DN.get(
|
dnStr, getExceptionMessage(e));
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
|
String id = baseToIDMap.get(dn);
|
if (id == null)
|
{
|
Message message = INFO_LISTBACKENDS_NOT_BASE_DN.get(
|
dn.toString());
|
out.println(message);
|
|
DN parentDN = dn.getParent();
|
while (true)
|
{
|
if (parentDN == null)
|
{
|
message = INFO_LISTBACKENDS_NO_BACKEND_FOR_DN.get(
|
dn.toString());
|
out.println(message);
|
invalidDn = true;
|
break;
|
}
|
else
|
{
|
id = baseToIDMap.get(parentDN);
|
if (id != null)
|
{
|
message = INFO_LISTBACKENDS_DN_BELOW_BASE.get(
|
dn.toString(), parentDN.toString(), id);
|
out.println(message);
|
break;
|
}
|
}
|
|
parentDN = parentDN.getParent();
|
}
|
}
|
else
|
{
|
Message message = INFO_LISTBACKENDS_BASE_FOR_ID.get(
|
dn.toString(), id);
|
out.println(message);
|
}
|
}
|
}
|
else
|
{
|
LinkedList<String> backendIDs;
|
if (backendID.isPresent())
|
{
|
backendIDs = backendID.getValues();
|
}
|
else
|
{
|
backendIDs = new LinkedList<String>(backends.keySet());
|
}
|
|
// Figure out the length of the longest backend ID and base DN defined in
|
// the server. We'll use that information to try to align the output.
|
Message backendIDLabel = INFO_LISTBACKENDS_LABEL_BACKEND_ID.get();
|
Message baseDNLabel = INFO_LISTBACKENDS_LABEL_BASE_DN.get();
|
int backendIDLength = 10;
|
int baseDNLength = 7;
|
|
Iterator<String> iterator = backendIDs.iterator();
|
while (iterator.hasNext())
|
{
|
String id = iterator.next();
|
TreeSet<DN> baseDNs = backends.get(id);
|
if (baseDNs == null)
|
{
|
Message message = ERR_LISTBACKENDS_NO_SUCH_BACKEND.get(id);
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
iterator.remove();
|
}
|
else
|
{
|
backendIDLength = Math.max(id.length(), backendIDLength);
|
for (DN dn : baseDNs)
|
{
|
baseDNLength = Math.max(dn.toString().length(), baseDNLength);
|
}
|
}
|
}
|
|
if (backendIDs.isEmpty())
|
{
|
Message message = ERR_LISTBACKENDS_NO_VALID_BACKENDS.get();
|
err.println(wrapText(message, MAX_LINE_WIDTH));
|
return 1;
|
}
|
|
TableBuilder table = new TableBuilder();
|
Message[] headers = {backendIDLabel, baseDNLabel};
|
for (int i=0; i< headers.length; i++)
|
{
|
table.appendHeading(headers[i]);
|
}
|
for (String id : backendIDs)
|
{
|
table.startRow();
|
table.appendCell(id);
|
StringBuilder buf = new StringBuilder();
|
|
TreeSet<DN> baseDNs = backends.get(id);
|
boolean isFirst = true;
|
for (DN dn : baseDNs)
|
{
|
if (!isFirst)
|
{
|
buf.append(",");
|
}
|
else
|
{
|
isFirst = false;
|
}
|
if (dn.getNumComponents() > 1)
|
{
|
buf.append("\""+dn.toString()+"\"");
|
}
|
else
|
{
|
buf.append(dn.toString());
|
}
|
}
|
table.appendCell(buf.toString());
|
}
|
TextTablePrinter printer = new TextTablePrinter(out);
|
printer.setColumnSeparator(ToolConstants.LIST_TABLE_SEPARATOR);
|
table.print(printer);
|
}
|
|
|
// If we've gotten here, then everything completed successfully.
|
return invalidDn ? 1 : 0 ;
|
}
|
|
|
|
/**
|
* Retrieves information about the backends configured in the Directory Server
|
* mapped between the backend ID to the set of base DNs for that backend.
|
*
|
* @return Information about the backends configured in the Directory Server.
|
*
|
* @throws ConfigException If a problem occurs while reading the server
|
* configuration.
|
*/
|
private static TreeMap<String,TreeSet<DN>> getBackends()
|
throws ConfigException
|
{
|
// Get the base entry for all backend configuration.
|
DN backendBaseDN = null;
|
try
|
{
|
backendBaseDN = DN.decode(DN_BACKEND_BASE);
|
}
|
catch (DirectoryException de)
|
{
|
Message message = ERR_CANNOT_DECODE_BACKEND_BASE_DN.get(
|
DN_BACKEND_BASE, de.getMessageObject());
|
throw new ConfigException(message, de);
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_CANNOT_DECODE_BACKEND_BASE_DN.get(
|
DN_BACKEND_BASE, getExceptionMessage(e));
|
throw new ConfigException(message, e);
|
}
|
|
ConfigEntry baseEntry = null;
|
try
|
{
|
baseEntry = DirectoryServer.getConfigEntry(backendBaseDN);
|
}
|
catch (ConfigException ce)
|
{
|
Message message = ERR_CANNOT_RETRIEVE_BACKEND_BASE_ENTRY.get(
|
DN_BACKEND_BASE, ce.getMessage());
|
throw new ConfigException(message, ce);
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_CANNOT_RETRIEVE_BACKEND_BASE_ENTRY.get(
|
DN_BACKEND_BASE, getExceptionMessage(e));
|
throw new ConfigException(message, e);
|
}
|
|
|
// Iterate through the immediate children, attempting to parse them as
|
// backends.
|
TreeMap<String,TreeSet<DN>> backendMap = new TreeMap<String,TreeSet<DN>>();
|
for (ConfigEntry configEntry : baseEntry.getChildren().values())
|
{
|
// Get the backend ID attribute from the entry. If there isn't one, then
|
// skip the entry.
|
String backendID = null;
|
try
|
{
|
Message msg = INFO_CONFIG_BACKEND_ATTR_DESCRIPTION_BACKEND_ID.get();
|
StringConfigAttribute idStub =
|
new StringConfigAttribute(ATTR_BACKEND_ID, msg,
|
true, false, true);
|
StringConfigAttribute idAttr =
|
(StringConfigAttribute) configEntry.getConfigAttribute(idStub);
|
if (idAttr == null)
|
{
|
continue;
|
}
|
else
|
{
|
backendID = idAttr.activeValue();
|
}
|
}
|
catch (ConfigException ce)
|
{
|
Message message = ERR_CANNOT_DETERMINE_BACKEND_ID.get(
|
String.valueOf(configEntry.getDN()), ce.getMessage());
|
throw new ConfigException(message, ce);
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_CANNOT_DETERMINE_BACKEND_ID.get(
|
String.valueOf(configEntry.getDN()), getExceptionMessage(e));
|
throw new ConfigException(message, e);
|
}
|
|
|
// Get the base DN attribute from the entry. If there isn't one, then
|
// just skip this entry.
|
TreeSet<DN> baseDNs = new TreeSet<DN>();
|
try
|
{
|
Message msg = INFO_CONFIG_BACKEND_ATTR_DESCRIPTION_BASE_DNS.get();
|
DNConfigAttribute baseDNStub =
|
new DNConfigAttribute(ATTR_BACKEND_BASE_DN, msg,
|
true, true, true);
|
DNConfigAttribute baseDNAttr =
|
(DNConfigAttribute) configEntry.getConfigAttribute(baseDNStub);
|
if (baseDNAttr != null)
|
{
|
baseDNs.addAll(baseDNAttr.activeValues());
|
}
|
}
|
catch (Exception e)
|
{
|
Message message = ERR_CANNOT_DETERMINE_BASES_FOR_BACKEND.get(
|
String.valueOf(configEntry.getDN()), getExceptionMessage(e));
|
throw new ConfigException(message, e);
|
}
|
|
backendMap.put(backendID, baseDNs);
|
}
|
|
return backendMap;
|
}
|
}
|
