Deploying with Tomcat

1

This article was written by Andrew Lindesay ([[http:~~/~~/www.lindesay.co.nz>>url:http://www.lindesay.co.nz||shape="rect"]]) around May 2005. It first appeared as LaTeX PDF and has been transcribed into this Wiki. You use the information contained in this document at your own risk. Please contact the author if you feel there may have been an error in the conversion to Wiki markup.

2

3

More information on tomcat deployment using Eclipse/WOLips, including information on how to deploy Project Wonder applications, is available [[here>>doc:WO.Home.Deprecated.Creating a wonder app to deploy as a servlet.WebHome]]

|=(((

Contents

)))

|(((

)))

= Abstract =

From WebObjects 5.2, it has been possible to derive a build product from a WebObjects application project that can be deployed into a J2EE servlet container. This article shows how it is possible to

15

deploy a WebObjects 5.2 application into a Tomcat environment and achieve a very similar topology to the "native" WebObjects deploy.

= Introduction =

This document was originally written assuming a Tomcat 5 deployment, but after some difficulties with web services and AXIS, I have modified this document to also cater for a Tomcat 3 deployment. This document covers both circumstances.

= Assumptions =

This article assumes the following:

24

25

* WebObjects 5.2 (likely to work fine with newer versions)

26

* Java 1.4

27

* Latest Tomcat release of version 5 (5.5.12 at the time of writing) or 3 (3.3.2 at the time of writing)

28

* Some sort of UNIX deployment.

29

* The reader has some conception of the concepts behind servlet technology.

30

* The reader is familiar with a standard WebObjects deployment topology which will be referred to as //wotaskd// deployment.

31

32

For the purposes of this document, it is assumed that Tomcat has been installed at a directory on the local disc called {{code language="none"}}$TOMCATDIR{{/code}}. It is also assumed that you will have another directory with the files required to configure and run an instance called {{code language="none"}}$INSTDIR{{/code}}. It is assumed also that you will have a directory called {{code language="none"}}$JKDIR{{/code}} with the Tomcat apache adaptor in it. In this article, some configuration files require the paths to be shown and these are tabulated below.

|(((

$TOMCATDIR

)))|(((

/opt/tomcat

)))

|(((

$INSTDIR

)))|(((

/opt/fooapp

)))

|(((

$JKDIR

)))|(((

/opt/modjk

)))

In reality, these directories could be located anywhere.

== Objective ==

The objective of this article is to show that a WebObjects application can be deployed into a servlet container and keep some of the desirable attributes of a WebObjects deployment topology. Some of these traits are itemised below.

67

68

* Clustering over a number of hardware nodes to prevent system downtime from a single hardware failure incident.

69

* Clustering over a number of virtual machine //instances// on each hardware node to avoid downtime from a single software failure incident.

70

* Ability to make efficient use of lower cost server hardware rather than encouraging use of large, expensive servers.

71

* Make maximum use of memory availabile in each virtual machine as cache to minimise database traffic and lower stress on the database server.

72

* Ability to make sessions "sticky" to a given virtual machine //instance//, whilst being multiplexed through a single web server front-end adaptor.

73

* Ability to load-balance requests to instances which are operational.

74

75

A standard WebObjects deployment topology is shown in the figure below alongside what is to be achieved with Tomcat. A typical J2EE deployment may have a different topology from this.

76

77

[[image:attach:wo-tomcat-deploy-topology.gif]]

78

79

= Servlet Build Products =

80

81

Creating a servlet build product from a WebObjects application project is covered in some depth by documentation that is supplied by Apple for WebObjects. This is not going to be repeated here, but here is a brief overview of the process.

82

83

* Include the {{code language="none"}}JavaWOJSPServlet.framework{{/code}} framework into your project.

84

* In the build settings, set the {{code language="none"}}SERVLET_SINGLE_DIR_DEPLOY{{/code}} value to {{code language="none"}}YES{{/code}} to create the most trouble-free form of deployment servlet.

85

* Edit the {{code language="none"}}SERVLET_DEPLOY_LICENSE{{/code}} to contain your valid deployment license key if you need one for the version of WebObjects you are using.

86

* Edit the {{code language="none"}}SERVLET_WEBAPPS_DIR{{/code}} to point to {{code language="none"}}$INSTDIR/webapps/{{/code}} or some place where you want the build product to go.

87

88

Now when you choose a //Deployment// build, you will also get the servlet assembled. The end result is a directory structure similar to that shown in the figure below.

89

90

[[image:attach:wo-tomcat-ssd-filelayout-3.gif]]

91

92

= Removing the DOCTYPE from .plist Files =

93

94

Many property-list files (often called plist files) have a document type at the top. This can refer to files on a MacOS-X machine or to files on Apple servers. In either case this can cause problems with deployments which are not on MacOS-X servers. The following script can be run with the argument of the {{code language="none"}}WEB-INF{{/code}} folder to remove these. The WebObjects application runs fine without this information in the plist files. This script can easily be incorporated one way or another as a step in the build process for your WebObjects project.

# [apl 3.may.2006]

# This will remove any DOCTYPE's from the top of plists so that

100

# they do not attempt to validate the DTD which is either

101

# extracted from /System or the internet over HTTP.

102

103

if [ -z $1 ]; then

104

echo "syntax: stripdocype.sh <directory>"

exit 1

fi

for PLISTFILE in `find $1 -name *.plist`

109

do

110

sed \

111

'/<!DOCTYPE [Deploying with Tomcat^>]*>/s/.*//' \

112

$PLISTFILE \

113

> /tmp/remove-plist-temp

114

115

cp /tmp/remove-plist-temp $PLISTFILE

done

= Application Configuration with Tomcat =

121

122

A WebObjects project with servlet support has a file called {{code language="none"}}web.xml.template{{/code}} in it. By default, this is located in {{code language="none"}}/Resources/Servlet Resources/WEB-INF{{/code}} in your project. The {{code language="none"}}web.xml.template{{/code}} file is used as a template for creating {{code language="none"}}web.xml{{/code}} which is also known as the {{code language="none"}}servlet deployment descriptor{{/code}}. This deployment descriptor is used as the means of communicating settings to the application as well as the servlet container in which the application runs. This section covers some common changes to that file as well as a discussion around a means of general configuration of the application when it is running inside a servlet container.

123

124

== Data Source for Model Database Configuration ==

125

126

Some WebObjects engineers use the {{code language="none"}}setConnectionDictionary(...){{/code}} method on a model to set the JDBC database connection parameters for the model. However, the servlet container has it's own {{code language="none"}}data source{{/code}} mechanism for supplying database information which will override any connection dictionary information which is set into the model. If you don't want this to happen, and you want your {{code language="none"}}setConnectionDictionary(...){{/code}} to take effect, comment out the {{code language="none"}}resource-ref{{/code}} item with the title {{code language="none"}}jdbc/DefaultDataSource{{/code}} in the {{code language="none"}}web.xml.template{{/code}} file.

127

128

If you have more than one data source Resource defined in either your WEB-INF/web.xml or in your META-INF/Context.xml file, WebObjects will complain about there being more than one configuration with this error:

129

130

**{{code language="none"}}An exception occurred while trying to open a channel: com.webobjects.jdbcadaptor.JDBCAdaptorException: Found multiple data sources. Please map the EOModels to a data source explicitly!{{/code}}**

131

132

You must set the name parameter of each data source Resource in the web.xml/Context.xml with the same name as your eomodel file. For example:

133

134

EOModel name: **MyModel**.eomodel

135

136

data source Resource definition:

<Resource

auth="Container"

description="MyApp Data Source"

143

HERE -> name="MyModel"

144

type="javax.sql.DataSource"

145

driverClassName="com.microsoft.jdbc.sqlserver.SQLServerDriver"

146

url="jdbc:microsoft:sqlserver://serveraddress:1433;databaseName=TEST"

username="user"

password="pass"

maxActive="4"

maxWait="5000"

maxIdle="10"

/>

== Serving WebServerResources ==

157

158

To stop the web server resources (images, CSS files and other static data) from being served out of the java environment, you need to configure the {{code language="none"}}context-param{{/code}} with the name {{code language="none"}}WOAppMode{{/code}} to be {{code language="none"}}Deployment{{/code}} in the {{code language="none"}}web.xml.template{{/code}} file.

159

160

== Application Specific Configuration ==

161

162

This area of configuration covers items such as the following ficticious examples;

163

164

1. Email address of person to contact when system fails.

165

1. Frequency of polling some resource.

166

1. Optional connection information for databases.

167

1. GST rate for New Zealand.

168

169

In other words, these are application-specific configuration values. One way to configure your application specific parameters in a servlet container is to load your config into {{code language="none"}}env-entry{{/code}}-s in your {{code language="none"}}web.xml{{/code}} file. Here is such an example of one such entry;

<env-entry>

<env-entry-name>foo/nz.co.foo.FooAppMailFrom</env-entry-name>

175

<env-entry-value>bar@foo.co.nz</env-entry-value>

176

<env-entry-type>java.lang.String</env-entry-type>

</env-entry>

You can retrieve these value inside the application with some code as shown below. See the LEConfig class from LEWOStuff, the WebObjects framework from Lindesay Electric for an example. LEWOStuff also comes with a tool to help load standard java properties files into the servlet deployment descriptor.

import javax.naming.*;

186

187

// ...later in the same class...

188

189

Object valueO = null;

try

{

InitialContext context = new InitialContext();

194

valueO = context.lookup("java:comp/env/foo/nz.co.foo.FooAppMailFrom");

195

}

196

catch(javax.naming.NamingException ne)

197

{ /* handle gracefully */ }

It is probably easiest to apply these settings in some automated fashion to the {{code language="none"}}web.xml{{/code}} file as part of a further automated build or deploy process.

202

203

== Application Binary ==

204

205

Put your application servlet build product at {{code language="none"}}$INSTDIR{{/code}} such that the following path exists.

$INSTDIR/webapps/FooApp/WEB-INF

== Tomcat Server Configuration Files ==

214

215

You need to create a tomcat configuration file for each of the instances that you would like to have. The pattern is followed here of having an instance number proceeded by the lower case letter "i". Put the first server configuration file at the following location.

$INSTDIR/server_i1.xml

Here is an example of how this file might look. There is no coverage of the individual settings here as the reader is expected to review the tomcat documentation to discover the specific meanings of these settings.

=== Tomcat 5 ===

<Connector port="8081" maxHttpHeaderSize="8192"

232

maxThreads="150" minSpareThreads="25" maxSpareThreads="75"

233

enableLookups="false" acceptCount="100"

234

connectionTimeout="20000" disableUploadTimeout="true" />

<Host name="appserver1.foo.co.nz"

240

appBase="/home/fooapp/webapps"

241

unpackWARs="true" autoDeploy="false"

242

xmlValidation="false" xmlNamespaceAware="false">

243

<Context cookies="false" docBase="FooApp"

244

path="FooApp" reloadable="false">

</Context>

</Host>

</Engine>

</Service>

</Server>

=== Tomcat 3 ===

<?xml version="1.0" encoding="ISO-8859-1"?>

</ContextManager>

</Server>

Assuming that there will be three instances in this example deploy, this entire file should be replicated and modified twice for the other two instances. For the other instances' server configuration files, change the "i1" (Tomcat 5 only) by modifying the numerical component and change the port numbers by making the last digit the instance number. For example, the ports {{code language="none"}}7071{{/code}}, {{code language="none"}}8081{{/code}} and {{code language="none"}}9091{{/code}} are used here. For "i2", use {{code language="none"}}7072{{/code}}, {{code language="none"}}8082{{/code}} and {{code language="none"}}9092{{/code}}.

291

292

You should have three files now present called {{code language="none"}}server_i1.xml{{/code}}, {{code language="none"}}server_i2.xml{{/code}} and {{code language="none"}}server_i3.xml{{/code}} in the directory {{code language="none"}}$INSTDIR{{/code}}.

293

294

== Startup An Instance ==

295

296

To startup an instance, issue a command as follows. You should issue this command for each of the server configuration files. The {{code language="none"}}$JAVA_HOME{{/code}} shell environment variable should have been setup correctly before launching an instance.

|=(((

Tomcat 5

)))|(((

$TOMCATDIR/bin/startup.sh -config $INSTDIR/server_i1.xml

)))

|=(((

Tomcat 3

)))|(((

$TOMCATDIR/bin/startup -config $INSTDIR/server_i1.xml -home $TOMCATDIR

)))

=== Tomcat 3 Environment Variables ===

314

315

To pass java environment variables to your application, set the {{code language="none"}}TOMCAT_OPTS{{/code}} shell environment variable before starting up the Tomcat 3 environment. An example of this would be as follows;

TOMCAT_OPTS=-Dabc=xyz

export TOMCAT_OPTS

== Check Availability ==

325

326

You can now see if your instance is up using the following URL.

http://appserver1.foo.co.nz:8081/FooApp/WebObjects/FooApp.woa

Note that both the AJP (This is the protocol between the apache adaptor and the individual Tomcat instances.) and the regular HTTP engines are accessing the same running application. This means that a test straight onto the application via HTTP is actually testing the application that is being accessed via AJP. This behaviour provides an opportunity to be able to monitor specific instances of Tomcat over direct HTTP.

335

336

Check each of your instances.

== Problems ==

Under Tomcat 5, check the log file at {{code language="none"}}$TOMCATHOME/logs/catalina.out{{/code}} if you are unable to access your instance.

341

342

== Shutdown An Instance ==

343

344

To shutdown an instance, issue a command as follows.

=== Tomcat 5 ===

$TOMCATDIR/bin/shutdown.sh -config $INSTDIR/server_i1.xml

It is also possible to use the UNIX {{code language="none"}}telnet{{/code}} command to connect to the port described in the server configuration file's {{code language="none"}}Server{{/code}} tag and type the word supplied in the {{code language="none"}}shutdown{{/code}} attribute to take out the Tomcat instance.

=== Tomcat 3 ===

TOMCATDIR/bin/shutdown -ajp13 -port 9091

= Apache Adaptor Setup =

365

366

A final deployment usually involves apache feeding inbound requests to instances and handling situations where an instance has gone down and balancing load over the instances that are currently running. This job is undertaken by {{code language="none"}}mod_jk{{/code}} which is a module for apache written by the Tomcat group. This module communicates with the tomcat instances using a protocol called {{code language="none"}}AJP{{/code}}. This protocol carries all the information required to check instances are operational as well as relaying requests to the instances. It is assumed that the configuration as well as binaries for the {{code language="none"}}mod_jk{{/code}} apache module will be located at {{code language="none"}}$JKDIR{{/code}}.

367

368

== Compiling and Installing ==

369

370

Instructions for downloading and installing {{code language="none"}}mod_jk{{/code}} can be obtained from the Tomcat website. The {{code language="none"}}mod_jk.so{{/code}} binary should be located at the following path.

$JKDIR/mod_jk.so

Add a line to your system's apache httpd configuration file like this:

Include /opt/modjk/apache.conf

Edit this file to look like this:

LoadModule jk_module /opt/modjk/mod_jk.so

391

AddModule mod_jk.c

392

393

JkLogFile /opt/modjk/mod_jk.log

394

JkLogLevel info

395

396

JkWorkerProperty worker.list=i1,i2,i3,loadbalancer

397

JkWorkerProperty worker.i1.type=ajp13

398

JkWorkerProperty worker.i1.port=9091

399

JkWorkerProperty worker.i1.host=appserver1.foo.co.nz

400

JkWorkerProperty worker.i1.lbfactor=1

401

JkWorkerProperty worker.i2.type=ajp13

402

JkWorkerProperty worker.i2.port=9092

403

JkWorkerProperty worker.i2.host=appserver1.foo.co.nz

404

JkWorkerProperty worker.i2.lbfactor=1

405

JkWorkerProperty worker.i3.type=ajp13

406

JkWorkerProperty worker.i3.port=9093

407

JkWorkerProperty worker.i3.host=appserver1.foo.co.nz

408

JkWorkerProperty worker.i3.lbfactor=1

409

JkWorkerProperty worker.loadbalancer.type=lb

410

JkWorkerProperty worker.loadbalancer.sticky_session=1

411

JkWorkerProperty worker.loadbalancer.local_worker_only=1

412

JkWorkerProperty worker.loadbalancer.balance_workers=i1,i2,i3

413

414

JkMount /FooApp/* loadbalancer

Again, the details of the exact settings will not be covered in this article, but this should provide a simple guide to setting up this file to provide for a multi-instance deploy under Tomcat.

== Restart Apache ==

Now restart apache with the following command:

sudo apachectl restart

== Test Application ==

431

432

Now you can test your application using a URL such as this one.

http://www.foo.co.nz/FooApp/WebObjects/FooApp.woa

All three instances that you have setup should take some of the inbound requests.

441

442

== Choosing the Right Instance ==

443

444

{{code language="none"}}mod_jk{{/code}} ensures that requests that have started a session will be directed to the correct instance where the session originated. This behaviour is known as sticky sessions. It does not appear to be possible to nominate the instance from the servlet container in another way.

Wiki source code of Deploying with Tomcat

Applications

Navigation

My Recent Modifications

Need help?