/** {@inheritDoc} */ @SuppressWarnings("unchecked") @Override public MenuResult<Integer> run(ConsoleApplication app, ManagementContextFactory factory) throws ArgumentException, ClientException, CLIException { // Get the naming argument values. List<String> names = getNamingArgValues(app, namingArgs); // Reset the command builder getCommandBuilder().clearArguments(); setCommandBuilderUseful(false); // Update the command builder. updateCommandBuilderWithSubCommand(); // Get the targeted managed object. Message ufn = path.getRelationDefinition().getUserFriendlyName(); ManagementContext context = factory.getManagementContext(app); MenuResult<ManagedObject<?>> result; try { result = getManagedObject(app, context, path, names); } catch (AuthorizationException e) { Message msg = ERR_DSCFG_ERROR_MODIFY_AUTHZ.get(ufn); throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS, msg); } catch (DefinitionDecodingException e) { Message msg = ERR_DSCFG_ERROR_GET_CHILD_DDE.get(ufn, ufn, ufn); throw new ClientException(LDAPResultCode.OTHER, msg); } catch (ManagedObjectDecodingException e) { // FIXME: should not abort here. Instead, display the errors (if // verbose) and apply the changes to the partial managed object. Message msg = ERR_DSCFG_ERROR_GET_CHILD_MODE.get(ufn); throw new ClientException(LDAPResultCode.OTHER, msg, e); } catch (CommunicationException e) { Message msg = ERR_DSCFG_ERROR_MODIFY_CE.get(ufn, e.getMessage()); throw new ClientException(LDAPResultCode.OTHER, msg); } catch (ConcurrentModificationException e) { Message msg = ERR_DSCFG_ERROR_MODIFY_CME.get(ufn); throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg); } catch (ManagedObjectNotFoundException e) { String objName = names.get(names.size() - 1); ArgumentException except = null; Message msg; // if object name is 'null', get a user-friendly string to represent this if (objName == null) { msg = ERR_DSCFG_ERROR_FINDER_NO_CHILDREN_NULL.get(); except = new ArgumentException(msg); } else { except = ArgumentExceptionFactory.unknownValueForChildComponent("\"" + objName + "\""); } if (app.isInteractive()) { app.println(); app.printVerboseMessage(except.getMessageObject()); return MenuResult.cancel(); } else { throw except; } } if (result.isQuit()) { if (!app.isMenuDrivenMode()) { // User chose to quit. Message msg = INFO_DSCFG_CONFIRM_MODIFY_FAIL.get(ufn); app.printVerboseMessage(msg); } return MenuResult.quit(); } else if (result.isCancel()) { return MenuResult.cancel(); } ManagedObject<?> child = result.getValue(); ManagedObjectDefinition<?, ?> d = child.getManagedObjectDefinition(); Map<String, ModificationType> lastModTypes = new HashMap<String, ModificationType>(); Map<PropertyDefinition, Set> changes = new HashMap<PropertyDefinition, Set>(); // Reset properties. for (String m : propertyResetArgument.getValues()) { // Check one does not try to reset with a value if (m.contains(":")) { throw ArgumentExceptionFactory.unableToResetPropertyWithValue(m, OPTION_DSCFG_LONG_RESET); } PropertyDefinition<?> pd = getPropertyDefinition(d, m); // Mandatory properties which have no defined defaults cannot be reset. if (pd.hasOption(PropertyOption.MANDATORY) && pd.getDefaultBehaviorProvider() instanceof UndefinedDefaultBehaviorProvider) { throw ArgumentExceptionFactory.unableToResetMandatoryProperty(d, m, OPTION_DSCFG_LONG_SET); } // Save the modification type. lastModTypes.put(m, ModificationType.SET); // Apply the modification. modifyPropertyValues(child, pd, changes, ModificationType.SET, null); } // Set properties. for (String m : propertySetArgument.getValues()) { Pair<String, String> pair = parseValue(m); String propertyName = pair.getFirst(); String value = pair.getSecond(); PropertyDefinition<?> pd = getPropertyDefinition(d, propertyName); // Apply the modification. if (lastModTypes.containsKey(propertyName)) { modifyPropertyValues(child, pd, changes, ModificationType.ADD, value); } else { lastModTypes.put(propertyName, ModificationType.SET); modifyPropertyValues(child, pd, changes, ModificationType.SET, value); } } // Remove properties. for (String m : propertyRemoveArgument.getValues()) { Pair<String, String> pair = parseValue(m); String propertyName = pair.getFirst(); String value = pair.getSecond(); PropertyDefinition<?> pd = getPropertyDefinition(d, propertyName); // Apply the modification. if (lastModTypes.containsKey(propertyName) && lastModTypes.get(propertyName) == ModificationType.SET) { throw ArgumentExceptionFactory.incompatiblePropertyModification(m); } lastModTypes.put(propertyName, ModificationType.REMOVE); modifyPropertyValues(child, pd, changes, ModificationType.REMOVE, value); } // Add properties. for (String m : propertyAddArgument.getValues()) { Pair<String, String> pair = parseValue(m); String propertyName = pair.getFirst(); String value = pair.getSecond(); PropertyDefinition<?> pd = getPropertyDefinition(d, propertyName); // Apply the modification. if (lastModTypes.containsKey(propertyName) && lastModTypes.get(propertyName) == ModificationType.SET) { throw ArgumentExceptionFactory.incompatiblePropertyModification(m); } lastModTypes.put(propertyName, ModificationType.ADD); modifyPropertyValues(child, pd, changes, ModificationType.ADD, value); } // Apply the command line changes. for (PropertyDefinition<?> pd : changes.keySet()) { try { child.setPropertyValues(pd, changes.get(pd)); } catch (PropertyException e) { throw ArgumentExceptionFactory.adaptPropertyException(e, d); } setCommandBuilderUseful(true); } // Now the command line changes have been made, apply the changes // interacting with the user to fix any problems if required. MenuResult<Void> result2 = modifyManagedObject(app, context, child, this); if (result2.isCancel()) { return MenuResult.cancel(); } else if (result2.isQuit()) { return MenuResult.quit(); } else { if (propertyResetArgument.hasValue()) { getCommandBuilder().addArgument(propertyResetArgument); } if (propertySetArgument.hasValue()) { getCommandBuilder().addArgument(propertySetArgument); } if (propertyAddArgument.hasValue()) { getCommandBuilder().addArgument(propertyAddArgument); } if (propertyRemoveArgument.hasValue()) { getCommandBuilder().addArgument(propertyRemoveArgument); } return MenuResult.success(0); } }
/** * Configure the provided managed object and updates the command builder in the pased * SetPropSubCommandHandler object. * * @param app The console application. * @param context The management context. * @param mo The managed object to be configured. * @param handler The SubCommandHandler whose command builder properties must be updated. * @return Returns a MenuResult.success() if the managed object was configured successfully, or * MenuResult.quit(), or MenuResult.cancel(), if the managed object was edited interactively * and the user chose to quit or cancel. * @throws ClientException If an unrecoverable client exception occurred whilst interacting with * the server. * @throws CLIException If an error occurred whilst interacting with the console. */ public static MenuResult<Void> modifyManagedObject( ConsoleApplication app, ManagementContext context, ManagedObject<?> mo, SubCommandHandler handler) throws ClientException, CLIException { ManagedObjectDefinition<?, ?> d = mo.getManagedObjectDefinition(); Message ufn = d.getUserFriendlyName(); PropertyValueEditor editor = new PropertyValueEditor(app, context); while (true) { // Interactively set properties if applicable. if (app.isInteractive()) { SortedSet<PropertyDefinition<?>> properties = new TreeSet<PropertyDefinition<?>>(); for (PropertyDefinition<?> pd : d.getAllPropertyDefinitions()) { if (pd.hasOption(PropertyOption.HIDDEN)) { continue; } if (!app.isAdvancedMode() && pd.hasOption(PropertyOption.ADVANCED)) { continue; } properties.add(pd); } MenuResult<Void> result = editor.edit(mo, properties, false); // Interactively enable/edit referenced components. if (result.isSuccess()) { result = checkReferences(app, context, mo, handler); if (result.isAgain()) { // Edit again. continue; } } if (result.isQuit()) { if (!app.isMenuDrivenMode()) { // User chose to cancel any changes. Message msg = INFO_DSCFG_CONFIRM_MODIFY_FAIL.get(ufn); app.printVerboseMessage(msg); } return MenuResult.quit(); } else if (result.isCancel()) { return MenuResult.cancel(); } } try { // Commit the changes if necessary if (mo.isModified()) { mo.commit(); // Output success message. if (app.isVerbose() || app.isInteractive()) { app.println(); Message msg = INFO_DSCFG_CONFIRM_MODIFY_SUCCESS.get(ufn); app.printVerboseMessage(msg); } for (PropertyEditorModification<?> mod : editor.getModifications()) { try { handler.getCommandBuilder().addArgument(createArgument(mod)); } catch (ArgumentException ae) { // This is a bug throw new RuntimeException( "Unexpected error generating the command builder: " + ae, ae); } } handler.setCommandBuilderUseful(true); } return MenuResult.success(); } catch (MissingMandatoryPropertiesException e) { if (app.isInteractive()) { // If interactive, give the user the chance to fix the // problems. app.println(); displayMissingMandatoryPropertyException(app, e); app.println(); if (!app.confirmAction(INFO_DSCFG_PROMPT_EDIT_AGAIN.get(ufn), true)) { return MenuResult.cancel(); } } else { throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, e.getMessageObject(), e); } } catch (AuthorizationException e) { Message msg = ERR_DSCFG_ERROR_MODIFY_AUTHZ.get(ufn); throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS, msg); } catch (ConcurrentModificationException e) { Message msg = ERR_DSCFG_ERROR_MODIFY_CME.get(ufn); throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg); } catch (OperationRejectedException e) { if (app.isInteractive()) { // If interactive, give the user the chance to fix the // problems. app.println(); displayOperationRejectedException(app, e); app.println(); if (!app.confirmAction(INFO_DSCFG_PROMPT_EDIT_AGAIN.get(ufn), true)) { return MenuResult.cancel(); } } else { throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, e.getMessageObject(), e); } } catch (CommunicationException e) { Message msg = ERR_DSCFG_ERROR_MODIFY_CE.get(ufn, e.getMessage()); throw new ClientException(LDAPResultCode.OTHER, msg); } catch (ManagedObjectAlreadyExistsException e) { // Should never happen. throw new IllegalStateException(e); } } }