fixing the remaining jdk 8 javadoc errors

Author: lukeis

java/server/src/cybervillains/ca/CertificateCreator.java

@@ -46,6 +46,7 @@ public class CertificateCreator {
    * @throws NoSuchProviderException provider is invalid
    * @throws NoSuchAlgorithmException algorithm exception
    * @throws CertificateException a problem with the certificate
+   * @throws SignatureException signature exception
    * @param keyPair keyPair for the certificate
    * @return a X509 Certificate
    */

java/server/src/cybervillains/ca/KeyStoreManager.java

@@ -489,6 +489,7 @@ public synchronized X509Certificate getCertificateByHostname(final String hostna
    * Gets the authority root signing cert.
    *
    * @throws KeyStoreException keystore
+   * @return certificate
    */
   public synchronized X509Certificate getSigningCert() throws KeyStoreException {
     return _caCert;
@@ -497,7 +498,7 @@ public synchronized X509Certificate getSigningCert() throws KeyStoreException {
   /**
    * Gets the authority private signing key.
    *
-   * @@throws KeyStoreException key store exception
+   * @throws KeyStoreException key store exception
    * @throws UnrecoverableKeyException unrecoverable key
    * @throws NoSuchAlgorithmException no such algorithm
    * @return private key
@@ -519,6 +520,7 @@ public synchronized PrivateKey getSigningPrivateKey() throws KeyStoreException,
    * @throws CertificateException certificate
    * @throws SignatureException signature
    * @throws InvalidKeyException invalid key
+   * @param hostname host name
    * @return mapped certificate
    */
   public X509Certificate getMappedCertificateForHostname(String hostname)
@@ -568,7 +570,7 @@ private synchronized void persistSubjectMap() {
   }
 
   /**
-   * Generate an RSA Key Pair
+   * @return Generated RSA Key Pair
    */
   public KeyPair getRSAKeyPair()
   {

java/server/src/org/openqa/grid/internal/BaseRemoteProxy.java

@@ -103,10 +103,10 @@ public CapabilityMatcher getCapabilityHelper() {
 
 
   /**
-   * Create the proxy from the info sent by the remote. <p/> If maxSession is not specified, default
-   * to 1 = max number of tests running at a given time will be 1. <p/> For each capability,
+   * Create the proxy from the info sent by the remote. <p> If maxSession is not specified, default
+   * to 1 = max number of tests running at a given time will be 1. <p> For each capability,
    * maxInstances is defaulted to 1 if not specified = max number of test of each capability running
-   * at a time will be 1. maxInstances for firefox can be > 1. IE won't support it.
+   * at a time will be 1. maxInstances for firefox can be &gt; 1. IE won't support it.
    *
    * @param request  The request
    * @param registry The registry to use

java/server/src/org/openqa/grid/internal/Registry.java

@@ -186,6 +186,8 @@ public void removeIfPresent(RemoteProxy proxy) {
 
   /**
    * Releases the test slot, WITHOUT running any listener.
+   * @param testSlot test slot to be released
+   * @param reason reason for termination
    */
   public void forceRelease(TestSlot testSlot, SessionTerminationReason reason) {
     if (testSlot.getSession() == null) {
@@ -378,7 +380,7 @@ public void add(RemoteProxy proxy) {
   /**
    * If throwOnCapabilityNotPresent is set to true, the hub will reject test request for a
    * capability that is not on the grid. No exception will be thrown if the capability is present
-   * but busy. <p/> If set to false, the test will be queued hoping a new proxy will register later
+   * but busy. <p> If set to false, the test will be queued hoping a new proxy will register later
    * offering that capability.
    *
    * @param throwOnCapabilityNotPresent true to throw if capability not present

java/server/src/org/openqa/grid/internal/RemoteProxy.java

@@ -30,7 +30,7 @@
 import java.util.Map;
 
 /**
- * Proxy to a remote server executing the tests. <p/> The proxy keeps a state of what is happening
+ * Proxy to a remote server executing the tests. <p> The proxy keeps a state of what is happening
  * on the remote server and knows if a new test can be run on the remote server. There are several
  * reasons why a test could not be run on the specified remote server, for instance: if the
  * RemoteProxy decides the remote server has reached the maximum number of concurrent sessions, or
@@ -163,9 +163,9 @@ public interface RemoteProxy extends Comparable<RemoteProxy> {
 
   /**
    * Checks if the node has the capability requested.
-   * <br /><br />
+   * <br>
    * The definition of "has" is defined by {@link CapabilityMatcher#matches(Map, Map)}
-   * <br /><br />
+   * <br>
    * <code>hasCapability = true</code> doesn't mean the test cast start just now, only that the proxy will be
    * able to run a test requiring that capability at some point.
    *

java/server/src/org/openqa/grid/internal/TestSession.java

@@ -66,7 +66,7 @@
 
 /**
  * Represent a running test for the hub/registry. A test session is created when a TestSlot becomes
- * available for a test. <p/> The session is destroyed when the test ends ( ended by the client or
+ * available for a test. <p> The session is destroyed when the test ends ( ended by the client or
  * timed out)
  */
 @SuppressWarnings("JavaDoc")
@@ -91,7 +91,7 @@ public String getInternalKey() {
     return internalKey;
   }
 
-  /**
+  /*
    * Creates a test session on the specified testSlot.
    */
   public TestSession(TestSlot slot, Map<String, Object> requestedCapabilities,
@@ -104,7 +104,7 @@ public TestSession(TestSlot slot, Map<String, Object> requestedCapabilities,
   }
 
   /**
-   * the capabilities the client requested. It will match the TestSlot capabilities, but is not
+   * @return the capabilities the client requested. It will match the TestSlot capabilities, but is not
    * equals.
    */
   public Map<String, Object> getRequestedCapabilities() {
@@ -123,6 +123,7 @@ public ExternalSessionKey getExternalKey() {
 
   /**
    * associate this session to the session provided by the remote.
+   * @param externalKey external session key
    */
   public void setExternalKey(ExternalSessionKey externalKey) {
     this.externalKey = externalKey;
@@ -203,7 +204,7 @@ private HttpClient getClient() {
     return slot.getProxy().getHttpClientFactory().getGridHttpClient(browserTimeout, browserTimeout);
   }
 
-  /**
+  /*
    * forwards the request to the node.
    */
   public String forward(SeleniumBasedRequest request, HttpServletResponse response,
@@ -508,6 +509,7 @@ private void processResponseHeaders(HttpServletRequest request, HttpServletRespo
   /**
    * Allow you to retrieve an object previously stored on the test session.
    *
+   * @param key key
    * @return the object you stored
    */
   public Object get(String key) {
@@ -518,6 +520,7 @@ public Object get(String key) {
    * Allows you to store an object on the test session.
    *
    * @param key a non-null string
+   * @param value value object
    */
   public void put(String key, Object value) {
     objects.put(key, value);
@@ -574,8 +577,10 @@ public boolean sendDeleteSessionRequest() {
 
 
   /**
-   * allow to bypass time out for this session. ignore = true => the session will not time out.
+   * allow to bypass time out for this session. ignore = true =&gt; the session will not time out.
    * setIgnoreTimeout(true) also update the lastActivity to now.
+   *
+   * @param ignore true to ignore the timeout
    */
   public void setIgnoreTimeout(boolean ignore) {
     if (!ignore) {

java/server/src/org/openqa/grid/internal/TestSlot.java

@@ -37,7 +37,7 @@
  * The entity on a proxy that can host a test session. A test slot has only 1 desired capabilities (
  * firefox or chrome for instance, but if a remoteproxy needs to support both, the remoteproxy will
  * need 2 TestSlots ) A TestSlot can host 1 TestSession max at a time.
- * <p/>
+ * <p>
  * The listener ({@link TestSessionListener} attached to the test session of this test slot is
  * thread safe. If 2 threads are trying to execute the before / after session, only 1 will be
  * executed.The other one will be discarded.
@@ -93,7 +93,7 @@ public RemoteProxy getProxy() {
    * Try to get a new session for the test slot for the desired capability. To define if the
    * test slot can host the desired capabilities, {@link CapabilityMatcher#matches(Map, Map)} is
    * invoked.
-   * <p/>
+   * <p>
    * Use {@link GridHubConfiguration#setCapabilityMatcher(CapabilityMatcher)}
    * on the proxy hosting the test slot to modify the definition of match
    *
@@ -164,7 +164,7 @@ public TestSession getSession() {
    * Starts the release process for the TestSlot. Once the release process has started, the clients
    * can't access the test slot any more, but the slot can't be reserved for another test until
    * finishReleaseProcess is called.
-   * <p/>
+   * <p>
    * That gives time to run exactly once the cleanup operation needed using @see
    * {@link TestSessionListener#afterSession(TestSession)}
    *

java/server/src/org/openqa/grid/internal/listeners/CommandListener.java

@@ -30,7 +30,7 @@ public interface CommandListener {
   /**
    * Executed before the hub forwards the request. reading the content of the request stream will
    * prevent the content from being forwarded.
-   * <p/>
+   * <p>
    * Throwing an exception will prevent the forward to the remote.
    *
    * @param session session
@@ -42,7 +42,7 @@ public void beforeCommand(TestSession session, HttpServletRequest request,
 
   /**
    * Executed just before the forwards returns.
-   * <p/>
+   * <p>
    * Throwing an exception will result in an error for the client.
    *
    * @param session session

java/server/src/org/openqa/grid/internal/listeners/Prioritizer.java

@@ -22,10 +22,10 @@
 public interface Prioritizer {
 
   /**
-   * priority of a is lower than b : compare(a,b) > 0
-   * <p/>
-   * priority of b is lower than a : compare(a,b) < 0
-   * <p/>
+   * priority of a is lower than b : compare(a,b) &gt; 0
+   * <p>
+   * priority of b is lower than a : compare(a,b) &lt; 0
+   * <p>
    * a and b have the same priority : compare(a,b) = 0
    *
    * @param a first item

java/server/src/org/openqa/grid/internal/listeners/RegistrationListener.java

@@ -25,8 +25,7 @@ public interface RegistrationListener {
   /**
    * Will be run before the proxy you register is added to the Registry, letting you run the
    * configuration / validation necessary before the proxy becomes accessible to the clients.
-   * <p/>
-   * <p/>
+   * <p>
    * If an exception is thrown, the proxy won't be registered.
    */
   public void beforeRegistration();