/*
|
* 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 2006-2007 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.admin.client.cli;
|
|
import static org.opends.server.messages.AdminMessages.*;
|
import static org.opends.server.messages.MessageHandler.getMessage;
|
import static org.opends.server.messages.ToolMessages.*;
|
import static org.opends.server.tools.ToolConstants.*;
|
|
import java.io.OutputStream;
|
import java.io.PrintStream;
|
import java.util.ArrayList;
|
import java.util.HashMap;
|
import java.util.HashSet;
|
import java.util.LinkedList;
|
import java.util.List;
|
import java.util.Map;
|
import java.util.Set;
|
|
import javax.naming.NamingException;
|
import javax.naming.ldap.InitialLdapContext;
|
|
import org.opends.admin.ads.ADSContext;
|
import org.opends.admin.ads.ADSContextException;
|
import org.opends.admin.ads.ADSContext.ServerProperty;
|
import org.opends.server.admin.PropertyOption;
|
import org.opends.server.admin.client.cli.DsFrameworkCliReturnCode.ReturnCode;
|
import org.opends.server.tools.dsconfig.ArgumentExceptionFactory;
|
import org.opends.server.tools.dsconfig.Messages;
|
import org.opends.server.util.args.Argument;
|
import org.opends.server.util.args.ArgumentException;
|
import org.opends.server.util.args.BooleanArgument;
|
import org.opends.server.util.args.IntegerArgument;
|
import org.opends.server.util.args.StringArgument;
|
import org.opends.server.util.args.SubCommand;
|
import org.opends.server.util.table.TableBuilder;
|
import org.opends.server.util.table.TextTablePrinter;
|
|
/**
|
* This class is handling server group CLI.
|
*/
|
public class DsFrameworkCliServer implements DsFrameworkCliSubCommandGroup
|
{
|
// Strings used in property help.
|
private static final String KEY_PREFIX = "help-properties.";
|
|
private final static String DESCRIPTION_OPTIONS_TITLE = Messages
|
.getString(KEY_PREFIX + "description.options"); //$NON-NLS-1$
|
|
private final static String DESCRIPTION_OPTIONS_READ = Messages
|
.getString(KEY_PREFIX + "description.read"); //$NON-NLS-1$
|
|
private final static String DESCRIPTION_OPTIONS_WRITE = Messages
|
.getString(KEY_PREFIX + "description.write"); //$NON-NLS-1$
|
|
private final static String DESCRIPTION_OPTIONS_MANDATORY = Messages
|
.getString(KEY_PREFIX + "description.mandatory"); //$NON-NLS-1$
|
|
private final static String DESCRIPTION_OPTIONS_SINGLE = Messages
|
.getString(KEY_PREFIX + "description.single-valued"); //$NON-NLS-1$
|
|
/**
|
* The subcommand Parser.
|
*/
|
private DsFrameworkCliParser argParser;
|
|
/**
|
* The verbose argument.
|
*/
|
private BooleanArgument verboseArg;
|
|
/**
|
* The enumeration containing the different subCommand names.
|
*/
|
private enum SubCommandNameEnum
|
{
|
/**
|
* The register-server subcommand.
|
*/
|
REGISTER_SERVER("register-server"),
|
|
/**
|
* The unregister-server subcommand.
|
*/
|
UNREGISTER_SERVER("unregister-server"),
|
|
/**
|
* The list-servers subcommand.
|
*/
|
LIST_SERVERS("list-servers"),
|
|
/**
|
* The get-server-properties subcommand.
|
*/
|
GET_SERVER_PROPERTIES("get-server-properties"),
|
|
/**
|
* The set-server-propertiess subcommand.
|
*/
|
SET_SERVER_PROPERTIES("set-server-properties"),
|
|
/**
|
* The list-servers subcommand.
|
*/
|
LIST_SERVER_PROPERTIES("list-server-properties");
|
|
// String representation of the value.
|
private final String name;
|
|
// Private constructor.
|
private SubCommandNameEnum(String name)
|
{
|
this.name = name;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public String toString()
|
{
|
return name;
|
}
|
|
// A lookup table for resolving a unit from its name.
|
private static final List<String> nameToSubCmdName;
|
static
|
{
|
nameToSubCmdName = new ArrayList<String>();
|
|
for (SubCommandNameEnum subCmd : SubCommandNameEnum.values())
|
{
|
nameToSubCmdName.add(subCmd.toString());
|
}
|
}
|
|
public static boolean isSubCommand(String name)
|
{
|
return nameToSubCmdName.contains(name);
|
}
|
}
|
|
/**
|
* The 'register-server' subcommand.
|
*/
|
private SubCommand registerServerSubCmd;
|
|
/**
|
* The 'serverID' argument of the 'register-server' subcommand.
|
*/
|
private StringArgument registerServerServerIdArg;
|
|
/**
|
* The 'serverName' argument of the 'register-server' subcommand.
|
*/
|
private StringArgument registerServerSetArg;
|
|
/**
|
* The 'unregister-server' subcommand.
|
*/
|
private SubCommand unregisterServerSubCmd;
|
|
/**
|
* The 'serverHost' argument of the 'unregister-server' subcommand.
|
*/
|
private StringArgument unregisterServerServerIDArg;
|
|
/**
|
* The 'list-server-properties' subcommand.
|
*/
|
private SubCommand listServerPropertiesSubCmd;
|
|
/**
|
* The 'list-servers' subcommand.
|
*/
|
private SubCommand listServersSubCmd;
|
|
/**
|
* The 'get-server-properties' subcommand.
|
*/
|
private SubCommand getServerPropertiesSubCmd;
|
|
/**
|
* The 'serverID' argument of the 'get-server-properties' subcommand.
|
*/
|
private StringArgument getServerPropertiesServerIdArg;
|
|
/**
|
* The 'set-server-properties' subcommand.
|
*/
|
private SubCommand setServerPropertiesSubCmd;
|
|
/**
|
* The 'serverID' argument of the 'set-server-properties' subcommand.
|
*/
|
private StringArgument setServerPropertiesServerIdArg;
|
|
/**
|
* The 'serverName' argument of the 'set-server-properties' subcommand.
|
*/
|
private StringArgument setServerPropertiesSetArg;
|
|
/**
|
* Association between ADSContext enum and properties.
|
*/
|
private HashMap<ServerProperty, Argument> serverProperties;
|
|
/**
|
* List of read-only server properties.
|
*/
|
private HashSet<ServerProperty> readonlyServerProperties;
|
|
/**
|
* The subcommand list.
|
*/
|
private HashSet<SubCommand> subCommands = new HashSet<SubCommand>();
|
|
/**
|
* Indicates whether this subCommand should be hidden in the usage
|
* information.
|
*/
|
private boolean isHidden;
|
|
/**
|
* The subcommand group name.
|
*/
|
private String groupName;
|
|
/**
|
* {@inheritDoc}
|
*/
|
public Set<SubCommand> getSubCommands()
|
{
|
return subCommands;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isHidden()
|
{
|
return isHidden;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public String getGroupName()
|
{
|
return groupName;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void initializeCliGroup(DsFrameworkCliParser argParser,
|
BooleanArgument verboseArg) throws ArgumentException
|
{
|
this.verboseArg = verboseArg;
|
isHidden = false;
|
groupName = "server";
|
this.argParser = argParser;
|
|
// list-server-properties subcommand
|
listServerPropertiesSubCmd = new SubCommand(argParser,
|
SubCommandNameEnum.LIST_SERVER_PROPERTIES.toString(),
|
MSGID_ADMIN_SUBCMD_LIST_SERVER_PROPS_DESCRIPTION);
|
subCommands.add(listServerPropertiesSubCmd);
|
|
// register-server subcommand
|
registerServerSubCmd = new SubCommand(argParser,
|
SubCommandNameEnum.REGISTER_SERVER.toString(),
|
MSGID_ADMIN_SUBCMD_REGISTER_SERVER_DESCRIPTION);
|
subCommands.add(registerServerSubCmd);
|
|
registerServerServerIdArg = new StringArgument("serverID", null,
|
OPTION_LONG_SERVERID, false, true, OPTION_VALUE_SERVERID,
|
MSGID_ADMIN_ARG_SERVERID_DESCRIPTION);
|
registerServerSubCmd.addArgument(registerServerServerIdArg);
|
|
registerServerSetArg = new StringArgument(OPTION_LONG_SET,
|
OPTION_SHORT_SET, OPTION_LONG_SET, false, true, true,
|
OPTION_VALUE_SET, null, null, MSGID_DSCFG_DESCRIPTION_PROP_VAL);
|
registerServerSubCmd.addArgument(registerServerSetArg);
|
|
// unregister-server subcommand
|
unregisterServerSubCmd = new SubCommand(argParser,
|
SubCommandNameEnum.UNREGISTER_SERVER.toString(),
|
MSGID_ADMIN_SUBCMD_UNREGISTER_SERVER_DESCRIPTION);
|
subCommands.add(unregisterServerSubCmd);
|
|
unregisterServerServerIDArg = new StringArgument("serverID", null,
|
OPTION_LONG_SERVERID, false, true, OPTION_VALUE_SERVERID,
|
MSGID_ADMIN_ARG_SERVERID_DESCRIPTION);
|
unregisterServerSubCmd.addArgument(unregisterServerServerIDArg);
|
|
// list-servers subcommand
|
listServersSubCmd = new SubCommand(argParser,
|
SubCommandNameEnum.LIST_SERVERS.toString(),
|
MSGID_ADMIN_SUBCMD_LIST_SERVERS_DESCRIPTION);
|
subCommands.add(listServersSubCmd);
|
|
// get-server-properties subcommand
|
getServerPropertiesSubCmd = new SubCommand(argParser,
|
SubCommandNameEnum.GET_SERVER_PROPERTIES.toString(),
|
MSGID_ADMIN_SUBCMD_GET_SERVER_PROPERTIES_DESCRIPTION);
|
subCommands.add(getServerPropertiesSubCmd);
|
|
getServerPropertiesServerIdArg = new StringArgument("serverID", null,
|
OPTION_LONG_SERVERID, false, true, OPTION_VALUE_SERVERID,
|
MSGID_ADMIN_ARG_SERVERID_DESCRIPTION);
|
getServerPropertiesServerIdArg.setMultiValued(true);
|
getServerPropertiesSubCmd.addArgument(getServerPropertiesServerIdArg);
|
|
|
// set-server-properties subcommand
|
setServerPropertiesSubCmd = new SubCommand(argParser,
|
SubCommandNameEnum.SET_SERVER_PROPERTIES.toString(),
|
MSGID_ADMIN_SUBCMD_SET_SERVER_PROPERTIES_DESCRIPTION);
|
subCommands.add(setServerPropertiesSubCmd);
|
|
setServerPropertiesServerIdArg = new StringArgument("serverID", null,
|
OPTION_LONG_SERVERID, true, true, OPTION_VALUE_SERVERID,
|
MSGID_ADMIN_ARG_SERVERID_DESCRIPTION);
|
setServerPropertiesSubCmd.addArgument(setServerPropertiesServerIdArg);
|
|
setServerPropertiesSetArg = new StringArgument(OPTION_LONG_SET,
|
OPTION_SHORT_SET, OPTION_LONG_SET, false, true, true,
|
OPTION_VALUE_SET, null, null, MSGID_DSCFG_DESCRIPTION_PROP_VAL);
|
setServerPropertiesSubCmd.addArgument(setServerPropertiesSetArg);
|
|
|
// Create association between ADSContext enum and server
|
// properties
|
// Server properties are mapped to Argument.
|
serverProperties = new HashMap<ServerProperty, Argument>();
|
readonlyServerProperties = new HashSet<ServerProperty>();
|
|
/**
|
* The ID used to identify the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.ID;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(prop.getAttributeName(), null,
|
prop.getAttributeName(), false, false, true, "", null, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The host name of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.HOST_NAME;
|
String attName = prop.getAttributeName();
|
readonlyServerProperties.add(prop);
|
StringArgument arg = new StringArgument(attName, null, attName, true,
|
false, true, "", "localhost", null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The LDAP port of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.LDAP_PORT;
|
String attName = prop.getAttributeName();
|
IntegerArgument arg = new IntegerArgument(attName, null, attName, true,
|
true, true, attName, 389, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The JMX port of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.JMX_PORT;
|
String attName = prop.getAttributeName();
|
IntegerArgument arg = new IntegerArgument(attName, null, attName,
|
false, true, attName, -1);
|
arg.setMultiValued(true);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The JMX secure port of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.JMXS_PORT;
|
String attName = prop.getAttributeName();
|
IntegerArgument arg = new IntegerArgument(attName, null, attName,
|
false, true, attName, -1);
|
arg.setMultiValued(true);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The LDAPS port of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.LDAPS_PORT;
|
String attName = prop.getAttributeName();
|
IntegerArgument arg = new IntegerArgument(attName, null, attName,
|
false, true, attName, -1);
|
arg.setMultiValued(true);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The certificate used by the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.CERTIFICATE;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(attName, null, attName, false,
|
false, true, attName, null, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The path where the server is installed.
|
*/
|
{
|
ServerProperty prop = ServerProperty.INSTANCE_PATH;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(attName, null, attName, false,
|
false, true, attName, null, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The description of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.DESCRIPTION;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(attName, null, attName, false,
|
false, true, attName, null, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The OS of the machine where the server is installed.
|
*/
|
{
|
ServerProperty prop = ServerProperty.HOST_OS;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(attName, null, attName, false,
|
false, true, attName, null, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* Whether LDAP is enabled or not.
|
*/
|
{
|
ServerProperty prop = ServerProperty.LDAP_ENABLED;
|
String attName = prop.getAttributeName();
|
BooleanArgument arg = new BooleanArgument(attName, null, attName, -1);
|
arg.setDefaultValue("false");
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* Whether LDAPS is enabled or not.
|
*/
|
{
|
ServerProperty prop = ServerProperty.LDAPS_ENABLED;
|
String attName = prop.getAttributeName();
|
BooleanArgument arg = new BooleanArgument(attName, null, attName, -1);
|
arg.setDefaultValue("false");
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* Whether StartTLS is enabled or not.
|
*/
|
{
|
ServerProperty prop = ServerProperty.STARTTLS_ENABLED;
|
String attName = prop.getAttributeName();
|
BooleanArgument arg = new BooleanArgument(attName, null, attName, -1);
|
arg.setDefaultValue("false");
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* Whether JMX is enabled or not.
|
*/
|
{
|
ServerProperty prop = ServerProperty.JMX_ENABLED;
|
String attName = prop.getAttributeName();
|
BooleanArgument arg = new BooleanArgument(attName, null, attName, -1);
|
arg.setDefaultValue("false");
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* Whether JMXS is enabled or not.
|
*/
|
{
|
ServerProperty prop = ServerProperty.JMXS_ENABLED;
|
String attName = prop.getAttributeName();
|
BooleanArgument arg = new BooleanArgument(attName, null, attName, -1);
|
arg.setDefaultValue("false");
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The location of the server.
|
*/
|
{
|
ServerProperty prop = ServerProperty.LOCATION;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(attName, null, attName, false,
|
false, true, attName, null, null, -1);
|
serverProperties.put(prop, arg);
|
}
|
|
/**
|
* The list of groups in which the server is registered.
|
*/
|
{
|
ServerProperty prop = ServerProperty.GROUPS;
|
String attName = prop.getAttributeName();
|
StringArgument arg = new StringArgument(attName, null, attName, false,
|
true, true, attName, null, null, -1);
|
arg.setHidden(true);
|
serverProperties.put(prop, arg);
|
}
|
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isSubCommand(SubCommand subCmd)
|
{
|
return SubCommandNameEnum.isSubCommand(subCmd.getName());
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public ReturnCode performSubCommand(SubCommand subCmd,
|
OutputStream outStream, OutputStream errStream)
|
throws ADSContextException, ArgumentException
|
{
|
|
ADSContext adsCtx = null;
|
InitialLdapContext ctx = null;
|
ReturnCode returnCode = ReturnCode.ERROR_UNEXPECTED;
|
|
try
|
{
|
// -----------------------
|
// register-server subcommand
|
// -----------------------
|
if (subCmd.getName().equals(registerServerSubCmd.getName()))
|
{
|
Map<ServerProperty, Object> map =
|
mapSetOptionsToMap(registerServerSetArg);
|
if (registerServerServerIdArg.isPresent())
|
{
|
map.put(ServerProperty.ID, registerServerServerIdArg.getValue());
|
}
|
else
|
{
|
map.put(ServerProperty.ID, ADSContext
|
.getServerIdFromServerProperties(map));
|
}
|
|
ctx = argParser.getContext(outStream, errStream);
|
if (ctx == null)
|
{
|
return ReturnCode.CANNOT_CONNECT_TO_ADS;
|
}
|
adsCtx = new ADSContext(ctx);
|
adsCtx.registerServer(map);
|
returnCode = ReturnCode.SUCCESSFUL;
|
}
|
else
|
// -----------------------
|
// unregister-server subcommand
|
// -----------------------
|
if (subCmd.getName().equals(unregisterServerSubCmd.getName()))
|
{
|
Map<ServerProperty, Object> map = new HashMap<ServerProperty, Object>();
|
if (unregisterServerServerIDArg.isPresent())
|
{
|
map.put(ServerProperty.ID, unregisterServerServerIDArg.getValue());
|
}
|
else
|
{
|
map.put(ServerProperty.ID, ADSContext
|
.getServerIdFromServerProperties(map));
|
}
|
|
ctx = argParser.getContext(outStream, errStream);
|
if (ctx == null)
|
{
|
return ReturnCode.CANNOT_CONNECT_TO_ADS;
|
}
|
adsCtx = new ADSContext(ctx);
|
adsCtx.unregisterServer(map);
|
returnCode = ReturnCode.SUCCESSFUL;
|
}
|
else
|
// -----------------------
|
// list-servers subcommand
|
// -----------------------
|
if (subCmd.getName().equals(listServersSubCmd.getName()))
|
{
|
ctx = argParser.getContext(outStream, errStream);
|
if (ctx == null)
|
{
|
return ReturnCode.CANNOT_CONNECT_TO_ADS;
|
}
|
adsCtx = new ADSContext(ctx);
|
Set<Map<ServerProperty, Object>> serverList = adsCtx
|
.readServerRegistry();
|
|
PrintStream out = new PrintStream(outStream);
|
for (Map<ServerProperty, Object> server : serverList)
|
{
|
// print out server ID
|
out.println(ServerProperty.ID.getAttributeName() + ": "
|
+ server.get(ServerProperty.ID));
|
}
|
returnCode = ReturnCode.SUCCESSFUL;
|
}
|
else
|
// -----------------------
|
// get-server-properties subcommand
|
// -----------------------
|
if (subCmd.getName().equals(getServerPropertiesSubCmd.getName()))
|
{
|
ctx = argParser.getContext(outStream, errStream);
|
if (ctx == null)
|
{
|
return ReturnCode.CANNOT_CONNECT_TO_ADS;
|
}
|
adsCtx = new ADSContext(ctx);
|
Set<Map<ServerProperty, Object>> adsServerList = adsCtx
|
.readServerRegistry();
|
|
LinkedList<String> userServerList = getServerPropertiesServerIdArg
|
.getValues();
|
PrintStream out = new PrintStream(outStream);
|
for (Map<ServerProperty, Object> server : adsServerList)
|
{
|
String serverID = (String) server.get(ServerProperty.ID);
|
if (!userServerList.contains(serverID))
|
{
|
continue;
|
}
|
// print out server ID
|
out.println(ServerProperty.ID.getAttributeName() + ": "
|
+ server.get(ServerProperty.ID));
|
for (ServerProperty sp : server.keySet())
|
{
|
if (sp.equals(ServerProperty.ID))
|
{
|
continue;
|
}
|
out.println(sp.getAttributeName() + ": " + server.get(sp));
|
}
|
out.println();
|
}
|
returnCode = ReturnCode.SUCCESSFUL;
|
}
|
else
|
// -----------------------
|
// set-server-properties subcommand
|
// -----------------------
|
if (subCmd.getName().equals(setServerPropertiesSubCmd.getName()))
|
{
|
Map<ServerProperty, Object> map =
|
mapSetOptionsToMap(setServerPropertiesSetArg);
|
|
// if the ID is specify in the --set list, it may mean that
|
// the user wants to rename the serverID
|
String newServerId = (String) map.get(ServerProperty.ID) ;
|
|
// replace the serverID in the map
|
map.put(ServerProperty.ID, setServerPropertiesServerIdArg.getValue());
|
|
ctx = argParser.getContext(outStream, errStream);
|
if (ctx == null)
|
{
|
return ReturnCode.CANNOT_CONNECT_TO_ADS;
|
}
|
adsCtx = new ADSContext(ctx);
|
adsCtx.updateServer(map, newServerId);
|
returnCode = ReturnCode.SUCCESSFUL;
|
}
|
else
|
// -----------------------
|
// list-server-properties subcommand
|
// -----------------------
|
if (subCmd.getName().equals(listServerPropertiesSubCmd.getName()))
|
{
|
PrintStream out = new PrintStream(outStream);
|
out.println(DESCRIPTION_OPTIONS_TITLE);
|
out.println();
|
out.print(" r -- ");
|
out.println(DESCRIPTION_OPTIONS_READ);
|
out.print(" w -- ");
|
out.println(DESCRIPTION_OPTIONS_WRITE);
|
out.print(" m -- ");
|
out.println(DESCRIPTION_OPTIONS_MANDATORY);
|
out.print(" s -- ");
|
out.println(DESCRIPTION_OPTIONS_SINGLE);
|
out.println();
|
|
TableBuilder table = new TableBuilder();
|
table.appendHeading(getMessage(MSGID_DSCFG_HEADING_PROPERTY_NAME));
|
table.appendHeading(getMessage(MSGID_DSCFG_HEADING_PROPERTY_OPTIONS));
|
table.appendHeading(getMessage(MSGID_DSCFG_HEADING_PROPERTY_SYNTAX));
|
table.appendHeading(getMessage(
|
MSGID_CLI_HEADING_PROPERTY_DEFAULT_VALUE));
|
for (ServerProperty serverProp : serverProperties.keySet())
|
{
|
if (serverProperties.get(serverProp).isHidden())
|
{
|
continue;
|
}
|
table.startRow();
|
table.appendCell(serverProp.getAttributeName());
|
table.appendCell(getPropertyOptionSummary(serverProperties
|
.get(serverProp)));
|
table.appendCell(serverProp.getAttributeSyntax());
|
if (serverProperties.get(serverProp).getDefaultValue() != null)
|
{
|
table.appendCell(serverProperties.get(serverProp)
|
.getDefaultValue());
|
}
|
else
|
{
|
table.appendCell("-");
|
}
|
}
|
TextTablePrinter printer = new TextTablePrinter(outStream);
|
table.print(printer);
|
returnCode = ReturnCode.SUCCESSFUL;
|
}
|
else
|
{
|
// Should never occurs: If we are here, it means that the code
|
// to
|
// handle to subcommand is not yet written.
|
returnCode = ReturnCode.ERROR_UNEXPECTED;
|
}
|
}
|
catch (ADSContextException e)
|
{
|
if (ctx != null)
|
{
|
try
|
{
|
ctx.close();
|
}
|
catch (NamingException x)
|
{
|
}
|
}
|
throw e;
|
}
|
|
// Close the connection, if needed
|
if (ctx != null)
|
{
|
try
|
{
|
ctx.close();
|
}
|
catch (NamingException x)
|
{
|
}
|
}
|
|
// return part
|
return returnCode;
|
}
|
|
// Compute the options field.
|
private String getPropertyOptionSummary(Argument arg)
|
{
|
StringBuilder b = new StringBuilder();
|
|
if (readonlyServerProperties.contains(
|
ADSContext.getPropFromName(arg.getName())))
|
{
|
b.append("r-"); //$NON-NLS-1$
|
}
|
else
|
{
|
b.append("rw"); //$NON-NLS-1$
|
}
|
|
if (arg.isRequired())
|
{
|
b.append('m');
|
}
|
else
|
{
|
b.append('-');
|
}
|
|
if (arg.isMultiValued())
|
{
|
b.append('-');
|
}
|
else
|
{
|
b.append('s');
|
}
|
return b.toString();
|
}
|
|
/**
|
* Translate a Set properties a to a MAP.
|
*
|
* @param propertySetArgument
|
* The input set argument.
|
* @return The created map.
|
* @throws ArgumentException
|
* If error error occurs during set parsing.
|
*/
|
private Map<ServerProperty, Object> mapSetOptionsToMap(
|
StringArgument propertySetArgument) throws ArgumentException
|
{
|
HashMap<ServerProperty, Object> map = new HashMap<ServerProperty, Object>();
|
for (String m : propertySetArgument.getValues())
|
{
|
// Parse the property "property:value".
|
int sep = m.indexOf(':');
|
|
if (sep < 0)
|
{
|
throw ArgumentExceptionFactory.missingSeparatorInPropertyArgument(m);
|
}
|
|
if (sep == 0)
|
{
|
throw ArgumentExceptionFactory.missingNameInPropertyArgument(m);
|
}
|
|
String propertyName = m.substring(0, sep);
|
String value = m.substring(sep + 1, m.length());
|
if (value.length() == 0)
|
{
|
throw ArgumentExceptionFactory.missingValueInPropertyArgument(m);
|
}
|
|
// Check that propName is a known prop.
|
ServerProperty serverProperty = ADSContext
|
.getPropFromName(propertyName);
|
if (serverProperty == null)
|
{
|
int msgID = MSGID_CLI_ERROR_PROPERTY_UNRECOGNIZED;
|
String message = getMessage(msgID, propertyName);
|
throw new ArgumentException(msgID, message);
|
}
|
|
// Check that propName is not hidden.
|
if (serverProperties.get(serverProperty).isHidden())
|
{
|
int msgID = MSGID_CLI_ERROR_PROPERTY_UNRECOGNIZED;
|
String message = getMessage(msgID, propertyName);
|
throw new ArgumentException(msgID, message);
|
}
|
|
// Check the property Syntax.
|
StringBuilder invalidReason = new StringBuilder();
|
Argument arg = serverProperties.get(serverProperty) ;
|
if ( ! arg.valueIsAcceptable(value, invalidReason))
|
{
|
int msgID = MSGID_CLI_ERROR_INVALID_PROPERTY_VALUE;
|
String message = getMessage(msgID, propertyName, value);
|
throw new ArgumentException(msgID, message);
|
}
|
serverProperties.get(serverProperty).addValue(value);
|
|
// add to the map.
|
map.put(serverProperty, value);
|
}
|
|
// Check that all mandatory props are set.
|
HashSet<PropertyOption> propList;
|
for (ServerProperty s : ServerProperty.values())
|
{
|
Argument arg = serverProperties.get(s);
|
if (arg.isHidden())
|
{
|
continue;
|
}
|
if (map.containsKey(s))
|
{
|
continue ;
|
}
|
if ( ! arg.isRequired())
|
{
|
continue ;
|
}
|
|
// If we are here, it means that the argument is required
|
// but not yet is the map. Cjeck if we have a default value.
|
if (arg.getDefaultValue() == null)
|
{
|
int msgID = MSGID_CLI_ERROR_MISSING_PROPERTY;
|
String message = getMessage(msgID, s.getAttributeName());
|
throw new ArgumentException(msgID, message);
|
}
|
else
|
{
|
map.put(s, arg.getDefaultValue());
|
}
|
}
|
return map;
|
}
|
}
|
