Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

464727 - Update Javadoc for Java 8 DocLint

This commit is contained in:
Joakim Erdfelt 2015-04-22 16:54:50 -07:00
parent 18a1096412
commit 4db2784354
18 changed files with 104 additions and 348 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
jetty-maven-plugin/pom.xml
View File

@ -21,6 +21,49 @@
<skip>true</skip> <skip>true</skip>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<tags>
<tag>
<name>goal</name>
<placement>t</placement>
<head>Goal:</head>
</tag>
<tag>
<name>description</name>
<placement>a</placement>
<head>Description:</head>
</tag>
<tag>
<name>parameter</name>
<placement>f</placement>
<head>Parameter:</head>
</tag>
<tag>
<name>required</name>
<placement>f</placement>
<head>Required:</head>
</tag>
<tag>
<name>readonly</name>
<placement>f</placement>
<head>Read-Only:</head>
</tag>
<tag>
<name>execute</name>
<placement>X</placement>
<head />
</tag>
<tag>
<name>requiresDependencyResolution</name>
<placement>X</placement>
<head />
</tag>
</tags>
</configuration>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId> <artifactId>maven-plugin-plugin</artifactId>

90
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java
View File

@ -18,7 +18,6 @@
package org.eclipse.jetty.maven.plugin; package org.eclipse.jetty.maven.plugin;
import java.io.File; import java.io.File;
import java.io.FileInputStream; import java.io.FileInputStream;
import java.io.InputStream; import java.io.InputStream;
@ -50,19 +49,11 @@ import org.eclipse.jetty.util.Scanner;
import org.eclipse.jetty.util.resource.Resource; import org.eclipse.jetty.util.resource.Resource;
import org.eclipse.jetty.xml.XmlConfiguration; import org.eclipse.jetty.xml.XmlConfiguration;
/** /**
* AbstractJettyMojo
*
* Common base class for most jetty mojos. * Common base class for most jetty mojos.
*
*
*/ */
public abstract class AbstractJettyMojo extends AbstractMojo public abstract class AbstractJettyMojo extends AbstractMojo
{ {
/** /**
* Whether or not to include dependencies on the plugin's classpath with &lt;scope&gt;provided&lt;/scope&gt; * Whether or not to include dependencies on the plugin's classpath with &lt;scope&gt;provided&lt;/scope&gt;
* Use WITH CAUTION as you may wind up with duplicate jars/classes. * Use WITH CAUTION as you may wind up with duplicate jars/classes.
@ -72,7 +63,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected boolean useProvidedScope; protected boolean useProvidedScope;
/** /**
* List of goals that are NOT to be used * List of goals that are NOT to be used
* *
@ -81,9 +71,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected String[] excludedGoals; protected String[] excludedGoals;
/** /**
* List of other contexts to set up. Consider using instead * List of other contexts to set up. Consider using instead
* the &lt;jettyXml&gt; element to specify external jetty xml config file. * the &lt;jettyXml&gt; element to specify external jetty xml config file.
@ -94,7 +81,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected ContextHandler[] contextHandlers; protected ContextHandler[] contextHandlers;
/** /**
* List of security realms to set up. Consider using instead * List of security realms to set up. Consider using instead
* the &lt;jettyXml&gt; element to specify external jetty xml config file. * the &lt;jettyXml&gt; element to specify external jetty xml config file.
@ -105,7 +91,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected LoginService[] loginServices; protected LoginService[] loginServices;
/** /**
* A RequestLog implementation to use for the webapp at runtime. * A RequestLog implementation to use for the webapp at runtime.
* Consider using instead the &lt;jettyXml&gt; element to specify external jetty xml config file. * Consider using instead the &lt;jettyXml&gt; element to specify external jetty xml config file.
@ -116,7 +101,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected RequestLog requestLog; protected RequestLog requestLog;
/** /**
* An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp. * An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp.
* Use any of its setters to configure the webapp. This is the preferred and most * Use any of its setters to configure the webapp. This is the preferred and most
@ -127,7 +111,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected JettyWebAppContext webApp; protected JettyWebAppContext webApp;
/** /**
* The interval in seconds to scan the webapp for changes * The interval in seconds to scan the webapp for changes
* and restart the context if necessary. Ignored if reload * and restart the context if necessary. Ignored if reload
@ -138,7 +121,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
*/ */
protected int scanIntervalSeconds; protected int scanIntervalSeconds;
/** /**
* reload can be set to either 'automatic' or 'manual' * reload can be set to either 'automatic' or 'manual'
* *
@ -208,8 +190,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
protected boolean dumpOnStart; protected boolean dumpOnStart;
/** /**
* Skip this mojo execution. * Skip this mojo execution.
* *
@ -361,9 +341,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
/**
* @throws MojoExecutionException
*/
public void configurePluginClasspath() throws MojoExecutionException public void configurePluginClasspath() throws MojoExecutionException
{ {
//if we are configured to include the provided dependencies on the plugin's classpath //if we are configured to include the provided dependencies on the plugin's classpath
@ -403,13 +380,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
} }
} }
/**
* @param artifact
* @return
*/
public boolean isPluginArtifact(Artifact artifact) public boolean isPluginArtifact(Artifact artifact)
{ {
if (pluginArtifacts == null || pluginArtifacts.isEmpty()) if (pluginArtifacts == null || pluginArtifacts.isEmpty())
@ -427,12 +397,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
return isPluginArtifact; return isPluginArtifact;
} }
/**
* @throws Exception
*/
public void finishConfigurationBeforeStart() throws Exception public void finishConfigurationBeforeStart() throws Exception
{ {
HandlerCollection contexts = (HandlerCollection)server.getChildHandlerByClass(ContextHandlerCollection.class); HandlerCollection contexts = (HandlerCollection)server.getChildHandlerByClass(ContextHandlerCollection.class);
@ -445,12 +409,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
} }
} }
/**
* @throws Exception
*/
public void applyJettyXml() throws Exception public void applyJettyXml() throws Exception
{ {
Server tmp = ServerSupport.applyXmlConfigurations(server, getJettyXmlFiles()); Server tmp = ServerSupport.applyXmlConfigurations(server, getJettyXmlFiles());
@ -461,12 +419,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
server = new Server(); server = new Server();
} }
/**
* @throws MojoExecutionException
*/
public void startJetty () throws MojoExecutionException public void startJetty () throws MojoExecutionException
{ {
try try
@ -568,7 +520,7 @@ public abstract class AbstractJettyMojo extends AbstractMojo
* Subclasses should invoke this to setup basic info * Subclasses should invoke this to setup basic info
* on the webapp * on the webapp
* *
* @throws MojoExecutionException * @throws Exception if unable to configure web application
*/ */
public void configureWebApplication () throws Exception public void configureWebApplication () throws Exception
{ {
@ -651,6 +603,7 @@ public abstract class AbstractJettyMojo extends AbstractMojo
/** /**
* Run a thread that monitors the console input to detect ENTER hits. * Run a thread that monitors the console input to detect ENTER hits.
* @throws Exception if unable to start the console
*/ */
protected void startConsoleScanner() throws Exception protected void startConsoleScanner() throws Exception
{ {
@ -662,12 +615,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
} }
} }
/**
*
*/
protected void printSystemProperties () protected void printSystemProperties ()
{ {
// print out which system properties were set up // print out which system properties were set up
@ -685,13 +632,10 @@ public abstract class AbstractJettyMojo extends AbstractMojo
} }
} }
/** /**
* Try and find a jetty-web.xml file, using some * Try and find a jetty-web.xml file, using some
* historical naming conventions if necessary. * historical naming conventions if necessary.
* @param webInfDir * @param webInfDir the web inf directory
* @return the jetty web xml file * @return the jetty web xml file
*/ */
public File findJettyWebXmlFile (File webInfDir) public File findJettyWebXmlFile (File webInfDir)
@ -713,13 +657,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
return null; return null;
} }
/**
* @param file
* @throws Exception
*/
public void setSystemPropertiesFile(File file) throws Exception public void setSystemPropertiesFile(File file) throws Exception
{ {
this.systemPropertiesFile = file; this.systemPropertiesFile = file;
@ -745,12 +682,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
} }
} }
/**
* @param systemProperties
*/
public void setSystemProperties(SystemProperties systemProperties) public void setSystemProperties(SystemProperties systemProperties)
{ {
if (this.systemProperties == null) if (this.systemProperties == null)
@ -764,15 +695,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
} }
} }
/**
* @return
*/
public List<File> getJettyXmlFiles() public List<File> getJettyXmlFiles()
{ {
if ( this.jettyXml == null ) if ( this.jettyXml == null )
@ -799,12 +721,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo
return jettyXmlFiles; return jettyXmlFiles;
} }
/**
* @param goal
* @return
*/
public boolean isExcluded (String goal) public boolean isExcluded (String goal)
{ {
if (excludedGoals == null || goal == null) if (excludedGoals == null || goal == null)

38
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ConsoleScanner.java
View File

@ -20,9 +20,6 @@ package org.eclipse.jetty.maven.plugin;
import java.io.IOException; import java.io.IOException;
/** /**
* ConsoleScanner * ConsoleScanner
* *
@ -30,16 +27,8 @@ import java.io.IOException;
*/ */
public class ConsoleScanner extends Thread public class ConsoleScanner extends Thread
{ {
private final AbstractJettyMojo mojo; private final AbstractJettyMojo mojo;
/**
* @param mojo
*/
public ConsoleScanner(AbstractJettyMojo mojo) public ConsoleScanner(AbstractJettyMojo mojo)
{ {
this.mojo = mojo; this.mojo = mojo;
@ -47,12 +36,6 @@ public class ConsoleScanner extends Thread
setDaemon(true); setDaemon(true);
} }
/**
* @see java.lang.Thread#run()
*/
public void run() public void run()
{ {
try try
@ -69,12 +52,6 @@ public class ConsoleScanner extends Thread
} }
} }
/**
*
*/
private void getSomeSleep() private void getSomeSleep()
{ {
try try
@ -87,12 +64,6 @@ public class ConsoleScanner extends Thread
} }
} }
/**
* @throws IOException
*/
private void checkSystemInput() throws IOException private void checkSystemInput() throws IOException
{ {
while (System.in.available() > 0) { while (System.in.available() > 0) {
@ -107,9 +78,6 @@ public class ConsoleScanner extends Thread
} }
} }
/** /**
* Skip buffered bytes of system console. * Skip buffered bytes of system console.
*/ */
@ -136,12 +104,6 @@ public class ConsoleScanner extends Thread
} }
} }
/**
*
*/
private void restartWebApp() private void restartWebApp()
{ {
try try

104
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunForkedMojo.java
View File

@ -53,25 +53,20 @@ import org.eclipse.jetty.util.thread.QueuedThreadPool;
/** /**
* This goal is used to deploy your unassembled webapp into a forked JVM.
* <p> * <p>
* This goal is used to deploy your unassembled webapp into a forked JVM. * You need to define a jetty.xml file to configure connectors etc. You can use the normal setters of o.e.j.webapp.WebAppContext on the <b>webApp</b>
* </p> * configuration element for this plugin. You may also need context xml file for any particularly complex webapp setup.
* <p> * about your webapp.
* You need to define a jetty.xml file to configure connectors etc. You can use the normal setters of o.e.j.webapp.WebAppContext on the <b>webApp</b> * <p>
* configuration element for this plugin. You may also need context xml file for any particularly complex webapp setup. * Unlike the other jetty goals, this does NOT support the <b>scanIntervalSeconds</b> parameter: the webapp will be deployed only once.
* about your webapp. * <p>
* </p> * The <b>stopKey</b>, <b>stopPort</b> configuration elements can be used to control the stopping of the forked process. By default, this plugin will launch
* <p> * the forked jetty instance and wait for it to complete (in which case it acts much like the <b>jetty:run</b> goal, and you will need to Cntrl-C to stop).
* Unlike the other jetty goals, this does NOT support the <b>scanIntervalSeconds</b> parameter: the webapp will be deployed only once. * By setting the configuration element <b>waitForChild</b> to <b>false</b>, the plugin will terminate after having forked the jetty process. In this case
* </p> * you can use the <b>jetty:stop</b> goal to terminate the process.
* <p> * <p>
* The <b>stopKey</b>, <b>stopPort</b> configuration elements can be used to control the stopping of the forked process. By default, this plugin will launch * See <a href="http://www.eclipse.org/jetty/documentation/">http://www.eclipse.org/jetty/documentation</a> for more information on this and other jetty plugins.
* the forked jetty instance and wait for it to complete (in which case it acts much like the <b>jetty:run</b> goal, and you will need to Cntrl-C to stop).
* By setting the configuration element <b>waitForChild</b> to <b>false</b>, the plugin will terminate after having forked the jetty process. In this case
* you can use the <b>jetty:stop</b> goal to terminate the process.
* <p>
* See <a href="http://www.eclipse.org/jetty/documentation/">http://www.eclipse.org/jetty/documentation</a> for more information on this and other jetty plugins.
* </p>
* *
* @goal run-forked * @goal run-forked
* @requiresDependencyResolution test * @requiresDependencyResolution test
@ -415,13 +410,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
} }
} }
/**
* @return
* @throws MojoExecutionException
*/
public List<String> getProvidedJars() throws MojoExecutionException public List<String> getProvidedJars() throws MojoExecutionException
{ {
//if we are configured to include the provided dependencies on the plugin's classpath //if we are configured to include the provided dependencies on the plugin's classpath
@ -448,13 +436,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
return null; return null;
} }
/**
* @return
* @throws MojoExecutionException
*/
public File prepareConfiguration() throws MojoExecutionException public File prepareConfiguration() throws MojoExecutionException
{ {
try try
@ -602,15 +583,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
return warArtifacts; return warArtifacts;
} }
/**
* @param artifact
* @return
*/
public boolean isPluginArtifact(Artifact artifact) public boolean isPluginArtifact(Artifact artifact)
{ {
if (pluginArtifacts == null || pluginArtifacts.isEmpty()) if (pluginArtifacts == null || pluginArtifacts.isEmpty())
@ -628,13 +600,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
return isPluginArtifact; return isPluginArtifact;
} }
/**
* @return
* @throws Exception
*/
private Set<Artifact> getExtraJars() private Set<Artifact> getExtraJars()
throws Exception throws Exception
{ {
@ -660,15 +625,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
return extraJars; return extraJars;
} }
/**
* @return
* @throws Exception
*/
public String getContainerClassPath() throws Exception public String getContainerClassPath() throws Exception
{ {
StringBuilder classPath = new StringBuilder(); StringBuilder classPath = new StringBuilder();
@ -734,13 +690,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
return "java"; return "java";
} }
/**
* @param path
* @return
*/
public static String fileSeparators(String path) public static String fileSeparators(String path)
{ {
StringBuilder ret = new StringBuilder(); StringBuilder ret = new StringBuilder();
@ -758,13 +707,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
return ret.toString(); return ret.toString();
} }
/**
* @param path
* @return
*/
public static String pathSeparators(String path) public static String pathSeparators(String path)
{ {
StringBuilder ret = new StringBuilder(); StringBuilder ret = new StringBuilder();
@ -782,24 +724,11 @@ public class JettyRunForkedMojo extends JettyRunMojo
return ret.toString(); return ret.toString();
} }
/**
* @return
*/
private String createToken () private String createToken ()
{ {
return Long.toString(random.nextLong()^System.currentTimeMillis(), 36).toUpperCase(Locale.ENGLISH); return Long.toString(random.nextLong()^System.currentTimeMillis(), 36).toUpperCase(Locale.ENGLISH);
} }
/**
* @param mode
* @param inputStream
*/
private void startPump(String mode, InputStream inputStream) private void startPump(String mode, InputStream inputStream)
{ {
ConsoleStreamer pump = new ConsoleStreamer(mode,inputStream); ConsoleStreamer pump = new ConsoleStreamer(mode,inputStream);
@ -808,13 +737,6 @@ public class JettyRunForkedMojo extends JettyRunMojo
thread.start(); thread.start();
} }
/**
* @param strings
* @return
*/
private String toCSV (List<String> strings) private String toCSV (List<String> strings)
{ {
if (strings == null) if (strings == null)

15
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunMojo.java
View File

@ -36,28 +36,22 @@ import org.eclipse.jetty.util.Scanner;
import org.eclipse.jetty.util.resource.Resource; import org.eclipse.jetty.util.resource.Resource;
import org.eclipse.jetty.webapp.WebAppContext; import org.eclipse.jetty.webapp.WebAppContext;
/** /**
* <p>
* This goal is used in-situ on a Maven project without first requiring that the project * This goal is used in-situ on a Maven project without first requiring that the project
* is assembled into a war, saving time during the development cycle. * is assembled into a war, saving time during the development cycle.
* <p>
* The plugin forks a parallel lifecycle to ensure that the "compile" phase has been completed before invoking Jetty. This means * The plugin forks a parallel lifecycle to ensure that the "compile" phase has been completed before invoking Jetty. This means
* that you do not need to explicity execute a "mvn compile" first. It also means that a "mvn clean jetty:run" will ensure that * that you do not need to explicity execute a "mvn compile" first. It also means that a "mvn clean jetty:run" will ensure that
* a full fresh compile is done before invoking Jetty. * a full fresh compile is done before invoking Jetty.
* </p>
* <p> * <p>
* Once invoked, the plugin can be configured to run continuously, scanning for changes in the project and automatically performing a * Once invoked, the plugin can be configured to run continuously, scanning for changes in the project and automatically performing a
* hot redeploy when necessary. This allows the developer to concentrate on coding changes to the project using their IDE of choice and have those changes * hot redeploy when necessary. This allows the developer to concentrate on coding changes to the project using their IDE of choice and have those changes
* immediately and transparently reflected in the running web container, eliminating development time that is wasted on rebuilding, reassembling and redeploying. * immediately and transparently reflected in the running web container, eliminating development time that is wasted on rebuilding, reassembling and redeploying.
* </p>
* <p> * <p>
* You may also specify the location of a jetty.xml file whose contents will be applied before any plugin configuration. * You may also specify the location of a jetty.xml file whose contents will be applied before any plugin configuration.
* This can be used, for example, to deploy a static webapp that is not part of your maven build. * This can be used, for example, to deploy a static webapp that is not part of your maven build.
* </p>
* <p> * <p>
* There is a <a href="http://www.eclipse.org/jetty/documentation/current/maven-and-jetty.html">reference guide</a> to the configuration parameters for this plugin. * There is a <a href="http://www.eclipse.org/jetty/documentation/current/maven-and-jetty.html">reference guide</a> to the configuration parameters for this plugin.
* </p>
*
* *
* @goal run * @goal run
* @requiresDependencyResolution test * @requiresDependencyResolution test
@ -605,13 +599,6 @@ public class JettyRunMojo extends AbstractJettyMojo
return warArtifacts; return warArtifacts;
} }
/**
* @param o
* @param warArtifacts
* @return
*/
protected Artifact getArtifactForOverlay (OverlayConfig o, List<Artifact> warArtifacts) protected Artifact getArtifactForOverlay (OverlayConfig o, List<Artifact> warArtifacts)
{ {
if (o == null || warArtifacts == null || warArtifacts.isEmpty()) if (o == null || warArtifacts == null || warArtifacts.isEmpty())

3
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyWebAppContext.java
View File

@ -21,7 +21,6 @@ package org.eclipse.jetty.maven.plugin;
import java.io.File; import java.io.File;
import java.io.FileOutputStream; import java.io.FileOutputStream;
import java.io.IOException; import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.net.MalformedURLException; import java.net.MalformedURLException;
import java.util.ArrayList; import java.util.ArrayList;
@ -207,7 +206,7 @@ public class JettyWebAppContext extends WebAppContext
/** /**
* Ordered list of wars to overlay on top of the current project. The list * Ordered list of wars to overlay on top of the current project. The list
* may contain an overlay that represents the current project. * may contain an overlay that represents the current project.
* @param overlays * @param overlays the list of overlays
*/ */
public void setOverlays (List<Overlay> overlays) public void setOverlays (List<Overlay> overlays)
{ {

8
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/MavenWebInfConfiguration.java
View File

@ -40,8 +40,7 @@ import org.eclipse.jetty.webapp.WebInfConfiguration;
* MavenWebInfConfiguration * MavenWebInfConfiguration
* *
* WebInfConfiguration to take account of overlaid wars expressed as project dependencies and * WebInfConfiguration to take account of overlaid wars expressed as project dependencies and
* potentiall configured via the maven-war-plugin. * potential configured via the maven-war-plugin.
*
*/ */
public class MavenWebInfConfiguration extends WebInfConfiguration public class MavenWebInfConfiguration extends WebInfConfiguration
{ {
@ -52,9 +51,6 @@ public class MavenWebInfConfiguration extends WebInfConfiguration
protected Resource _originalResourceBase; protected Resource _originalResourceBase;
protected List<Resource> _unpackedOverlayResources; protected List<Resource> _unpackedOverlayResources;
/** /**
* @see org.eclipse.jetty.webapp.WebInfConfiguration#configure(org.eclipse.jetty.webapp.WebAppContext) * @see org.eclipse.jetty.webapp.WebInfConfiguration#configure(org.eclipse.jetty.webapp.WebAppContext)
*/ */
@ -204,7 +200,7 @@ public class MavenWebInfConfiguration extends WebInfConfiguration
* Get the jars to examine from the files from which we have * Get the jars to examine from the files from which we have
* synthesized the classpath. Note that the classpath is not * synthesized the classpath. Note that the classpath is not
* set at this point, so we cannot get them from the classpath. * set at this point, so we cannot get them from the classpath.
* @param context * @param context the web app context
* @return the list of jars found * @return the list of jars found
*/ */
@Override @Override

13
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/OverlayConfig.java
View File

@ -28,8 +28,6 @@ import org.codehaus.plexus.util.xml.Xpp3Dom;
/** /**
* OverlayConfig * OverlayConfig
*
*
*/ */
public class OverlayConfig public class OverlayConfig
{ {
@ -270,7 +268,7 @@ public class OverlayConfig
* @param gid Artifact groupId * @param gid Artifact groupId
* @param aid Artifact artifactId * @param aid Artifact artifactId
* @param cls Artifact classifier * @param cls Artifact classifier
* @return * @return true if matched
*/ */
public boolean matchesArtifact (String gid, String aid, String cls) public boolean matchesArtifact (String gid, String aid, String cls)
{ {
@ -285,9 +283,9 @@ public class OverlayConfig
/** /**
* Check if this overlay configuration matches an Artifact's info * Check if this overlay configuration matches an Artifact's info
* *
* @param gid * @param gid the group id
* @param aid * @param aid the artifact id
* @return * @return true if matched
*/ */
public boolean matchesArtifact (String gid, String aid) public boolean matchesArtifact (String gid, String aid)
{ {
@ -298,9 +296,6 @@ public class OverlayConfig
return false; return false;
} }
public String toString() public String toString()
{ {
StringBuffer strbuff = new StringBuffer(); StringBuffer strbuff = new StringBuffer();

10
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/SelectiveJarResource.java
View File

@ -52,30 +52,20 @@ public class SelectiveJarResource extends JarResource
public static final List<String> DEFAULT_INCLUDES = Arrays.asList(new String[]{"**"});// No includes supplied, so set it to 'matches all' public static final List<String> DEFAULT_INCLUDES = Arrays.asList(new String[]{"**"});// No includes supplied, so set it to 'matches all'
public static final List<String> DEFAULT_EXCLUDES = Collections.emptyList(); //No includes, set to no exclusions public static final List<String> DEFAULT_EXCLUDES = Collections.emptyList(); //No includes, set to no exclusions
List<String> _includes = null; List<String> _includes = null;
List<String> _excludes = null; List<String> _excludes = null;
boolean _caseSensitive = false; boolean _caseSensitive = false;
/**
* @param url
*/
public SelectiveJarResource(URL url) public SelectiveJarResource(URL url)
{ {
super(url); super(url);
} }
/**
* @param url
* @param useCaches
*/
public SelectiveJarResource(URL url, boolean useCaches) public SelectiveJarResource(URL url, boolean useCaches)
{ {
super(url, useCaches); super(url, useCaches);
} }
public void setCaseSensitive (boolean caseSensitive) public void setCaseSensitive (boolean caseSensitive)
{ {
_caseSensitive = caseSensitive; _caseSensitive = caseSensitive;

24
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ServerSupport.java
View File

@ -46,14 +46,14 @@ import org.eclipse.jetty.xml.XmlConfiguration;
*/ */
public class ServerSupport public class ServerSupport
{ {
/** /**
* Set up the handler structure to receive a webapp. * Set up the handler structure to receive a webapp.
* Also put in a DefaultHandler so we get a nice page * Also put in a DefaultHandler so we get a nice page
* than a 404 if we hit the root and the webapp's * than a 404 if we hit the root and the webapp's
* context isn't at root. * context isn't at root.
* @throws Exception * @param server the server
* @param requestLog the request log
* @throws Exception if unable to configure the handlers
*/ */
public static void configureHandlers (Server server, RequestLog requestLog) throws Exception public static void configureHandlers (Server server, RequestLog requestLog) throws Exception
{ {
@ -87,8 +87,8 @@ public class ServerSupport
/** /**
* Configure at least one connector for the server * Configure at least one connector for the server
* *
* @param server * @param server the server
* @param connector * @param connector the connector
*/ */
public static void configureConnectors (Server server, Connector connector) public static void configureConnectors (Server server, Connector connector)
{ {
@ -122,8 +122,8 @@ public class ServerSupport
/** /**
* Set up any security LoginServices provided. * Set up any security LoginServices provided.
* *
* @param server * @param server the server
* @param loginServices * @param loginServices the login services
*/ */
public static void configureLoginServices (Server server, LoginService[] loginServices) public static void configureLoginServices (Server server, LoginService[] loginServices)
{ {
@ -140,10 +140,6 @@ public class ServerSupport
} }
} }
/**
* @see org.eclipse.jetty.server.handler.HandlerCollection#addHandler(org.eclipse.jetty.server.Handler)
*/
public static void addWebApplication(Server server, WebAppContext webapp) throws Exception public static void addWebApplication(Server server, WebAppContext webapp) throws Exception
{ {
if (server == null) if (server == null)
@ -168,8 +164,10 @@ public class ServerSupport
* Apply xml files to server startup, passing in ourselves as the * Apply xml files to server startup, passing in ourselves as the
* "Server" instance. * "Server" instance.
* *
* @param files * @param server the server to apply the xml to
* @throws Exception * @param files the list of xml files
* @return the Server implementation, after the xml is applied
* @throws Exception if unable to apply the xml configuration
*/ */
public static Server applyXmlConfigurations (Server server, List<File> files) public static Server applyXmlConfigurations (Server server, List<File> files)
throws Exception throws Exception

41
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/Starter.java
View File

@ -44,10 +44,7 @@ import org.eclipse.jetty.xml.XmlConfiguration;
/** /**
* Starter * Starter Class which is exec'ed to create a new jetty process. Used by the JettyRunForked mojo.
*
* Class which is exec'ed to create a new jetty process. Used by the JettyRunForked mojo.
*
*/ */
public class Starter public class Starter
{ {
@ -114,9 +111,6 @@ public class Starter
/**
* @throws Exception
*/
public void configureJetty () throws Exception public void configureJetty () throws Exception
{ {
LOG.debug("Starting Jetty Server ..."); LOG.debug("Starting Jetty Server ...");
@ -168,10 +162,6 @@ public class Starter
} }
} }
/**
* @throws Exception
*/
public void configureWebApp () public void configureWebApp ()
throws Exception throws Exception
{ {
@ -318,10 +308,6 @@ public class Starter
} }
/**
* @param args
* @throws Exception
*/
public void getConfiguration (String[] args) public void getConfiguration (String[] args)
throws Exception throws Exception
{ {
@ -372,9 +358,6 @@ public class Starter
} }
/**
* @throws Exception
*/
public void run() throws Exception public void run() throws Exception
{ {
LOG.info("Started Jetty Server"); LOG.info("Started Jetty Server");
@ -382,18 +365,12 @@ public class Starter
} }
/**
* @throws Exception
*/
public void join () throws Exception public void join () throws Exception
{ {
server.join(); server.join();
} }
/**
* @param e
*/
public void communicateStartupResult (Exception e) public void communicateStartupResult (Exception e)
{ {
if (token != null) if (token != null)
@ -408,7 +385,7 @@ public class Starter
/** /**
* Apply any jetty xml files given * Apply any jetty xml files given
* @throws Exception * @throws Exception if unable to apply the xml
*/ */
public void applyJettyXml() throws Exception public void applyJettyXml() throws Exception
{ {
@ -423,10 +400,6 @@ public class Starter
/**
* @param handler
* @param handlers
*/
protected void prependHandler (Handler handler, HandlerCollection handlers) protected void prependHandler (Handler handler, HandlerCollection handlers)
{ {
if (handler == null || handlers == null) if (handler == null || handlers == null)
@ -441,11 +414,6 @@ public class Starter
/**
* @param c
* @param wars
* @return
*/
protected Artifact getArtifactForOverlayConfig (OverlayConfig c, List<Artifact> wars) protected Artifact getArtifactForOverlayConfig (OverlayConfig c, List<Artifact> wars)
{ {
if (wars == null || wars.isEmpty() || c == null) if (wars == null || wars.isEmpty() || c == null)
@ -480,11 +448,6 @@ public class Starter
return list; return list;
} }
/**
* @param args
*/
public static final void main(String[] args) public static final void main(String[] args)
{ {
if (args == null) if (args == null)

16
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/WarPluginInfo.java
View File

@ -29,11 +29,9 @@ import org.apache.maven.model.Plugin;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.xml.Xpp3Dom; import org.codehaus.plexus.util.xml.Xpp3Dom;
/** /**
* WarPluginInfo * WarPluginInfo
* * <p>
* Information about the maven-war-plugin contained in the pom * Information about the maven-war-plugin contained in the pom
*/ */
public class WarPluginInfo public class WarPluginInfo
@ -45,10 +43,6 @@ public class WarPluginInfo
private List<OverlayConfig> _overlayConfigs; private List<OverlayConfig> _overlayConfigs;
/**
* @param project
*/
public WarPluginInfo (MavenProject project) public WarPluginInfo (MavenProject project)
{ {
_project = project; _project = project;
@ -59,7 +53,7 @@ public class WarPluginInfo
/** /**
* Find the maven-war-plugin, if one is configured * Find the maven-war-plugin, if one is configured
* @return * @return the plugin
*/ */
public Plugin getPlugin() public Plugin getPlugin()
{ {
@ -86,7 +80,7 @@ public class WarPluginInfo
/** /**
* Get value of dependentWarIncludes for maven-war-plugin * Get value of dependentWarIncludes for maven-war-plugin
* @return * @return the list of dependent war includes
*/ */
public List<String> getDependentMavenWarIncludes() public List<String> getDependentMavenWarIncludes()
{ {
@ -115,7 +109,7 @@ public class WarPluginInfo
/** /**
* Get value of dependentWarExcludes for maven-war-plugin * Get value of dependentWarExcludes for maven-war-plugin
* @return * @return the list of dependent war excludes
*/ */
public List<String> getDependentMavenWarExcludes() public List<String> getDependentMavenWarExcludes()
{ {
@ -145,7 +139,7 @@ public class WarPluginInfo
/** /**
* Get config for any overlays that have been declared for the maven-war-plugin. * Get config for any overlays that have been declared for the maven-war-plugin.
* *
* @return * @return the list of overlay configs
*/ */
public List<OverlayConfig> getMavenWarOverlayConfigs () public List<OverlayConfig> getMavenWarOverlayConfigs ()
{ {

3
jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java
View File

@ -30,7 +30,6 @@ public class PreconfigureQuickStartWar
private static final Logger LOG = Log.getLogger(PreconfigureQuickStartWar.class); private static final Logger LOG = Log.getLogger(PreconfigureQuickStartWar.class);
static final boolean ORIGIN=LOG.isDebugEnabled(); static final boolean ORIGIN=LOG.isDebugEnabled();
public static void main(String... args) throws Exception public static void main(String... args) throws Exception
{ {
Resource war = null; Resource war = null;
@ -80,7 +79,7 @@ public class PreconfigureQuickStartWar
* @param war The war (or directory) to preconfigure * @param war The war (or directory) to preconfigure
* @param dir The directory to expand the war into (or null if war is a directory) * @param dir The directory to expand the war into (or null if war is a directory)
* @param xml A context XML to apply (or null if none) * @param xml A context XML to apply (or null if none)
* @throws Exception * @throws Exception if unable to pre configure
*/ */
public static void preconfigure(Resource war, Resource dir, Resource xml) throws Exception public static void preconfigure(Resource war, Resource dir, Resource xml) throws Exception
{ {

9
jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java
View File

@ -31,10 +31,9 @@ import org.eclipse.jetty.webapp.WebInfConfiguration;
/** /**
* QuickStartConfiguration * QuickStartConfiguration
* * <p>
* Re-inflate a deployable webapp from a saved effective-web.xml * Re-inflate a deployable webapp from a saved effective-web.xml
* which combines all pre-parsed web xml descriptors and annotations. * which combines all pre-parsed web xml descriptors and annotations.
*
*/ */
public class QuickStartConfiguration extends WebInfConfiguration public class QuickStartConfiguration extends WebInfConfiguration
{ {
@ -83,9 +82,9 @@ public class QuickStartConfiguration extends WebInfConfiguration
/** /**
* Get the quickstart-web.xml file as a Resource. * Get the quickstart-web.xml file as a Resource.
* *
* @param context * @param context the web app context
* @return * @return the Resource for the quickstart-web.xml
* @throws Exception * @throws Exception if unable to find the quickstart xml
*/ */
public Resource getQuickStartWebXml (WebAppContext context) throws Exception public Resource getQuickStartWebXml (WebAppContext context) throws Exception
{ {

16
jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java
View File

@ -62,11 +62,9 @@ import org.eclipse.jetty.webapp.MetaInfConfiguration;
import org.eclipse.jetty.webapp.WebAppContext; import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jetty.xml.XmlAppendable; import org.eclipse.jetty.xml.XmlAppendable;
/** /**
* QuickStartDescriptorGenerator * QuickStartDescriptorGenerator
* * <p>
* Generate an effective web.xml from a WebAppContext, including all components * Generate an effective web.xml from a WebAppContext, including all components
* from web.xml, web-fragment.xmls annotations etc. * from web.xml, web-fragment.xmls annotations etc.
*/ */
@ -94,9 +92,9 @@ public class QuickStartDescriptorGenerator
/** /**
* Perform the generation of the xml file * Perform the generation of the xml file
* @throws IOException * @param stream the stream to generate the quickstart-web.xml to
* @throws FileNotFoundException * @throws IOException if unable to generate the quickstart-web.xml
* @throws Exception * @throws FileNotFoundException if unable to find the file
*/ */
public void generateQuickStartWebXml (OutputStream stream) throws FileNotFoundException, IOException public void generateQuickStartWebXml (OutputStream stream) throws FileNotFoundException, IOException
{ {
@ -668,9 +666,9 @@ public class QuickStartDescriptorGenerator
/** /**
* Find the origin (web.xml, fragment, annotation etc) of a web artifact from MetaData. * Find the origin (web.xml, fragment, annotation etc) of a web artifact from MetaData.
* *
* @param md * @param md the metadata
* @param name * @param name the name
* @return * @return the origin map
*/ */
public Map<String, String> origin(MetaData md, String name) public Map<String, String> origin(MetaData md, String name)
{ {

9
jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java
View File

@ -44,9 +44,6 @@ import org.eclipse.jetty.xml.XmlParser;
*/ */
public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor
{ {
/**
*
*/
public QuickStartDescriptorProcessor() public QuickStartDescriptorProcessor()
{ {
try try
@ -75,12 +72,6 @@ public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor
{ {
} }
/**
* @param context
* @param descriptor
* @param node
*/
public void visitContextParam (WebAppContext context, Descriptor descriptor, XmlParser.Node node) public void visitContextParam (WebAppContext context, Descriptor descriptor, XmlParser.Node node)
throws Exception throws Exception
{ {

7
tests/pom.xml
View File

@ -31,6 +31,13 @@
<packaging>pom</packaging> <packaging>pom</packaging>
<build> <build>
<plugins> <plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
<plugin> <plugin>
<groupId>org.codehaus.mojo</groupId> <groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId> <artifactId>findbugs-maven-plugin</artifactId>

3
tests/test-webapps/test-mock-resources/src/main/java/com/acme/MockTransport.java
View File

@ -28,12 +28,9 @@ import javax.mail.URLName;
/** /**
* MockTransport * MockTransport
*
*
*/ */
public class MockTransport extends Transport public class MockTransport extends Transport
{ {
/** /**
* @param session * @param session
* @param urlname * @param urlname