Merge pull request jglobus#162 from ellert/javadoc

Javadoc fixes

gram/src/main/java/org/globus/gram/GramAttributes.java

@@ -38,7 +38,7 @@
  * </pre>
  * the resulting rsl will look like:
  * <pre>
- * &("stdout"="$(MY_URL)/hello")("environment"=("MY_URL" "http://foo"))
+ * &amp;("stdout"="$(MY_URL)/hello")("environment"=("MY_URL" "http://foo"))
  * </pre>
  * Since the "$(MY_URL)/hello" is in double quotes it will be treated as
  * a single string and the variable will never be resolved. The parser

gram/src/main/java/org/globus/gram/GramJob.java

@@ -198,7 +198,7 @@ protected void setExitCode(int exitCode) {
      * the job has not completed, or if the service did not provide
      * an exit code for this job, this method will return
      * <code>0</code> and {@link #isExitCodeValid()} will return
-     * <code>false</code>.</p>
+     * <code>false</code>.
      * @return the job exit code or <code>0</code> if the service did
      * not provide one or the job has not completed.
      */
@@ -208,7 +208,7 @@ public int getExitCode() {
 
     /**
      * <p>Can be used to determine whether the job exit code
-     * returned by {@link #getExitCode()} is valid.</p>
+     * returned by {@link #getExitCode()} is valid.
      * <p>This method will return <code>false</code> if either
      * of the following is true:
      * <ul>

gram/src/main/java/org/globus/rsl/ParseException.java

@@ -22,7 +22,7 @@ public class ParseException extends Exception {
    * This constructor calls its super class with the empty string
    * to force the "toString" method of parent class "Throwable" to
    * print the error message in the form:
-   *     ParseException: <result of getMessage>
+   *     ParseException: &lt;result of getMessage&gt;
    */
   public ParseException(Token currentTokenVal,
                         int[][] expectedTokenSequencesVal,

gridftp/src/main/java/org/globus/ftp/ByteRange.java

@@ -33,7 +33,7 @@ public class ByteRange {
     /**
        @param from lower range limit
        @param to upper range limit
-       @throws IllegalArgumentException if to < from
+       @throws IllegalArgumentException if to &lt; from
      **/
     public ByteRange(long from, long to) {
 	if (to < from) {

gridftp/src/main/java/org/globus/ftp/ByteRangeList.java

@@ -94,9 +94,9 @@ public int hashCode() {
        while the parameter object will remain intact.
        For instance:
        <ul>
-       <li>merge("10-15 30-35", "20-25") ->  "10-15 20-25 30-35"
-       <li>merge("10-15 30-35", "12-15") ->  "10-15 20-25"
-       <li>merge("10-15 30-35", "16-40") ->  "10-40"
+       <li>merge("10-15 30-35", "20-25") -&lt;  "10-15 20-25 30-35"
+       <li>merge("10-15 30-35", "12-15") -&lt;  "10-15 20-25"
+       <li>merge("10-15 30-35", "16-40") -&lt;  "10-40"
        </ul>
      **/
     public void merge(final ByteRange range) {

gridftp/src/main/java/org/globus/ftp/FTPClient.java

@@ -2063,14 +2063,14 @@ public boolean getUseAllo() {
      * <a href="http://www.ogf.org/documents/GFD.47.pdf">GridFTP v2 Protocol Description</a>
      * checksum feature has the following syntax:
      * <pre>
-     * CKSUM <algorithm>[, …]
+     * CKSUM &lt;algorithm&gt;[, …]
      * </pre>
      * getSupportedCksumAlgorithms parses checsum feauture parms and form a
      * list of checksum algorithms supported by the server
      * @return a list of checksum algorithms supported by the server in the order
      * specified by the server
      * @throws org.globus.ftp.exception.ClientException
-     * @throws org.globus.ftp.org.globus.ftp.exception.ServerException
+     * @throws org.globus.ftp.exception.ServerException
      * @throws java.io.IOException
      */
     public List<String> getSupportedCksumAlgorithms()
@@ -2130,12 +2130,12 @@ private void checkCksumSupport(String algorithm)
      * 5.1 CKSM
      * This command is used by the client to request checksum calculation over a portion or
      * whole file existing on the server. The syntax is:
-     * CKSM <algorithm> <offset> <length> <path> CRLF
+     * CKSM &lt;algorithm&gt; &lt;offset&gt; &lt;length&gt; &lt;path&gt; CRLF
      * Server executes this command by calculating specified type of checksum over
      * portion of the file starting at the offset and of the specified length. If length is –1,
      * the checksum will be calculated through the end of the file. On success, the server
      * replies with
-     * 2xx <checksum value>
+     * 2xx &lt;checksum value&gt;
      * Actual format of checksum value depends on the algorithm used, but generally,
      * hexadecimal representation should be used.
      * </pre>
@@ -2146,7 +2146,7 @@ private void checkCksumSupport(String algorithm)
      * @param path
      * @return ckecksum value returned by the server
      * @throws org.globus.ftp.exception.ClientException
-     * @throws org.globus.ftp.org.globus.ftp.exception.ServerException
+     * @throws org.globus.ftp.exception.ServerException
      * @throws java.io.IOException
      */
     public String getChecksum(String algorithm,
@@ -2180,7 +2180,7 @@ public String getChecksum(String algorithm,
      * @param  path
      * @return ckecksum value returned by the server
      * @throws org.globus.ftp.exception.ClientException
-     * @throws org.globus.ftp.org.globus.ftp.exception.ServerException
+     * @throws org.globus.ftp.exception.ServerException
      * @throws java.io.IOException
      */
     public String getChecksum(String algorithm,
@@ -2199,14 +2199,14 @@ public String getChecksum(String algorithm,
      * uploaded. At the end of transfer, server will calculate checksum for the received file,
      * and if it does not match, will consider the transfer to have failed. Syntax of the
      * command is:
-     * SCKS <algorithm> <value> CRLF
+     * SCKS &lt;algorithm&gt; &lt;value&gt; CRLF
      * Actual format of checksum value depends on the algorithm used, but generally,
      * hexadecimal representation should be used.
      * </pre>
      * @param algorithm
      * @param value
      * @throws org.globus.ftp.exception.ClientException
-     * @throws org.globus.ftp.org.globus.ftp.exception.ServerException
+     * @throws org.globus.ftp.exception.ServerException
      * @throws java.io.IOException
      */
     public void setChecksum(String algorithm, String value)

gridftp/src/main/java/org/globus/ftp/HostPort6.java

@@ -38,7 +38,7 @@ public HostPort6(String version, String host, int port) {
      * Parses host-port from passive mode reply message.
      * Note that the argument is not the whole message, but
      * only the content of the brackets:
-     * <d><net-prt><d><net-addr><d><tcp-port><d>
+     * &lt;d&gt;&lt;net-prt&gt;&lt;d&gt;&lt;net-addr&gt;&lt;d&gt;&lt;tcp-port&gt;&lt;d&gt;
      *
      * @param passiveReplyMessage reply message for the EPSV command
      */
@@ -143,7 +143,7 @@ public void setVersion(String version) {
     /**
      * Returns the host-port information in the
      * format used by EPRT command.
-     * <d><net-prt><d><net-addr><d><tcp-port><d>
+     * &lt;d&gt;&lt;net-prt&gt;&lt;d&gt;&lt;net-addr&gt;&lt;d&gt;&lt;tcp-port&gt;&lt;d&gt;
      *
      * @return host-port information in EPRT command
      *         representation.

gridftp/src/main/java/org/globus/ftp/dc/AbstractDataChannel.java

@@ -124,7 +124,7 @@ public static void registerHandler(int transferMode,
 
     /**
      * Tests if the client supports specified transfer type and mode
-     * (the client can read data in specific type & mode from the
+     * (the client can read data in specific type and mode from the
      * data connection)
      */
     public boolean isDataSourceModeSupported() {
@@ -134,7 +134,7 @@ public boolean isDataSourceModeSupported() {
 
     /**
      * Tests if the client supports specified transfer type and mode
-     * (the client can write data in specific type & mode to the
+     * (the client can write data in specific type and mode to the
      * data connection)
      */
     public boolean isDataSinkModeSupported() {

gridftp/src/main/java/org/globus/ftp/vanilla/Command.java

@@ -73,8 +73,7 @@ private void initialize(String name, String parameters)
 
     /**
      * @return a String representation of this object, that is
-     * <name> <sp> <parameters> <CRLF>
-     * </p>
+     * &lt;name&gt; &lt;sp&gt; &lt;parameters&gt; &lt;CRLF&gt;
      */
     public static String toString(Command command) {
 	return command.toString();

gridftp/src/main/java/org/globus/ftp/vanilla/Reply.java

@@ -196,10 +196,6 @@ public boolean isMultiline() {
      * dash "-" and the CRLF following the last line, excluding the mentioned
      * dash and CRLF. Note that lines are separated by the local line separator
      * [as returned by System.getProperty("line.separator")] rather than CRLF.
-     *
-     * </p>
-     * <p>
-     *
      * </p>
      */
     public String getMessage() {

gss/src/main/java/org/globus/gsi/gssapi/GlobusGSSName.java

@@ -320,7 +320,7 @@ public boolean equals(GSSName another)
     /**
      * Returns globus ID string representation of the name.
      * If name represents is an anonymous name string
-     * "<anonymous>" is returned.
+     * "&lt;anonymous&gt;" is returned.
      */
     public String toString() {
 	if (this.name == null) {

jsse/src/test/java/org/globus/gsi/jsse/SSLConfiguratorTest.java

@@ -110,7 +110,7 @@ private SSLServerSocket startServer(SSLConfigurator config)
 			 * used to create a thread, starting the thread causes the object's
 			 * <code>run</code> method to be called in that separately executing
 			 * thread.
-			 * <p/>
+			 * <p>
 			 * The general contract of the method <code>run</code> is that it
 			 * may take any action whatsoever.
 			 *

ssl-proxies/src/main/java/org/globus/common/CoGProperties.java

@@ -401,7 +401,7 @@ public void setProxyFile(String proxyFile) {
      * property is checked. If that system property is not set then it returns
      * the value specified in the configuration file. Returns null if the port
      * range is not defined.<BR>
-     * The port range is in the following form: <minport>, <maxport>
+     * The port range is in the following form: &lt;minport&gt;, &lt;maxport&gt;
      *
      * @return <code>String</code> the port range.
      */
@@ -426,7 +426,7 @@ public String getTcpPortRange() {
      * If that system property is not set then it returns
      * the value specified in the configuration file. Returns null if the port
      * range is not defined.<BR>
-     * The port range is in the following form: <minport>, <maxport>
+     * The port range is in the following form: &lt;minport&gt;, &lt;maxport&gt;
      *
      * @return <code>String</code> the port range.
      */
@@ -451,7 +451,7 @@ public String getTcpSourcePortRange() {
      * If that system property is not set then it returns
      * the value specified in the configuration file. Returns null if the port
      * range is not defined.<BR>
-     * The port range is in the following form: <minport>, <maxport>
+     * The port range is in the following form: &lt;minport&gt;, &lt;maxport&gt;
      *
      * @return <code>String</code> the port range.
      */

ssl-proxies/src/main/java/org/globus/gsi/OpenSSLKey.java

@@ -50,7 +50,7 @@
 /**
  * Represents a OpenSSL-style PEM-formatted private key. It supports encryption and decryption of the key. Currently,
  * only RSA keys are supported, and only TripleDES encryption is supported.
- * <p/>
+ * <p>
  * This is based on work done by Ming Yung at DSTC.
  *
  * @version ${version}

ssl-proxies/src/main/java/org/globus/gsi/SigningPolicyParser.java

@@ -39,18 +39,23 @@
 
 /**
  * Signing policy BCNF grammar as implemented here: (based on C implementation)
- * <p/>
- * eacl ::=  {eacl_entry} eacl_entry ::= {access_identity} pos_rights
- * {restriction} {pos_rights {restriction}} | {access_identity} neg_rights
- * access_identity ::= access_identity_type  def_authority  value  \n
- * access_identity_type ::= "access_id_HOST"  | "access_id_USER"  |
- * "access_id_GROUP" | "access_id_CA"    | "access_id_APPLICATION" |
- * "access_id_ANYBODY" pos_rights ::=  "pos_rights" def_authority value
- * {"pos_rights" def_authority value} neg_rights ::= "neg_rights" def_authority
- * value {"neg_rights" def_authority value} restriction ::= condition_type
- * def_authority  value  \n condition_type ::= alphanumeric_string def_authority
- * ::= alphanumeric_string value ::= alphanumeric_string
- * <p/>
+ * <p>
+ * eacl ::= {eacl_entry}<br>
+ * eacl_entry ::= {access_identity} pos_rights {restriction}
+ * {pos_rights {restriction}} | {access_identity} neg_rights<br>
+ * access_identity ::= access_identity_type def_authority value<br>
+ * access_identity_type ::= "access_id_HOST" | "access_id_USER" |
+ * "access_id_GROUP" | "access_id_CA" | "access_id_APPLICATION" |
+ * "access_id_ANYBODY"<br>
+ * pos_rights ::= "pos_rights" def_authority value
+ * {"pos_rights" def_authority value}<br>
+ * neg_rights ::= "neg_rights" def_authority value
+ * {"neg_rights" def_authority value}<br>
+ * restriction ::= condition_type def_authority value<br>
+ * condition_type ::= alphanumeric_string<br>
+ * def_authority ::= alphanumeric_string<br>
+ * value ::= alphanumeric_string
+ * <p>
  * This class take a signing policy file as input and parses it to extract the
  * policy that is enforced. Only the following policy is enforced: access_id_CA
  * with defining authority as X509 with CA DN as value. Any positive rights
@@ -59,16 +64,16 @@
  * CA is authorized to sign. restrictions are assumed to start with cond_. Order
  * of rights matter, so the first occurance of CA:Sign with allowedDNs is used
  * and rest of the policy is ignored.
- * <p/>
+ * <p>
  * For a given signing policy file, only policy with the particular CA's DN is
  * parsed.
- * <p/>
+ * <p>
  * subject names may include the following wildcard characters: *    Matches
  * zero or any number of characters. ?    Matches any single character.
- * <p/>
+ * <p>
  * All subject names should be in Globus format, with slashes and should NOT be
  * revered.
- * <p/>
+ * <p>
  * The allowed DN patterns are returned as a vector of java.util.regexp.Pattern.
  * The BCNF grammar that uses wildcard (*) and single character (?) are replaced
  * with the regexp grammar needed by the Pattern class.

ssl-proxies/src/main/java/org/globus/gsi/TrustedCertificates.java

@@ -82,7 +82,7 @@ public class TrustedCertificates implements Serializable {
 
     /**
      * Default signing policy suffix. The files are expected to be
-     * <caHash>.signing_policy in the same directory as the trusted
+     * &lt;caHash&gt;.signing_policy in the same directory as the trusted
      * certificates.
      */
     public final static String SIGNING_POLICY_FILE_SUFFIX = ".signing_policy";
@@ -176,7 +176,7 @@ public SigningPolicy getSigningPolicy(String subject) {
      * and all files in the form of <i>hashcode.number</i> and will be
      * loaded automatically as trusted certificates. An attempt will
      * be made to load signing policy for the CA associated with
-     * that hashcode from <hashcode>.signing_policy. If policy file is
+     * that hashcode from &lt;hashcode&gt;.signing_policy. If policy file is
      * not found, no error will be thrown, only path validation code
      * enforces the signing policy requirement.
      *
@@ -305,7 +305,7 @@ public synchronized void reload(String locations) {
     }
 
     /**
-     * Signing policy name is created as <hashcode>.signing_policy.
+     * Signing policy name is created as &lt;hashcode&gt;.signing_policy.
      */
     private String getPolicyFileName(String caFileName) {
         return caFileName.substring(0, caFileName.lastIndexOf(".")) + SIGNING_POLICY_FILE_SUFFIX ;

ssl-proxies/src/main/java/org/globus/gsi/X509Credential.java

@@ -63,7 +63,7 @@
 
 /**
  * FILL ME
- * <p/>
+ * <p>
  * This class equivalent was called GlobusCredential in CoG -maybe a better name?
  *
  * @author [email protected]

ssl-proxies/src/main/java/org/globus/gsi/X509ProxyCertPathParameters.java

@@ -23,8 +23,6 @@
 import org.globus.gsi.proxy.ProxyPolicyHandler;
 
 /**
- *
- * <p/>
  * Refactor to have an interface that retuns trusted certificates, crls,
  * keys and policy. Manage stores within parameters. PKITrustManager can take
  * that interface and the validator can also be agnostic of this implementation

ssl-proxies/src/main/java/org/globus/gsi/gssapi/jaas/JaasSubject.java

@@ -91,7 +91,7 @@ public abstract Object runAs(Subject subject, PrivilegedExceptionAction action)
 
     /**
      * A convenience method, calls
-     * <code>JaasSubject.getJaasSubject().runAs()<code/>.
+     * <code>JaasSubject.getJaasSubject().runAs()</code>.
      */
     public static Object doAs(Subject subject, PrivilegedExceptionAction action)
 	throws PrivilegedActionException {
@@ -100,15 +100,15 @@ public static Object doAs(Subject subject, PrivilegedExceptionAction action)
 
     /**
      * A convenience method, calls
-     * <code>JaasSubject.getJaasSubject().runAs()<code/>.
+     * <code>JaasSubject.getJaasSubject().runAs()</code>.
      */
     public static Object doAs(Subject subject, PrivilegedAction action) {
 	return JaasSubject.getJaasSubject().runAs(subject, action);
     }
 
     /**
      * A convenience method, calls
-     * <code>JaasSubject.getJaasSubject().getSubject()<code/>.
+     * <code>JaasSubject.getJaasSubject().getSubject()</code>.
      */
     public static Subject getCurrentSubject() {
 	return JaasSubject.getJaasSubject().getSubject();

ssl-proxies/src/main/java/org/globus/gsi/proxy/ext/ProxyCertInfo.java

@@ -28,7 +28,7 @@
 
 /**
  * Represents ProxyCertInfo extension. <BR>
- * <p/>
+ * <p>
  * <PRE>
  * ProxyCertInfo ::= SEQUENCE { pCPathLenConstraint      INTEGER (0..MAX) OPTIONAL, proxyPolicy ProxyPolicy }
  * </PRE>

ssl-proxies/src/main/java/org/globus/gsi/stores/PEMKeyStoreParameters.java

@@ -20,7 +20,7 @@
 
 /**
  * This parameter class provides all of the options for creating a FileBasedKeyStore.
- * <p/>
+ * <p>
  * It is immutable.
  *
  * @version ${vesion}