481903 Module Descriptions

apache-jsp/src/main/config/modules/apache-jsp.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Apache JSP Module
+Enables use of the apache implementation of JSP
-#
 
 [name]
 apache-jsp

apache-jstl/src/main/config/modules/apache-jstl.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Apache JSTL 
+Enables the apache version of JSTL
-#
 
 [name]
 apache-jstl

jetty-alpn/jetty-alpn-server/src/main/config/modules/alpn.mod

@@ -1,11 +1,10 @@
-# ALPN is provided via a -Xbootclasspath that modifies the secure connections
+[description]
-# in java to support the ALPN layer needed for HTTP/2.
+Enables the ALPN extension to TLS(SSL) by adding modified classes to
-#
+the JVM bootpath. 
-# This modification has a tight dependency on specific recent updates of
+This modification has a tight dependency on specific recent updates of
-# Java 1.7 and Java 1.8 (Java versions prior to 1.7u40 are not supported).
+Java 1.7 and Java 1.8 (Java versions prior to 1.7u40 are not supported).
-#
+The alpn module will use an appropriate alpn-boot jar for your
-# The alpn module will use an appropriate alpn-boot jar for your
+specific version of Java.
-# specific version of Java.
 #
 # IMPORTANT: Versions of Java that exist after this module was created are
 #            not guaranteed to work with existing alpn-boot jars, and might

jetty-annotations/src/main/config/modules/annotations.mod

@@ -1,15 +1,11 @@
-#
+[description]
-# Jetty Annotation Scanning Module
+Enables Annotation scanning for deployed webapplications.
-#
 
 [depend]
-# Annotations needs plus, and jndi features
 plus
 
 [lib]
-# Annotations needs jetty annotation jars
 lib/jetty-annotations-${jetty.version}.jar
