/*
|
* 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 legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* 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 legal-notices/CDDLv1_0.txt.
|
* 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
|
*
|
* Copyright 2008-2009 Sun Microsystems, Inc.
|
* Portions copyright 2012 ForgeRock AS.
|
*/
|
package org.opends.server.tools.dsconfig;
|
|
|
|
import static org.opends.messages.DSConfigMessages.*;
|
|
import java.io.PrintStream;
|
import java.util.List;
|
import java.util.Set;
|
import java.util.SortedMap;
|
import java.util.SortedSet;
|
import java.util.TreeMap;
|
|
import org.opends.messages.Message;
|
import org.opends.server.admin.DefinitionDecodingException;
|
import org.opends.server.admin.InstantiableRelationDefinition;
|
import org.opends.server.admin.ManagedObjectDefinition;
|
import org.opends.server.admin.ManagedObjectNotFoundException;
|
import org.opends.server.admin.ManagedObjectOption;
|
import org.opends.server.admin.ManagedObjectPath;
|
import org.opends.server.admin.OptionalRelationDefinition;
|
import org.opends.server.admin.PropertyDefinition;
|
import org.opends.server.admin.RelationDefinition;
|
import org.opends.server.admin.SetRelationDefinition;
|
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.ManagementContext;
|
import org.opends.server.protocols.ldap.LDAPResultCode;
|
import org.opends.server.tools.ClientException;
|
import org.opends.server.tools.ToolConstants;
|
import org.opends.server.util.args.ArgumentException;
|
import org.opends.server.util.args.StringArgument;
|
import org.opends.server.util.args.SubCommand;
|
import org.opends.server.util.args.SubCommandArgumentParser;
|
import org.opends.server.util.cli.CLIException;
|
import org.opends.server.util.cli.ConsoleApplication;
|
import org.opends.server.util.cli.MenuResult;
|
import org.opends.server.util.table.TableBuilder;
|
import org.opends.server.util.table.TablePrinter;
|
import org.opends.server.util.table.TextTablePrinter;
|
|
|
|
/**
|
* A sub-command handler which is used to list existing managed
|
* objects.
|
* <p>
|
* This sub-command implements the various list-xxx sub-commands.
|
*/
|
final class ListSubCommandHandler extends SubCommandHandler {
|
|
/**
|
* Creates a new list-xxx sub-command for an instantiable relation.
|
*
|
* @param parser
|
* The sub-command argument parser.
|
* @param p
|
* The parent managed object path.
|
* @param r
|
* The instantiable relation.
|
* @return Returns the new list-xxx sub-command.
|
* @throws ArgumentException
|
* If the sub-command could not be created successfully.
|
*/
|
public static ListSubCommandHandler create(
|
SubCommandArgumentParser parser, ManagedObjectPath<?, ?> p,
|
InstantiableRelationDefinition<?, ?> r) throws ArgumentException {
|
return new ListSubCommandHandler(parser, p, r, r.getPluralName(), r
|
.getUserFriendlyPluralName());
|
}
|
|
|
|
/**
|
* Creates a new list-xxx sub-command for a set relation.
|
*
|
* @param parser
|
* The sub-command argument parser.
|
* @param p
|
* The parent managed object path.
|
* @param r
|
* The set relation.
|
* @return Returns the new list-xxx sub-command.
|
* @throws ArgumentException
|
* If the sub-command could not be created successfully.
|
*/
|
public static ListSubCommandHandler create(
|
SubCommandArgumentParser parser, ManagedObjectPath<?, ?> p,
|
SetRelationDefinition<?, ?> r) throws ArgumentException {
|
return new ListSubCommandHandler(parser, p, r, r.getPluralName(), r
|
.getUserFriendlyPluralName());
|
}
|
|
|
|
/**
|
* Creates a new list-xxx sub-command for an optional relation.
|
*
|
* @param parser
|
* The sub-command argument parser.
|
* @param p
|
* The parent managed object path.
|
* @param r
|
* The optional relation.
|
* @return Returns the new list-xxx sub-command.
|
* @throws ArgumentException
|
* If the sub-command could not be created successfully.
|
*/
|
public static ListSubCommandHandler create(
|
SubCommandArgumentParser parser, ManagedObjectPath<?, ?> p,
|
OptionalRelationDefinition<?, ?> r) throws ArgumentException {
|
return new ListSubCommandHandler(parser, p, r, r.getName(), r
|
.getUserFriendlyName());
|
}
|
|
// The sub-commands naming arguments.
|
private final List<StringArgument> namingArgs;
|
|
// The path of the parent managed object.
|
private final ManagedObjectPath<?, ?> path;
|
|
// The relation which should be listed.
|
private final RelationDefinition<?, ?> relation;
|
|
// The sub-command associated with this handler.
|
private final SubCommand subCommand;
|
|
|
|
// Private constructor.
|
private ListSubCommandHandler(
|
SubCommandArgumentParser parser, ManagedObjectPath<?, ?> p,
|
RelationDefinition<?, ?> r, String rname, Message rufn)
|
throws ArgumentException {
|
this.path = p;
|
this.relation = r;
|
|
// Create the sub-command.
|
String name = "list-" + rname;
|
Message desc = INFO_DSCFG_DESCRIPTION_SUBCMD_LIST.get(rufn);
|
this.subCommand = new SubCommand(parser, name, false, 0, 0, null, desc);
|
|
// Create the naming arguments.
|
this.namingArgs = createNamingArgs(subCommand, path, false);
|
|
// Register arguments.
|
registerPropertyNameArgument(this.subCommand);
|
registerUnitSizeArgument(this.subCommand);
|
registerUnitTimeArgument(this.subCommand);
|
|
// Register the tags associated with the child managed objects.
|
addTags(relation.getChildDefinition().getAllTags());
|
}
|
|
|
|
/**
|
* Gets the relation definition associated with the type of
|
* component that this sub-command handles.
|
*
|
* @return Returns the relation definition associated with the type
|
* of component that this sub-command handles.
|
*/
|
public RelationDefinition<?, ?> getRelationDefinition() {
|
return relation;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public SubCommand getSubCommand() {
|
return subCommand;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public MenuResult<Integer> run(ConsoleApplication app,
|
ManagementContextFactory factory) throws ArgumentException,
|
ClientException, CLIException {
|
// Get the property names.
|
Set<String> propertyNames = getPropertyNames();
|
|
// Reset the command builder
|
getCommandBuilder().clearArguments();
|
|
// Update the command builder.
|
updateCommandBuilderWithSubCommand();
|
|
if (propertyNames.isEmpty()) {
|
// Use a default set of properties.
|
propertyNames = CLIProfile.getInstance().getDefaultListPropertyNames(
|
relation);
|
}
|
|
PropertyValuePrinter valuePrinter = new PropertyValuePrinter(getSizeUnit(),
|
getTimeUnit(), app.isScriptFriendly());
|
|
// Get the naming argument values.
|
List<String> names = getNamingArgValues(app, namingArgs);
|
|
Message ufn;
|
if (relation instanceof InstantiableRelationDefinition) {
|
InstantiableRelationDefinition<?, ?> irelation =
|
(InstantiableRelationDefinition<?, ?>) relation;
|
ufn = irelation.getUserFriendlyPluralName();
|
} else if (relation instanceof SetRelationDefinition) {
|
SetRelationDefinition<?, ?> srelation =
|
(SetRelationDefinition<?, ?>) relation;
|
ufn = srelation.getUserFriendlyPluralName();
|
} else {
|
ufn = relation.getUserFriendlyName();
|
}
|
|
// List the children.
|
ManagementContext context = factory.getManagementContext(app);
|
MenuResult<ManagedObject<?>> result;
|
try {
|
result = getManagedObject(app, context, path, names);
|
} catch (AuthorizationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_AUTHZ.get(ufn);
|
throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS,
|
msg);
|
} catch (DefinitionDecodingException e) {
|
ufn = path.getManagedObjectDefinition().getUserFriendlyName();
|
Message msg = ERR_DSCFG_ERROR_GET_PARENT_DDE.get(ufn, ufn, ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg);
|
} catch (ManagedObjectDecodingException e) {
|
ufn = path.getManagedObjectDefinition().getUserFriendlyName();
|
Message msg = ERR_DSCFG_ERROR_GET_PARENT_MODE.get(ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg, e);
|
} catch (CommunicationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CE.get(ufn, e.getMessage());
|
throw new ClientException(LDAPResultCode.CLIENT_SIDE_SERVER_DOWN, msg);
|
} catch (ConcurrentModificationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CME.get(ufn);
|
throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg);
|
} catch (ManagedObjectNotFoundException e) {
|
ufn = path.getManagedObjectDefinition().getUserFriendlyName();
|
Message msg = ERR_DSCFG_ERROR_GET_PARENT_MONFE.get(ufn);
|
if (app.isInteractive()) {
|
app.println();
|
app.printVerboseMessage(msg);
|
return MenuResult.cancel();
|
} else {
|
throw new ClientException(LDAPResultCode.NO_SUCH_OBJECT, msg);
|
}
|
}
|
|
if (result.isQuit()) {
|
return MenuResult.quit();
|
} else if (result.isCancel()) {
|
return MenuResult.cancel();
|
}
|
|
ManagedObject<?> parent = result.getValue();
|
SortedMap<String, ManagedObject<?>> children =
|
new TreeMap<String, ManagedObject<?>>();
|
if (relation instanceof InstantiableRelationDefinition) {
|
InstantiableRelationDefinition<?, ?> irelation =
|
(InstantiableRelationDefinition<?, ?>) relation;
|
try {
|
for (String s : parent.listChildren(irelation)) {
|
try {
|
children.put(s, parent.getChild(irelation, s));
|
} catch (ManagedObjectNotFoundException e) {
|
// Ignore - as it's been removed since we did the list.
|
}
|
}
|
} catch (DefinitionDecodingException e) {
|
// FIXME: just output this as a warnings (incl. the name) but
|
// continue.
|
Message msg = ERR_DSCFG_ERROR_LIST_DDE.get(ufn, ufn, ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg);
|
} catch (ManagedObjectDecodingException e) {
|
// FIXME: just output this as a warnings (incl. the name) but
|
// continue.
|
Message msg = ERR_DSCFG_ERROR_LIST_MODE.get(ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg, e);
|
} catch (AuthorizationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_AUTHZ.get(ufn);
|
throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS,
|
msg);
|
} catch (ConcurrentModificationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CME.get(ufn);
|
throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg);
|
} catch (CommunicationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CE.get(ufn, e.getMessage());
|
throw new ClientException(LDAPResultCode.CLIENT_SIDE_SERVER_DOWN,
|
msg);
|
}
|
} else if (relation instanceof SetRelationDefinition) {
|
SetRelationDefinition<?, ?> srelation =
|
(SetRelationDefinition<?, ?>) relation;
|
try {
|
for (String s : parent.listChildren(srelation)) {
|
try {
|
children.put(s, parent.getChild(srelation, s));
|
} catch (ManagedObjectNotFoundException e) {
|
// Ignore - as it's been removed since we did the list.
|
}
|
}
|
} catch (DefinitionDecodingException e) {
|
// FIXME: just output this as a warnings (incl. the name) but
|
// continue.
|
Message msg = ERR_DSCFG_ERROR_LIST_DDE.get(ufn, ufn, ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg);
|
} catch (ManagedObjectDecodingException e) {
|
// FIXME: just output this as a warnings (incl. the name) but
|
// continue.
|
Message msg = ERR_DSCFG_ERROR_LIST_MODE.get(ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg, e);
|
} catch (AuthorizationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_AUTHZ.get(ufn);
|
throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS,
|
msg);
|
} catch (ConcurrentModificationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CME.get(ufn);
|
throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg);
|
} catch (CommunicationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CE.get(ufn, e.getMessage());
|
throw new ClientException(LDAPResultCode.CLIENT_SIDE_SERVER_DOWN,
|
msg);
|
}
|
} else if (relation instanceof OptionalRelationDefinition) {
|
OptionalRelationDefinition<?, ?> orelation =
|
(OptionalRelationDefinition<?, ?>) relation;
|
try {
|
if (parent.hasChild(orelation)) {
|
ManagedObject<?> child = parent.getChild(orelation);
|
children.put(child.getManagedObjectDefinition().getName(), child);
|
} else {
|
// Indicate that the managed object does not exist.
|
Message msg = ERR_DSCFG_ERROR_FINDER_NO_CHILDREN.get(ufn);
|
if (app.isInteractive()) {
|
app.println();
|
app.printVerboseMessage(msg);
|
return MenuResult.cancel();
|
} else {
|
throw new ClientException(LDAPResultCode.NO_SUCH_OBJECT, msg);
|
}
|
}
|
} catch (AuthorizationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_AUTHZ.get(ufn);
|
throw new ClientException(LDAPResultCode.INSUFFICIENT_ACCESS_RIGHTS,
|
msg);
|
} catch (DefinitionDecodingException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_DDE.get(ufn, ufn, ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg);
|
} catch (ManagedObjectDecodingException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_MODE.get(ufn);
|
throw new ClientException(LDAPResultCode.OTHER, msg, e);
|
} catch (ConcurrentModificationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CME.get(ufn);
|
throw new ClientException(LDAPResultCode.CONSTRAINT_VIOLATION, msg);
|
} catch (CommunicationException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_CE.get(ufn, e.getMessage());
|
throw new ClientException(LDAPResultCode.CLIENT_SIDE_SERVER_DOWN,
|
msg);
|
} catch (ManagedObjectNotFoundException e) {
|
Message msg = ERR_DSCFG_ERROR_LIST_MONFE.get(ufn);
|
throw new ClientException(LDAPResultCode.NO_SUCH_OBJECT, msg);
|
}
|
}
|
|
// Output the results.
|
if (app.isScriptFriendly()) {
|
// Output just the names of the children.
|
for (String name : children.keySet()) {
|
// Skip advanced and hidden components in non-advanced mode.
|
if (!app.isAdvancedMode()) {
|
ManagedObject<?> child = children.get(name);
|
ManagedObjectDefinition<?, ?> d = child.getManagedObjectDefinition();
|
|
if (d.hasOption(ManagedObjectOption.HIDDEN)) {
|
continue;
|
}
|
|
if (d.hasOption(ManagedObjectOption.ADVANCED)) {
|
continue;
|
}
|
}
|
|
app.println(Message.raw(name));
|
}
|
} else {
|
// Create a table of their properties containing the name, type (if
|
// appropriate), and requested properties.
|
SortedMap<String, ?> subTypes =
|
getSubTypes(relation.getChildDefinition());
|
boolean includeTypesColumn = (subTypes.size() != 1
|
|| !subTypes.containsKey(DSConfig.GENERIC_TYPE));
|
|
TableBuilder builder = new TableBuilder();
|
builder.appendHeading(relation.getUserFriendlyName());
|
if (includeTypesColumn) {
|
builder.appendHeading(INFO_DSCFG_HEADING_COMPONENT_TYPE.get());
|
}
|
for (String propertyName : propertyNames) {
|
builder.appendHeading(Message.raw(propertyName));
|
}
|
builder.addSortKey(0);
|
|
String baseType = relation.getChildDefinition().getName();
|
String typeSuffix = "-" + baseType;
|
for (String name : children.keySet()) {
|
ManagedObject<?> child = children.get(name);
|
ManagedObjectDefinition<?, ?> d = child.getManagedObjectDefinition();
|
|
// Skip advanced and hidden components in non-advanced mode.
|
if (!app.isAdvancedMode()) {
|
if (d.hasOption(ManagedObjectOption.HIDDEN)) {
|
continue;
|
}
|
|
if (d.hasOption(ManagedObjectOption.ADVANCED)) {
|
continue;
|
}
|
}
|
|
// First output the name.
|
builder.startRow();
|
if (relation instanceof SetRelationDefinition) {
|
builder.appendCell(d.getUserFriendlyName());
|
} else {
|
builder.appendCell(name);
|
}
|
|
if (includeTypesColumn) {
|
// Output the managed object type in the form used in
|
// create-xxx commands.
|
String childType = d.getName();
|
boolean isCustom = CLIProfile.getInstance().isForCustomization(d);
|
if (baseType.equals(childType)) {
|
if (isCustom) {
|
builder.appendCell(DSConfig.CUSTOM_TYPE);
|
} else {
|
builder.appendCell(DSConfig.GENERIC_TYPE);
|
}
|
} else if (childType.endsWith(typeSuffix)) {
|
String ctname = childType.substring(0, childType.length()
|
- typeSuffix.length());
|
if (isCustom) {
|
ctname = String.format("%s-%s", DSConfig.CUSTOM_TYPE, ctname);
|
}
|
builder.appendCell(ctname);
|
} else {
|
builder.appendCell(childType);
|
}
|
}
|
|
// Now any requested properties.
|
for (String propertyName : propertyNames) {
|
try {
|
PropertyDefinition<?> pd = d.getPropertyDefinition(propertyName);
|
displayProperty(app, builder, child, pd, valuePrinter);
|
} catch (IllegalArgumentException e) {
|
// Assume this child managed object does not support this
|
// property.
|
if (app.isScriptFriendly()) {
|
builder.appendCell();
|
} else {
|
builder.appendCell("-");
|
}
|
}
|
}
|
}
|
|
PrintStream out = app.getOutputStream();
|
if (app.isScriptFriendly()) {
|
TablePrinter printer = createScriptFriendlyTablePrinter(out);
|
builder.print(printer);
|
} else {
|
if (app.isInteractive()) {
|
// Make interactive mode prettier.
|
app.println();
|
app.println();
|
}
|
|
TextTablePrinter printer = new TextTablePrinter(out);
|
printer.setColumnSeparator(ToolConstants.LIST_TABLE_SEPARATOR);
|
builder.print(printer);
|
}
|
}
|
|
return MenuResult.success(0);
|
}
|
|
|
|
// Display the set of values associated with a property.
|
private <T> void displayProperty(ConsoleApplication app,
|
TableBuilder builder, ManagedObject<?> mo, PropertyDefinition<T> pd,
|
PropertyValuePrinter valuePrinter) {
|
SortedSet<T> values = mo.getPropertyValues(pd);
|
if (values.isEmpty()) {
|
if (app.isScriptFriendly()) {
|
builder.appendCell();
|
} else {
|
builder.appendCell("-");
|
}
|
} else {
|
StringBuilder sb = new StringBuilder();
|
boolean isFirst = true;
|
for (T value : values) {
|
if (!isFirst) {
|
sb.append(", ");
|
}
|
sb.append(valuePrinter.print(pd, value));
|
isFirst = false;
|
}
|
|
builder.appendCell(sb.toString());
|
}
|
}
|
}
|
