blob: 109fea2a491be44c034ac244a74111624950eac8 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
<document url="extras.html">
<title>Additional Components</title>
<author>Remy Maucherat</author>
<section name="Table of Contents">
<section name="Introduction">
A number of additional components may be used with Apache Tomcat. These
components may be built by users should they need them or they can be
downloaded from one of the mirrors.
<section name="Downloading">
To download the extras components open the
<download>Tomcat download page</download>
and select "Browse" from the Quick Navigation Links. The extras components
can be found in bin/extras.
<section name="Building">
The additional components are built using the <code>extras</code> target
of the standard Tomcat Ant script which is present in the source bundle of
<p>The build process is the following:</p>
<li>Follow the <a href="building.html">build instructions</a> to build a
Tomcat binary from the source bundle (note: it will be used by the build
process of the additional components, but does not need to be actually
used later on)</li>
<li>Execute the command <code>ant extras</code> to run the build
<li>The additional components JARs will be placed in the
<code>output/extras</code> folder</li>
<li>Refer to the documentation below about the usage of these JARs</li>
<section name="Components list">
<subsection name="Full commons-logging implementation">
Tomcat uses a package renamed commons-logging API implementation which is
hardcoded to use the java.util.logging API. The commons-logging additional
component builds a full fledged package renamed commons-logging
implementation which can be used to replace the implementation provided with
Tomcat. See the <a href="logging.html">logging</a> page for usage
<subsection name="Web Services support (JSR 109)">
Tomcat provides factories for JSR 109 which may be used to resolve web
services references. Place the generated catalina-ws.jar as well as
jaxrpc.jar and wsdl4j.jar (or another implementation of JSR 109) in the
Tomcat lib folder.
Users should be aware that wsdl4j.jar is licensed under CPL 1.0 and not the
Apache License version 2.0.
<subsection name="JMX Remote Lifecycle Listener">
The JMX protocol requires the JMX server (Tomcat in this instance) to listen
on two network ports. One of these ports can be fixed via configuration but
the second is selected randomly. This makes it difficult to use JMX through
a firewall. The JMX Remote Lifecycle Listener allows both ports to be fixed,
simplifying the process of connecting to JMX through a firewall. See the <a
href="config/listeners.html">listeners</a> page for usage instructions.