-# Need annotation processing jars too
 lib/annotations/*.jar
 
 [xml]

jetty-cdi/cdi-servlet/src/main/config/modules/cdi.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# [EXPERIMENTAL] CDI / Weld Jetty module
+Experimental CDI/Weld integration
-#
 
 [depend]
 deploy

jetty-client/src/main/config/modules/client.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Client Feature
+Adds the Jetty HTTP client to the server classpath.
-#
 
 [lib]
 lib/jetty-client-${jetty.version}.jar

jetty-deploy/src/main/config/modules/deploy.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Deploy Feature
+Enables webapplication deployment from the webapps directory.
-#
 
 [depend]
 webapp

jetty-distribution/src/main/resources/modules/hawtio.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Hawtio x module
+Deploys the Hawtio console as a webapplication.
-#
 
 [depend]
 stats

jetty-distribution/src/main/resources/modules/jamon.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# JAMon Jetty module
+Deploys the JAMon webapplication
-#
 
 [depend]
 stats

jetty-distribution/src/main/resources/modules/jminix.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# JaMON Jetty module
+Deploys the Jminix JMX Console within the server
-#
 
 [depend]
 stats

jetty-distribution/src/main/resources/modules/jolokia.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jolokia Jetty module
+Deploys the Jolokia console as a web application.
-#
 
 [depend]
 stats

jetty-distribution/src/main/resources/modules/jsp.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty JSP Module
+Enables JSP for all webapplications deployed on the server.
-#
 
 [depend]
 servlet

jetty-distribution/src/main/resources/modules/jstl.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty JSTL Module
+Enables JSTL for all webapplications deployed on the server
-#
 
 [depend]
 jsp

jetty-distribution/src/main/resources/modules/setuid.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Set UID Feature
+Enables the unix setUID configuration so that the server
-#
+may be started as root to open privileged ports/files before
+changing to a restricted user (eg jetty).
 
 [depend]
 server

jetty-fcgi/fcgi-server/src/main/config/modules/fcgi.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# FastCGI Module
+Adds the FastCGI implementation to the classpath.
-#
 
 [depend]
 servlet

jetty-gcloud/gcloud-session-manager/src/main/config/modules/gcloud-sessions.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty GCloudDatastore Session Manager module
+Enables the GCloudDatastore Session Mananger module.
-#
 
 [depend]
 annotations

jetty-http2/http2-server/src/main/config/modules/http2.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# HTTP2 Support Module
+Enables HTTP2 protocol support on the TLS(SSL) Connector,
-#
+using the ALPN extension to select which protocol to use.
 
 [depend]
 ssl

jetty-http2/http2-server/src/main/config/modules/http2c.mod

@@ -1,9 +1,6 @@
-#
+[description]
-# HTTP2 Clear Text Support Module
+Enables the HTTP2C protocol on the HTTP Connector
-# This module adds support for HTTP/2 clear text to the
+The connector will accept both HTTP/1 and HTTP/2 connections.
-# HTTP/1 clear text connector (defined in jetty-http.xml).
-# The resulting connector will accept both HTTP/1 and HTTP/2 connections.
-#
 
 [depend]
 http

jetty-infinispan/src/main/config/modules/infinispan.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty Infinispan module
+Enables an Infinispan Session Manager for session 
-#
+persistance and/or clustering
 
 [depend]
 annotations

jetty-jaas/src/main/config/modules/jaas.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# JAAS Module
+Enable JAAS for deployed webapplications.
-#
 
 [depend]
 server

jetty-jaspi/src/main/config/modules/jaspi.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty JASPI Module
+Enable JASPI authentication for deployed webapplications.
-#
 
 [depend]
 security

jetty-jmx/src/main/config/modules/jmx-remote.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# JMX Remote Module
+Enables remote RMI access to JMX
-#
 
 [depend]
 jmx

jetty-jmx/src/main/config/modules/jmx.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# JMX Module
+Enables JMX instrumentation for server beans and 
-#
+enables JMX agent.
 
 [depend]
 server

jetty-jndi/src/main/config/modules/jndi.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# JNDI Support
+Adds the Jetty JNDI implementation to the classpath.
-#
 
 [depend]
 server

jetty-monitor/src/main/config/modules/monitor.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty Monitor module
+Enables the Jetty Monitor Module to periodically
-#
+check/publish JMX parameters of the server.
 
 [depend]
 server

jetty-nosql/src/main/config/modules/nosql.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty NoSql module
+Enables NoSql session management with a MongoDB driver.
-#
 
 [depend]
 webapp

jetty-overlay-deployer/src/main/config/modules/overlay.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty Overlay module
+Enable the jetty overlay deployer that allows
-#
+webapplications to be dynamically composed of layers.
 
 [depend]
 deploy

jetty-plus/src/main/config/modules/plus.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Jetty Plus module
+Enables JNDI and resource injection for webapplications 
-#
+and other servlet 3.x features not supported in the core
+jetty webapps module.
 
 [depend]
 server

jetty-proxy/src/main/config/modules/proxy.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty Proxy module
+Enable the Jetty Proxy, that allows the server to act
-#
+as a non-transparent proxy for browsers.
 
 [depend]
 servlet

jetty-quickstart/src/main/config/modules/quickstart.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty Quickstart module
+Enables the Jetty Quickstart module for rapid
-#
+deployment of preconfigured webapplications.
 
 [depend]
 server

jetty-rewrite/src/main/config/modules/rewrite.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty Rewrite module
+Enables the jetty-rewrite handler.  Specific rewrite
-#
+rules must be added to etc/jetty-rewrite.xml
 
 [depend]
 server

jetty-security/src/main/config/modules/security.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty Security Module
+Adds servlet standard security handling to the classpath.
-#
 
 [depend]
 server

jetty-server/src/main/config/modules/continuation.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Classic Jetty Continuation Support Module
+Enables support for Continuation style asynchronous
-#
+Servlets.  Now deprecated in favour of Servlet 3.1
+API
 
 [lib]
 lib/jetty-continuation-${jetty.version}.jar

jetty-server/src/main/config/modules/debug.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Debug module
+Enables the DebugListener to generate additional 
-#
+logging regarding detailed request handling events.
+Renames threads to include request URI.
 
 [depend]
 deploy

jetty-server/src/main/config/modules/debuglog.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Debug module
+Deprecated Debug Log using the DebugHandle.
-#
+Replaced with the debug module.
 
 [depend]
 server

jetty-server/src/main/config/modules/ext.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Module to add all lib/ext/**.jar files to classpath
+Adds all jar files discovered in $JETTY_HOME/lib/ext
-#
+and $JETTY_BASE/lib/ext to the servers classpath.
 
 [lib]
 lib/ext/**.jar

jetty-server/src/main/config/modules/gzip.mod

@@ -1,7 +1,6 @@
-#
+[description]
-# GZIP module
+Enable GzipHandler for dynamic gzip compression
-# Applies GzipHandler to entire server
+for the entire server.
-#
 
 [depend]
 server

jetty-server/src/main/config/modules/home-base-warning.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Home and Base Warning
+Generates a warning that server has been run from $JETTY_HOME
-#
+rather than from a $JETTY_BASE.
 
 [xml]
 etc/home-base-warning.xml

jetty-server/src/main/config/modules/http-forwarded.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty HTTP Connector
+Adds a forwarded request customizer to the HTTP Connector
-#
+to process forwarded-for style headers from a proxy.
 
 [depend]
 http

jetty-server/src/main/config/modules/http.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Jetty HTTP Connector
+Enables a HTTP connector on the server.
-#
+By default HTTP/1 is support, but HTTP2C can
+be added to the connector with the http2c module.
 
 [depend]
 server

jetty-server/src/main/config/modules/https.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty HTTPS Connector
+Adds HTTPS protocol support to the TLS(SSL) Connector
-#
 
 [depend]
 ssl

jetty-server/src/main/config/modules/ipaccess.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# IPAccess module
+Enable the ipaccess handler to apply a white/black list
-#
+control of the remote IP of requests.
 
 [depend]
 server

jetty-server/src/main/config/modules/jdbc-sessions.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty JDBC Session module
+Enables JDBC Session management.
-#
 
 [depend]
 annotations
@@ -9,7 +8,6 @@ webapp
 [xml]
 etc/jetty-jdbc-sessions.xml
 
-
 [ini-template]
 ## JDBC Session config
 

jetty-server/src/main/config/modules/jvm.mod

@@ -1,3 +1,6 @@
+[description]
+A noop module that creates an ini template useful for
+setting JVM arguments (eg -Xmx )
 [ini-template]
 ## JVM Configuration
 ## If JVM args are include in an ini file then --exec is needed

jetty-server/src/main/config/modules/lowresources.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Low Resources module
+Enables a low resource monitor on the server
-#
+that can take actions if threads and/or connections
+cross configured threshholds.
 
 [depend]
 server

jetty-server/src/main/config/modules/proxy-protocol-ssl.mod

@@ -1,6 +1,9 @@
-#
+[description]
-# PROXY Protocol Module - SSL
+Enables the Proxy Protocol on the TLS(SSL) Connector.
-#
+http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
+This allows a Proxy operating in TCP mode to transport
+details of the proxied connection to the server.
+Both V1 and V2 versions of the protocol are supported.
 
 [depend]
 ssl

jetty-server/src/main/config/modules/proxy-protocol.mod

@@ -1,6 +1,10 @@
-#
+[description]
-# PROXY Protocol Module - HTTP
+Enables the Proxy Protocol on the HTTP Connector.
-#
+http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
+This allows a proxy operating in TCP mode to 
+transport details of the proxied connection to
+the server.
+Both V1 and V2 versions of the protocol are supported. 
 
 [depend]
 http

jetty-server/src/main/config/modules/requestlog.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Request Log module
+Enables a NCSA style request log.
-#
 
 [depend]
 server

jetty-server/src/main/config/modules/resources.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# Module to add resources directory to classpath
+Adds the $JETTY_HOME/resources and/or $JETTY_BASE/resources
-#
+directory to the server classpath. Useful for configuration
+property files (eg jetty-logging.properties)
 
 [lib]
 resources/

jetty-server/src/main/config/modules/server.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Base Server Module
+Enables the core Jetty server on the classpath.
-#
 
 [optional]
 jvm

jetty-server/src/main/config/modules/ssl.mod

@@ -1,6 +1,7 @@
-#
+[description]
-# SSL Keystore module
+Enables a TLS(SSL) Connector on the server.
-#
+This may be used for HTTPS and/or HTTP2 by enabling
+the associated support modules.
 
 [name]
 ssl

jetty-server/src/main/config/modules/stats.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Stats module
+Enable detailed statistics collection for the server,
-#
+available via JMX.
 
 [depend]
 server

jetty-servlet/src/main/config/modules/servlet.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# Jetty Servlet Module
+Enables standard Servlet handling.
-#
 
 [depend]
 server

jetty-servlets/src/main/config/modules/servlets.mod

@@ -1,7 +1,8 @@
-#
+[description]
-# Jetty Servlets Module
+Puts a collection of jetty utility servlets and filters
-#
+on the server classpath (CGI, CrossOriginFilter, DosFilter,
-
+MultiPartFilter, PushCacheFilter, QoSFilter, etc.) for
+use by all webapplications.
 
 [depend]
 servlet

jetty-spring/src/main/config/modules/spring.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Spring
+Enable spring configuration processing so all jetty style 
-#
+xml files can optionally be written as spring beans
 
 [name]
 spring

jetty-unixsocket/src/main/config/modules/unixsocket-forwarded.mod

@@ -1,7 +1,8 @@
 [description]
 Adds a forwarded request customizer to the HTTP configuration used
 by the Unix Domain Socket connector, for use when behind a proxy operating
-in HTTP mode that adds forwarded-for style HTTP headers
+in HTTP mode that adds forwarded-for style HTTP headers. Typically this
+is an alternate to the Proxy Protocol used mostly for TCP mode.
 
 [depend]
 unixsocket-http

jetty-unixsocket/src/main/config/modules/unixsocket-http.mod

@@ -1,5 +1,5 @@
 [description]
-Adds a HTTP connection factory to the Unix Domain Socket connector.
+Adds a HTTP protocol support to the Unix Domain Socket connector.
 It should be used when a proxy is forwarding either HTTP or decrypted
 HTTPS traffic to the connector and may be used with the 
 unix-socket-http2c modules to upgrade to HTTP/2.

jetty-unixsocket/src/main/config/modules/unixsocket-proxy-protocol.mod

@@ -5,7 +5,8 @@ This allows information about the proxied connection to be
 efficiently forwarded as the connection is accepted.
 Both V1 and V2 versions of the protocol are supported and any
 SSL properties may be interpreted by the unixsocket-secure 
-module to indicate secure HTTPS traffic.
+module to indicate secure HTTPS traffic. Typically this
+is an alternate to the forwarded module.
 
 [depend]
 unixsocket

jetty-unixsocket/src/main/config/modules/unixsocket.mod

@@ -4,7 +4,6 @@ requests from a local proxy and/or SSL offloader (eg haproxy) in either
 HTTP or TCP mode.  Unix Domain Sockets are more efficient than 
 localhost TCP/IP connections  as they reduce data copies, avoid 
 needless fragmentation and have better dispatch behaviours. 
-
 When enabled with corresponding support modules, the connector can 
 accept HTTP, HTTPS or HTTP2C traffic.
 

jetty-util/src/main/config/modules/logging.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# Jetty std err/out logging
+Redirects JVMs stderr and stdout to a log file,
-#
+including output from Jetty's default StdErrLog logging.
 
 [xml]
 etc/jetty-logging.xml

jetty-webapp/src/main/config/modules/webapp.mod

@@ -1,6 +1,6 @@
-#
+[description]
-# WebApp Support Module
+Adds support for servlet specification webapplication to the server
-#
+classpath.  Without this, only Jetty specific handlers may be deployed.
 
 [depend]
 servlet

jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod

@@ -1,6 +1,5 @@
-#
+[description]
-# WebSocket Module
+Enable websockets for deployed web applications
-#
 
 [depend]
 # javax.websocket needs annotations