Merge branch 'jetty-9.4.x'

jetty-documentation/src/main/asciidoc/development/handlers/writing-custom-handlers.adoc

@@ -19,11 +19,12 @@
 
 The Handler is the Jetty component that deals with received requests.
 
-Many users of Jetty never need to write a Jetty Handler, but instead use the link:{JXURL}/org/eclipse/jetty/servlet/package-summary.html[Servlet API.] You can reuse the existing Jetty handlers for context, security, sessions and servlets without the need for extension.
+Many users of Jetty never need to write a Jetty Handler, but instead use the link:{JXURL}/org/eclipse/jetty/servlet/package-summary.html[Servlet API.]
+You can reuse the existing Jetty handlers for context, security, sessions and servlets without the need for extension.
 However, some users might have special requirements or footprint concerns that prohibit the use of the full servlet API.
 For them implementing a Jetty handler is a straight forward way to provide dynamic web content with a minimum of fuss.
 
-See xref:basic-architecture[] to understand more about Handlers vs. Servlets.
+See the section on xref:basic-architecture[] to understand more about Handlers vs. Servlets.
 
 [[handler-api]]
 ==== The Handler API
@@ -39,29 +40,30 @@ public void handle(String target, Request baseRequest, HttpServletRequest reques
     throws IOException, ServletException
 ----
 
-An implementation of this method can handle a request, pass the request onto another handler (or servlet), or it can modify and/or wrap the request and then pass it on.
+An implementation of this method can handle a request and pass the request onto another handler (or servlet), or it can modify and/or wrap the request before passing it on.
 This gives three styles of handler:
 
-* Coordinating Handlers - Handlers that route requests to other handlers (HandlerCollection, ContextHandlerCollection)
-* Filtering Handlers - Handlers that augment a request and pass it on to other handlers (HandlerWrapper, ContextHandler, SessionHandler)
-* Generating Handlers - Handlers that produce content (ResourceHandler and ServletHandler)
+* Coordinating Handlers - Handlers that route requests to other handlers (`HandlerCollection`, `ContextHandlerCollection`)
+* Filtering Handlers - Handlers that augment a request and pass it on to other handlers (`HandlerWrapper`, `ContextHandler`, `SessionHandler`)
+* Generating Handlers - Handlers that produce content (`ResourceHandler` and `ServletHandler`)
 
 [[target]]
 ===== The Target
 
 The target of a handler is an identifier for the resource that should handle the passed request.
-This is normally the URI that is parsed from an HTTP Request. However, in two key circumstances the target may differ from the URI of the passed request:
+This is normally the URI that is parsed from an HTTP Request.
+However, in two key circumstances the target may differ from the URI of the passed request:
 
 * If the request has been dispatched to a named resource, such as a named servlet, the target is the name of that resource.
-* If the request is being made by a call to http://download.oracle.com/docs/cd/E17477_01/javaee/5/api/javax/servlet/RequestDispatcher.html[Request Dispatcher], the target is the URI of the included resource and is different to the URI of the actual request.
+* If the request is being made by a call to link:http://docs.oracle.com/javaee/7/api/javax/servlet/RequestDispatcher.html[`RequestDispatcher`], the target is the URI of the included resource and is different to the URI of the actual request.
 
 [[request-and-response]]
 ===== The Request and Response
 
 The request and response objects used in the signature of the handle method are
-http://download.oracle.com/docs/cd/E17477_01/javaee/5/api/javax/servlet/http/HttpServletRequest.html[Servlet Request] and http://download.oracle.com/docs/cd/E17477_01/javaee/5/api/javax/servlet/http/HttpServletResponse.html[Servlet Response].
+link:http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html[`ServletRequest`] and link:http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html[`ServletResponse`].
 These are the standard APIs and are moderately restricted in what they can do to the request and response.
-More often than not, access to the Jetty implementations of these classes is required: link:{JDURL}/org/eclipse/jetty/server/Request.html[Request] and link:{JDURL}/org/eclipse/jetty/server/Response.html[Response].
+More often than not, access to the Jetty implementations of these classes is required: link:{JDURL}/org/eclipse/jetty/server/Request.html[`Request`] and link:{JDURL}/org/eclipse/jetty/server/Response.html[`Response`].
 However, as the request and response may be wrapped by handlers, filters and servlets, it is not possible to pass the implementation directly.
 The following mantra retrieves the core implementation objects from under any wrappers:
 
@@ -71,7 +73,7 @@ Request base_request = request instanceof Request ? (Request)request : HttpConne
 Response base_response = response instanceof Response ? (Response)response : HttpConnection.getCurrentConnection().getHttpChannel().getResponse();
 ----
 
-Notice that if the handler passes the request on to another handler, it should use the request/response objects passed in, and not the base objects.
+Notice that if the handler passes the request on to another handler, it should use the Request/Response objects passed in, and not the base objects.
 This is to preserve any wrapping done by up stream handlers.
 
 [[dispatch]]
@@ -79,10 +81,10 @@ This is to preserve any wrapping done by up stream handlers.
 
 The dispatch argument indicates the state of the handling of the call and may be:
 
-* REQUEST == 1 - An original request received from a connector.
-* FORWARD == 2 - A request being forwarded by a RequestDispatcher.
-* INCLUDE == 4 - A request being included by a RequestDispatcher.
-* ERROR == 8 - A request being forwarded to a error handler by the container.
+* `REQUEST == 1` - An original request received from a connector.
+* `FORWARD == 2` - A request being forwarded by a RequestDispatcher.
+* `INCLUDE == 4` - A request being included by a RequestDispatcher.
+* `ERROR == 8` - A request being forwarded to a error handler by the container.
 
 These mostly have significance for servlet and related handlers.
 For example, the security handler only applies authentication and authorization to REQUEST dispatches.
@@ -99,9 +101,9 @@ A Handler may handle a request by:
 [[generating-response]]
 ===== Generating a Response
 
-The link:{JDURL}/org/eclipse/jetty/embedded/OneHandler.html[OneHandler] embedded example shows how a simple handler can generate a response.
+The link:{JDURL}/org/eclipse/jetty/embedded/OneHandler.html[`OneHandler`] embedded example shows how a simple handler can generate a response.
 
-You can use the normal servlet response API, which will typically set some status, content headers and then write out the content:
+You can use the standard servlet response API, which will typically set some status, content headers and then write out the content:
 
 [source, java, subs="{sub-order}"]
 ----
@@ -115,7 +117,7 @@ It is also very important that a handler indicate that it has completed handling
 [source, java, subs="{sub-order}"]
 ----
  Request base_request = (request instanceof Request) ? (Request)request:HttpConnection.getCurrentConnection().getHttpChannel().getRequest();
- base_request.setHandled(true);              
+ base_request.setHandled(true);
 ----
 
 [[filtering-request-or-response]]
@@ -133,7 +135,7 @@ Typically you would make modifications to accomplish:
 You can also update the context of the request:
 
 * Setting the current threads context classloader.
-* Setting thread locals to identify the current ServletContext.
+* Setting thread locals to identify the current `ServletContext`.
 
 Typically Jetty passes a modified request to another handler and undoes modifications in a finally block afterwards:
 
@@ -150,23 +152,23 @@ Typically Jetty passes a modified request to another handler and undoes modifica
  }
 ----
 
