ch.ralscha.embeddedtc

Class EmbeddedTomcat

java.lang.Object

ch.ralscha.embeddedtc.EmbeddedTomcat

public class EmbeddedTomcat
extends Object

Helper class to simplify setting up a Embedded Tomcat in a IDE and with a Maven web project.

Author:

Ralph Schaer

Constructor Summary

Constructors

Constructor and Description
EmbeddedTomcat() Creates an embedded Tomcat with context path "/" and port 8080.
EmbeddedTomcat(int port) Creates an embedded Tomcat with context path "/" and specified port.
EmbeddedTomcat(String contextPath) Creates an embedded Tomcat with the specified context path and port 8080 Context directory points to current directory + /src/main/webapp Change context directory with the method setContextDirectory(String)
EmbeddedTomcat(String contextPath, int port) Creates an embedded Tomcat with specified context path and specified port.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllDependenciesAsResourceJar() Adds all the dependencies specified in the pom.xml (except scope provided) to the context as a resource jar.
void	addContextEnvironment(org.apache.catalina.deploy.ContextEnvironment env) Adds a ContextEnvironment object to embedded Tomcat.
void	addContextEnvironment(String name, String value, String type) Convenient method for adding a context environment to the embedded Tomcat.
void	addContextEnvironmentString(String name, String value) Convenient method for adding a context environment with type java.lang.String to the embedded Tomcat.
void	addContextResource(org.apache.catalina.deploy.ContextResource res) Adds a ContextResource object to the list of resources in the embedded Tomcat.
void	addDependencyAsResourceJar(String groupId, String artifact) Adds the specified jar to the context as a resource jar.
void	addInitializer(Class<? extends ServletContainerInitializer> containerInitializer, Class<?> handlesClass) Adds a container initializer to the list of initializers.
void	dontAddShutdownHook() The EmbeddedTomcat opens as default a shutdown port on port + 1000 with the shutdown command EMBEDDED_TC_SHUTDOWN Calling this method disables adding the shutdown hook.
static void	main(String[] args) Starts a embedded Tomcat on port 8080 with context path "/" and context directory current directory + /src/main/webapp
void	removeDefaultServlet() Calling this method prevents adding the DefaultServlet to the context.
void	setContextDirectory(String contextDirectory) Sets the context directory.
void	setM2Directory(File m2Directory) Sets the path to the Maven local repository.
void	setPomFile(File pomFile) Sets the location of the pom file.
void	setPrivileged(boolean privileged) Set the privileged flag for this web application.
void	setSecondsToWaitBeforePortBecomesAvailable(int seconds) Before starting the embedded Tomcat the programm tries to stop a previous process by sendig the shutdown command to the shutdown port.
void	setShutdownPort(int shutdownPort) Specifies the port the server is listen for the shutdown command.
void	setSilent(boolean silent) Set the silent flag of Tomcat.
void	setTempDirectory(File tempDirectory) Sets the location of the temporary directory.
void	setTempDirectoryName(String name) Sets the temporary directory to a directory beneath System.getProperty("java.io.tmpdir") The directory does not have to exists, Tomcat will create it automatically if necessary.
void	start() Starts the embedded Tomcat and do not wait for incoming requests.
void	startAndWait() Starts the embedded Tomcat and waits for incoming requests.
void	stop() Stops the embedded tomcat.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbeddedTomcat

public EmbeddedTomcat()

Creates an embedded Tomcat with context path "/" and port 8080. Context directory points to current directory + /src/main/webapp Change context directory with the method setContextDirectory(String)

See Also:

setContextDirectory(String)

EmbeddedTomcat

public EmbeddedTomcat(int port)

Creates an embedded Tomcat with context path "/" and specified port. Context directory points to current directory + /src/main/webapp Change context directory with the method setContextDirectory(String)

Parameters:

port - ip port the server is listening

See Also:

setContextDirectory(String)

EmbeddedTomcat

public EmbeddedTomcat(String contextPath)

Creates an embedded Tomcat with the specified context path and port 8080 Context directory points to current directory + /src/main/webapp Change context directory with the method setContextDirectory(String)

Parameters:

contextPath - The context path has to start with /

See Also:

