diff options
Diffstat (limited to 'pki/base/silent/src/com/netscape/pkisilent')
15 files changed, 261 insertions, 97 deletions
diff --git a/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParser.java b/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParser.java index f0712e38..d6f02d9c 100755 --- a/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParser.java +++ b/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParser.java @@ -58,7 +58,9 @@ import java.util.Vector; * <h3><a name="example">Basic Example</a></h3> * * <p> - * Here is a simple example in which an application has three command line options: <code>-theta</code> (followed by a floating point value), <code>-file</code> (followed by a string value), and <code>-debug</code>, which causes a boolean value to be set. + * Here is a simple example in which an application has three command line options: <code>-theta</code> (followed by a + * floating point value), <code>-file</code> (followed by a string value), and <code>-debug</code>, which causes a + * boolean value to be set. * * <pre> * @@ -95,20 +97,37 @@ import java.util.Vector; * </pre> * * <p> - * The application creates an instance of ArgParser and then adds descriptions of the allowed options using {@link #addOption addOption}. The method {@link #matchAllArgs(String[]) matchAllArgs} is then used to match these options against the command line arguments. Values associated with each option are returned in the <code>value</code> field of special ``holder'' classes (e.g., {@link argparser.DoubleHolder DoubleHolder}, {@link argparser.StringHolder StringHolder}, etc.). + * The application creates an instance of ArgParser and then adds descriptions of the allowed options using + * {@link #addOption addOption}. The method {@link #matchAllArgs(String[]) matchAllArgs} is then used to match these + * options against the command line arguments. Values associated with each option are returned in the <code>value</code> + * field of special ``holder'' classes (e.g., {@link argparser.DoubleHolder DoubleHolder}, + * {@link argparser.StringHolder StringHolder}, etc.). * * <p> - * The first argument to {@link #addOption addOption} is a string that specifies (1) the option's name, (2) a conversion code for its associated value (e.g., <code>%f</code> for floating point, <code>%s</code> for a string, <code>%v</code> for a boolean flag), and (3) an optional description (following the <code>#</code> character) which is used for generating help messages. The second argument is the holder object through which the value is returned. This may be either a type-specific object - * (such as {@link argparser.DoubleHolder DoubleHolder} or {@link argparser.StringHolder - * StringHolder}), an array of the appropriate type, or <a href=#multipleOptionInvocation> an instance of <code>java.util.Vector</code></a>. + * The first argument to {@link #addOption addOption} is a string that specifies (1) the option's name, (2) a conversion + * code for its associated value (e.g., <code>%f</code> for floating point, <code>%s</code> for a string, + * <code>%v</code> for a boolean flag), and (3) an optional description (following the <code>#</code> character) which + * is used for generating help messages. The second argument is the holder object through which the value is returned. + * This may be either a type-specific object (such as {@link argparser.DoubleHolder DoubleHolder} or + * {@link argparser.StringHolder + * StringHolder}), an array of the appropriate type, or <a href=#multipleOptionInvocation> an instance of + * <code>java.util.Vector</code></a>. * * <p> - * By default, arguments that don't match the specified options, are <a href=#rangespec>out of range</a>, or are otherwise formatted incorrectly, will cause <code>matchAllArgs</code> to print a message and exit the program. Alternatively, an application can use {@link #matchAllArgs(String[],int,int) matchAllArgs(args,idx,exitFlags)} to obtain an array of unmatched arguments which can then be <a href=#customArgParsing>processed separately</a> + * By default, arguments that don't match the specified options, are <a href=#rangespec>out of range</a>, or are + * otherwise formatted incorrectly, will cause <code>matchAllArgs</code> to print a message and exit the program. + * Alternatively, an application can use {@link #matchAllArgs(String[],int,int) matchAllArgs(args,idx,exitFlags)} to + * obtain an array of unmatched arguments which can then be <a href=#customArgParsing>processed separately</a> * * <h3><a name="rangespec">Range Specification</a></h3> * - * The values associated with options can also be given range specifications. A range specification appears in curly braces immediately following the conversion code. In the code fragment below, we show how to specify an option <code>-name</code> that expects to be provided with one of three string values (<code>john</code>, <code>mary</code>, or <code>jane</code>), an option <code>-index</code> that expects to be supplied with a integer value in the range 1 to 256, an option <code>-size</code> - * that expects to be supplied with integer values of either 1, 2, 4, 8, or 16, and an option <code>-foo</code> that expects to be supplied with floating point values in the ranges -99 < foo <= -50, or 50 <= foo < 99. + * The values associated with options can also be given range specifications. A range specification appears in curly + * braces immediately following the conversion code. In the code fragment below, we show how to specify an option + * <code>-name</code> that expects to be provided with one of three string values (<code>john</code>, <code>mary</code>, + * or <code>jane</code>), an option <code>-index</code> that expects to be supplied with a integer value in the range 1 + * to 256, an option <code>-size</code> that expects to be supplied with integer values of either 1, 2, 4, 8, or 16, and + * an option <code>-foo</code> that expects to be supplied with floating point values in the ranges -99 < foo <= -50, or + * 50 <= foo < 99. * * <pre> * StringHolder name = new StringHolder(); @@ -135,7 +154,8 @@ import java.util.Vector; * * <h3><a name="singleWordOptions">Single Word Options</a></h3> * - * Normally, options are assumed to be "multi-word", meaning that any associated value must follow the option as a separate argument string. For example, + * Normally, options are assumed to be "multi-word", meaning that any associated value must follow the option as a + * separate argument string. For example, * * <pre> * parser.addOption("-file %s #file name"); @@ -147,7 +167,8 @@ import java.util.Vector; * -file someFileName * </pre> * - * However, if there is no white space separting the option's name from it's conversion code, then values associated with that option will be assumed to be part of the same argument string as the option itself. For example, + * However, if there is no white space separting the option's name from it's conversion code, then values associated + * with that option will be assumed to be part of the same argument string as the option itself. For example, * * <pre> * parser.addOption("-file=%s #file name"); @@ -162,7 +183,9 @@ import java.util.Vector; * Such an option is called a "single word" option. * * <p> - * In cases where an option has multiple names, then this single word behavior is invoked if there is no white space between the last indicated name and the conversion code. However, previous names in the list will still be given multi-word behavior if there is white space between the name and the following comma. For example, + * In cases where an option has multiple names, then this single word behavior is invoked if there is no white space + * between the last indicated name and the conversion code. However, previous names in the list will still be given + * multi-word behavior if there is white space between the name and the following comma. For example, * * <pre> * parser.addOption("-nb=,-number ,-n%d #number of blocks"); @@ -178,7 +201,10 @@ import java.util.Vector; * * <h3><a name="multipleOptionValues">Multiple Option Values</a></h3> * - * If may be useful for an option to be followed by several values. For instance, we might have an option <code>-velocity</code> which should be followed by three numbers denoting the x, y, and z components of a velocity vector. We can require multiple values for an option by placing a <i>multiplier</i> specification, of the form <code>X</code>N, where N is an integer, after the conversion code (or range specification, if present). For example, + * If may be useful for an option to be followed by several values. For instance, we might have an option + * <code>-velocity</code> which should be followed by three numbers denoting the x, y, and z components of a velocity + * vector. We can require multiple values for an option by placing a <i>multiplier</i> specification, of the form + * <code>X</code>N, where N is an integer, after the conversion code (or range specification, if present). For example, * * <pre> * double[] pos = new double[3]; @@ -192,15 +218,20 @@ import java.util.Vector; * -position xx yy zz * </pre> * - * in the argument list, where <code>xx</code>, <code>yy</code>, and <code>zz</code> are numbers. The values are stored in the array <code>pos</code>. + * in the argument list, where <code>xx</code>, <code>yy</code>, and <code>zz</code> are numbers. The values are stored + * in the array <code>pos</code>. * * Options requiring multiple values must use arrays to return their values, and cannot be used in single word format. * * <h3><a name="multipleOptionInvocation">Multiple Option Invocation</a></h3> * - * Normally, if an option appears twice in the command list, the value associated with the second instance simply overwrites the value associated with the first instance. + * Normally, if an option appears twice in the command list, the value associated with the second instance simply + * overwrites the value associated with the first instance. * - * However, the application can instead arrange for the storage of <i>all</i> values associated with multiple option invocation, by supplying a instance of <code>java.util.Vector</code> to serve as the value holder. Then every time the option appears in the argument list, the parser will create a value holder of appropriate type, set it to the current value, and store the holder in the vector. For example, the construction + * However, the application can instead arrange for the storage of <i>all</i> values associated with multiple option + * invocation, by supplying a instance of <code>java.util.Vector</code> to serve as the value holder. Then every time + * the option appears in the argument list, the parser will create a value holder of appropriate type, set it to the + * current value, and store the holder in the vector. For example, the construction * * <pre> * Vector vec = new Vector(10); @@ -215,12 +246,18 @@ import java.util.Vector; * -foo 1.2 -foo 1000 -foo -78 * </pre> * - * will create three instances of {@link argparser.DoubleHolder DoubleHolder}, initialized to <code>1.2</code>, <code>1000</code>, and <code>-78</code>, and store them in <code>vec</code>. + * will create three instances of {@link argparser.DoubleHolder DoubleHolder}, initialized to <code>1.2</code>, + * <code>1000</code>, and <code>-78</code>, and store them in <code>vec</code>. * * <h3><a name="helpInfo">Generating help information</a></h3> * - * ArgParser automatically generates help information for the options, and this information may be printed in response to a <i>help</i> option, or may be queried by the application using {@link #getHelpMessage getHelpMessage}. The information for each option consists of the option's name(s), it's required value(s), and an application-supplied description. Value information is generated automaticlly from the conversion code, range, and multiplier specifications (although this can be overriden, as - * <a href=#valueInfo>described below</a>). The application-supplied description is whatever appears in the specification string after the optional <code>#</code> character. The string returned by {@link #getHelpMessage getHelpMessage} for the <a href=#example>first example above</a> would be + * ArgParser automatically generates help information for the options, and this information may be printed in response + * to a <i>help</i> option, or may be queried by the application using {@link #getHelpMessage getHelpMessage}. The + * information for each option consists of the option's name(s), it's required value(s), and an application-supplied + * description. Value information is generated automaticlly from the conversion code, range, and multiplier + * specifications (although this can be overriden, as <a href=#valueInfo>described below</a>). The application-supplied + * description is whatever appears in the specification string after the optional <code>#</code> character. The string + * returned by {@link #getHelpMessage getHelpMessage} for the <a href=#example>first example above</a> would be * * <pre> * Usage: java argparser.SimpleExample @@ -232,12 +269,18 @@ import java.util.Vector; * -debug enables display of debugging info * </pre> * - * The options <code>-help</code> and <code>-?</code> are including in the parser by default as help options, and they automatically cause the help message to be printed. To exclude these options, one should use the constructor {@link #ArgParser(String,boolean) - * ArgParser(synopsis,false)}. Help options can also be specified by the application using {@link #addOption addOption} and the conversion code <code>%h</code>. Help options can be disabled using {@link #setHelpOptionsEnabled + * The options <code>-help</code> and <code>-?</code> are including in the parser by default as help options, and they + * automatically cause the help message to be printed. To exclude these options, one should use the constructor + * {@link #ArgParser(String,boolean) + * ArgParser(synopsis,false)}. Help options can also be specified by the application using {@link #addOption addOption} + * and the conversion code <code>%h</code>. Help options can be disabled using {@link #setHelpOptionsEnabled * setHelpOptionsEnabled(false)}. * * <p> - * <a name=valueInfo> A description of the required values for an option can be specified explicitly by placing a second <code>#</code> character in the specification string. Everything between the first and second <code>#</code> characters then becomes the value description, and everything after the second <code>#</code> character becomes the option description. For example, if the <code>-theta</code> option above was specified with + * <a name=valueInfo> A description of the required values for an option can be specified explicitly by placing a second + * <code>#</code> character in the specification string. Everything between the first and second <code>#</code> + * characters then becomes the value description, and everything after the second <code>#</code> character becomes the + * option description. For example, if the <code>-theta</code> option above was specified with * * <pre> * parser.addOption("-theta %f #NUMBER#theta value (in degrees)", theta); @@ -257,7 +300,8 @@ import java.util.Vector; * * <h3><a name="customArgParsing">Custom Argument Parsing</a></h3> * - * An application may find it necessary to handle arguments that don't fit into the framework of this class. There are a couple of ways to do this. + * An application may find it necessary to handle arguments that don't fit into the framework of this class. There are a + * couple of ways to do this. * * <p> * First, the method {@link #matchAllArgs(String[],int,int) @@ -271,7 +315,8 @@ import java.util.Vector; * } * </pre> * - * For instance, this would be useful for an applicatoon that accepts an arbitrary number of input file names. The options can be parsed using <code>matchAllArgs</code>, and the remaining unmatched arguments give the file names. + * For instance, this would be useful for an applicatoon that accepts an arbitrary number of input file names. The + * options can be parsed using <code>matchAllArgs</code>, and the remaining unmatched arguments give the file names. * * <p> * If we need more control over the parsing, we can parse arguments one at a time using {@link #matchArg matchArg}: @@ -293,11 +338,16 @@ import java.util.Vector; * } * </pre> * - * {@link #matchArg matchArg(args,idx)} matches one option at location <code>idx</code> in the argument list, and then returns the location value that should be used for the next match. If an argument does not match any option, {@link #getUnmatchedArgument getUnmatchedArgument} will return a copy of the unmatched argument. + * {@link #matchArg matchArg(args,idx)} matches one option at location <code>idx</code> in the argument list, and then + * returns the location value that should be used for the next match. If an argument does not match any option, + * {@link #getUnmatchedArgument getUnmatchedArgument} will return a copy of the unmatched argument. * * <h3><a name="argsFromAFile">Reading Arguments From a File</a></h3> * - * The method {@link #prependArgs prependArgs} can be used to automatically read in a set of arguments from a file and prepend them onto an existing argument list. Argument words correspond to white-space-delimited strings, and the file may contain the comment character <code>#</code> (which comments out everything to the end of the current line). A typical usage looks like this: + * The method {@link #prependArgs prependArgs} can be used to automatically read in a set of arguments from a file and + * prepend them onto an existing argument list. Argument words correspond to white-space-delimited strings, and the file + * may contain the comment character <code>#</code> (which comments out everything to the end of the current line). A + * typical usage looks like this: * * <pre> * ... create parser and add options ... @@ -915,7 +965,8 @@ public class ArgParser { * Enables or disables help options. Help options are those * associated with a conversion code of <code>%h</code>. If * help options are enabled, and a help option is matched, - * then the string produced by {@link #getHelpMessage getHelpMessage} is printed to the default print stream and the program + * then the string produced by {@link #getHelpMessage getHelpMessage} is printed to the default print stream and the + * program * exits with code 0. Otherwise, arguments which match help * options are ignored. * @@ -1075,7 +1126,9 @@ public class ArgParser { * The specification string has the general form * * <p> - * <var>optionNames</var> <code>%</code><var>conversionCode</var> [<code>{</code><var>rangeSpec</var><code>}</code>] [<code>X</code><var>multiplier</var>] [<code>#</code><var>valueDescription</var>] [<code>#</code><var>optionDescription</var>] </code> + * <var>optionNames</var> <code>%</code><var>conversionCode</var> [<code>{</code><var>rangeSpec</var><code>}</code>] + * [<code>X</code><var>multiplier</var>] [<code>#</code><var>valueDescription</var>] [<code>#</code> + * <var>optionDescription</var>] </code> * * <p> * where @@ -1084,7 +1137,8 @@ public class ArgParser { * <li><var>optionNames</var> is a comma-separated list of names for the option (such as <code>-f, --file</code>). * * <p> - * <li><var>conversionCode</var> is a single letter, following a <code>%</code> character, specifying information about what value the option requires: + * <li><var>conversionCode</var> is a single letter, following a <code>%</code> character, specifying information + * about what value the option requires: * * <table> * <tr> @@ -1092,7 +1146,8 @@ public class ArgParser { * <td>a floating point number</td> * <tr> * <td><code>%i</code></td> - * <td>an integer, in either decimal, hex (if preceeded by <code>0x</code>), or octal (if preceeded by <code>0</code>)</td> + * <td>an integer, in either decimal, hex (if preceeded by <code>0x</code>), or octal (if preceeded by + * <code>0</code>)</td> * <tr valign=top> * <td><code>%d</code></td> * <td>a decimal integer</td> @@ -1104,7 +1159,8 @@ public class ArgParser { * <td>a hex integer (without the preceeding <code>0x</code>)</td> * <tr valign=top> * <td><code>%c</code></td> - * <td>a single character, including escape sequences (such as <code>\n</code> or <code>\007</code>), and optionally enclosed in single quotes + * <td>a single character, including escape sequences (such as <code>\n</code> or <code>\007</code>), and optionally + * enclosed in single quotes * <tr valign=top> * <td><code>%b</code></td> * <td>a boolean value (<code>true</code> or <code>false</code>)</td> @@ -1113,12 +1169,19 @@ public class ArgParser { * <td>a string. This will be the argument string itself (or its remainder, in the case of a single word option)</td> * <tr valign=top> * <td><code>%v</code></td> - * <td>no explicit value is expected, but a boolean value of <code>true</code> (by default) will be stored into the associated result holder if this option is matched. If one wishes to have a value of <code>false</code> stored instead, then the <code>%v</code> should be followed by a "range spec" containing <code>false</code>, as in <code>%v{false}</code>. + * <td>no explicit value is expected, but a boolean value of <code>true</code> (by default) will be stored into the + * associated result holder if this option is matched. If one wishes to have a value of <code>false</code> stored + * instead, then the <code>%v</code> should be followed by a "range spec" containing <code>false</code>, as in + * <code>%v{false}</code>. * </table> * * <p> - * <li><var>rangeSpec</var> is an optional range specification, placed inside curly braces, consisting of a comma-separated list of range items each specifying permissible values for the option. A range item may be an individual value, or it may itself be a subrange, consisting of two individual values, separated by a comma, and enclosed in square or round brackets. Square and round brackets denote closed and open endpoints of a subrange, indicating that the associated endpoint value is - * included or excluded from the subrange. The values specified in the range spec need to be consistent with the type of value expected by the option. + * <li><var>rangeSpec</var> is an optional range specification, placed inside curly braces, consisting of a + * comma-separated list of range items each specifying permissible values for the option. A range item may be an + * individual value, or it may itself be a subrange, consisting of two individual values, separated by a comma, and + * enclosed in square or round brackets. Square and round brackets denote closed and open endpoints of a subrange, + * indicating that the associated endpoint value is included or excluded from the subrange. The values specified in + * the range spec need to be consistent with the type of value expected by the option. * * <p> * <b>Examples:</b> @@ -1127,27 +1190,44 @@ public class ArgParser { * A range spec of <code>{2,4,8,16}</code> for an integer value will allow the integers 2, 4, 8, or 16. * * <p> - * A range spec of <code>{[-1.0,1.0]}</code> for a floating point value will allow any floating point number in the range -1.0 to 1.0. + * A range spec of <code>{[-1.0,1.0]}</code> for a floating point value will allow any floating point number in the + * range -1.0 to 1.0. * * <p> - * A range spec of <code>{(-88,100],1000}</code> for an integer value will allow values > -88 and <= 100, as well as 1000. + * A range spec of <code>{(-88,100],1000}</code> for an integer value will allow values > -88 and <= 100, as well as + * 1000. * * <p> - * A range spec of <code>{"foo", "bar", ["aaa","zzz")} </code> for a string value will allow strings equal to <code>"foo"</code> or <code>"bar"</code>, plus any string lexically greater than or equal to <code>"aaa"</code> but less then <code>"zzz"</code>. + * A range spec of <code>{"foo", "bar", ["aaa","zzz")} </code> for a string value will allow strings equal to + * <code>"foo"</code> or <code>"bar"</code>, plus any string lexically greater than or equal to <code>"aaa"</code> + * but less then <code>"zzz"</code>. * * <p> - * <li><var>multiplier</var> is an optional integer, following a <code>X</code> character, indicating the number of values which the option expects. If the multiplier is not specified, it is assumed to be 1. If the multiplier value is greater than 1, then the result holder should be either an array (of appropriate type) with a length greater than or equal to the multiplier value, or a <code>java.util.Vector</code> <a href=#vectorHolder>as discussed below</a>. + * <li><var>multiplier</var> is an optional integer, following a <code>X</code> character, indicating the number of + * values which the option expects. If the multiplier is not specified, it is assumed to be 1. If the multiplier + * value is greater than 1, then the result holder should be either an array (of appropriate type) with a length + * greater than or equal to the multiplier value, or a <code>java.util.Vector</code> <a href=#vectorHolder>as + * discussed below</a>. * * <p> - * <li><var>valueDescription</var> is an optional description of the option's value requirements, and consists of all characters between two <code>#</code> characters. The final <code>#</code> character initiates the <i>option description</i>, which may be empty. The value description is used in <a href=#helpInfo>generating help messages</a>. + * <li><var>valueDescription</var> is an optional description of the option's value requirements, and consists of + * all characters between two <code>#</code> characters. The final <code>#</code> character initiates the <i>option + * description</i>, which may be empty. The value description is used in <a href=#helpInfo>generating help + * messages</a>. * * <p> - * <li><var>optionDescription</var> is an optional description of the option itself, consisting of all characters between a <code>#</code> character and the end of the specification string. The option description is used in <a href=#helpInfo>generating help messages</a>. + * <li><var>optionDescription</var> is an optional description of the option itself, consisting of all characters + * between a <code>#</code> character and the end of the specification string. The option description is used in <a + * href=#helpInfo>generating help messages</a>. * </ul> * * <p> - * The result holder must be an object capable of holding a value compatible with the conversion code, or it must be a <code>java.util.Vector</code>. When the option is matched, its associated value is placed in the result holder. If the same option is matched repeatedly, the result holder value will be overwritten, unless the result holder is a <code>java.util.Vector</code>, in which case new holder objects for each match will be allocated and added to the vector. Thus if multiple instances - * of an option are desired by the program, the result holder should be a <code>java.util.Vector</code>. + * The result holder must be an object capable of holding a value compatible with the conversion code, or it must be + * a <code>java.util.Vector</code>. When the option is matched, its associated value is placed in the result holder. + * If the same option is matched repeatedly, the result holder value will be overwritten, unless the result holder + * is a <code>java.util.Vector</code>, in which case new holder objects for each match will be allocated and added + * to the vector. Thus if multiple instances of an option are desired by the program, the result holder should be a + * <code>java.util.Vector</code>. * * <p> * If the result holder is not a <code>Vector</code>, then it must correspond as follows to the conversion code: @@ -1155,12 +1235,14 @@ public class ArgParser { * <table> * <tr valign=top> * <td><code>%i</code>, <code>%d</code>, <code>%x</code>, <code>%o</code></td> - * <td>{@link argparser.IntHolder IntHolder}, {@link argparser.LongHolder LongHolder}, <code>int[]</code>, or <code>long[]</code></td> + * <td>{@link argparser.IntHolder IntHolder}, {@link argparser.LongHolder LongHolder}, <code>int[]</code>, or + * <code>long[]</code></td> * </tr> * * <tr valign=top> * <td><code>%f</code></td> - * <td>{@link argparser.FloatHolder FloatHolder}, {@link argparser.DoubleHolder DoubleHolder}, <code>float[]</code>, or <code>double[]</code></td> + * <td>{@link argparser.FloatHolder FloatHolder}, {@link argparser.DoubleHolder DoubleHolder}, <code>float[]</code>, + * or <code>double[]</code></td> * </tr> * * <tr valign=top> @@ -1180,10 +1262,13 @@ public class ArgParser { * </table> * * <p> - * In addition, if the multiplier is greater than 1, then only the array type indicated above may be used, and the array must be at least as long as the multiplier. + * In addition, if the multiplier is greater than 1, then only the array type indicated above may be used, and the + * array must be at least as long as the multiplier. * * <p> - * <a name=vectorHolder>If the result holder is a <code>Vector</code>, then the system will create an appropriate result holder object and add it to the vector. Multiple occurances of the option will cause multiple results to be added to the vector. + * <a name=vectorHolder>If the result holder is a <code>Vector</code>, then the system will create an appropriate + * result holder object and add it to the vector. Multiple occurances of the option will cause multiple results to + * be added to the vector. * * <p> * The object allocated by the system to store the result will correspond to the conversion code as follows: @@ -1682,11 +1767,14 @@ public class ArgParser { * Matches arguments within an argument list. * * <p> - * In the event of an erroneous or unmatched argument, the method prints a message and exits the program with code 1. + * In the event of an erroneous or unmatched argument, the method prints a message and exits the program with code + * 1. * * <p> - * If help options are enabled and one of the arguments matches a help option, then the result of {@link #getHelpMessage - * getHelpMessage} is printed to the default print stream and the program exits with code 0. If help options are not enabled, they are ignored. + * If help options are enabled and one of the arguments matches a help option, then the result of + * {@link #getHelpMessage + * getHelpMessage} is printed to the default print stream and the program exits with code 0. If help options are not + * enabled, they are ignored. * * @param args argument list * @see ArgParser#getDefaultPrintStream @@ -1702,14 +1790,20 @@ public class ArgParser { * unmatched arguments are returned in a String array. * * <p> - * In the event of an erroneous argument, the method either prints a message and exits the program (if {@link #EXIT_ON_ERROR} is set in <code>exitFlags</code>) or terminates the matching and creates a error message that can be retrieved by {@link #getErrorMessage}. + * In the event of an erroneous argument, the method either prints a message and exits the program (if + * {@link #EXIT_ON_ERROR} is set in <code>exitFlags</code>) or terminates the matching and creates a error message + * that can be retrieved by {@link #getErrorMessage}. * * <p> - * In the event of an umatched argument, the method will print a message and exit if {@link #EXIT_ON_UNMATCHED} is set in <code>errorFlags</code>. Otherwise, the unmatched argument will be appended to the returned array of unmatched values, and the matching will continue at the next location. + * In the event of an umatched argument, the method will print a message and exit if {@link #EXIT_ON_UNMATCHED} is + * set in <code>errorFlags</code>. Otherwise, the unmatched argument will be appended to the returned array of + * unmatched values, and the matching will continue at the next location. * * <p> - * If help options are enabled and one of the arguments matches a help option, then the result of {@link #getHelpMessage - * getHelpMessage} is printed to the the default print stream and the program exits with code 0. If help options are not enabled, then they will not be matched. + * If help options are enabled and one of the arguments matches a help option, then the result of + * {@link #getHelpMessage + * getHelpMessage} is printed to the the default print stream and the program exits with code 0. If help options are + * not enabled, then they will not be matched. * * @param args argument list * @param idx starting location in list @@ -1752,13 +1846,19 @@ public class ArgParser { * match should begin. * * <p> - * In the event of an erroneous argument, the method throws an {@link argparser.ArgParseException ArgParseException} with an appropriate error message. This error message can also be retrieved using {@link #getErrorMessage getErrorMessage}. + * In the event of an erroneous argument, the method throws an {@link argparser.ArgParseException ArgParseException} + * with an appropriate error message. This error message can also be retrieved using {@link #getErrorMessage + * getErrorMessage}. * * <p> - * In the event of an umatched argument, the method will return idx + 1, and {@link #getUnmatchedArgument getUnmatchedArgument} will return a copy of the unmatched argument. If an argument is matched, {@link #getUnmatchedArgument getUnmatchedArgument} will return <code>null</code>. + * In the event of an umatched argument, the method will return idx + 1, and {@link #getUnmatchedArgument + * getUnmatchedArgument} will return a copy of the unmatched argument. If an argument is matched, + * {@link #getUnmatchedArgument getUnmatchedArgument} will return <code>null</code>. * * <p> - * If help options are enabled and the argument matches a help option, then the result of {@link #getHelpMessage getHelpMessage} is printed to the the default print stream and the program exits with code 0. If help options are not enabled, then they are ignored. + * If help options are enabled and the argument matches a help option, then the result of {@link #getHelpMessage + * getHelpMessage} is printed to the the default print stream and the program exits with code 0. If help options are + * not enabled, then they are ignored. * * @param args argument list * @param idx location in list where match should start @@ -1965,7 +2065,8 @@ public class ArgParser { /** * Returns the parser's error message. This is automatically - * set whenever an error is encountered in <code>matchArg</code> or <code>matchAllArgs</code>, and is automatically set to <code>null</code> at the beginning of these methods. + * set whenever an error is encountered in <code>matchArg</code> or <code>matchAllArgs</code>, and is automatically + * set to <code>null</code> at the beginning of these methods. * * @return error message */ @@ -1974,7 +2075,8 @@ public class ArgParser { } /** - * Returns the value of an unmatched argument discovered {@link #matchArg matchArg} or {@link #matchAllArgs(String[],int,int) + * Returns the value of an unmatched argument discovered {@link #matchArg matchArg} or + * {@link #matchAllArgs(String[],int,int) * matchAllArgs}. If there was no unmatched argument, <code>null</code> is returned. * * @return unmatched argument diff --git a/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParserTest.java b/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParserTest.java index 4a7b20e4..9ddb8077 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParserTest.java +++ b/pki/base/silent/src/com/netscape/pkisilent/argparser/ArgParserTest.java @@ -37,7 +37,8 @@ import java.lang.reflect.Array; import java.util.Vector; /** - * Testing class for the class ArgParser. Executing the <code>main</code> method of this class will perform a suite of tests to help verify correct + * Testing class for the class ArgParser. Executing the <code>main</code> method of this class will perform a suite of + * tests to help verify correct * operation of the parser class. * * @author John E. Lloyd, Fall 2004 diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/AutoInstaller.java b/pki/base/silent/src/com/netscape/pkisilent/common/AutoInstaller.java index cdc9a7fb..879278a5 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/AutoInstaller.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/AutoInstaller.java @@ -85,7 +85,8 @@ public class AutoInstaller { // Set InternalDBVInfo /** - * Set Internal Database Information . Takes parameters internaldatabase hostname, internaldatabase port, internaldatabase name, internaldatabase binddn, internaldatabase password + * Set Internal Database Information . Takes parameters internaldatabase hostname, internaldatabase port, + * internaldatabase name, internaldatabase binddn, internaldatabase password */ public void setInternalDBInfo(String dbh, String dbp, String dbname, String dbdn, String dbpswd) { @@ -230,7 +231,9 @@ public class AutoInstaller { // Set Subsystem Information for Configuring /** - * Takes parameters - sID- ServerID e.x cert1, sRoot- ServerRootK kT- keyType "RSA/DSA" , kL - keylength (1024.2048) , cVD- certificate validity dates e.g 365 for 1 year, sdn - subsystems dn, sAdp - subsystem's Admin port, sAgp - subsystems's Agentport,seSP- subsystem's ee SSL port , sep- Subsystems ee port. + * Takes parameters - sID- ServerID e.x cert1, sRoot- ServerRootK kT- keyType "RSA/DSA" , kL - keylength (1024.2048) + * , cVD- certificate validity dates e.g 365 for 1 year, sdn - subsystems dn, sAdp - subsystem's Admin port, sAgp - + * subsystems's Agentport,seSP- subsystem's ee SSL port , sep- Subsystems ee port. */ public void setSubSystemInfo(String sID, String sRoot, String kT, String kL, String hT, String cVD, String sdn, diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/BaseState.java b/pki/base/silent/src/com/netscape/pkisilent/common/BaseState.java index 99487a8f..0d5e9cfc 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/BaseState.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/BaseState.java @@ -48,7 +48,8 @@ public class BaseState { } /** - * Set the publishing directory information . Takes the paramters ldaphost,ldapport,ldapDN, ldapDN password, BaseDN , Secure coonection (true/false) + * Set the publishing directory information . Takes the paramters ldaphost,ldapport,ldapDN, ldapDN password, BaseDN + * , Secure coonection (true/false) */ public void setLDAPInfo(String h, String p, String dn, String pw, String base, boolean sc) { ldaphost = h; diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/CMSConfig.java b/pki/base/silent/src/com/netscape/pkisilent/common/CMSConfig.java index 601e5998..f5737167 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/CMSConfig.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/CMSConfig.java @@ -85,7 +85,8 @@ public class CMSConfig extends ServerInfo { // Enable DirectoryBased Authentication /** - * Takes parameters : secureConnection( true/false), basedn, ldaphostname, lapdaportnumber ( in case of secured connection give ldap secured port) + * Takes parameters : secureConnection( true/false), basedn, ldaphostname, lapdaportnumber ( in case of secured + * connection give ldap secured port) */ public void EnableDirEnrollment(boolean secureConn, String ldapbase, String lhost, String lport) { @@ -146,7 +147,8 @@ public class CMSConfig extends ServerInfo { } /** - * Takes parameters : secureConnection( true/false), ldapbinddn, ldapbindnpassword,ldaphostname, lapdaportnumber ( in case of secured connection give ldap secured port), basedn (e.g ou=people,o=mcom.com) + * Takes parameters : secureConnection( true/false), ldapbinddn, ldapbindnpassword,ldaphostname, lapdaportnumber ( + * in case of secured connection give ldap secured port), basedn (e.g ou=people,o=mcom.com) */ void EnablePortalAuth(boolean secureConn, String ldaprootDN, String ldaprootDNPW, String lhost, String lport, @@ -207,7 +209,8 @@ public class CMSConfig extends ServerInfo { // Publishing /** - * Takes parameters : secureConnection( true/false), ldapbinddn, ldapbindnpassword,ldaphostname, lapdaportnumber ( in case of secured connection give ldap secured port) + * Takes parameters : secureConnection( true/false), ldapbinddn, ldapbindnpassword,ldaphostname, lapdaportnumber ( + * in case of secured connection give ldap secured port) */ public void EnablePublishing(boolean secureConn, String ldaprootDN, String ldaprootDNPW, String lhost, String lport) { diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/CMSInstance.java b/pki/base/silent/src/com/netscape/pkisilent/common/CMSInstance.java index ec7ce354..1868f17c 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/CMSInstance.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/CMSInstance.java @@ -38,7 +38,9 @@ public class CMSInstance { */ /** - * Constructor. Takes parameters hostname, adminserverport, adminDN, adminDNpassword, Dominanname, ServerRoot( full path) , instanceID, mnameand sieURL. mname is the fully qualified name of the server ( jupiter2.nscp.aoltw.net) sieURL is ("ldap://jupiter2.nscp.aoltw.net:(ConfigLADPPort)/o=NetscapeRoot" + * Constructor. Takes parameters hostname, adminserverport, adminDN, adminDNpassword, Dominanname, ServerRoot( full + * path) , instanceID, mnameand sieURL. mname is the fully qualified name of the server ( jupiter2.nscp.aoltw.net) + * sieURL is ("ldap://jupiter2.nscp.aoltw.net:(ConfigLADPPort)/o=NetscapeRoot" */ private String cs_server_root, cs_tps_root, tps_hostname, tps_fqdn, tps_instanceid, tps_ee_port, tps_agent_port, diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/CMSProperties.java b/pki/base/silent/src/com/netscape/pkisilent/common/CMSProperties.java index c79174f6..a4ba55d2 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/CMSProperties.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/CMSProperties.java @@ -47,12 +47,20 @@ import java.util.Hashtable; * or loaded from a stream. Each key and its corresponding value in * the property list is a string. * <p> - * A property list can contain another property list as its "defaults"; this second property list is searched if the property key is not found in the original property list. + * A property list can contain another property list as its "defaults"; this second property list is searched if the + * property key is not found in the original property list. * <p> - * Because <code>Properties</code> inherits from <code>Hashtable</code>, the <code>put</code> and <code>putAll</code> methods can be applied to a <code>Properties</code> object. Their use is strongly discouraged as they allow the caller to insert entries whose keys or values are not <code>Strings</code>. The <code>setProperty</code> method should be used instead. If the <code>store</code> or <code>save</code> method is called on a "compromised" <code>Properties</code> object that contains a non- - * <code>String</code> key or value, the call will fail. + * Because <code>Properties</code> inherits from <code>Hashtable</code>, the <code>put</code> and <code>putAll</code> + * methods can be applied to a <code>Properties</code> object. Their use is strongly discouraged as they allow the + * caller to insert entries whose keys or values are not <code>Strings</code>. The <code>setProperty</code> method + * should be used instead. If the <code>store</code> or <code>save</code> method is called on a "compromised" + * <code>Properties</code> object that contains a non- <code>String</code> key or value, the call will fail. * <p> - * <a name="encoding"></a> When saving properties to a stream or loading them from a stream, the ISO 8859-1 character encoding is used. For characters that cannot be directly represented in this encoding, <a href="http://java.sun.com/docs/books/jls/html/3.doc.html#100850">Unicode escapes</a> are used; however, only a single 'u' character is allowed in an escape sequence. The native2ascii tool can be used to convert property files to and from other character encodings. + * <a name="encoding"></a> When saving properties to a stream or loading them from a stream, the ISO 8859-1 character + * encoding is used. For characters that cannot be directly represented in this encoding, <a + * href="http://java.sun.com/docs/books/jls/html/3.doc.html#100850">Unicode escapes</a> are used; however, only a single + * 'u' character is allowed in an escape sequence. The native2ascii tool can be used to convert property files to and + * from other character encodings. * * @see <a href="../../../tooldocs/solaris/native2ascii.html">native2ascii tool for Solaris</a> * @see <a href="../../../tooldocs/win32/native2ascii.html">native2ascii tool for Windows</a> @@ -120,15 +128,29 @@ class CMSProperties extends Hashtable<String, String> { * Reads a property list (key and element pairs) from the input stream. * The stream is assumed to be using the ISO 8859-1 character encoding. * <p> - * Every property occupies one line of the input stream. Each line is terminated by a line terminator (<code>\n</code> or <code>\r</code> or <code>\r\n</code>). Lines from the input stream are processed until end of file is reached on the input stream. + * Every property occupies one line of the input stream. Each line is terminated by a line terminator ( + * <code>\n</code> or <code>\r</code> or <code>\r\n</code>). Lines from the input stream are processed until end of + * file is reached on the input stream. * <p> - * A line that contains only whitespace or whose first non-whitespace character is an ASCII <code>#</code> or <code>!</code> is ignored (thus, <code>#</code> or <code>!</code> indicate comment lines). + * A line that contains only whitespace or whose first non-whitespace character is an ASCII <code>#</code> or + * <code>!</code> is ignored (thus, <code>#</code> or <code>!</code> indicate comment lines). * <p> - * Every line other than a blank line or a comment line describes one property to be added to the table (except that if a line ends with \, then the following line, if it exists, is treated as a continuation line, as described below). The key consists of all the characters in the line starting with the first non-whitespace character and up to, but not including, the first ASCII <code>=</code>, <code>:</code>, or whitespace character. All of the key termination characters may be included in - * the key by preceding them with a \. Any whitespace after the key is skipped; if the first non-whitespace character after the key is <code>=</code> or <code>:</code>, then it is ignored and any whitespace characters after it are also skipped. All remaining characters on the line become part of the associated element string. Within the element string, the ASCII escape sequences <code>\t</code>, <code>\n</code>, <code>\r</code>, <code>\\</code>, <code>\"</code>, <code>\'</code>, - * <code>\  </code>  (a backslash and a space), and <code>\u</code><i>xxxx</i> are recognized and converted to single characters. Moreover, if the last character on the line is <code>\</code>, then the next line is treated as a continuation of the current line; the <code>\</code> and line terminator are simply discarded, and any leading whitespace characters on the continuation line are also discarded and are not part of the element string. + * Every line other than a blank line or a comment line describes one property to be added to the table (except that + * if a line ends with \, then the following line, if it exists, is treated as a continuation line, as described + * below). The key consists of all the characters in the line starting with the first non-whitespace character and + * up to, but not including, the first ASCII <code>=</code>, <code>:</code>, or whitespace character. All of the key + * termination characters may be included in the key by preceding them with a \. Any whitespace after the key is + * skipped; if the first non-whitespace character after the key is <code>=</code> or <code>:</code>, then it is + * ignored and any whitespace characters after it are also skipped. All remaining characters on the line become part + * of the associated element string. Within the element string, the ASCII escape sequences <code>\t</code>, + * <code>\n</code>, <code>\r</code>, <code>\\</code>, <code>\"</code>, <code>\'</code>, <code>\  </code>  (a + * backslash and a space), and <code>\u</code><i>xxxx</i> are recognized and converted to single characters. + * Moreover, if the last character on the line is <code>\</code>, then the next line is treated as a continuation of + * the current line; the <code>\</code> and line terminator are simply discarded, and any leading whitespace + * characters on the continuation line are also discarded and are not part of the element string. * <p> - * As an example, each of the following four lines specifies the key <code>"Truth"</code> and the associated element value <code>"Beauty"</code>: + * As an example, each of the following four lines specifies the key <code>"Truth"</code> and the associated element + * value <code>"Beauty"</code>: * <p> * * <pre> @@ -153,7 +175,9 @@ class CMSProperties extends Hashtable<String, String> { * "apple, banana, pear, cantaloupe, watermelon,kiwi, mango" * </pre> * - * Note that a space appears before each <code>\</code> so that a space will appear after each comma in the final result; the <code>\</code>, line terminator, and leading whitespace on the continuation line are merely discarded and are <i>not</i> replaced by one or more other characters. + * Note that a space appears before each <code>\</code> so that a space will appear after each comma in the final + * result; the <code>\</code>, line terminator, and leading whitespace on the continuation line are merely discarded + * and are <i>not</i> replaced by one or more other characters. * <p> * As a third example, the line: * <p> @@ -451,20 +475,34 @@ class CMSProperties extends Hashtable<String, String> { } /** - * Writes this property list (key and element pairs) in this <code>Properties</code> table to the output stream in a format suitable + * Writes this property list (key and element pairs) in this <code>Properties</code> table to the output stream in a + * format suitable * for loading into a <code>Properties</code> table using the <code>load</code> method. * The stream is written using the ISO 8859-1 character encoding. * <p> - * Properties from the defaults table of this <code>Properties</code> table (if any) are <i>not</i> written out by this method. + * Properties from the defaults table of this <code>Properties</code> table (if any) are <i>not</i> written out by + * this method. * <p> - * If the header argument is not null, then an ASCII <code>#</code> character, the header string, and a line separator are first written to the output stream. Thus, the <code>header</code> can serve as an identifying comment. + * If the header argument is not null, then an ASCII <code>#</code> character, the header string, and a line + * separator are first written to the output stream. Thus, the <code>header</code> can serve as an identifying + * comment. * <p> - * Next, a comment line is always written, consisting of an ASCII <code>#</code> character, the current date and time (as if produced by the <code>toString</code> method of <code>Date</code> for the current time), and a line separator as generated by the Writer. + * Next, a comment line is always written, consisting of an ASCII <code>#</code> character, the current date and + * time (as if produced by the <code>toString</code> method of <code>Date</code> for the current time), and a line + * separator as generated by the Writer. * <p> - * Then every entry in this <code>Properties</code> table is written out, one per line. For each entry the key string is written, then an ASCII <code>=</code>, then the associated element string. Each character of the element string is examined to see whether it should be rendered as an escape sequence. The ASCII characters <code>\</code>, tab, newline, and carriage return are written as <code>\\</code>, <code>\t</code>, <code>\n</code>, and <code>\r</code>, respectively. Characters less - * than <code>\u0020</code> and characters greater than <code>\u007E</code> are written as <code>\u</code><i>xxxx</i> for the appropriate hexadecimal value <i>xxxx</i>. Leading space characters, but not embedded or trailing space characters, are written with a preceding <code>\</code>. The key and value characters <code>#</code>, <code>!</code>, <code>=</code>, and <code>:</code> are written with a preceding slash to ensure that they are properly loaded. + * Then every entry in this <code>Properties</code> table is written out, one per line. For each entry the key + * string is written, then an ASCII <code>=</code>, then the associated element string. Each character of the + * element string is examined to see whether it should be rendered as an escape sequence. The ASCII characters + * <code>\</code>, tab, newline, and carriage return are written as <code>\\</code>, <code>\t</code>, + * <code>\n</code>, and <code>\r</code>, respectively. Characters less than <code>\u0020</code> and characters + * greater than <code>\u007E</code> are written as <code>\u</code><i>xxxx</i> for the appropriate + * hexadecimal value <i>xxxx</i>. Leading space characters, but not embedded or trailing space characters, are + * written with a preceding <code>\</code>. The key and value characters <code>#</code>, <code>!</code>, + * <code>=</code>, and <code>:</code> are written with a preceding slash to ensure that they are properly loaded. * <p> - * After the entries have been written, the output stream is flushed. The output stream remains open after this method returns. + * After the entries have been written, the output stream is flushed. The output stream remains open after this + * method returns. * * @param out an output stream. * @param header a description of the property list. @@ -505,7 +543,8 @@ class CMSProperties extends Hashtable<String, String> { /** * Searches for the property with the specified key in this property list. * If the key is not found in this property list, the default property list, - * and its defaults, recursively, are then checked. The method returns <code>null</code> if the property is not found. + * and its defaults, recursively, are then checked. The method returns <code>null</code> if the property is not + * found. * * @param key the property key. * @return the value in this property list with the specified key value. diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/ComCrypto.java b/pki/base/silent/src/com/netscape/pkisilent/common/ComCrypto.java index 9881aa2c..1c308e2c 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/ComCrypto.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/ComCrypto.java @@ -101,7 +101,8 @@ public class ComCrypto { }; /** - * Constructor . Takes the parameter certificatedbdirectory , passwordfor cert database, certificatenickname,keysize, keytype(RSA/DSA) + * Constructor . Takes the parameter certificatedbdirectory , passwordfor cert database, + * certificatenickname,keysize, keytype(RSA/DSA) * * @param certdbdirectory. * @param certdbpassword diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/DirEnroll.java b/pki/base/silent/src/com/netscape/pkisilent/common/DirEnroll.java index 0087da25..0e47084e 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/DirEnroll.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/DirEnroll.java @@ -72,7 +72,8 @@ public class DirEnroll extends TestClient { } /** - * Constructor. Takes hostname,EESSLportnumber,uid,password,certdbdirectorypath,certdbpassword,certificatenickname,keysize,teytype + * Constructor. Takes + * hostname,EESSLportnumber,uid,password,certdbdirectorypath,certdbpassword,certificatenickname,keysize,teytype * <p> * * @param hostname diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/PostQuery.java b/pki/base/silent/src/com/netscape/pkisilent/common/PostQuery.java index 64e49d90..bf5db504 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/PostQuery.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/PostQuery.java @@ -31,7 +31,8 @@ import com.netscape.osutil.OSUtil; /** * CMS Test framework . - * This class submits request to admin server after authenticating with UID and Password. You can get back the response by calling the method. getPage(). + * This class submits request to admin server after authenticating with UID and Password. You can get back the response + * by calling the method. getPage(). */ public class PostQuery { @@ -44,7 +45,8 @@ public class PostQuery { private StringBuffer stdout = new StringBuffer(); /** - * Constructor . Takes the parameters urlstring("http://hostname:<portnumber> , Id for authenticating to the server, password for authentication to the server and query which needs to be submitted to the server + * Constructor . Takes the parameters urlstring("http://hostname:<portnumber> , Id for authenticating to the server, + * password for authentication to the server and query which needs to be submitted to the server */ public PostQuery(String urlstr, String authid, String authpwd, String querystring) { diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/ServerInfo.java b/pki/base/silent/src/com/netscape/pkisilent/common/ServerInfo.java index 617fb583..f63a0f54 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/ServerInfo.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/ServerInfo.java @@ -26,7 +26,8 @@ import java.util.StringTokenizer; /** * CMS Test framework . - * This class fetches all the necssary ServerInformation to run the test . For example AdminServer information linke port , hsotname, Config LDAP server port, CMS servers Agentport,AdminPort, EESSL port, EE port etc.. + * This class fetches all the necssary ServerInformation to run the test . For example AdminServer information linke + * port , hsotname, Config LDAP server port, CMS servers Agentport,AdminPort, EESSL port, EE port etc.. */ public class ServerInfo { @@ -48,7 +49,8 @@ public class ServerInfo { } /** - * Constructor. Takes Server root as parameter for example ( /export/qa). Reads and collects information about adminserver and Config LDAP server. + * Constructor. Takes Server root as parameter for example ( /export/qa). Reads and collects information about + * adminserver and Config LDAP server. */ public ServerInfo(String sroot) { serverRoot = sroot; @@ -58,7 +60,8 @@ public class ServerInfo { } /** - * Constructor. Takes Serverroot ( /export/qa) and instanceRoot (/export/qa/cert-jupiter2) as parameters . Reads and collects information about Admin Server , Config LDAP server and CMS server . + * Constructor. Takes Serverroot ( /export/qa) and instanceRoot (/export/qa/cert-jupiter2) as parameters . Reads and + * collects information about Admin Server , Config LDAP server and CMS server . */ public ServerInfo(String sroot, String instRoot) { diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/TestClient.java b/pki/base/silent/src/com/netscape/pkisilent/common/TestClient.java index b0840c90..87161d68 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/TestClient.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/TestClient.java @@ -99,7 +99,8 @@ public class TestClient implements SSLCertificateApprovalCallback { /** * Constructor . Takes the parameter for keysize and keytype . - * Before creating a new instance of this class make sure you have set TEST_CONFIG_FILE variable in your environnemt. + * Before creating a new instance of this class make sure you have set TEST_CONFIG_FILE variable in your + * environnemt. * Reads the TEST_CONFIG_FILE . Initializes the certificate database. See engage.cfg file for example. * * @param keysize diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/UserEnroll.java b/pki/base/silent/src/com/netscape/pkisilent/common/UserEnroll.java index 1fbf834b..e5c2f0b4 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/UserEnroll.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/UserEnroll.java @@ -68,7 +68,8 @@ public class UserEnroll extends TestClient { } /** - * Constructor . Takes the parameter for hostname, EESSLportnumber, subjectdn, E, CN,UID,OU,O, CertdbDirecrory(fullpath) , certdbPassword, keysize, keytype, requestorName,requestorEmail and Certtype. + * Constructor . Takes the parameter for hostname, EESSLportnumber, subjectdn, E, CN,UID,OU,O, + * CertdbDirecrory(fullpath) , certdbPassword, keysize, keytype, requestorName,requestorEmail and Certtype. * valid values for Certtype - "ca","ra","ocsp" * <p> * diff --git a/pki/base/silent/src/com/netscape/pkisilent/common/checkRequest.java b/pki/base/silent/src/com/netscape/pkisilent/common/checkRequest.java index d0b0373d..99a6e084 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/common/checkRequest.java +++ b/pki/base/silent/src/com/netscape/pkisilent/common/checkRequest.java @@ -31,7 +31,8 @@ import org.mozilla.jss.ssl.SSLSocket; /** * CMS Test framework . - * Submits a checkRequestStatus request to the server. parses the response from server and can import cert to the specified client database. + * Submits a checkRequestStatus request to the server. parses the response from server and can import cert to the + * specified client database. * <P> */ @@ -90,7 +91,8 @@ public class checkRequest extends TestClient { } /** - * Constructor . Takes the parameter for hostname , EESSLportnumber , certdbdir, certdbpassword, Requestnumber ,certnickname and ImportCert ( true/false) + * Constructor . Takes the parameter for hostname , EESSLportnumber , certdbdir, certdbpassword, Requestnumber + * ,certnickname and ImportCert ( true/false) * <p> */ diff --git a/pki/base/silent/src/com/netscape/pkisilent/http/HTMLDocument.java b/pki/base/silent/src/com/netscape/pkisilent/http/HTMLDocument.java index 67e95cf5..e8de2908 100644 --- a/pki/base/silent/src/com/netscape/pkisilent/http/HTMLDocument.java +++ b/pki/base/silent/src/com/netscape/pkisilent/http/HTMLDocument.java @@ -498,7 +498,8 @@ public class HTMLDocument { /** * Retrieves the contents of the HTML document with all tags removed. * - * @return The contents of the HTML document with all tags removed, or <CODE>null</CODE> if a problem occurs while trying to parse the + * @return The contents of the HTML document with all tags removed, or <CODE>null</CODE> if a problem occurs while + * trying to parse the * HTML. */ public String getTextData() { @@ -538,7 +539,8 @@ public class HTMLDocument { * that are in the form of links to other content. * * @return An array containing a set of URLs parsed from the HTML document - * that are in the form of links to other content, or <CODE>null</CODE> if a problem occurs while trying to parse the + * that are in the form of links to other content, or <CODE>null</CODE> if a problem occurs while trying to + * parse the * HTML. */ public String[] getDocumentLinks() { |