-The classes that implement the link:{JDURL}/org/eclipse/jetty/server/handler/HandlerWrapper.html[HandlerWrapper] class are typically handler filters of this style.
+The classes that implement the link:{JDURL}/org/eclipse/jetty/server/handler/HandlerWrapper.html[`HandlerWrapper`] class are typically handler filters of this style.
 
 [[passing-request-and-response]]
 ===== Passing the Request and Response to Another Handler
 
 A handler might simply inspect the request and use the target, request URI or other information to select another handler to pass the request to.
-These handlers typically implement the link:{JDURL}/org/eclipse/jetty/server/HandlerContainer.html[HandlerContainer] interface.
+These handlers typically implement the link:{JDURL}/org/eclipse/jetty/server/HandlerContainer.html[`HandlerContainer`] interface.
 
 Examples include:
 
-* link:{JDURL}/org/eclipse/jetty/server/handler/HandlerCollection.html[Class Handler Collection] -
+* link:{JDURL}/org/eclipse/jetty/server/handler/HandlerCollection.html[Class `HandlerCollection`] -
 A collection of handlers, where each handler is called regardless of the state of the request.
-This is typically used to pass a request to a link:{JDURL}/org/eclipse/jetty/server/handler/ContextHandlerCollection.html[ContextHandlerCollection,] and then the link:{JDURL}/org/eclipse/jetty/server/handler/RequestLogHandler.html[RequestLogHandler.]
-* link:{JDURL}/org/eclipse/jetty/server/handler/HandlerList.html[HandlerList] - A list of handlers that are called in turn until the request state is set as handled.
-* link:{JDURL}/org/eclipse/jetty/server/handler/ContextHandlerCollection.html[ContextHandlerCollection] - A collection of Handlers, of which one is selected by best match for the context path.
+This is typically used to pass a request to a link:{JDURL}/org/eclipse/jetty/server/handler/ContextHandlerCollection.html[`ContextHandlerCollection`,] and then the link:{JDURL}/org/eclipse/jetty/server/handler/RequestLogHandler.html[`RequestLogHandler`.]
+* link:{JDURL}/org/eclipse/jetty/server/handler/HandlerList.html[`HandlerList`] - A list of handlers that are called in turn until the request state is set as handled.
+* link:{JDURL}/org/eclipse/jetty/server/handler/ContextHandlerCollection.html[`ContextHandlerCollection`] - A collection of Handlers, of which one is selected by best match for the context path.
 
 [[more-about-handlers]]
 ==== More About Handlers
 