setContextDirectory(String)

EmbeddedTomcat

public EmbeddedTomcat(String contextPath,
              int port)

Creates an embedded Tomcat with specified context path and specified port. Context directory points to current directory + /src/main/webapp Change context directory with the method setContextDirectory(String)

Parameters:

contextPath - has to begin with /

port - ip port the server is listening

See Also:

setContextDirectory(String)

Method Detail

main

public static void main(String[] args)

Starts a embedded Tomcat on port 8080 with context path "/" and context directory current directory + /src/main/webapp

Parameters:

args - program arguments

setContextDirectory

public void setContextDirectory(String contextDirectory)

Sets the context directory. Normally this point to the directory that hosts the WEB-INF directory. Default value is: current directory + /src/main/webapp This is the normal location of the webapplication directory in a Maven web app project.

Parameters:

contextDirectory - Path name to the directory that contains the web application.

setTempDirectory

public void setTempDirectory(File tempDirectory)

Sets the location of the temporary directory. Tomcat needs this for storing temporary files like compiled jsp files. Default value is for a context path "/"

System.getProperty("java.io.tmpdir") + "/_" + port

and with every other context path

System.getProperty("java.io.tmpdir") + contextPath + "_" + port

Parameters:

tempDirectory - File object that represents the location of the temp directory

setTempDirectoryName

public void setTempDirectoryName(String name)

Sets the temporary directory to a directory beneath System.getProperty("java.io.tmpdir")
The directory does not have to exists, Tomcat will create it automatically if necessary.

Parameters:

name - directory name

See Also:

setTempDirectory(File)

setPomFile

public void setPomFile(File pomFile)

Sets the location of the pom file.
Default value is current directory + /pom.xml

Parameters:

pomFile - File object that points to the maven pom file (pom.xml)

setM2Directory

public void setM2Directory(File m2Directory)

Sets the path to the Maven local repository. Default value is System.getProperty("user.home") + /.m2/repository/

Parameters:

m2Directory - File object that points to the Maven local repository directory

removeDefaultServlet

public void removeDefaultServlet()

Calling this method prevents adding the DefaultServlet to the context. This is needed if the programm uses an initializer that adds a servlet with a mapping of "/"

See Also:

addInitializer(Class, Class)

dontAddShutdownHook

public void dontAddShutdownHook()

The EmbeddedTomcat opens as default a shutdown port on port + 1000 with the shutdown command EMBEDDED_TC_SHUTDOWN Calling this method disables adding the shutdown hook.

setSecondsToWaitBeforePortBecomesAvailable

public void setSecondsToWaitBeforePortBecomesAvailable(int seconds)

Before starting the embedded Tomcat the programm tries to stop a previous process by sendig the shutdown command to the shutdown port. It then waits for the port to become available. It checks this every second for the specified number of seconds

Parameters:

seconds - number of seconds

setShutdownPort

public void setShutdownPort(int shutdownPort)

Specifies the port the server is listen for the shutdown command. Default is port + 1000

Parameters:

shutdownPort - the shutdown port

See Also:

dontAddShutdownHook()

setPrivileged

public void setPrivileged(boolean privileged)

Set the privileged flag for this web application.

Parameters:

privileged - The new privileged flag

setSilent

public void setSilent(boolean silent)

Set the silent flag of Tomcat. If true Tomcat no longer prints any log messages

Parameters:

silent - The new silent flag

addAllDependenciesAsResourceJar

public void addAllDependenciesAsResourceJar()

Adds all the dependencies specified in the pom.xml (except scope provided) to the context as a resource jar. A resource jar contains static resources in the directory META-INF/resources <

See Also:

Context.addResourceJarUrl(URL)

addDependencyAsResourceJar

public void addDependencyAsResourceJar(String groupId,
                              String artifact)

Adds the specified jar to the context as a resource jar. The helper class automatically locates the version of the specified artifact in the pom.xml and locates the jar file in the local maven repository.

Parameters:

groupId - the maven groupId name

artifact - the maven artifact name

See Also:

Context.addResourceJarUrl(URL), addAllDependenciesAsResourceJar()

addInitializer

public void addInitializer(Class<? extends ServletContainerInitializer> containerInitializer,
                  Class<?> handlesClass)

