/** Private constructor. */
private SetPropSubCommandHandler(
SubCommandArgumentParser parser, ManagedObjectPath<?, ?> path, RelationDefinition<?, ?> r)
throws ArgumentException {
this.path = path;
// Create the sub-command.
String name = "set-" + r.getName() + "-prop";
Message description =
INFO_DSCFG_DESCRIPTION_SUBCMD_SETPROP.get(r.getChildDefinition().getUserFriendlyName());
this.subCommand = new SubCommand(parser, name, false, 0, 0, null, description);
// Create the naming arguments.
this.namingArgs = createNamingArgs(subCommand, path, false);
// Create the --set argument.
this.propertySetArgument =
new StringArgument(
OPTION_DSCFG_LONG_SET,
OPTION_DSCFG_SHORT_SET,
OPTION_DSCFG_LONG_SET,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_PROP_VAL.get());
this.subCommand.addArgument(this.propertySetArgument);
// Create the --reset argument.
this.propertyResetArgument =
new StringArgument(
OPTION_DSCFG_LONG_RESET,
OPTION_DSCFG_SHORT_RESET,
OPTION_DSCFG_LONG_RESET,
false,
true,
true,
INFO_PROPERTY_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_RESET_PROP.get());
this.subCommand.addArgument(this.propertyResetArgument);
// Create the --add argument.
this.propertyAddArgument =
new StringArgument(
OPTION_DSCFG_LONG_ADD,
OPTION_DSCFG_SHORT_ADD,
OPTION_DSCFG_LONG_ADD,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_ADD_PROP_VAL.get());
this.subCommand.addArgument(this.propertyAddArgument);
// Create the --remove argument.
this.propertyRemoveArgument =
new StringArgument(
OPTION_DSCFG_LONG_REMOVE,
OPTION_DSCFG_SHORT_REMOVE,
OPTION_DSCFG_LONG_REMOVE,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_REMOVE_PROP_VAL.get());
this.subCommand.addArgument(this.propertyRemoveArgument);
// Register the tags associated with the child managed objects.
addTags(path.getManagedObjectDefinition().getAllTags());
}
/**
* Creates an argument (the one that the user should provide in the command-line) that is
* equivalent to the modification proposed by the user in the provided PropertyEditorModification
* object.
*
* @param mod the object describing the modification made.
* @param <T> the type of the property to be retrieved.
* @return the argument representing the modification.
* @throws ArgumentException if there is a problem creating the argument.
*/
private static <T> Argument createArgument(PropertyEditorModification<T> mod)
throws ArgumentException {
StringArgument arg;
PropertyDefinition<T> propertyDefinition = mod.getPropertyDefinition();
String propName = propertyDefinition.getName();
switch (mod.getType()) {
case RESET:
arg =
new StringArgument(
OPTION_DSCFG_LONG_RESET,
OPTION_DSCFG_SHORT_RESET,
OPTION_DSCFG_LONG_RESET,
false,
true,
true,
INFO_PROPERTY_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_RESET_PROP.get());
arg.addValue(propName);
break;
case REMOVE:
arg =
new StringArgument(
OPTION_DSCFG_LONG_REMOVE,
OPTION_DSCFG_SHORT_REMOVE,
OPTION_DSCFG_LONG_REMOVE,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_REMOVE_PROP_VAL.get());
for (T value : mod.getModificationValues()) {
arg.addValue(propName + ':' + getArgumentValue(propertyDefinition, value));
}
break;
case ADD:
arg =
new StringArgument(
OPTION_DSCFG_LONG_ADD,
OPTION_DSCFG_SHORT_ADD,
OPTION_DSCFG_LONG_ADD,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_ADD_PROP_VAL.get());
for (T value : mod.getModificationValues()) {
arg.addValue(propName + ':' + getArgumentValue(propertyDefinition, value));
}
break;
case SET:
arg =
new StringArgument(
OPTION_DSCFG_LONG_SET,
OPTION_DSCFG_SHORT_SET,
OPTION_DSCFG_LONG_SET,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_PROP_VAL.get());
for (T value : mod.getModificationValues()) {
arg.addValue(propName + ':' + getArgumentValue(propertyDefinition, value));
}
break;
default:
// Bug
throw new IllegalStateException("Unknown modification type: " + mod.getType());
}
return arg;
}
/** Check that any referenced components are enabled if required. */
private static MenuResult<Void> checkReferences(
ConsoleApplication app,
ManagementContext context,
ManagedObject<?> mo,
SubCommandHandler handler)
throws ClientException, CLIException {
ManagedObjectDefinition<?, ?> d = mo.getManagedObjectDefinition();
Message ufn = d.getUserFriendlyName();
try {
for (PropertyDefinition<?> pd : d.getAllPropertyDefinitions()) {
if (pd instanceof AggregationPropertyDefinition<?, ?>) {
AggregationPropertyDefinition<?, ?> apd = (AggregationPropertyDefinition<?, ?>) pd;
// Skip this aggregation if the referenced managed objects
// do not need to be enabled.
if (!apd.getTargetNeedsEnablingCondition().evaluate(context, mo)) {
continue;
}
// The referenced component(s) must be enabled.
for (String name : mo.getPropertyValues(apd)) {
ManagedObjectPath<?, ?> path = apd.getChildPath(name);
Message rufn = path.getManagedObjectDefinition().getUserFriendlyName();
ManagedObject<?> ref;
try {
ref = context.getManagedObject(path);
} catch (DefinitionDecodingException e) {
Message msg = ERR_DSCFG_ERROR_GET_CHILD_DDE.get(rufn, rufn, rufn);
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(rufn);
throw new ClientException(LDAPResultCode.OTHER, msg, e);
} catch (ManagedObjectNotFoundException e) {
Message msg = ERR_DSCFG_ERROR_GET_CHILD_MONFE.get(rufn);
throw new ClientException(LDAPResultCode.NO_SUCH_OBJECT, msg);
}
Condition condition = apd.getTargetIsEnabledCondition();
while (!condition.evaluate(context, ref)) {
boolean isBadReference = true;
if (condition instanceof ContainsCondition) {
// Attempt to automatically enable the managed object.
ContainsCondition cvc = (ContainsCondition) condition;
app.println();
if (app.confirmAction(
INFO_EDITOR_PROMPT_ENABLED_REFERENCED_COMPONENT.get(rufn, name, ufn), true)) {
cvc.setPropertyValue(ref);
try {
ref.commit();
// Try to create the command builder
if ((app instanceof DSConfig) && app.isInteractive()) {
DSConfig dsConfig = (DSConfig) app;
String subCommandName =
"set-" + path.getRelationDefinition().getName() + "-prop";
CommandBuilder builder = dsConfig.getCommandBuilder(subCommandName);
if (path.getRelationDefinition()
instanceof InstantiableRelationDefinition<?, ?>) {
String argName =
CLIProfile.getInstance()
.getNamingArgument(path.getRelationDefinition());
try {
StringArgument arg =
new StringArgument(
argName,
null,
argName,
false,
true,
INFO_NAME_PLACEHOLDER.get(),
INFO_DSCFG_DESCRIPTION_NAME.get(d.getUserFriendlyName()));
arg.addValue(name);
builder.addArgument(arg);
} catch (Throwable t) {
// Bug
throw new RuntimeException("Unexpected error: " + t, t);
}
}
try {
StringArgument arg =
new StringArgument(
OPTION_DSCFG_LONG_SET,
OPTION_DSCFG_SHORT_SET,
OPTION_DSCFG_LONG_SET,
false,
true,
true,
INFO_VALUE_SET_PLACEHOLDER.get(),
null,
null,
INFO_DSCFG_DESCRIPTION_PROP_VAL.get());
PropertyDefinition<?> propertyDefinition = cvc.getPropertyDefinition();
arg.addValue(
propertyDefinition.getName()
+ ':'
+ castAndGetArgumentValue(propertyDefinition, cvc.getValue()));
builder.addArgument(arg);
} catch (Throwable t) {
// Bug
throw new RuntimeException("Unexpected error: " + t, t);
}
dsConfig.printCommandBuilder(builder);
}
isBadReference = false;
} catch (MissingMandatoryPropertiesException e) {
// Give the user the chance to fix the problems.
app.println();
displayMissingMandatoryPropertyException(app, e);
app.println();
if (app.confirmAction(INFO_DSCFG_PROMPT_EDIT.get(rufn), true)) {
MenuResult<Void> result = modifyManagedObject(app, context, ref, handler);
if (result.isQuit()) {
return result;
} else if (result.isSuccess()) {
// The referenced component was modified
// successfully, but may still be disabled.
isBadReference = false;
}
}
} catch (ConcurrentModificationException e) {
Message msg = ERR_DSCFG_ERROR_MODIFY_CME.get(ufn);
throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg);
} catch (OperationRejectedException e) {
// Give the user the chance to fix the problems.
app.println();
displayOperationRejectedException(app, e);
app.println();
if (app.confirmAction(INFO_DSCFG_PROMPT_EDIT.get(rufn), true)) {
MenuResult<Void> result = modifyManagedObject(app, context, ref, handler);
if (result.isQuit()) {
return result;
} else if (result.isSuccess()) {
// The referenced component was modified
// successfully, but may still be disabled.
isBadReference = false;
}
}
} catch (ManagedObjectAlreadyExistsException e) {
// Should never happen.
throw new IllegalStateException(e);
}
}
} else {
app.println();
if (app.confirmAction(
INFO_DSCFG_PROMPT_EDIT_TO_ENABLE.get(rufn, name, ufn), true)) {
MenuResult<Void> result =
SetPropSubCommandHandler.modifyManagedObject(app, context, ref, handler);
if (result.isQuit()) {
return result;
} else if (result.isSuccess()) {
// The referenced component was modified
// successfully, but may still be disabled.
isBadReference = false;
}
}
}
// If the referenced component is still disabled because
// the user refused to modify it, then give the used the
// option of editing the referencing component.
if (isBadReference) {
app.println();
app.println(ERR_SET_REFERENCED_COMPONENT_DISABLED.get(ufn, rufn));
app.println();
if (app.confirmAction(INFO_DSCFG_PROMPT_EDIT_AGAIN.get(ufn), true)) {
return MenuResult.again();
} else {
return MenuResult.cancel();
}
}
}
}
}
}
} catch (AuthorizationException e) {
Message msg = ERR_DSCFG_ERROR_MODIFY_AUTHZ.get(ufn);
throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS, msg);
} catch (CommunicationException e) {
Message msg = ERR_DSCFG_ERROR_MODIFY_CE.get(ufn, e.getMessage());
throw new ClientException(LDAPResultCode.OTHER, msg);
}
return MenuResult.success();
}