-See link:{JXURL}/[Jetty Latest Source XRef] and link:{JDURL}/[Jetty Latest JavaDoc] for detailed information on each Jetty handler.
+See the link:{JXURL}/[latest Jetty Source XRef] and the link:{JDURL}/[latest Jetty JavaDoc] for detailed information on each Jetty handler.

jetty-documentation/src/main/asciidoc/development/part.adoc

@@ -20,11 +20,10 @@
 include::embedding/chapter.adoc[]
 include::clients/http/chapter.adoc[]
 include::maven/chapter.adoc[]
+include::ant/chapter.adoc[]
 include::handlers/chapter.adoc[]
-include::debugging/chapter.adoc[]
 include::websockets/intro/chapter.adoc[]
 include::websockets/jetty/chapter.adoc[]
 //include::websockets/java/chapter.adoc[]
 include::continuations/chapter.adoc[]
 include::frameworks/chapter.adoc[]
-include::ant/chapter.adoc[]

jetty-documentation/src/main/asciidoc/reference/jetty-xml/chapter.adoc

@@ -15,7 +15,7 @@
 //  ========================================================================
 
 [[reference-section]]
-== Reference Section
+== Jetty XML Reference
 
 include::jetty-xml-syntax.adoc[]
 include::jetty-xml-usage.adoc[]
@@ -23,4 +23,4 @@ include::jetty-xml-config.adoc[]
 include::jetty-web-xml-config.adoc[]
 include::jetty-env-xml.adoc[]
 include::webdefault-xml.adoc[]
-include::override-web-xml.adoc[]
+include::override-web-xml.adoc[]

jetty-documentation/src/main/asciidoc/reference/part.adoc

@@ -13,12 +13,14 @@
 //
 //  You may elect to redistribute this code under either of these licenses.
 //  ========================================================================
+// #TODO Remove chapter in Jetty 10
 [[jetty-ref-guide]]
 
 = Jetty Reference Guide
 
-include::platforms/chapter.adoc[]
 include::architecture/chapter.adoc[]
-include::contributing/chapter.adoc[]
+include::platforms/chapter.adoc[]
 include::jetty-xml/chapter.adoc[]
 include::troubleshooting/chapter.adoc[]
+include::debugging/chapter.adoc[]
+include::contributing/chapter.adoc[]

jetty-start/src/main/java/org/eclipse/jetty/start/Modules.java

@@ -262,9 +262,13 @@ public class Modules implements Iterable<Module>
         }
       
         // Enable the  module
-        if (module.enable(enabledFrom,transitive))
+        if (module.isEnabled() && !transitive)
         {
-            StartLog.debug("enabled %s",module.getName());
+            StartLog.info("Module %s has already been enabled.", module.getName());
+        }
+        else if (module.enable(enabledFrom,transitive))
+        {
+            StartLog.debug("Enabled %s",module.getName());
             newlyEnabled.add(module.getName());
             
             // Expand module properties
@@ -281,8 +285,7 @@ public class Modules implements Iterable<Module>
         }
         else if (module.isTransitive() && module.hasIniTemplate())
             newlyEnabled.add(module.getName());
-        
-        
+
         // Process module dependencies (always processed as may be dynamic)
         for(String dependsOn:module.getDepends())
         {

jetty-start/src/main/java/org/eclipse/jetty/start/builders/StartIniBuilder.java

@@ -88,12 +88,6 @@ public class StartIniBuilder implements BaseBuilder.Config
     @Override
     public boolean addModule(Module module) throws IOException
     {
-        if (modulesPresent.contains(module.getName()))
-        {
-            StartLog.info("%-15s already initialised in %s",module.getName(),baseHome.toShortForm(startIni));
-            // skip, already present
-            return false;
-        }
 
         if (module.isDynamic())
         {

jetty-start/src/test/resources/usecases/alternate.ModulePriorEnabled.assert.txt

@@ -0,0 +1,13 @@
+## The XMLs we expect (order is important)
+XML|${jetty.home}/etc/base.xml
+XML|${jetty.home}/etc/main.xml
+
+# The LIBs we expect (order is irrelevant)
+LIB|${jetty.home}/lib/base.jar
+LIB|${jetty.home}/lib/main.jar
+LIB|${jetty.home}/lib/other.jar
+
+# The Properties we expect (order is irrelevant)
+PROP|main.prop=value0
+
+OUTPUT|INFO : Module base has already been enabled.

jetty-start/src/test/resources/usecases/alternate.ModulePriorEnabled.cmdline.txt

@@ -0,0 +1 @@
+--module=base