From 6ecfb96508df39578c65a41f5104fb174d05e9ac Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Wed, 22 Apr 2015 17:18:05 -0700 Subject: [PATCH] 464727 - Update Javadoc for Java 8 DocLint --- .../eclipse/jetty/deploy/AppLifeCycle.java | 4 +- .../org/eclipse/jetty/deploy/AppProvider.java | 6 +- .../jetty/deploy/DeploymentManager.java | 4 +- .../jaspi/JaspiAuthenticatorFactory.java | 5 ++ .../security/jaspi/JaspiMessageInfo.java | 3 - .../jaspi/ServletCallbackHandler.java | 3 - .../security/jaspi/SimpleAuthConfig.java | 3 - .../jaspi/modules/BaseAuthModule.java | 3 - .../jaspi/modules/BasicAuthModule.java | 5 +- .../jaspi/modules/ClientCertAuthModule.java | 5 +- .../jaspi/modules/DigestAuthModule.java | 9 +-- .../jaspi/modules/FormAuthModule.java | 5 +- .../security/jaspi/modules/UserInfo.java | 3 - jetty-jspc-maven-plugin/pom.xml | 64 ++++++++++++++++++- .../eclipse/jetty/jspc/plugin/JspcMojo.java | 16 ++--- 15 files changed, 83 insertions(+), 55 deletions(-) diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java index 3e079b1fd73..80a9280a037 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java @@ -32,11 +32,11 @@ import org.eclipse.jetty.util.log.Logger; /** * The lifecycle of an App in the {@link DeploymentManager}. - * + *

* Setups a the default {@link Graph}, and manages the bindings to the life cycle via the {@link AppLifeCycle.Binding} * annotation. *

- * + * app lifecycle graph */ public class AppLifeCycle extends Graph { diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppProvider.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppProvider.java index b4097b2a382..ca151c9ae45 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppProvider.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppProvider.java @@ -31,7 +31,7 @@ public interface AppProvider extends LifeCycle /** * Set the Deployment Manager * - * @param deploymentManager + * @param deploymentManager the deployment manager * @throws IllegalStateException * if the provider {@link #isRunning()}. */ @@ -41,8 +41,8 @@ public interface AppProvider extends LifeCycle /** Create a ContextHandler for an App * @param app The App * @return A ContextHandler - * @throws IOException - * @throws Exception + * @throws IOException if unable to create context + * @throws Exception if unable to create context */ ContextHandler createContextHandler(App app) throws Exception; } diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java index 43bbaf30f54..6135284d98f 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java @@ -51,14 +51,14 @@ import org.eclipse.jetty.util.log.Logger; *

* Responsibilities: *

- * + * deployment manager roles graph *

    *
  1. Tracking Apps and their LifeCycle Location
    2. *
  2. Managing AppProviders and the Apps that they provide.
    3. *
  3. Executing AppLifeCycle on App based on current and desired LifeCycle Location.
    4. *
*

