/**
* 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);
}
}
}
