| | |
| | | * (the "License"). You may not use this file except in compliance |
| | | * with the License. |
| | | * |
| | | * You can obtain a copy of the license at |
| | | * trunk/opendj3/legal-notices/CDDLv1_0.txt |
| | | * 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 |
| | | * trunk/opendj3/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: |
| | | * 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 |
| | |
| | | |
| | | package com.forgerock.opendj.ldap.tools; |
| | | |
| | | |
| | | |
| | | import static com.forgerock.opendj.ldap.tools.ToolConstants.*; |
| | | import static com.forgerock.opendj.ldap.tools.ToolConstants.OPTION_LONG_HELP; |
| | | import static com.forgerock.opendj.ldap.tools.ToolConstants.OPTION_LONG_OUTPUT_LDIF_FILENAME; |
| | | import static com.forgerock.opendj.ldap.tools.ToolConstants.OPTION_SHORT_HELP; |
| | | import static com.forgerock.opendj.ldap.tools.ToolConstants.OPTION_SHORT_OUTPUT_LDIF_FILENAME; |
| | | import static com.forgerock.opendj.ldap.tools.ToolsMessages.*; |
| | | import static com.forgerock.opendj.ldap.tools.Utils.filterExitCode; |
| | | |
| | | import java.io.*; |
| | | import java.io.FileInputStream; |
| | | import java.io.FileNotFoundException; |
| | | import java.io.FileOutputStream; |
| | | import java.io.IOException; |
| | | import java.io.InputStream; |
| | | import java.io.OutputStream; |
| | | import java.util.List; |
| | | |
| | | import org.forgerock.i18n.LocalizableException; |
| | |
| | | import org.forgerock.opendj.ldap.requests.DeleteRequest; |
| | | import org.forgerock.opendj.ldap.requests.ModifyDNRequest; |
| | | import org.forgerock.opendj.ldap.requests.ModifyRequest; |
| | | import org.forgerock.opendj.ldif.*; |
| | | |
| | | |
| | | import org.forgerock.opendj.ldif.LDIF; |
| | | import org.forgerock.opendj.ldif.LDIFChangeRecordReader; |
| | | import org.forgerock.opendj.ldif.LDIFEntryReader; |
| | | import org.forgerock.opendj.ldif.LDIFEntryWriter; |
| | | import org.forgerock.opendj.ldif.RejectedChangeRecordListener; |
| | | |
| | | /** |
| | | * A tool that can be used to issue update (Add/Delete/Modify/ModifyDN) requests |
| | | * to a set of entries contained in an LDIF file. |
| | | */ |
| | | public final class LDIFModify extends ConsoleApplication |
| | | { |
| | | public final class LDIFModify extends ConsoleApplication { |
| | | |
| | | /** |
| | | * The main method for LDIFModify tool. |
| | | * |
| | | * @param args |
| | | * The command-line arguments provided to this program. |
| | | */ |
| | | /** |
| | | * The main method for LDIFModify tool. |
| | | * |
| | | * @param args |
| | | * The command-line arguments provided to this program. |
| | | */ |
| | | |
| | | public static void main(final String[] args) |
| | | { |
| | | final int retCode = new LDIFModify().run(args); |
| | | System.exit(filterExitCode(retCode)); |
| | | } |
| | | |
| | | |
| | | |
| | | private LDIFModify() |
| | | { |
| | | // Nothing to do. |
| | | } |
| | | |
| | | |
| | | |
| | | private int run(final String[] args) |
| | | { |
| | | // Create the command-line argument parser for use with this |
| | | // program. |
| | | |
| | | final LocalizableMessage toolDescription = INFO_LDIFMODIFY_TOOL_DESCRIPTION |
| | | .get(); |
| | | final ArgumentParser argParser = new ArgumentParser( |
| | | LDIFModify.class.getName(), toolDescription, false, true, 1, 2, |
| | | "source [changes]"); |
| | | |
| | | final BooleanArgument continueOnError; |
| | | final BooleanArgument showUsage; |
| | | final StringArgument outputFilename; |
| | | |
| | | try |
| | | { |
| | | outputFilename = new StringArgument("outputFilename", |
| | | OPTION_SHORT_OUTPUT_LDIF_FILENAME, OPTION_LONG_OUTPUT_LDIF_FILENAME, |
| | | false, false, true, INFO_OUTPUT_LDIF_FILE_PLACEHOLDER.get(), |
| | | "stdout", null, |
| | | INFO_LDIFMODIFY_DESCRIPTION_OUTPUT_FILENAME |
| | | .get(INFO_OUTPUT_LDIF_FILE_PLACEHOLDER.get())); |
| | | argParser.addArgument(outputFilename); |
| | | |
| | | continueOnError = new BooleanArgument("continueOnError", 'c', |
| | | "continueOnError", INFO_DESCRIPTION_CONTINUE_ON_ERROR.get()); |
| | | continueOnError.setPropertyName("continueOnError"); |
| | | argParser.addArgument(continueOnError); |
| | | |
| | | showUsage = new BooleanArgument("showUsage", OPTION_SHORT_HELP, |
| | | OPTION_LONG_HELP, INFO_DESCRIPTION_SHOWUSAGE.get()); |
| | | argParser.addArgument(showUsage); |
| | | argParser.setUsageArgument(showUsage, getOutputStream()); |
| | | } |
| | | catch (final ArgumentException ae) |
| | | { |
| | | final LocalizableMessage message = ERR_CANNOT_INITIALIZE_ARGS.get(ae |
| | | .getMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | public static void main(final String[] args) { |
| | | final int retCode = new LDIFModify().run(args); |
| | | System.exit(filterExitCode(retCode)); |
| | | } |
| | | |
| | | // Parse the command-line arguments provided to this program. |
| | | try |
| | | { |
| | | argParser.parseArguments(args); |
| | | |
| | | // If we should just display usage or version information, |
| | | // then print it and exit. |
| | | if (argParser.usageOrVersionDisplayed()) |
| | | { |
| | | return 0; |
| | | } |
| | | } |
| | | catch (final ArgumentException ae) |
| | | { |
| | | final LocalizableMessage message = ERR_ERROR_PARSING_ARGS.get(ae |
| | | .getMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | private LDIFModify() { |
| | | // Nothing to do. |
| | | } |
| | | |
| | | InputStream sourceInputStream = null; |
| | | InputStream changesInputStream = null; |
| | | OutputStream outputStream = null; |
| | | LDIFEntryReader sourceReader = null; |
| | | LDIFChangeRecordReader changesReader = null; |
| | | LDIFEntryWriter outputWriter = null; |
| | | private int run(final String[] args) { |
| | | // Create the command-line argument parser for use with this |
| | | // program. |
| | | |
| | | try |
| | | { |
| | | // First source file. |
| | | final List<String> trailingArguments = argParser.getTrailingArguments(); |
| | | if (!trailingArguments.get(0).equals("-")) |
| | | { |
| | | try |
| | | { |
| | | sourceInputStream = new FileInputStream(trailingArguments.get(0)); |
| | | } |
| | | catch (final FileNotFoundException e) |
| | | { |
| | | final LocalizableMessage message = ERR_LDIF_FILE_CANNOT_OPEN_FOR_READ |
| | | .get(trailingArguments.get(0), e.getLocalizedMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | } |
| | | final LocalizableMessage toolDescription = INFO_LDIFMODIFY_TOOL_DESCRIPTION.get(); |
| | | final ArgumentParser argParser = |
| | | new ArgumentParser(LDIFModify.class.getName(), toolDescription, false, true, 1, 2, |
| | | "source [changes]"); |
| | | |
| | | // Patch file. |
| | | if (trailingArguments.size() > 1 && !trailingArguments.get(1).equals("-")) |
| | | { |
| | | try |
| | | { |
| | | changesInputStream = new FileInputStream(trailingArguments.get(1)); |
| | | } |
| | | catch (final FileNotFoundException e) |
| | | { |
| | | final LocalizableMessage message = ERR_LDIF_FILE_CANNOT_OPEN_FOR_READ |
| | | .get(trailingArguments.get(1), e.getLocalizedMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | } |
| | | final BooleanArgument continueOnError; |
| | | final BooleanArgument showUsage; |
| | | final StringArgument outputFilename; |
| | | |
| | | // Output file. |
| | | if (outputFilename.isPresent() && !outputFilename.getValue().equals("-")) |
| | | { |
| | | try |
| | | { |
| | | outputStream = new FileOutputStream(outputFilename.getValue()); |
| | | } |
| | | catch (final FileNotFoundException e) |
| | | { |
| | | final LocalizableMessage message = ERR_LDIF_FILE_CANNOT_OPEN_FOR_WRITE |
| | | .get(outputFilename.getValue(), e.getLocalizedMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | } |
| | | try { |
| | | outputFilename = |
| | | new StringArgument("outputFilename", OPTION_SHORT_OUTPUT_LDIF_FILENAME, |
| | | OPTION_LONG_OUTPUT_LDIF_FILENAME, false, false, true, |
| | | INFO_OUTPUT_LDIF_FILE_PLACEHOLDER.get(), "stdout", null, |
| | | INFO_LDIFMODIFY_DESCRIPTION_OUTPUT_FILENAME |
| | | .get(INFO_OUTPUT_LDIF_FILE_PLACEHOLDER.get())); |
| | | argParser.addArgument(outputFilename); |
| | | |
| | | // Default to stdin/stdout for all streams if not specified. |
| | | if (sourceInputStream == null) |
| | | { |
| | | // Command line parameter was "-". |
| | | sourceInputStream = System.in; |
| | | } |
| | | continueOnError = |
| | | new BooleanArgument("continueOnError", 'c', "continueOnError", |
| | | INFO_DESCRIPTION_CONTINUE_ON_ERROR.get()); |
| | | continueOnError.setPropertyName("continueOnError"); |
| | | argParser.addArgument(continueOnError); |
| | | |
| | | if (changesInputStream == null) |
| | | { |
| | | changesInputStream = System.in; |
| | | } |
| | | |
| | | if (outputStream == null) |
| | | { |
| | | outputStream = System.out; |
| | | } |
| | | |
| | | // Check that we are not attempting to read both the source and changes |
| | | // from stdin. |
| | | if (sourceInputStream == changesInputStream) |
| | | { |
| | | final LocalizableMessage message = ERR_LDIFMODIFY_MULTIPLE_USES_OF_STDIN |
| | | .get(); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | |
| | | // Apply the changes. |
| | | sourceReader = new LDIFEntryReader(sourceInputStream); |
| | | changesReader = new LDIFChangeRecordReader(changesInputStream); |
| | | outputWriter = new LDIFEntryWriter(outputStream); |
| | | |
| | | final RejectedChangeRecordListener listener = new RejectedChangeRecordListener() |
| | | { |
| | | public Entry handleDuplicateEntry(final AddRequest change, |
| | | final Entry existingEntry) throws DecodeException |
| | | { |
| | | try |
| | | { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleDuplicateEntry(change, |
| | | existingEntry); |
| | | } |
| | | catch (final DecodeException e) |
| | | { |
| | | logErrorOrFail(e); |
| | | } |
| | | return change; |
| | | showUsage = |
| | | new BooleanArgument("showUsage", OPTION_SHORT_HELP, OPTION_LONG_HELP, |
| | | INFO_DESCRIPTION_SHOWUSAGE.get()); |
| | | argParser.addArgument(showUsage); |
| | | argParser.setUsageArgument(showUsage, getOutputStream()); |
| | | } catch (final ArgumentException ae) { |
| | | final LocalizableMessage message = ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | |
| | | // Parse the command-line arguments provided to this program. |
| | | try { |
| | | argParser.parseArguments(args); |
| | | |
| | | |
| | | public Entry handleDuplicateEntry(final ModifyDNRequest change, |
| | | final Entry existingEntry, final Entry renamedEntry) |
| | | throws DecodeException |
| | | { |
| | | try |
| | | { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleDuplicateEntry(change, |
| | | existingEntry, renamedEntry); |
| | | } |
| | | catch (final DecodeException e) |
| | | { |
| | | logErrorOrFail(e); |
| | | } |
| | | return renamedEntry; |
| | | // If we should just display usage or version information, |
| | | // then print it and exit. |
| | | if (argParser.usageOrVersionDisplayed()) { |
| | | return 0; |
| | | } |
| | | } catch (final ArgumentException ae) { |
| | | final LocalizableMessage message = ERR_ERROR_PARSING_ARGS.get(ae.getMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | |
| | | InputStream sourceInputStream = null; |
| | | InputStream changesInputStream = null; |
| | | OutputStream outputStream = null; |
| | | LDIFEntryReader sourceReader = null; |
| | | LDIFChangeRecordReader changesReader = null; |
| | | LDIFEntryWriter outputWriter = null; |
| | | |
| | | try { |
| | | // First source file. |
| | | final List<String> trailingArguments = argParser.getTrailingArguments(); |
| | | if (!trailingArguments.get(0).equals("-")) { |
| | | try { |
| | | sourceInputStream = new FileInputStream(trailingArguments.get(0)); |
| | | } catch (final FileNotFoundException e) { |
| | | final LocalizableMessage message = |
| | | ERR_LDIF_FILE_CANNOT_OPEN_FOR_READ.get(trailingArguments.get(0), e |
| | | .getLocalizedMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | } |
| | | |
| | | public void handleRejectedChangeRecord(final AddRequest change, |
| | | final LocalizableMessage reason) throws DecodeException |
| | | { |
| | | try |
| | | { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord( |
| | | change, reason); |
| | | } |
| | | catch (final DecodeException e) |
| | | { |
| | | logErrorOrFail(e); |
| | | } |
| | | // Patch file. |
| | | if (trailingArguments.size() > 1 && !trailingArguments.get(1).equals("-")) { |
| | | try { |
| | | changesInputStream = new FileInputStream(trailingArguments.get(1)); |
| | | } catch (final FileNotFoundException e) { |
| | | final LocalizableMessage message = |
| | | ERR_LDIF_FILE_CANNOT_OPEN_FOR_READ.get(trailingArguments.get(1), e |
| | | .getLocalizedMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | } |
| | | |
| | | // Output file. |
| | | if (outputFilename.isPresent() && !outputFilename.getValue().equals("-")) { |
| | | try { |
| | | outputStream = new FileOutputStream(outputFilename.getValue()); |
| | | } catch (final FileNotFoundException e) { |
| | | final LocalizableMessage message = |
| | | ERR_LDIF_FILE_CANNOT_OPEN_FOR_WRITE.get(outputFilename.getValue(), e |
| | | .getLocalizedMessage()); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | } |
| | | |
| | | // Default to stdin/stdout for all streams if not specified. |
| | | if (sourceInputStream == null) { |
| | | // Command line parameter was "-". |
| | | sourceInputStream = System.in; |
| | | } |
| | | |
| | | if (changesInputStream == null) { |
| | | changesInputStream = System.in; |
| | | } |
| | | |
| | | if (outputStream == null) { |
| | | outputStream = System.out; |
| | | } |
| | | |
| | | // Check that we are not attempting to read both the source and |
| | | // changes |
| | | // from stdin. |
| | | if (sourceInputStream == changesInputStream) { |
| | | final LocalizableMessage message = ERR_LDIFMODIFY_MULTIPLE_USES_OF_STDIN.get(); |
| | | println(message); |
| | | return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue(); |
| | | } |
| | | |
| | | // Apply the changes. |
| | | sourceReader = new LDIFEntryReader(sourceInputStream); |
| | | changesReader = new LDIFChangeRecordReader(changesInputStream); |
| | | outputWriter = new LDIFEntryWriter(outputStream); |
| | | |
| | | final RejectedChangeRecordListener listener = new RejectedChangeRecordListener() { |
| | | public Entry handleDuplicateEntry(final AddRequest change, final Entry existingEntry) |
| | | throws DecodeException { |
| | | try { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleDuplicateEntry(change, |
| | | existingEntry); |
| | | } catch (final DecodeException e) { |
| | | logErrorOrFail(e); |
| | | } |
| | | return change; |
| | | } |
| | | |
| | | public Entry handleDuplicateEntry(final ModifyDNRequest change, |
| | | final Entry existingEntry, final Entry renamedEntry) throws DecodeException { |
| | | try { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleDuplicateEntry(change, |
| | | existingEntry, renamedEntry); |
| | | } catch (final DecodeException e) { |
| | | logErrorOrFail(e); |
| | | } |
| | | return renamedEntry; |
| | | } |
| | | |
| | | public void handleRejectedChangeRecord(final AddRequest change, |
| | | final LocalizableMessage reason) throws DecodeException { |
| | | try { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord(change, |
| | | reason); |
| | | } catch (final DecodeException e) { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | public void handleRejectedChangeRecord(final DeleteRequest change, |
| | | final LocalizableMessage reason) throws DecodeException { |
| | | try { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord(change, |
| | | reason); |
| | | } catch (final DecodeException e) { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | public void handleRejectedChangeRecord(final ModifyDNRequest change, |
| | | final LocalizableMessage reason) throws DecodeException { |
| | | try { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord(change, |
| | | reason); |
| | | } catch (final DecodeException e) { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | public void handleRejectedChangeRecord(final ModifyRequest change, |
| | | final LocalizableMessage reason) throws DecodeException { |
| | | try { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord(change, |
| | | reason); |
| | | } catch (final DecodeException e) { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | private void logErrorOrFail(final DecodeException e) throws DecodeException { |
| | | if (continueOnError.isPresent()) { |
| | | println(e.getMessageObject()); |
| | | } else { |
| | | throw e; |
| | | } |
| | | } |
| | | }; |
| | | |
| | | LDIF.copyTo(LDIF.patch(sourceReader, changesReader, listener), outputWriter); |
| | | } catch (final IOException e) { |
| | | if (e instanceof LocalizableException) { |
| | | println(ERR_LDIFMODIFY_PATCH_FAILED.get(((LocalizableException) e) |
| | | .getMessageObject())); |
| | | } else { |
| | | println(ERR_LDIFMODIFY_PATCH_FAILED.get(e.getLocalizedMessage())); |
| | | } |
| | | return ResultCode.CLIENT_SIDE_LOCAL_ERROR.intValue(); |
| | | } finally { |
| | | closeIfNotNull(sourceReader); |
| | | closeIfNotNull(changesReader); |
| | | closeIfNotNull(outputWriter); |
| | | |
| | | closeIfNotNull(sourceInputStream); |
| | | closeIfNotNull(changesInputStream); |
| | | closeIfNotNull(outputStream); |
| | | } |
| | | |
| | | |
| | | |
| | | public void handleRejectedChangeRecord(final DeleteRequest change, |
| | | final LocalizableMessage reason) throws DecodeException |
| | | { |
| | | try |
| | | { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord( |
| | | change, reason); |
| | | } |
| | | catch (final DecodeException e) |
| | | { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | |
| | | |
| | | public void handleRejectedChangeRecord(final ModifyDNRequest change, |
| | | final LocalizableMessage reason) throws DecodeException |
| | | { |
| | | try |
| | | { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord( |
| | | change, reason); |
| | | } |
| | | catch (final DecodeException e) |
| | | { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | |
| | | |
| | | public void handleRejectedChangeRecord(final ModifyRequest change, |
| | | final LocalizableMessage reason) throws DecodeException |
| | | { |
| | | try |
| | | { |
| | | RejectedChangeRecordListener.FAIL_FAST.handleRejectedChangeRecord( |
| | | change, reason); |
| | | } |
| | | catch (final DecodeException e) |
| | | { |
| | | logErrorOrFail(e); |
| | | } |
| | | } |
| | | |
| | | |
| | | |
| | | private void logErrorOrFail(final DecodeException e) |
| | | throws DecodeException |
| | | { |
| | | if (continueOnError.isPresent()) |
| | | { |
| | | println(e.getMessageObject()); |
| | | } |
| | | else |
| | | { |
| | | throw e; |
| | | } |
| | | } |
| | | }; |
| | | |
| | | LDIF.copyTo(LDIF.patch(sourceReader, changesReader, listener), |
| | | outputWriter); |
| | | return ResultCode.SUCCESS.intValue(); |
| | | } |
| | | catch (final IOException e) |
| | | { |
| | | if (e instanceof LocalizableException) |
| | | { |
| | | println(ERR_LDIFMODIFY_PATCH_FAILED.get(((LocalizableException) e) |
| | | .getMessageObject())); |
| | | } |
| | | else |
| | | { |
| | | println(ERR_LDIFMODIFY_PATCH_FAILED.get(e.getLocalizedMessage())); |
| | | } |
| | | return ResultCode.CLIENT_SIDE_LOCAL_ERROR.intValue(); |
| | | } |
| | | finally |
| | | { |
| | | closeIfNotNull(sourceReader); |
| | | closeIfNotNull(changesReader); |
| | | closeIfNotNull(outputWriter); |
| | | |
| | | closeIfNotNull(sourceInputStream); |
| | | closeIfNotNull(changesInputStream); |
| | | closeIfNotNull(outputStream); |
| | | } |
| | | |
| | | return ResultCode.SUCCESS.intValue(); |
| | | } |
| | | } |