- * + * deployment manager graph */ @ManagedObject("Deployment Manager") public class DeploymentManager extends ContainerLifeCycle diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.java index 0e35e995bfe..9cb280b4f62 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.java @@ -135,6 +135,8 @@ public class JaspiAuthenticatorFactory extends DefaultAuthenticatorFactory * If {@link #setServiceSubject(Subject)} has not been used to * set a subject, then the {@link Server#getBeans(Class)} method is * used to look for a Subject. + * @param server the server to pull the Subject from + * @return the subject */ protected Subject findServiceSubject(Server server) { @@ -151,6 +153,9 @@ public class JaspiAuthenticatorFactory extends DefaultAuthenticatorFactory * If {@link #setServerName(String)} has not been called, then * use the name of the a principal in the service subject. * If not found, return "server". + * @param server not used + * @param subject the subject to use + * @return the server name from the subject (or default value if not found in subject or principals) */ protected String findServerName(Server server, Subject subject) { diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiMessageInfo.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiMessageInfo.java index e0ae5b1dab4..43f6d8b04bc 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiMessageInfo.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/JaspiMessageInfo.java @@ -27,11 +27,8 @@ import javax.security.auth.message.MessageInfo; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; - /** * Almost an implementation of jaspi MessageInfo. - * - * @version $Rev: 4660 $ $Date: 2009-02-25 17:29:53 +0100 (Wed, 25 Feb 2009) $ */ public class JaspiMessageInfo implements MessageInfo { diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java index c47a3743f15..fa079647b04 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java @@ -39,10 +39,7 @@ import org.eclipse.jetty.security.jaspi.callback.CredentialValidationCallback; import org.eclipse.jetty.server.UserIdentity; /** - * * Idiot class required by jaspi stupidity - * - * @version $Rev: 4793 $ $Date: 2009-03-19 00:00:01 +0100 (Thu, 19 Mar 2009) $ */ public class ServletCallbackHandler implements CallbackHandler { diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/SimpleAuthConfig.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/SimpleAuthConfig.java index 49b1f6d88b6..864a3e0e328 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/SimpleAuthConfig.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/SimpleAuthConfig.java @@ -26,9 +26,6 @@ import javax.security.auth.message.MessageInfo; import javax.security.auth.message.config.ServerAuthConfig; import javax.security.auth.message.config.ServerAuthContext; -/** - * @version $Rev: 4660 $ $Date: 2009-02-25 17:29:53 +0100 (Wed, 25 Feb 2009) $ - */ public class SimpleAuthConfig implements ServerAuthConfig { public static final String HTTP_SERVLET = "HttpServlet"; diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.java index 3de4e334201..f223d5ab1b6 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.java @@ -45,9 +45,6 @@ import org.eclipse.jetty.util.B64Code; import org.eclipse.jetty.util.security.Credential; import org.eclipse.jetty.util.security.Password; -/** - * @version $Rev: 4792 $ $Date: 2009-03-18 22:55:52 +0100 (Wed, 18 Mar 2009) $ - */ public class BaseAuthModule implements ServerAuthModule, ServerAuthContext { private static final Class[] SUPPORTED_MESSAGE_TYPES = new Class[] { HttpServletRequest.class, HttpServletResponse.class }; diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.java index 482183394d4..dbe28c3c828 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.java @@ -36,10 +36,7 @@ import org.eclipse.jetty.util.log.Log; import org.eclipse.jetty.util.log.Logger; import org.eclipse.jetty.util.security.Constraint; -/** - * @deprecated use *ServerAuthentication - * @version $Rev: 4660 $ $Date: 2009-02-25 17:29:53 +0100 (Wed, 25 Feb 2009) $ - */ +@Deprecated public class BasicAuthModule extends BaseAuthModule { private static final Logger LOG = Log.getLogger(BasicAuthModule.class); diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/ClientCertAuthModule.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/ClientCertAuthModule.java index 94dc89cb2c8..f046d0c527d 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/ClientCertAuthModule.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/ClientCertAuthModule.java @@ -34,10 +34,7 @@ import org.eclipse.jetty.util.B64Code; import org.eclipse.jetty.util.security.Constraint; import org.eclipse.jetty.util.security.Password; -/** - * @deprecated use *ServerAuthentication - * @version $Rev: 4530 $ $Date: 2009-02-13 00:47:44 +0100 (Fri, 13 Feb 2009) $ - */ +@Deprecated public class ClientCertAuthModule extends BaseAuthModule { diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/DigestAuthModule.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/DigestAuthModule.java index 800cbc96837..b3b12291935 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/DigestAuthModule.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/DigestAuthModule.java @@ -42,15 +42,11 @@ import org.eclipse.jetty.util.log.Logger; import org.eclipse.jetty.util.security.Constraint; import org.eclipse.jetty.util.security.Credential; -/** - * @deprecated use *ServerAuthentication - * @version $Rev: 4627 $ $Date: 2009-02-20 00:07:19 +0100 (Fri, 20 Feb 2009) $ - */ +@Deprecated public class DigestAuthModule extends BaseAuthModule { private static final Logger LOG = Log.getLogger(DigestAuthModule.class); - protected long maxNonceAge = 0; protected long nonceSecret = this.hashCode() ^ System.currentTimeMillis(); @@ -213,11 +209,10 @@ public class DigestAuthModule extends BaseAuthModule } /** - * @param nonce + * @param nonce the nonce * @param timestamp should be timestamp of request. * @return -1 for a bad nonce, 0 for a stale none, 1 for a good nonce */ - /* ------------------------------------------------------------ */ public int checkNonce(String nonce, long timestamp) { try diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/FormAuthModule.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/FormAuthModule.java index c87c9498109..4c5678c40f3 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/FormAuthModule.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/FormAuthModule.java @@ -44,10 +44,7 @@ import org.eclipse.jetty.util.log.Logger; import org.eclipse.jetty.util.security.Constraint; import org.eclipse.jetty.util.security.Password; -/** - * @deprecated use *ServerAuthentication - * @version $Rev: 4792 $ $Date: 2009-03-18 22:55:52 +0100 (Wed, 18 Mar 2009) $ - */ +@Deprecated public class FormAuthModule extends BaseAuthModule { private static final Logger LOG = Log.getLogger(FormAuthModule.class); diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/UserInfo.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/UserInfo.java index 3cbdf968bac..de555d375a2 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/UserInfo.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/modules/UserInfo.java @@ -20,9 +20,6 @@ package org.eclipse.jetty.security.jaspi.modules; import java.util.Arrays; -/** - * @version $Rev: 4466 $ $Date: 2009-02-10 23:42:54 +0100 (Tue, 10 Feb 2009) $ - */ public class UserInfo { private final String userName; diff --git a/jetty-jspc-maven-plugin/pom.xml b/jetty-jspc-maven-plugin/pom.xml index 853f6f59d83..deb7481d752 100644 --- a/jetty-jspc-maven-plugin/pom.xml +++ b/jetty-jspc-maven-plugin/pom.xml @@ -14,25 +14,85 @@ + org.apache.maven.plugins maven-surefire-plugin true + org.apache.maven.plugins maven-plugin-plugin - 2.9 + 3.4 exec-plugin-doc generate-sources - xdoc + descriptor helpmojo + + org.apache.maven.plugins + maven-javadoc-plugin + + + + phase + t + Phase: + + + goal + t + Goal: + + + description + a + Description: + + + parameter + f + Parameter: + + + required + f + Required: + + + readonly + f + Read-Only: + + + execute + X + + + + requiresDependencyResolution + X + + + + requiresProject + X + + + + threadSafe + X + + + + + diff --git a/jetty-jspc-maven-plugin/src/main/java/org/eclipse/jetty/jspc/plugin/JspcMojo.java b/jetty-jspc-maven-plugin/src/main/java/org/eclipse/jetty/jspc/plugin/JspcMojo.java index dd7d614c492..5083898baa8 100644 --- a/jetty-jspc-maven-plugin/src/main/java/org/eclipse/jetty/jspc/plugin/JspcMojo.java +++ b/jetty-jspc-maven-plugin/src/main/java/org/eclipse/jetty/jspc/plugin/JspcMojo.java @@ -51,29 +51,21 @@ import org.eclipse.jetty.util.PatternMatcher; import org.eclipse.jetty.util.resource.Resource; /** - *

* This goal will compile jsps for a webapp so that they can be included in a * war. - *

*

* At runtime, the plugin will use the jsp2.0 jspc compiler if you are running * on a 1.4 or lower jvm. If you are using a 1.5 jvm, then the jsp2.1 compiler * will be selected. (this is the same behaviour as the jetty plugin for executing + * href="https://www.eclipse.org/jetty/documentation/current/maven-and-jetty.html">jetty plugin for executing * webapps). - *

*

* Note that the same java compiler will be used as for on-the-fly compiled * jsps, which will be the Eclipse java compiler. - *

- * *

* See Usage + * href="https://www.eclipse.org/jetty/documentation/current/jetty-jspc-maven-plugin.html">Usage * Guide for instructions on using this plugin. - *

- * - * @author janb * * @goal jspc * @phase process-classes @@ -387,7 +379,7 @@ public class JspcMojo extends AbstractMojo * Until Jasper supports the option to generate the srcs in a different dir * than the classes, this is the best we can do. * - * @throws Exception + * @throws Exception if unable to clean srcs */ public void cleanupSrcs() throws Exception { @@ -433,7 +425,7 @@ public class JspcMojo extends AbstractMojo * If you dont specify the insertionMarker, then the fragment will be * inserted at the end of the file just before the </webapp> * - * @throws Exception + * @throws Exception if unable to merge the web xml */ public void mergeWebXml() throws Exception {