This module exists for strict environments where you are force to deploy into a Servlet Container.

If you are free to deploy a new server technology, we strongly recommend to avoid this and go
directly with netty, jetty or undertow.

Generate a *.war file at build time. The *.war file can be deployed into a Servlet Container.

Add the ```jooby-servlet``` dependency to your ```pom.xml```:

```xml
<dependency>
  <groupId>org.jooby</groupId>
  <artifactId>jooby-ftl</artifactId>
  <version>{{version}}</version>
  <scope>provided</scope>
</dependency>
```

IMPORTANT: Scope must be ```provided```.

Find out the ```maven-assembly-plugin``` section in your ```pom.xml```, it looks like this:

```xml
<!-- Build jooby.zip | jooby.war -->
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <descriptorRefs>
      <descriptorRef>jooby.zip</descriptorRef>
    </descriptorRefs>
  </configuration>
</plugin>
```

Add a new descriptorRef: ```jooby.war```

```xml
<!-- Build jooby.zip | jooby.war -->
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <descriptorRefs>
      <descriptorRef>jooby.zip</descriptorRef>
      <descriptorRef>jooby.war</descriptorRef>
    </descriptorRefs>
  </configuration>
</plugin>
```

Run: ```mvn clean package``` and find the ```*.war``` file in the ```target``` directory.

* web-sockets are not supported
* some properties has no effect when deploying into a Servlet Container:
 - application.path
 - appplication.port
 - any other server specific property: server.*, jetty.*, netty.*, undertow.*

