/* * 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 2007 Sun Microsystems, Inc. */ package org.opends.server.tools.dsconfig; import org.opends.messages.Message; import static org.opends.messages.ToolMessages.*; import java.util.List; import org.opends.server.admin.DefinitionDecodingException; import org.opends.server.admin.InstantiableRelationDefinition; import org.opends.server.admin.ManagedObjectNotFoundException; import org.opends.server.admin.ManagedObjectPath; import org.opends.server.admin.OptionalRelationDefinition; import org.opends.server.admin.RelationDefinition; import org.opends.server.admin.client.AuthorizationException; import org.opends.server.admin.client.CommunicationException; import org.opends.server.admin.client.ConcurrentModificationException; import org.opends.server.admin.client.ManagedObject; import org.opends.server.admin.client.ManagedObjectDecodingException; import org.opends.server.admin.client.OperationRejectedException; import org.opends.server.protocols.ldap.LDAPResultCode; import org.opends.server.tools.ClientException; import org.opends.server.util.args.ArgumentException; import org.opends.server.util.args.BooleanArgument; import org.opends.server.util.args.StringArgument; import org.opends.server.util.args.SubCommand; import org.opends.server.util.args.SubCommandArgumentParser; /** * A sub-command handler which is used to delete existing managed * objects. *

* This sub-command implements the various delete-xxx sub-commands. */ final class DeleteSubCommandHandler extends SubCommandHandler { /** * The value for the long option force. */ private static final String OPTION_DSCFG_LONG_FORCE = "force"; /** * The value for the short option force. */ private static final char OPTION_DSCFG_SHORT_FORCE = 'f'; /** * Creates a new delete-xxx sub-command for an instantiable * relation. * * @param app * The console application. * @param parser * The sub-command argument parser. * @param p * The parent managed object path. * @param r * The instantiable relation. * @return Returns the new delete-xxx sub-command. * @throws ArgumentException * If the sub-command could not be created successfully. */ public static DeleteSubCommandHandler create(ConsoleApplication app, SubCommandArgumentParser parser, ManagedObjectPath p, InstantiableRelationDefinition r) throws ArgumentException { return new DeleteSubCommandHandler(app, parser, p, r, p.child(r, "DUMMY")); } /** * Creates a new delete-xxx sub-command for an optional relation. * * @param app * The console application. * @param parser * The sub-command argument parser. * @param p * The parent managed object path. * @param r * The optional relation. * @return Returns the new delete-xxx sub-command. * @throws ArgumentException * If the sub-command could not be created successfully. */ public static DeleteSubCommandHandler create(ConsoleApplication app, SubCommandArgumentParser parser, ManagedObjectPath p, OptionalRelationDefinition r) throws ArgumentException { return new DeleteSubCommandHandler(app, parser, p, r, p.child(r)); } // The argument which should be used to force deletion. private final BooleanArgument forceArgument; // The sub-commands naming arguments. private final List namingArgs; // The path of the managed object. private final ManagedObjectPath path; // The relation which references the managed // object to be deleted. private final RelationDefinition relation; // The sub-command associated with this handler. private final SubCommand subCommand; // Private constructor. private DeleteSubCommandHandler(ConsoleApplication app, SubCommandArgumentParser parser, ManagedObjectPath p, RelationDefinition r, ManagedObjectPath c) throws ArgumentException { super(app); this.path = p; this.relation = r; // Create the sub-command. String name = "delete-" + r.getName(); Message ufpn = r.getChildDefinition().getUserFriendlyPluralName(); Message description = INFO_DSCFG_DESCRIPTION_SUBCMD_DELETE.get(ufpn); this.subCommand = new SubCommand(parser, name, false, 0, 0, null, description); // Create the naming arguments. this.namingArgs = createNamingArgs(subCommand, c, false); // Create the --force argument which is used to force deletion. this.forceArgument = new BooleanArgument(OPTION_DSCFG_LONG_FORCE, OPTION_DSCFG_SHORT_FORCE, OPTION_DSCFG_LONG_FORCE, INFO_DSCFG_DESCRIPTION_FORCE.get(ufpn)); subCommand.addArgument(forceArgument); // Register the tags associated with the child managed objects. addTags(relation.getChildDefinition().getAllTags()); } /** * {@inheritDoc} */ @Override public SubCommand getSubCommand() { return subCommand; } /** * {@inheritDoc} */ @Override public int run() throws ArgumentException, ClientException { // Get the naming argument values. List names = getNamingArgValues(namingArgs); // Delete the child managed object. ManagedObject parent = null; try { parent = getManagedObject(path, names); } catch (AuthorizationException e) { Message msg = ERR_DSCFG_ERROR_DELETE_AUTHZ.get(relation.getUserFriendlyName()); throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS, msg); } catch (DefinitionDecodingException e) { Message ufn = path.getManagedObjectDefinition().getUserFriendlyName(); Message msg = ERR_DSCFG_ERROR_GET_PARENT_DDE.get(ufn, ufn, ufn); throw new ClientException(LDAPResultCode.OPERATIONS_ERROR, msg); } catch (ManagedObjectDecodingException e) { Message ufn = path.getManagedObjectDefinition().getUserFriendlyName(); Message msg = ERR_DSCFG_ERROR_GET_PARENT_MODE.get(ufn); throw new ClientException(LDAPResultCode.OPERATIONS_ERROR, msg); } catch (CommunicationException e) { Message msg = ERR_DSCFG_ERROR_DELETE_CE.get( relation.getUserFriendlyName(), e.getMessage()); throw new ClientException(LDAPResultCode.CLIENT_SIDE_SERVER_DOWN, msg); } catch (ConcurrentModificationException e) { Message msg = ERR_DSCFG_ERROR_DELETE_CME.get(relation.getUserFriendlyName()); throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg); } catch (ManagedObjectNotFoundException e) { // Ignore the error if the deletion is being forced. if (!forceArgument.isPresent()) { Message ufn = path.getManagedObjectDefinition().getUserFriendlyName(); Message msg = ERR_DSCFG_ERROR_GET_PARENT_MONFE.get(ufn); throw new ClientException(LDAPResultCode.NO_SUCH_OBJECT, msg); } } if (parent != null) { try { if (relation instanceof InstantiableRelationDefinition) { InstantiableRelationDefinition irelation = (InstantiableRelationDefinition) relation; String childName = names.get(names.size() - 1); if (childName == null) { childName = readChildName(parent, irelation, null); } if (confirmDeletion()) { parent.removeChild(irelation, childName); } else { return 1; } } else if (relation instanceof OptionalRelationDefinition) { OptionalRelationDefinition orelation = (OptionalRelationDefinition) relation; if (confirmDeletion()) { parent.removeChild(orelation); } else { return 1; } } } catch (AuthorizationException e) { Message msg = ERR_DSCFG_ERROR_DELETE_AUTHZ.get(relation.getUserFriendlyName()); throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS, msg); } catch (OperationRejectedException e) { Message msg = ERR_DSCFG_ERROR_DELETE_ORE.get( relation.getUserFriendlyName(), e.getMessage()); throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg); } catch (ManagedObjectNotFoundException e) { // Ignore the error if the deletion is being forced. if (!forceArgument.isPresent()) { Message msg = ERR_DSCFG_ERROR_DELETE_MONFE.get(relation.getUserFriendlyName()); throw new ClientException(LDAPResultCode.NO_SUCH_OBJECT, msg); } } catch (ConcurrentModificationException e) { Message msg = ERR_DSCFG_ERROR_DELETE_CME.get(relation.getUserFriendlyName()); throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg); } catch (CommunicationException e) { Message msg = ERR_DSCFG_ERROR_DELETE_CE.get( relation.getUserFriendlyName(), e.getMessage()); throw new ClientException(LDAPResultCode.CLIENT_SIDE_SERVER_DOWN, msg); } } // Output success message. Message msg = INFO_DSCFG_CONFIRM_DELETE_SUCCESS.get(relation.getUserFriendlyName()); getConsoleApplication().printVerboseMessage(msg); return 0; } // Confirm deletion. private boolean confirmDeletion() throws ArgumentException { Message prompt = INFO_DSCFG_CONFIRM_DELETE.get(relation.getUserFriendlyName()); if (!getConsoleApplication().confirmAction(prompt)) { // Output failure message. Message msg = INFO_DSCFG_CONFIRM_DELETE_FAIL.get(relation.getUserFriendlyName()); getConsoleApplication().printVerboseMessage(msg); return false; } else { return true; } } }