[CVS spice] Javadoc updates
sjoberg-yCVjj/[email protected] 20 Oct 2005 18:28:15 -0000
| Newsgroups | gmane.comp.java.spice.cvs |
|---|---|
| Message-ID | <[email protected]> |
<html>
<head>
<style><!--
body {background-color:#ffffff;}
.file {border:1px solid #eeeeee;margin-top:1em;margin-bottom:1em;}
.pathname {font-family:monospace; float:right;}
.fileheader {margin-bottom:.5em;}
.diff {margin:0;}
.tasklist {padding:4px;border:1px dashed #000000;margin-top:1em;}
.tasklist ul {margin-top:0;margin-bottom:0;}
tr.alt {background-color:#eeeeee}
#added {background-color:#ddffdd;}
#addedchars {background-color:#99ff99;font-weight:bolder;}
tr.alt #added {background-color:#ccf7cc;}
#removed {background-color:#ffdddd;}
#removedchars {background-color:#ff9999;font-weight:bolder;}
tr.alt #removed {background-color:#f7cccc;}
#info {color:#888888;}
#context {background-color:#eeeeee;}
td {padding-left:.3em;padding-right:.3em;}
tr.head {border-bottom-width:1px;border-bottom-style:solid;}
tr.head td {padding:0;padding-top:.2em;}
.task {background-color:#ffff00;}
.comment {padding:4px;border:1px dashed #000000;background-color:#ffffdd}
.error {color:red;}
hr {border-width:0px;height:2px;background:black;}
--></style>
</head>
<body>
<table cellspacing="0" cellpadding="0" border="0" rules="cols">
<tr class="head"><td colspan="4">Commit in <b><tt>spice/components/jervlet/src/java/org/codehaus/spice/jervlet</tt></b><span id="info"> on MAIN</span></td></tr>
<tr><td><tt>containers/jetty/pico/<a href="#file1">DefaultJettyContainerConfiguration.java</a></tt></td><td align="right" id="added">+4</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.3 -> 1.4</td></tr>
<tr class="alt"><td><tt> /<a href="#file2">GroovyJettyContainerBuilder.java</a></tt></td><td align="right" id="added">+3</td><td></td><td nowrap="nowrap" align="center">1.3 -> 1.4</td></tr>
<tr><td><tt>containers/jetty/<a href="#file3">JettyFilterHolder.java</a></tt></td><td align="right" id="added">+1</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr class="alt"><td><tt> /<a href="#file4">JettyServer.java</a></tt></td><td align="right" id="added">+7</td><td align="right" id="removed">-5</td><td nowrap="nowrap" align="center">1.5 -> 1.6</td></tr>
<tr><td><tt> /<a href="#file5">ShieldingJettyContainer.java</a></tt></td><td align="right" id="added">+1</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr class="alt"><td><tt>impl/pico/<a href="#file6">PicoContext.java</a></tt></td><td align="right" id="added">+49</td><td align="right" id="removed">-7</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr><td><tt> /<a href="#file7">PicoDefaultContextHandler.java</a></tt></td><td align="right" id="added">+55</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.1 -> 1.2</td></tr>
<tr class="alt"><td><tt>impl/<a href="#file8">AbstractDeploymentHelper.java</a></tt></td><td align="right" id="added">+2</td><td align="right" id="removed">-2</td><td nowrap="nowrap" align="center">1.1 -> 1.2</td></tr>
<tr><td><tt> /<a href="#file9">NoopContextMonitor.java</a></tt></td><td align="right" id="added">+1</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.1 -> 1.2</td></tr>
<tr class="alt"><td><tt> /<a href="#file10">NoopListenerMonitor.java</a></tt></td><td align="right" id="added">+1</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.1 -> 1.2</td></tr>
<tr><td></td><td align="right" id="added">+124</td><td align="right" id="removed">-20</td><td></td></tr>
</table>
<small id="info">10 modified files</small><br />
<pre class="comment">
Javadoc updates
</pre>
<hr /><a name="file1" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/containers/jetty/pico<br /></span>
<div class="fileheader"><big><b>DefaultJettyContainerConfiguration.java</b></big> <small id="info">1.3 -> 1.4</small></div>
<pre class="diff"><small id="info">diff -u -r1.3 -r1.4
--- DefaultJettyContainerConfiguration.java 19 Oct 2005 14:54:32 -0000 1.3
+++ DefaultJettyContainerConfiguration.java 20 Oct 2005 18:28:14 -0000 1.4
@@ -87,7 +87,10 @@
</small></pre><pre class="diff" id="context"> * to configure Jetty, with a String holding the path to
* Jetty's XML configuration file, a String that IS the
* XML configuration itself or with a URL also pointing
</pre><pre class="diff" id="removed">- * at the configuration file.
</pre><pre class="diff" id="added">+ * at the configuration file. Note, this configuration
+ * is in Jetty's own format defined by the Jetty project.
+ * Different versions of Jetty might need different types
+ * of configuration files.
</pre><pre class="diff" id="context"> *
* @param configuration a String, a URL or null to reset
*/
</pre></div>
<hr /><a name="file2" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/containers/jetty/pico<br /></span>
<div class="fileheader"><big><b>GroovyJettyContainerBuilder.java</b></big> <small id="info">1.3 -> 1.4</small></div>
<pre class="diff"><small id="info">diff -u -r1.3 -r1.4
--- GroovyJettyContainerBuilder.java 20 Oct 2005 15:07:24 -0000 1.3
+++ GroovyJettyContainerBuilder.java 20 Oct 2005 18:28:15 -0000 1.4
@@ -149,6 +149,9 @@
</small></pre><pre class="diff" id="context"> * <li>configuration - create a configuration (Jetty's own format)</li>
* <li>parameter - add a parameter to Jetty</li>
* <li>listener - create a listener</li>
</pre><pre class="diff" id="added">+ * <li>httpListener - create an HTTP listener</li>
+ * <li>ajp13Listener - create an AJP 1.3 listener</li>
+ * <li>tlsListener - create an SSL/TLS listener</li>
</pre><pre class="diff" id="context"> * <li>context - create a context</li>
* </ul>
*
</pre></div>
<hr /><a name="file3" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/containers/jetty<br /></span>
<div class="fileheader"><big><b>JettyFilterHolder.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- JettyFilterHolder.java 19 Oct 2005 15:08:04 -0000 1.2
+++ JettyFilterHolder.java 20 Oct 2005 18:28:15 -0000 1.3
@@ -55,7 +55,7 @@
</small></pre><pre class="diff" id="context"> import org.codehaus.spice.jervlet.Instantiator;
/**
</pre><pre class="diff" id="removed">- * Override for Jetty's FilterHolder allow custom
</pre><pre class="diff" id="added">+ * Override for Jetty's FilterHolder <span id="addedchars">to </span>allow custom
</pre><pre class="diff" id="context"> * filter handling.
*
* @author Paul Hammant
</pre></div>
<hr /><a name="file4" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/containers/jetty<br /></span>
<div class="fileheader"><big><b>JettyServer.java</b></big> <small id="info">1.5 -> 1.6</small></div>
<pre class="diff"><small id="info">diff -u -r1.5 -r1.6
--- JettyServer.java 20 Oct 2005 15:07:24 -0000 1.5
+++ JettyServer.java 20 Oct 2005 18:28:15 -0000 1.6
@@ -35,7 +35,7 @@
</small></pre><pre class="diff" id="context"> * many situations. Some functions of the Jetty server can be
* parametrized through System parameters, but for most cases where
* more advanced setups are needed it is best to feed the Constructor
</pre><pre class="diff" id="removed">- * an already configur<span id="removedchars">at</span>ed Jetty Server and use this class for
</pre><pre class="diff" id="added">+ * an already configured Jetty Server and use this class for
</pre><pre class="diff" id="context"> * deploying web applications. Note, this class is not intended
* to be used as a component, but rather be used as a tool by
* compnents.
</pre><pre class="diff"><small id="info">@@ -93,8 +93,8 @@
</small></pre><pre class="diff" id="context"> * Set the Jetty server. It can only be set once. Still a server
* must be set before the class will work, either in the
* constructor or here. <code>null</code> is an accepted value,
</pre><pre class="diff" id="removed">- * and if given a new empty Server an unconfigured instance will
- * be created.
</pre><pre class="diff" id="added">+ * and if given, a new empty and unconfigured <code>Server</code>
+ * instance will be created.
</pre><pre class="diff" id="context"> *
* @param jettyServer a jetty Server instance, or null. If
* <code>null</code> is given a new unconfigured intance
</pre><pre class="diff"><small id="info">@@ -118,7 +118,8 @@
</small></pre><pre class="diff" id="context"> /**
* Set the context monitor. A context monitor must be set before
* the class will work, and can be set anytime again while the
</pre><pre class="diff" id="removed">- * system is running.
</pre><pre class="diff" id="added">+ * system is running. Null is an accepted value and will result
+ * in no monitor events.
</pre><pre class="diff" id="context"> *
* @param contextMonitor the context monitor, or null for NoOp
*/
</pre><pre class="diff"><small id="info">@@ -137,7 +138,8 @@
</small></pre><pre class="diff" id="context"> /**
* Set the listener monitor. A listener monitor must be set
* before the class will work, and can be set anytime again while
</pre><pre class="diff" id="removed">- * the system is running.
</pre><pre class="diff" id="added">+ * the system is running. Null is an accepted value and will result
+ * in no monitor events.
</pre><pre class="diff" id="context"> *
* @param listenerMonitor the listener monitor, or null for NoOp
*/
</pre></div>
<hr /><a name="file5" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/containers/jetty<br /></span>
<div class="fileheader"><big><b>ShieldingJettyContainer.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- ShieldingJettyContainer.java 19 Oct 2005 15:08:04 -0000 1.2
+++ ShieldingJettyContainer.java 20 Oct 2005 18:28:15 -0000 1.3
@@ -25,7 +25,7 @@
</small></pre><pre class="diff" id="context"> * configuration or with an URL. This component can also let you set
* system properties affecting <b>only this</b> instance of Jetty.
* This means no real system properties are used, but Jetty will
</pre><pre class="diff" id="removed">- * believe so. Some of Jettys low level behavior can only be changed
</pre><pre class="diff" id="added">+ * believe so. Some of Jetty<span id="addedchars">'</span>s low level behavior can only be changed
</pre><pre class="diff" id="context"> * like this. If you need to configure the Jetty Server with the
* default configuration, you will probably want to at least set
* <code>jetty.home</code> and such parameters. It is highly
</pre></div>
<hr /><a name="file6" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/impl/pico<br /></span>
<div class="fileheader"><big><b>PicoContext.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- PicoContext.java 22 Aug 2005 00:38:55 -0000 1.2
+++ PicoContext.java 20 Oct 2005 18:28:15 -0000 1.3
@@ -15,32 +15,74 @@
</small></pre><pre class="diff" id="context"> import java.net.URL;
/**
</pre><pre class="diff" id="removed">- * @author <a href="mailto:[email protected]">peter royal</a>
</pre><pre class="diff" id="added">+ * Pico component wrapping a Context.
+ *
+ * @author Peter Royal
+ * @author Johan Sjoberg
</pre><pre class="diff" id="context"> */
public class PicoContext extends DefaultContext implements Startable
{
</pre><pre class="diff" id="added">+ /** Context handler */
</pre><pre class="diff" id="context"> private final ContextHandler m_contextHandler;
</pre><pre class="diff" id="added">+ /**
+ * Construct a new PicoContext
+ *
+ * @param contextHandler Context Handler to deploy/start/stop/undeploy
+ * the context with
+ * @param path The web path
+ * @param virtualHosts List of virtual hosts to deploy the
+ * contest to (optional), set to null for all hosts
+ * @param resource Application resource, meaning a pointer
+ * to the web archive
+ * @param extractWar If the resource points at a .war file,
+ * should it be exploded
+ * @param instantiator The instantiator reponsible for creating
+ * new servlet or filter classes
+ */
</pre><pre class="diff" id="context"> public PicoContext( ContextHandler contextHandler,
</pre><pre class="diff" id="removed">- String <span id="removedchars">context</span>,
</pre><pre class="diff" id="added">+ String <span id="addedchars">path</span>,
+ String[] virtualHosts,
</pre><pre class="diff" id="context"> URL resource,
</pre><pre class="diff" id="added">+ boolean extractWar,
</pre><pre class="diff" id="context"> Instantiator instantiator )
{
</pre><pre class="diff" id="removed">- super(context, null, resource, false, instantiator);
-
</pre><pre class="diff" id="added">+ super(path, virtualHosts, resource, extractWar, instantiator);
</pre><pre class="diff" id="context"> m_contextHandler = contextHandler;
</pre><pre class="diff" id="added">+ }
</pre><pre class="diff" id="context">
</pre><pre class="diff" id="removed">- System.out.println( "Created Context - " + this );
</pre><pre class="diff" id="added">+ /**
+ * Construct a new PicoContext
+ *
+ * @param contextHandler Context Handler to deploy/start/stop/undeploy
+ * the context with
+ * @param path The web path
+ * @param resource Application resource, meaning a pointer
+ * to the web archive
+ * @param instantiator The instantiator reponsible for creating
+ * new servlet or filter classes
+ */
+ public PicoContext( ContextHandler contextHandler,
+ String path,
+ URL resource,
+ Instantiator instantiator )
+ {
+ super(path, null, resource, false, instantiator);
+ m_contextHandler = contextHandler;
</pre><pre class="diff" id="context"> }
</pre><pre class="diff" id="added">+ /**
+ * Deploy and start the context
+ */
</pre><pre class="diff" id="context"> public void start()
{
</pre><pre class="diff" id="removed">- System.out.println( "Starting Context - " + this );
-
</pre><pre class="diff" id="context"> m_contextHandler.addContext( this );
m_contextHandler.startContext( this );
}
</pre><pre class="diff" id="added">+ /**
+ * Undeploy and stop the context
+ */
</pre><pre class="diff" id="context"> public void stop()
{
m_contextHandler.stopContext( this );
</pre></div>
<hr /><a name="file7" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/impl/pico<br /></span>
<div class="fileheader"><big><b>PicoDefaultContextHandler.java</b></big> <small id="info">1.1 -> 1.2</small></div>
<pre class="diff"><small id="info">diff -u -r1.1 -r1.2
--- PicoDefaultContextHandler.java 9 Aug 2005 01:42:12 -0000 1.1
+++ PicoDefaultContextHandler.java 20 Oct 2005 18:28:15 -0000 1.2
@@ -15,53 +15,107 @@
</small></pre><pre class="diff" id="context"> import org.picocontainer.Startable;
/**
</pre><pre class="diff" id="removed">- * @author <a href="mailto:[email protected]">peter royal</a>
</pre><pre class="diff" id="added">+ * Pico component representing a ContextHandler
+ *
+ * @author Peter Royal
+ * @author Johan Sjoberg
</pre><pre class="diff" id="context"> */
public class PicoDefaultContextHandler implements ContextHandler, Startable
{
</pre><pre class="diff" id="added">+ /** Container used to get a context handler */
</pre><pre class="diff" id="context"> private final Container m_container;
</pre><pre class="diff" id="added">+
+ /** Wrapped context handler */
</pre><pre class="diff" id="context"> private ContextHandler m_handler;
</pre><pre class="diff" id="added">+ /**
+ * Construct a new instance
+ *
+ * @param container The container to be used for creating
+ * and destroying context handlers
+ */
</pre><pre class="diff" id="context"> public PicoDefaultContextHandler( final Container container )
{
m_container = container;
}
</pre><pre class="diff" id="added">+ /**
+ * Start the context handler, meaning get a new
+ * context handler from the container. No contexts
+ * can be deployed before starting.
+ */
</pre><pre class="diff" id="context"> public void start()
{
m_handler = m_container.createContextHandler();
}
</pre><pre class="diff" id="added">+ /**
+ * Stop the context handler, meaning destroy the
+ * wrapped context handler with the container. No
+ * contexts can be deployed after stopping.
+ */
</pre><pre class="diff" id="context"> public void stop()
{
m_container.destroyContextHandler( m_handler );
}
</pre><pre class="diff" id="added">+ /**
+ * Add a context
+ *
+ * @param context The context to add
+ */
</pre><pre class="diff" id="context"> public void addContext( Context context )
{
m_handler.addContext( context );
}
</pre><pre class="diff" id="added">+ /**
+ * List all current contexts
+ *
+ * @return A list containing all current context. The
+ * list can be empty, but not null.
+ */
</pre><pre class="diff" id="context"> public List getContexts()
{
return m_handler.getContexts();
}
</pre><pre class="diff" id="added">+ /**
+ * Check if a context has been started
+ * @param context The context to check
+ * @return true if it has been started with this
+ * context handler, else false.
+ */
</pre><pre class="diff" id="context"> public boolean isStarted( Context context )
{
return m_handler.isStarted( context );
}
</pre><pre class="diff" id="added">+ /**
+ * Remove a context
+ *
+ * @param context The context to remove
+ */
</pre><pre class="diff" id="context"> public void removeContext( Context context )
{
m_handler.removeContext( context );
}
</pre><pre class="diff" id="added">+ /**
+ * Start a context
+ *
+ * @param context The context to start
+ */
</pre><pre class="diff" id="context"> public void startContext( Context context )
{
m_handler.startContext( context );
}
</pre><pre class="diff" id="added">+ /**
+ * Stop a context
+ *
+ * @param context The context to stop
+ */
</pre><pre class="diff" id="context"> public void stopContext( Context context )
{
m_handler.stopContext( context );
</pre></div>
<hr /><a name="file8" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/impl<br /></span>
<div class="fileheader"><big><b>AbstractDeploymentHelper.java</b></big> <small id="info">1.1 -> 1.2</small></div>
<pre class="diff"><small id="info">diff -u -r1.1 -r1.2
--- AbstractDeploymentHelper.java 5 Jul 2005 13:32:12 -0000 1.1
+++ AbstractDeploymentHelper.java 20 Oct 2005 18:28:15 -0000 1.2
@@ -16,9 +16,9 @@
</small></pre><pre class="diff" id="context"> import org.codehaus.spice.jervlet.Instantiator;
/**
</pre><pre class="diff" id="removed">- * Basic helper class <span id="removedchars">b</span>o be extended by "deployment" compoents.
</pre><pre class="diff" id="added">+ * Basic helper class <span id="addedchars">t</span>o be extended by "deployment" compoents.
</pre><pre class="diff" id="context"> * It includes common functionality to set and get resources
</pre><pre class="diff" id="removed">- * plus methods to help deploy and undeploy applications.
</pre><pre class="diff" id="added">+ * plus methods to help deployment and undeployment of applications.
</pre><pre class="diff" id="context"> *
* @author Johan Sjoberg
*/
</pre></div>
<hr /><a name="file9" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/impl<br /></span>
<div class="fileheader"><big><b>NoopContextMonitor.java</b></big> <small id="info">1.1 -> 1.2</small></div>
<pre class="diff"><small id="info">diff -u -r1.1 -r1.2
--- NoopContextMonitor.java 5 Jul 2005 13:32:12 -0000 1.1
+++ NoopContextMonitor.java 20 Oct 2005 18:28:15 -0000 1.2
@@ -6,7 +6,7 @@
</small></pre><pre class="diff" id="context">
/**
* Context monitor doing absolutely nothing,
</pre><pre class="diff" id="removed">- * but throwing exceptions.
</pre><pre class="diff" id="added">+ * but throwing exceptions<span id="addedchars"> when asked to</span>.
</pre><pre class="diff" id="context"> *
* @author Johan Sjoberg
*/
</pre></div>
<hr /><a name="file10" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet/impl<br /></span>
<div class="fileheader"><big><b>NoopListenerMonitor.java</b></big> <small id="info">1.1 -> 1.2</small></div>
<pre class="diff"><small id="info">diff -u -r1.1 -r1.2
--- NoopListenerMonitor.java 5 Jul 2005 13:32:12 -0000 1.1
+++ NoopListenerMonitor.java 20 Oct 2005 18:28:15 -0000 1.2
@@ -6,7 +6,7 @@
</small></pre><pre class="diff" id="context">
/**
* Listener monitor doing absolutely nothing,
</pre><pre class="diff" id="removed">- * but throwing exceptions.
</pre><pre class="diff" id="added">+ * but throwing exceptions<span id="addedchars"> when asked to</span>.
</pre><pre class="diff" id="context"> *
* @author Johan Sjoberg
*/
</pre></div>
<center><small><a href="http://www.badgers-in-foil.co.uk/projects/cvsspam/" title="commit -> email">CVSspam</a> 0.2.8</small></center>
</body></html>