The ```maven-assembly-plugin``` generates the *.war file. The assembly descriptor can be found
[here](https://github.com/jooby-project/jooby/blob/master/jooby-dist/src/main/resources/assemblies/jooby.war.xml)

All it does, is to adapt the project structure to the one required by a Servlet Container.

A default web.xml file is generated by the assembly plugin. File looks like:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  version="3.1">
  <context-param>
    <param-name>application.class</param-name>
    <param-value>${application.class}</param-value>
  </context-param>

  <listener>
    <listener-class>org.jooby.servlet.ServerInitializer</listener-class>
  </listener>

  <servlet>
    <servlet-name>jooby</servlet-name>
    <servlet-class>org.jooby.servlet.ServletHandler</servlet-class>
    <load-on-startup>0</load-on-startup>
    <!-- MultiPart setup -->
    <multipart-config>
      <file-size-threshold>0</file-size-threshold>
      <!-- Default 200k -->
      <max-request-size>${war.maxRequestSize}</max-request-size>
    </multipart-config>
  </servlet>

  <servlet-mapping>
    <servlet-name>jooby</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>
```

Default upload size is set to ```204800b``` (200kb). If you need to increase the upload size, add
the ```war.maxRequestSize``` property to ```pom.xml```:

```
<properties>
  <war.maxRequestSize>1048576</war.maxRequestSize> <!-- 1mb -->
</properties>
```

It is possible to provide your own ```web.xml``` file too. Follow these steps

1. create a dir: ```src/etc/war/WEB-INF```
2. save a ```web.xml``` file inside that dir
3. run: ```mvn clean package```

That's all folks! Enjoy it!!!

Author: jknack

jooby-servlet/src/main/resources/WEB-INF/web.xml

@@ -18,8 +18,7 @@
     <!-- MultiPart setup -->
     <multipart-config>
       <file-size-threshold>0</file-size-threshold>
-      <!-- 200k -->
-      <max-request-size>204800</max-request-size>
+      <max-request-size>${war.maxRequestSize}</max-request-size>
     </multipart-config>
   </servlet>
 

md/available-modules.md

@@ -14,3 +14,6 @@
 ### [jdbc](https://github.com/jooby-project/jooby/tree/master/jooby-jdbc)
 ### [jdbi](https://github.com/jooby-project/jooby/tree/master/jooby-jdbi)
 ### [hibernate](https://github.com/jooby-project/jooby/tree/master/jooby-hbm)
+
+## servlet deployment
+### [servlet](https://github.com/jooby-project/jooby/tree/master/jooby-servlet)

md/doc/jooby-servlet/README.md

@@ -0,0 +1,135 @@
+# jooby-servlet
+
+This module exists for strict environments where your ONLY option is to deploy into a Servlet Container.
+If you are free to deploy a new server technology, we strongly recommend to avoid this and go
+directly with netty, jetty or undertow.
+
+## prepare
+
+Generate a *.war file at build time. The *.war file can be deployed into a Servlet Container.
+
+### step 1
+
+Add the ```jooby-servlet``` dependency to your ```pom.xml```:
+
+```xml
+<dependency>
+  <groupId>org.jooby</groupId>
+  <artifactId>jooby-ftl</artifactId>
+  <version>{{version}}</version>
+  <scope>provided</scope>
+</dependency>
+```
+
+IMPORTANT: Scope must be ```provided```.
+
+### step 2
+
+Find out the ```maven-assembly-plugin``` section in your ```pom.xml```, it looks like this:
+
+```xml
+<!-- Build jooby.zip | jooby.war -->
+<plugin>
+  <groupId>org.apache.maven.plugins</groupId>
+  <artifactId>maven-assembly-plugin</artifactId>
+  <configuration>
+    <descriptorRefs>
+      <descriptorRef>jooby.zip</descriptorRef>
+    </descriptorRefs>
+  </configuration>
+</plugin>
+```
+
+Add a new descriptorRef: ```jooby.war```
+
+```xml
+<!-- Build jooby.zip | jooby.war -->
+<plugin>
+  <groupId>org.apache.maven.plugins</groupId>
+  <artifactId>maven-assembly-plugin</artifactId>
+  <configuration>
+    <descriptorRefs>
+      <descriptorRef>jooby.zip</descriptorRef>
+      <descriptorRef>jooby.war</descriptorRef>
+    </descriptorRefs>
+  </configuration>
+</plugin>
+```
+
+### step 3
+
+Run: ```mvn clean package``` and find the ```*.war``` file in the ```target``` directory.
+
+## limitations
+
+* web-sockets are not supported
+* some properties has no effect when deploying into a Servlet Container:
+ - application.path
+ - appplication.port
+ - any other server specific property: server.*, jetty.*, netty.*, undertow.*
+
+## how it works?
+
+The ```maven-assembly-plugin``` generates the *.war file. The assembly descriptor can be found
+[here](https://github.com/jooby-project/jooby/blob/master/jooby-dist/src/main/resources/assemblies/jooby.war.xml)
+
+All it does, is to adapt the project structure to the one required by a Servlet Container.
+
+
+### web.xml
+
+A default web.xml file is generated by the assembly plugin. File looks like:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
+  version="3.1">
+  <context-param>
+    <param-name>application.class</param-name>
+    <param-value>${application.class}</param-value>
+  </context-param>
+
+  <listener>
+    <listener-class>org.jooby.servlet.ServerInitializer</listener-class>
+  </listener>
+
+  <servlet>
+    <servlet-name>jooby</servlet-name>
+    <servlet-class>org.jooby.servlet.ServletHandler</servlet-class>
+    <load-on-startup>0</load-on-startup>
+    <!-- MultiPart setup -->
+    <multipart-config>
+      <file-size-threshold>0</file-size-threshold>
+      <!-- Default 200k -->
+      <max-request-size>${war.maxRequestSize}</max-request-size>
+    </multipart-config>
+  </servlet>
+
+  <servlet-mapping>
+    <servlet-name>jooby</servlet-name>
+    <url-pattern>/*</url-pattern>
+  </servlet-mapping>
+</web-app>
+```
+
+#### upload size
+
+Default upload size is set to ```204800b``` (200kb). If you need to increase the upload size, add
+the ```war.maxRequestSize``` property to ```pom.xml```:
+
+```
+<properties>
+  <war.maxRequestSize>1048576</war.maxRequestSize> <!-- 1mb -->
+</properties>
+```
+
+#### custom web.xml
+
+It is possible to provide your own ```web.xml``` file too. Follow these steps
+
+1. create a dir: ```src/etc/war/WEB-INF```
+2. save a ```web.xml``` file inside that dir
+3. run: ```mvn clean package```
+
+That's all folks! Enjoy it!!!

pom.xml

@@ -1022,6 +1022,7 @@
     <quartz.version>2.2.1</quartz.version>
     <jdbi.version>2.59</jdbi.version>
     <freemarker.version>2.3.22</freemarker.version>
+    <war.maxRequestSize>204800</war.maxRequestSize>
 
     <!-- Test dependencies -->
     <junit.version>4.11</junit.version>