Adds a container initializer to the list of initializers.

For example in a spring project adding a SpringServlet Initializer

  etc.addInitializer(SpringServletContainerInitializer.class, 
          MyWebAppInitializer.class);
 

If the initializer adds a servlet to the default root ("/") call removeDefaultServlet()

Parameters:

containerInitializer - class that implements ServletContainerInitializer

handlesClass - any class that is handled by the initializer

See Also:

Context.addServletContainerInitializer(ServletContainerInitializer, Set), removeDefaultServlet()

addContextEnvironment

public void addContextEnvironment(org.apache.catalina.deploy.ContextEnvironment env)

Adds a ContextEnvironment object to embedded Tomcat.

Example:
Tomcat context xml file

    <Environment name="aparam" 
                 value="test" 
                 type="java.lang.String" 
                 override="false"/>  
 

A programmatic way to add this environment to the embedded Tomcat is by calling this method

   ContextEnvironment env = new ContextEnvironment();
   env.setType("java.lang.String");
   env.setName("aparam");
   env.setValue("test");
   embeddedTomcat.addContextEnvironment(env);
 

Parameters:

env - context environment variable

See Also:

ContextEnvironment, NamingResources.addEnvironment(ContextEnvironment), addContextEnvironment(String, String, String), addContextEnvironmentString(String, String)

addContextResource

public void addContextResource(org.apache.catalina.deploy.ContextResource res)

Adds a ContextResource object to the list of resources in the embedded Tomcat.

Example:
Tomcat context xml file

  <Resource name="jdbc/ds" auth="Container"
     type="javax.sql.DataSource" username="sa" password=""
     driverClassName="org.h2.Driver"
     url="jdbc:h2:~/mydb"
     maxActive="20" maxIdle="4" maxWait="10000"
     defaultAutoCommit="false"/>
 

Programmatic way:

   ContextResource res = new ContextResource();
   res.setName("jdbc/ds");
   res.setType("javax.sql.DataSource");
   res.setAuth("Container");
   res.setProperty("username", "sa");
   res.setProperty("password", "");
   res.setProperty("driverClassName", "org.h2.Driver");
   res.setProperty("url", "jdbc:h2:~/mydb");
   res.setProperty("maxActive", "20");
   res.setProperty("maxIdle", "4");
   res.setProperty("maxWait", "10000");
   res.setProperty("defaultAutoCommit", "false");
    
   embeddedTomcat.addContextResource(res);
 

Parameters:

res - resource object

See Also:

ContextResource, NamingResources.addResource(ContextResource)

addContextEnvironment

public void addContextEnvironment(String name,
                         String value,
                         String type)

Convenient method for adding a context environment to the embedded Tomcat. Creates a ContextEnvironment object and adds it to the list of the context environments.

Example:
Tomcat context xml file

    <Environment name="aparam" 
                 value="test" 
                 type="java.lang.String" 
                 override="false"/>  
 

Programmatic way:

   embeddedTomcat.addContextEnvironment("aparam", "test", "java.lang.String");
 

Parameters:

name - name of the context environment

value - value of the context environment

type - type of the context environment

See Also:

ContextEnvironment, NamingResources.addEnvironment(ContextEnvironment), addContextEnvironment(ContextEnvironment), addContextEnvironmentString(String, String)

addContextEnvironmentString

public void addContextEnvironmentString(String name,
                               String value)

Convenient method for adding a context environment with type java.lang.String to the embedded Tomcat.

   embeddedTomcat.addContextEnvironment("aparam", "test");
 

Parameters:

name - name of the context environment

value - value of the context environment

See Also:

ContextEnvironment, NamingResources.addEnvironment(ContextEnvironment), addContextEnvironment(ContextEnvironment), addContextEnvironment(String, String, String)

start

public void start()

Starts the embedded Tomcat and do not wait for incoming requests. Returns immediately if the configured port is in use.

See Also:

startAndWait()

startAndWait

public void startAndWait()

Starts the embedded Tomcat and waits for incoming requests. Returns immediately if the configured port is in use.

See Also:

start()

stop

public void stop()

Stops the embedded tomcat. Does nothing if it's not started