/* * 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 * trunk/opends/resource/legal-notices/OpenDS.LICENSE * or https://OpenDS.dev.java.net/OpenDS.LICENSE. * 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/opends/resource/legal-notices/OpenDS.LICENSE. 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 * * * Portions Copyright 2006-2007 Sun Microsystems, Inc. */ package org.opends.server.tools; import java.io.BufferedReader; import java.io.FileReader; import java.io.InputStreamReader; import java.io.IOException; import java.io.OutputStream; import java.io.PrintStream; import java.io.Reader; import java.util.ArrayList; import java.util.LinkedList; import java.util.concurrent.atomic.AtomicInteger; import org.opends.server.core.DirectoryServer; import org.opends.server.protocols.asn1.ASN1Element; import org.opends.server.protocols.asn1.ASN1Exception; import org.opends.server.protocols.asn1.ASN1OctetString; import org.opends.server.protocols.asn1.ASN1Sequence; import org.opends.server.protocols.ldap.DeleteRequestProtocolOp; import org.opends.server.protocols.ldap.DeleteResponseProtocolOp; import org.opends.server.protocols.ldap.LDAPControl; import org.opends.server.protocols.ldap.LDAPException; import org.opends.server.protocols.ldap.LDAPMessage; import org.opends.server.protocols.ldap.ProtocolOp; import org.opends.server.types.NullOutputStream; import org.opends.server.types.DebugLogLevel; import org.opends.server.util.PasswordReader; 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.FileBasedArgument; import org.opends.server.util.args.IntegerArgument; import org.opends.server.util.args.StringArgument; import static org.opends.server.loggers.debug.DebugLogger.debugCaught; import static org.opends.server.loggers.debug.DebugLogger.debugEnabled; import static org.opends.server.messages.MessageHandler.*; import static org.opends.server.messages.ToolMessages.*; import static org.opends.server.protocols.ldap.LDAPResultCode.*; import static org.opends.server.util.ServerConstants.*; import static org.opends.server.util.StaticUtils.*; /** * This class provides a tool that can be used to issue delete requests to the * Directory Server. */ public class LDAPDelete { /** * The fully-qualified name of this class. */ private static final String CLASS_NAME = "org.opends.server.tools.LDAPDelete"; // The message ID counter to use for requests. private AtomicInteger nextMessageID; // The print stream to use for standard error. private PrintStream err; // The print stream to use for standard output. private PrintStream out; /** * Constructor for the LDAPDelete object. * * @param nextMessageID The next message ID to use for requests. * @param out The print stream to use for standard output. * @param err The print stream to use for standard error. */ public LDAPDelete(AtomicInteger nextMessageID, PrintStream out, PrintStream err) { this.nextMessageID = nextMessageID; this.out = out; this.err = err; } /** * Execute the delete request on the specified list of DNs. * * @param connection The connection to use to execute the request. * @param lines The list of DNs to delete. * @param deleteOptions The constraints to use for this request. * * @throws IOException If a problem occurs while attempting to communicate * with the Directory Server. * * @throws LDAPException If the Directory Server returns an error response. */ public void readAndExecute(LDAPConnection connection, ArrayList lines, LDAPDeleteOptions deleteOptions) throws IOException, LDAPException { for(String line : lines) { executeDelete(connection, line, deleteOptions); } } /** * Read the specified DNs from the given reader * (file or stdin) and execute the given delete request. * * @param connection The connection to use to execute the request. * @param reader The reader to read the list of DNs from. * @param deleteOptions The constraints to use for this request. * * @throws IOException If a problem occurs while attempting to communicate * with the Directory Server. * * @throws LDAPException If the Directory Server returns an error response. */ public void readAndExecute(LDAPConnection connection, Reader reader, LDAPDeleteOptions deleteOptions) throws IOException, LDAPException { BufferedReader in = new BufferedReader(reader); String line = null; while ((line = in.readLine()) != null) { executeDelete(connection, line, deleteOptions); } in.close(); } /** * Execute the delete request for the specified DN. * * @param connection The connection to use to execute the request. * @param line The DN to delete. * @param deleteOptions The list of constraints for this request. * * @throws IOException If a problem occurs while attempting to communicate * with the Directory Server. * * @throws LDAPException If the Directory Server returns an error response. */ private void executeDelete(LDAPConnection connection, String line, LDAPDeleteOptions deleteOptions) throws IOException, LDAPException { ArrayList controls = deleteOptions.getControls(); ProtocolOp protocolOp = null; ASN1OctetString asn1OctetStr = new ASN1OctetString(line); protocolOp = new DeleteRequestProtocolOp(asn1OctetStr); int msgID = MSGID_PROCESSING_OPERATION; out.println(getMessage(msgID, "DELETE", asn1OctetStr)); if(!deleteOptions.showOperations()) { LDAPMessage message = new LDAPMessage(nextMessageID.getAndIncrement(), protocolOp, controls); LDAPMessage responseMessage = null; try { int numBytes = connection.getASN1Writer().writeElement(message.encode()); ASN1Element element = connection.getASN1Reader().readElement(); responseMessage = LDAPMessage.decode( ASN1Sequence.decodeAsSequence(element)); } catch(ASN1Exception ae) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, ae); } if (!deleteOptions.continueOnError()) { throw new IOException(ae.getMessage()); } else { msgID = MSGID_OPERATION_FAILED; String msg = getMessage(msgID, "DELETE", line, ae.getMessage()); err.println(wrapText(msg, MAX_LINE_WIDTH)); return; } } DeleteResponseProtocolOp op = responseMessage.getDeleteResponseProtocolOp(); int resultCode = op.getResultCode(); String errorMessage = op.getErrorMessage(); if(resultCode != SUCCESS && resultCode != REFERRAL && !deleteOptions.continueOnError()) { msgID = MSGID_OPERATION_FAILED; String msg = getMessage(msgID, "DELETE", line, errorMessage); throw new LDAPException(resultCode, msgID, msg); } else { if(resultCode != SUCCESS && resultCode != REFERRAL) { msgID = MSGID_OPERATION_FAILED; String msg = getMessage(msgID, "DELETE", line, errorMessage); err.println(wrapText(msg, MAX_LINE_WIDTH)); } else { msgID = MSGID_OPERATION_SUCCESSFUL; String msg = getMessage(msgID, "DELETE", line); out.println(msg); } } } } /** * The main method for LDAPDelete tool. * * @param args The command-line arguments provided to this program. */ public static void main(String[] args) { int retCode = mainDelete(args, true, System.out, System.err); if(retCode != 0) { System.exit(retCode); } } /** * Parses the provided command-line arguments and uses that information to * run the ldapdelete tool. * * @param args The command-line arguments provided to this program. * * @return The error code. */ public static int mainDelete(String[] args) { return mainDelete(args, true, System.out, System.err); } /** * Parses the provided command-line arguments and uses that information to * run the ldapdelete tool. * * @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 * null if standard output is not * needed. * @param errStream The output stream to use for standard error, or * null if standard error is not * needed. * * @return The error code. */ public static int mainDelete(String[] args, boolean initializeServer, OutputStream outStream, OutputStream errStream) { PrintStream out; if (outStream == null) { out = NullOutputStream.printStream(); } else { out = new PrintStream(outStream); } PrintStream err; if (errStream == null) { err = NullOutputStream.printStream(); } else { err = new PrintStream(errStream); } LDAPConnectionOptions connectionOptions = new LDAPConnectionOptions(); LDAPDeleteOptions deleteOptions = new LDAPDeleteOptions(); LDAPConnection connection = null; BooleanArgument continueOnError = null; BooleanArgument deleteSubtree = null; BooleanArgument noop = null; BooleanArgument saslExternal = null; BooleanArgument showUsage = null; BooleanArgument startTLS = null; BooleanArgument trustAll = null; BooleanArgument useSSL = null; BooleanArgument verbose = null; FileBasedArgument bindPasswordFile = null; FileBasedArgument keyStorePasswordFile = null; FileBasedArgument trustStorePasswordFile = null; IntegerArgument port = null; IntegerArgument version = null; StringArgument bindDN = null; StringArgument bindPassword = null; StringArgument certNickname = null; StringArgument controlStr = null; StringArgument encodingStr = null; StringArgument filename = null; StringArgument hostName = null; StringArgument keyStorePath = null; StringArgument keyStorePassword = null; StringArgument saslOptions = null; StringArgument trustStorePath = null; StringArgument trustStorePassword = null; Reader rdr = null; ArrayList dnStrings = new ArrayList (); // Create the command-line argument parser for use with this program. String toolDescription = getMessage(MSGID_LDAPDELETE_TOOL_DESCRIPTION); ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription, false, true, 0, 1, "\"DN\""); try { hostName = new StringArgument("host", 'h', "host", false, false, true, "{host}", "localhost", null, MSGID_DESCRIPTION_HOST); argParser.addArgument(hostName); port = new IntegerArgument("port", 'p', "port", false, false, true, "{port}", 389, null, MSGID_DESCRIPTION_PORT); argParser.addArgument(port); useSSL = new BooleanArgument("useSSL", 'Z', "useSSL", MSGID_DESCRIPTION_USE_SSL); argParser.addArgument(useSSL); startTLS = new BooleanArgument("startTLS", 'q', "startTLS", MSGID_DESCRIPTION_START_TLS); argParser.addArgument(startTLS); bindDN = new StringArgument("bindDN", 'D', "bindDN", false, false, true, "{bindDN}", null, null, MSGID_DESCRIPTION_BINDDN); argParser.addArgument(bindDN); bindPassword = new StringArgument("bindPassword", 'w', "bindPassword", false, false, true, "{bindPassword}", null, null, MSGID_DESCRIPTION_BINDPASSWORD); argParser.addArgument(bindPassword); bindPasswordFile = new FileBasedArgument("bindPasswordFile", 'j', "bindPasswordFile", false, false, "{bindPasswordFilename}", null, null, MSGID_DESCRIPTION_BINDPASSWORDFILE); argParser.addArgument(bindPasswordFile); filename = new StringArgument("filename", 'f', "filename", false, false, true, "{filename}", null, null, MSGID_DELETE_DESCRIPTION_FILENAME); argParser.addArgument(filename); saslExternal = new BooleanArgument("useSASLExternal", 'r', "useSASLExternal", MSGID_DESCRIPTION_USE_SASL_EXTERNAL); argParser.addArgument(saslExternal); saslOptions = new StringArgument("saslOption", 'o', "saslOption", false, true, true, "{name=value}", null, null, MSGID_DESCRIPTION_SASL_PROPERTIES); argParser.addArgument(saslOptions); trustAll = new BooleanArgument("trustAll", 'X', "trustAll", MSGID_DESCRIPTION_TRUSTALL); argParser.addArgument(trustAll); keyStorePath = new StringArgument("keyStorePath", 'K', "keyStorePath", false, false, true, "{keyStorePath}", null, null, MSGID_DESCRIPTION_KEYSTOREPATH); argParser.addArgument(keyStorePath); keyStorePassword = new StringArgument("keyStorePassword", 'W', "keyStorePassword", false, false, true, "{keyStorePassword}", null, null, MSGID_DESCRIPTION_KEYSTOREPASSWORD); argParser.addArgument(keyStorePassword); keyStorePasswordFile = new FileBasedArgument("keyStorePasswordFile", null, "keyStorePasswordFile", false, false, "{path}", null, null, MSGID_DESCRIPTION_KEYSTOREPASSWORD_FILE); argParser.addArgument(keyStorePasswordFile); certNickname = new StringArgument("certnickname", 'N', "certNickname", false, false, true, "{nickname}", null, null, MSGID_DESCRIPTION_CERT_NICKNAME); argParser.addArgument(certNickname); trustStorePath = new StringArgument("trustStorePath", 'P', "trustStorePath", false, false, true, "{trustStorePath}", null, null, MSGID_DESCRIPTION_TRUSTSTOREPATH); argParser.addArgument(trustStorePath); trustStorePassword = new StringArgument("trustStorePassword", null, "trustStorePassword", false, false, true, "{trustStorePassword}", null, null, MSGID_DESCRIPTION_TRUSTSTOREPASSWORD); argParser.addArgument(trustStorePassword); trustStorePasswordFile = new FileBasedArgument("trustStorePasswordFile", null, "trustStorePasswordFile", false, false, "{path}", null, null, MSGID_DESCRIPTION_TRUSTSTOREPASSWORD_FILE); argParser.addArgument(trustStorePasswordFile); deleteSubtree = new BooleanArgument("deleteSubtree", 'x', "deleteSubtree", MSGID_DELETE_DESCRIPTION_DELETE_SUBTREE); argParser.addArgument(deleteSubtree); controlStr = new StringArgument("control", 'J', "control", false, true, true, "{controloid[:criticality[:value|::b64value|: trailingArgs = argParser.getTrailingArguments(); for(String s : trailingArgs) { dnStrings.add(s); } // Set the connection options. // Parse the SASL properties. connectionOptions.setSASLExternal(saslExternal.isPresent()); if(saslOptions.isPresent()) { LinkedList values = saslOptions.getValues(); for(String saslOption : values) { if(saslOption.startsWith("mech=")) { boolean val = connectionOptions.setSASLMechanism(saslOption); if(val == false) { return 1; } } else { boolean val = connectionOptions.addSASLProperty(saslOption); if(val == false) { return 1; } } } } connectionOptions.setUseSSL(useSSL.isPresent()); connectionOptions.setStartTLS(startTLS.isPresent()); if(connectionOptions.useSASLExternal()) { if(!connectionOptions.useSSL() && !connectionOptions.useStartTLS()) { int msgID = MSGID_TOOL_SASLEXTERNAL_NEEDS_SSL_OR_TLS; String message = getMessage(msgID); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } if(keyStorePathValue == null) { int msgID = MSGID_TOOL_SASLEXTERNAL_NEEDS_KEYSTORE; String message = getMessage(msgID); err.println(wrapText(message, MAX_LINE_WIDTH)); return 1; } } try { if (initializeServer) { // Bootstrap and initialize directory data structures. DirectoryServer.bootstrapClient(); } // Connect to the specified host with the supplied userDN and password. SSLConnectionFactory sslConnectionFactory = null; if(connectionOptions.useSSL() || connectionOptions.useStartTLS()) { String clientAlias; if (certNickname.isPresent()) { clientAlias = certNickname.getValue(); } else { clientAlias = null; } sslConnectionFactory = new SSLConnectionFactory(); sslConnectionFactory.init(trustAll.isPresent(), keyStorePathValue, keyStorePasswordValue, clientAlias, trustStorePathValue, trustStorePasswordValue); connectionOptions.setSSLConnectionFactory(sslConnectionFactory); } AtomicInteger nextMessageID = new AtomicInteger(1); connection = new LDAPConnection(hostNameValue, portNumber, connectionOptions, out, err); connection.connectToHost(bindDNValue, bindPasswordValue, nextMessageID); LDAPDelete ldapDelete = new LDAPDelete(nextMessageID, out, err); if(fileNameValue == null && dnStrings.isEmpty()) { // Read from stdin. rdr = new InputStreamReader(System.in); } else if(fileNameValue != null) { rdr = new FileReader(fileNameValue); } if(rdr != null) { ldapDelete.readAndExecute(connection, rdr, deleteOptions); } else { ldapDelete.readAndExecute(connection, dnStrings, deleteOptions); } } catch(LDAPException le) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, le); } err.println(wrapText(le.getMessage(), MAX_LINE_WIDTH)); int code = le.getResultCode(); return code; } catch(LDAPConnectionException lce) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, lce); } err.println(wrapText(lce.getMessage(), MAX_LINE_WIDTH)); int code = lce.getErrorCode(); return code; } catch(Exception e) { if (debugEnabled()) { debugCaught(DebugLogLevel.ERROR, e); } err.println(wrapText(e.getMessage(), MAX_LINE_WIDTH)); return 1; } finally { if(connection != null) { connection.close(); } } return 0; } }