/*
|
* 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-2010 Sun Microsystems, Inc.
|
* Portions Copyright 2013-2016 ForgeRock AS.
|
*/
|
package org.opends.server.tools.makeldif;
|
|
import static com.forgerock.opendj.cli.ArgumentConstants.*;
|
import static com.forgerock.opendj.cli.CliMessages.INFO_MAKELDIF_DESCRIPTION_SEED;
|
import static com.forgerock.opendj.cli.CliMessages.INFO_SEED_PLACEHOLDER;
|
import static com.forgerock.opendj.cli.Utils.*;
|
|
import static org.opends.messages.ToolMessages.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
import java.io.File;
|
import java.io.IOException;
|
import java.io.OutputStream;
|
import java.io.PrintStream;
|
import java.util.LinkedList;
|
import java.util.Random;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.core.DirectoryServer.DirectoryServerVersionHandler;
|
import org.opends.server.loggers.JDKLogging;
|
import org.forgerock.opendj.ldap.schema.AttributeType;
|
import org.opends.server.types.ExistingFileBehavior;
|
import org.opends.server.types.InitializationException;
|
import org.opends.server.types.LDIFExportConfig;
|
import org.opends.server.types.NullOutputStream;
|
import org.opends.server.util.BuildVersion;
|
import org.opends.server.util.LDIFWriter;
|
|
import com.forgerock.opendj.cli.ArgumentException;
|
import com.forgerock.opendj.cli.ArgumentParser;
|
import com.forgerock.opendj.cli.BooleanArgument;
|
import com.forgerock.opendj.cli.CommonArguments;
|
import com.forgerock.opendj.cli.IntegerArgument;
|
import com.forgerock.opendj.cli.StringArgument;
|
|
/**
|
* This class defines a program that can be used to generate LDIF content based
|
* on a template.
|
*/
|
public class MakeLDIF
|
implements EntryWriter
|
{
|
/**
|
* The fully-qualified name of this class.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.tools.makeldif.MakeLDIF";
|
|
/** The LDIF writer that will be used to write the entries. */
|
private LDIFWriter ldifWriter;
|
|
/** The total number of entries that have been written. */
|
private long entriesWritten;
|
|
private PrintStream out = System.out;
|
private PrintStream err = System.err;
|
|
/**
|
* Invokes the <CODE>makeLDIFMain</CODE> method with the provided set of
|
* arguments.
|
*
|
* @param args The command-line arguments provided for this program.
|
*/
|
public static void main(String[] args)
|
{
|
MakeLDIF makeLDIF = new MakeLDIF();
|
int returnCode = makeLDIF.makeLDIFMain(args);
|
if (returnCode != 0)
|
{
|
System.exit(filterExitCode(returnCode));
|
}
|
}
|
|
/**
|
* Provides the command-line arguments to the main application for
|
* processing and returns the exit code as an integer.
|
*
|
* @param args
|
* The set of command-line arguments provided to this
|
* program.
|
* @param outStream
|
* The output stream for standard output.
|
* @param errStream
|
* The output stream for standard error.
|
* @return Zero to indicate that the program completed successfully,
|
* or non-zero to indicate that an error occurred.
|
*/
|
public static int main(final String[] args, final OutputStream outStream, final OutputStream errStream)
|
{
|
return new MakeLDIF().makeLDIFMain(args, false, false, outStream, errStream);
|
}
|
|
/**
|
* Creates a new instance of this utility. It should just be used for
|
* invoking the <CODE>makeLDIFMain</CODE> method.
|
*/
|
public MakeLDIF()
|
{
|
ldifWriter = null;
|
entriesWritten = 0L;
|
}
|
|
/**
|
* Processes the provided set of command-line arguments and begins generating
|
* the LDIF content.
|
*
|
* @param args The command-line arguments provided for this program.
|
* @param initializeServer Indicates whether to initialize the server.
|
* @param initializeSchema Indicates whether to initialize the schema.
|
* @param outStream The output stream to use for standard output, or
|
* {@code null} if standard output is not needed.
|
* @param errStream The output stream to use for standard error, or
|
* {@code null} if standard error is not needed.
|
* @return A result code of zero if all processing completed properly, or
|
* a nonzero result if a problem occurred.
|
*
|
*/
|
public int makeLDIFMain(String[] args, boolean initializeServer,
|
boolean initializeSchema,
|
OutputStream outStream,
|
OutputStream errStream)
|
{
|
out = NullOutputStream.wrapOrNullStream(outStream);
|
err = NullOutputStream.wrapOrNullStream(errStream);
|
JDKLogging.disableLogging();
|
|
|
// Create and initialize the argument parser for this program.
|
LocalizableMessage toolDescription = INFO_MAKELDIF_TOOL_DESCRIPTION.get();
|
ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
|
false);
|
argParser.setShortToolDescription(REF_SHORT_DESC_MAKELDIF.get());
|
argParser.setVersionHandler(new DirectoryServerVersionHandler());
|
|
BooleanArgument showUsage;
|
IntegerArgument randomSeed;
|
StringArgument configClass;
|
StringArgument configFile;
|
StringArgument templatePath;
|
StringArgument ldifFile;
|
StringArgument resourcePath;
|
|
try
|
{
|
configFile =
|
StringArgument.builder("configFile")
|
.shortIdentifier('c')
|
.description(INFO_DESCRIPTION_CONFIG_FILE.get())
|
.hidden()
|
.required()
|
.valuePlaceholder(INFO_CONFIGFILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
configClass =
|
StringArgument.builder(OPTION_LONG_CONFIG_CLASS)
|
.shortIdentifier(OPTION_SHORT_CONFIG_CLASS)
|
.description(INFO_DESCRIPTION_CONFIG_CLASS.get())
|
.hidden()
|
.valuePlaceholder(INFO_CONFIGCLASS_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
resourcePath =
|
StringArgument.builder("resourcePath")
|
.shortIdentifier('r')
|
.description(INFO_MAKELDIF_DESCRIPTION_RESOURCE_PATH.get())
|
.hidden()
|
.required()
|
.valuePlaceholder(INFO_PATH_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
templatePath =
|
StringArgument.builder("templateFile")
|
.shortIdentifier('t')
|
.description(INFO_MAKELDIF_DESCRIPTION_TEMPLATE.get())
|
.required()
|
.valuePlaceholder(INFO_FILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
ldifFile =
|
StringArgument.builder("ldifFile")
|
.shortIdentifier('o')
|
.description(INFO_MAKELDIF_DESCRIPTION_LDIF.get())
|
.required()
|
.valuePlaceholder(INFO_FILE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
randomSeed =
|
IntegerArgument.builder(OPTION_LONG_RANDOM_SEED)
|
.shortIdentifier(OPTION_SHORT_RANDOM_SEED)
|
.description(INFO_MAKELDIF_DESCRIPTION_SEED.get())
|
.defaultValue(0)
|
.valuePlaceholder(INFO_SEED_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
|
showUsage = CommonArguments.getShowUsage();
|
argParser.addArgument(showUsage);
|
argParser.setUsageArgument(showUsage);
|
}
|
catch (ArgumentException ae)
|
{
|
printWrappedText(err, ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage()));
|
return 1;
|
}
|
|
|
// Parse the command-line arguments provided to the program.
|
try
|
{
|
argParser.parseArguments(args);
|
}
|
catch (ArgumentException ae)
|
{
|
argParser.displayMessageAndUsageReference(err, ERR_ERROR_PARSING_ARGS.get(ae.getMessage()));
|
return 1;
|
}
|
|
|
// If we should just display usage or version information,
|
// then print it and exit.
|
if (argParser.usageOrVersionDisplayed())
|
{
|
return 0;
|
}
|
|
// Checks the version - if upgrade required, the tool is unusable
|
try
|
{
|
BuildVersion.checkVersionMismatch();
|
}
|
catch (InitializationException e)
|
{
|
printWrappedText(err, e.getMessage());
|
return 1;
|
}
|
|
if (initializeServer)
|
{
|
// Initialize the Directory Server configuration handler using the
|
// information that was provided.
|
DirectoryServer directoryServer = DirectoryServer.getInstance();
|
DirectoryServer.bootstrapClient();
|
|
try
|
{
|
DirectoryServer.initializeJMX();
|
}
|
catch (Exception e)
|
{
|
printWrappedText(err, ERR_MAKELDIF_CANNOT_INITIALIZE_JMX.get(configFile.getValue(), e.getMessage()));
|
return 1;
|
}
|
|
try
|
{
|
directoryServer.initializeConfiguration(configClass.getValue(),
|
configFile.getValue());
|
}
|
catch (Exception e)
|
{
|
printWrappedText(err, ERR_MAKELDIF_CANNOT_INITIALIZE_CONFIG.get(configFile.getValue(), e.getMessage()));
|
return 1;
|
}
|
}
|
|
if (initializeSchema)
|
{
|
try
|
{
|
DirectoryServer.getInstance().initializeSchema();
|
}
|
catch (Exception e)
|
{
|
printWrappedText(err, ERR_MAKELDIF_CANNOT_INITIALIZE_SCHEMA.get(configFile.getValue(), e.getMessage()));
|
return 1;
|
}
|
}
|
|
|
// Create the random number generator that will be used for the generation
|
// process.
|
Random random;
|
if (randomSeed.isPresent())
|
{
|
try
|
{
|
random = new Random(randomSeed.getIntValue());
|
}
|
catch (Exception e)
|
{
|
random = new Random();
|
}
|
}
|
else
|
{
|
random = new Random();
|
}
|
|
|
// If a resource path was provided, then make sure it's acceptable.
|
File resourceDir = new File(resourcePath.getValue());
|
if (! resourceDir.exists())
|
{
|
printWrappedText(err, ERR_MAKELDIF_NO_SUCH_RESOURCE_DIRECTORY.get(resourcePath.getValue()));
|
return 1;
|
}
|
|
|
// Load and parse the template file.
|
LinkedList<LocalizableMessage> warnings = new LinkedList<>();
|
TemplateFile templateFile = new TemplateFile(resourcePath.getValue(), random);
|
try
|
{
|
templateFile.parse(templatePath.getValue(), warnings);
|
}
|
catch (IOException ioe)
|
{
|
printWrappedText(err, ERR_MAKELDIF_IOEXCEPTION_DURING_PARSE.get(ioe.getMessage()));
|
return 1;
|
}
|
catch (Exception e)
|
{
|
printWrappedText(err, ERR_MAKELDIF_EXCEPTION_DURING_PARSE.get(e.getMessage()));
|
return 1;
|
}
|
|
|
// If there were any warnings, then print them.
|
if (! warnings.isEmpty())
|
{
|
for (LocalizableMessage s : warnings)
|
{
|
printWrappedText(err, s);
|
}
|
}
|
|
|
// Create the LDIF writer that will be used to actually write the LDIF.
|
LDIFExportConfig exportConfig =
|
new LDIFExportConfig(ldifFile.getValue(),
|
ExistingFileBehavior.OVERWRITE);
|
try
|
{
|
ldifWriter = new LDIFWriter(exportConfig);
|
}
|
catch (IOException ioe)
|
{
|
printWrappedText(err, ERR_MAKELDIF_UNABLE_TO_CREATE_LDIF.get(ldifFile.getValue(), ioe));
|
return 1;
|
}
|
|
|
// Generate the LDIF content.
|
try
|
{
|
templateFile.generateLDIF(this);
|
}
|
catch (Exception e)
|
{
|
printWrappedText(err, ERR_MAKELDIF_ERROR_WRITING_LDIF.get(ldifFile.getValue(), stackTraceToSingleLineString(e)));
|
return 1;
|
}
|
finally
|
{
|
close(ldifWriter);
|
}
|
|
|
// If we've gotten here, then everything was successful.
|
return 0;
|
}
|
|
|
/**
|
* Processes the provided set of command-line arguments and begins generating
|
* the LDIF content.
|
*
|
* @param args The command-line arguments provided for this program.
|
*
|
* @return A result code of zero if all processing completed properly, or
|
* a nonzero result if a problem occurred.
|
*/
|
public int makeLDIFMain(String[] args)
|
{
|
return makeLDIFMain(args, true, true, System.out, System.err);
|
}
|
|
|
|
/**
|
* Writes the provided entry to the appropriate target.
|
*
|
* @param entry The entry to be written.
|
*
|
* @return <CODE>true</CODE> if the entry writer will accept more entries, or
|
* <CODE>false</CODE> if not.
|
*
|
* @throws IOException If a problem occurs while writing the entry to its
|
* intended destination.
|
*
|
* @throws MakeLDIFException If some other problem occurs.
|
*/
|
@Override
|
public boolean writeEntry(TemplateEntry entry)
|
throws IOException, MakeLDIFException
|
{
|
try
|
{
|
if (entry.getDN() != null)
|
{
|
ldifWriter.writeTemplateEntry(entry);
|
|
if ((++entriesWritten % 1000) == 0)
|
{
|
printWrappedText(out, INFO_MAKELDIF_PROCESSED_N_ENTRIES.get(entriesWritten));
|
}
|
}
|
else
|
{
|
AttributeType[] rdnAttrs = entry.getTemplate().getRDNAttributes();
|
String nullRdn = "";
|
for (AttributeType att : rdnAttrs)
|
{
|
if (entry.getValue(att) == null)
|
{
|
nullRdn = att.getNameOrOID();
|
break ;
|
}
|
}
|
printWrappedText(err, ERR_MAKELDIF_CANNOT_WRITE_ENTRY_WITHOUT_DN.get(nullRdn));
|
return true;
|
}
|
|
return true;
|
}
|
catch (IOException ioe)
|
{
|
throw ioe;
|
}
|
catch (Exception e)
|
{
|
LocalizableMessage message = ERR_MAKELDIF_CANNOT_WRITE_ENTRY.get(
|
entry.getDN(), stackTraceToSingleLineString(e));
|
throw new MakeLDIFException(message, e);
|
}
|
}
|
|
|
|
/**
|
* Notifies the entry writer that no more entries will be provided and that
|
* any associated cleanup may be performed.
|
*/
|
@Override
|
public void closeEntryWriter()
|
{
|
printWrappedText(out, INFO_MAKELDIF_PROCESSING_COMPLETE.get(entriesWritten));
|
}
|
}
|
