[jboss-cvs] jboss-docs/jbossas/install/en ...
Norman Richards
norman.richards at jboss.com
Mon Sep 18 12:48:19 EDT 2006
User: nrichards
Date: 06/09/18 12:48:19
Added: jbossas/install/en master.xml
Log:
problems checking in?
Revision Changes Path
1.1 date: 2006/09/18 16:48:19; author: nrichards; state: Exp;jboss-docs/jbossas/install/en/master.xml
Index: master.xml
===================================================================
<?xml version='1.0' encoding="iso-8859-1"?>
<book>
<bookinfo>
<title>The JBoss 4 Installation Guide</title>
<subtitle>JBoss AS 4.0.4</subtitle>
<mediaobject>
<imageobject>
<imagedata fileref="images/title.jpg"/>
</imageobject>
</mediaobject>
<copyright>
<year>2006></year>
<holder>JBoss, Inc.</holder>
</copyright>
</bookinfo>
<toc/>
<chapter>
<title>Installing JBoss</title>
<para>JBoss, a free J2EE 1.4 certified application server, is the most widely used open source application
server on the market. The highly flexible and easy-to-use server architecture has made JBoss the ideal
choice for users just starting out with J2EE, as well as senior architects looking for a customizable
middleware platform. The server binary and source code distributions are available from the SourceForge
repository. (<ulink url="http://sourceforge.net/projects/jboss"
>http://sourceforge.net/projects/jboss</ulink>). The ready availability of the source code allows you to
debug the server, learn its inner workings and create customized versions for your personal or business use.</para>
<para>This chapter will show you how to download and install JBoss 4.0. You will learn about the directory
structure and understand what the key services and configuration files are. </para>
<para>Before installing and running the server, you need to check your system to make sure you have a working
Java 1.4 or 1.5 installation. Java 1.5 is required to use the new simplified EJB3 technologies. The simplest
way to check on your Java environment is to execute the <literal>java -version</literal> command to ensure
that the <literal>java</literal> executable is in your path and that you are using an appropriate version:</para>
<programlisting>[tmp]$ java -version
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_02-56)
Java HotSpot(TM) Client VM (build 1.5.0_02-36, mixed mode, sharing)</programlisting>
<para>The most recent release of JBoss is available from the JBoss downloads page, <ulink
url="http://www.jboss.org/products/jbossas/downloads"/>. After you have downloaded the version you want
to install, use the JDK <literal>jar</literal> tool (or any other ZIP extraction tool) to extract the
<literal>jboss-4.0.4.zip</literal> archive contents into a location of your choice. It does not matter
where on your system you install JBoss. Note, however, that installing JBoss into a directory that has a
name that contains spaces causes problems in some situations with Sun-based VMs. This is caused by bugs with
file URLs not correctly escaping the spaces in the resulting URL. The <literal>jboss-4.0.4.tgz</literal>
archive is a gzipped tar file that requires a gnutar-compatible tar program that can handle the long
pathnames in the archive. The default tar binaries on Solaris and OS X do not currently support the long
pathnames. </para>
<para> JBoss also provides a GUI installer that can simplify the installation process. In addition to the basic
installation, the installer allows you to select the which services are installed secure the JBoss
management applications. Using a custom JBoss install created by the installer can greatly simplify the
installation and configuration of JBoss. </para>
<para>The installer can be run directly from a web browser using Java Web Start or can be downloaded as an
executable JAR file named <literal>jboss-4.0.4-installer.jar</literal>. On many operating system, you can
run executable JARs by double-clicking them. If your system doesn't support that, you can run the installer
directly from the command line: </para>
<programlisting>[tmp]$ java -jar jboss-4.0.4-installer.jar</programlisting>
<para> When you launch the installer, you will be able to select the starting server configuration set, as shown
in <xref linkend="ch1.installgroup.fig"/>.</para>
<figure id="ch1.installgroup.fig">
<title>The JBoss AS installer configuration set selection screen</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/installgroup.jpg"/>
</imageobject>
</mediaobject>
</figure>
<para>The starting configuration determine which sets of packages are available for installation. The following
table describes each of the configuration sets. </para>
<table id="ch1.installgroup.table">
<title>The JBoss AS installer configuration sets</title>
<tgroup cols="3">
<colspec colname="c1" colnum="1" colwidth="2*"/>
<colspec colname="c2" colnum="2" colwidth="4*"/>
<colspec colname="c3" colnum="3" colwidth="4*"/>
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<literal>default</literal>
</entry>
<entry>A base J2EE 1.4 server profile.</entry>
<entry/>
</row>
<row>
<entry>
<literal>all</literal>
</entry>
<entry>A full J2EE 1.4 server profile with enterprise extensions such as clustering and IIOP. </entry>
<entry/>
</row>
<row>
<entry>
<literal>minimal</literal>
</entry>
<entry>A minimal JMX microkernel</entry>
<entry>This is not a J2EE 1.4 compatible configuration.</entry>
</row>
<row>
<entry>
<literal>ejb3</literal>
</entry>
<entry>An EJB3 profile supporting the full EJB3 specification with Tomcat</entry>
<entry>This requires a Java 5 runtime and is not a J2EE 1.4 compatible configuration.</entry>
</row>
<row>
<entry>
<literal>ejb3-clustered</literal>
</entry>
<entry>An EJB3 profile supporting the full EJB3 specification with Tomcat and clustering.</entry>
<entry>This requires a Java 5 runtime and is not a J2EE 1.4 compatible configuration.</entry>
</row>
<row>
<entry>
<literal>jms</literal>
</entry>
<entry>A JMS 1.1 server profile</entry>
<entry>This is not a J2EE 1.4 compatible configuration.</entry>
</row>
<row>
<entry>
<literal>tomcat</literal>
</entry>
<entry>A Servlet 2.4 container profile</entry>
<entry>This is not a J2EE 1.4 compatible configuration.</entry>
</row>
</tbody>
</tgroup>
</table>
<para> After selecting the configuration set, you have the option to further customize the services installed,
eliminating unneeded options. When choosing configuration sets, be aware that you can not add packages not
in the configuration set. If you you wanted a simple web container (the tomcat configuration) that also had
JMS support (the jms configuration), it would be necessary to go to a larger configuration, such as the
default configuration, and remove the unwanted packages. <xref linkend="ch1.install.fig"/> shows the package
selection screen.</para>
<figure id="ch1.install.fig">
<title>The JBoss installer package selection screen</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/installer.jpg"/>
</imageobject>
</mediaobject>
</figure>
<para>The following screen (<xref linkend="ch1.installconfig.fig"/>) allows for the customization of the server
configuration name. Unless you need to create multiple configurations, you should use a configuration name
of <literal>default</literal>. Use of any other configuration requires you to start JBoss with the
<literal>-c</literal> option to specify the configuration JBoss should use. </para>
<figure id="ch1.installconfig.fig">
<title>The JBoss installer configuration name screen</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/installconfig.jpg"/>
</imageobject>
</mediaobject>
</figure>
<para>The installer will then guide you through a few install customization screens. The first screen allows you
to enable applications isolation, completely separating the classloading space of all applications.
Application isolation can be helpful in some instances, but it comes with the cost of requiring slow
pass-by-value semantics for passing data between applications. In most cases, it is preferable to use loader
repositories to control the sharing of classes on an application-by-application basis rather than enabling
isolation for the entire server. </para>
<para> When installed from the tar/zip archive, all JBoss services are left in a developer-friendly state
requiring no authentication to access most JBoss services, including administrative services. The installer
gives you a chance to secure those services on the security screen, shown in <xref
linkend="ch1.installsecurity.fig"/>. It is recommended that you click to enable security for all
services and change the password from the default <literal>admin</literal>/<literal>admin</literal> values. </para>
<figure id="ch1.installsecurity.fig">
<title>The JBoss installer security configuration screen</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/installsecurity.jpg"/>
</imageobject>
</mediaobject>
</figure>
<para> When you install from the installer, you get a smaller install image that is more tuned for your
environment. However, the directory structure will be slightly different than when using the tar/zip
archive. The examples in the book need to make use of many different configurations and will assume the
complete install. Although use of the installer is recommended for normal JBoss use, you'll need to download
the complete image to work through all the examples. </para>
</chapter>
<chapter>
<title>Directory Structure</title>
<para>Installing the JBoss distribution creates a <literal>jboss-4.0.4</literal> directory that contains server
start scripts, JARs, server configuration sets and working directories. You need to know your way around the
distribution layout to locate JARs for compiling code, updating configurations, deploying your code, etc.
<xref linkend="ch1.dirs.fig"/> illustrates the installation directory of the JBoss server.</para>
<figure id="ch1.dirs.fig">
<title>The JBoss AS directroy structure</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/jboss_directory_structure.jpg"/>
</imageobject>
</mediaobject>
</figure>
<para>Throughout this book we refer to the top-level <literal>jboss-4.0.4</literal> directory as the
<literal>JBOSS_DIST</literal> directory. In <xref linkend="ch1.dirs.fig"/>, the
<literal>default</literal> server configuration file set is shown expanded. It contains a number of
subdirectories: <literal>conf</literal>, <literal>data</literal>, <literal>deploy</literal>,
<literal>lib</literal>, <literal>log</literal>, and <literal>tmp</literal>. In a clean installation, only
the <literal>conf</literal>, <literal>deploy</literal>, and <literal>lib</literal> directories will exist.
Several of the locations may be overridden. For these locations, the
<literal>org.jboss.system.server.ServerConfig</literal> interface constant and its corresponding system
property string are shown. The names ending in <literal>URL</literal> correspond to locations that can be
specified using a URL to access remote locations, for example, HTTP URLs against a web server. <xref
linkend="ch1.dirs.table"/> shows the the top-level directories and their function. </para>
<table id="ch1.dirs.table">
<title>The JBoss top-level directory structure</title>
<tgroup cols="2">
<colspec colname="c1" colnum="1" colwidth="1*"/>
<colspec colname="c2" colnum="2" colwidth="4*"/>
<thead>
<row>
<entry>Directory</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<literal>bin</literal>
</entry>
<entry>All the entry point JARs and start scripts included with the JBoss distribution are
located in the <literal>bin</literal> directory.</entry>
</row>
<row>
<entry>
<literal>client</literal>
</entry>
<entry>The JARs that are required for clients that run outside of JBoss are located in the
<literal>client</literal> directory. </entry>
</row>
<row>
<entry>
<literal>server</literal>
</entry>
<entry> The JBoss <literal>server</literal> configuration sets are located under the
<literal>server</literal> directory. The default server configuration set is the
<literal>server/default</literal> set. JBoss ships with <literal>minimal</literal>,
<literal>default</literal> and <literal>all</literal> configuration sets. The
subdirectories and key configuration files contained <literal>default</literal>
configuration set are discussed in more detail in <xref linkend="ch1.config.section"/>
</entry>
</row>
<row>
<entry>
<literal>lib</literal>
</entry>
<entry> The <literal>lib</literal> directory contains startup JARs used by JBoss. Do not place
your own libraries in this directory.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
<xref linkend="ch1.config-dirs.table"/> shows the the directories inside of the server configuration
directory and their function. </para>
<table id="ch1.config-dirs.table">
<title>The JBoss server configuration directory structure</title>
<tgroup cols="2">
<colspec colname="c1" colnum="1" colwidth="1*"/>
<colspec colname="c2" colnum="2" colwidth="4*"/>
<thead>
<row>
<entry>Directory</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<literal>conf</literal>
</entry>
<entry> The <literal>conf</literal> directory contains the <literal>jboss-service.xml</literal>
bootstrap descriptor file for a given server configuration. This defines the core services
that are fixed for the lifetime of the server.</entry>
</row>
<row>
<entry>
<literal>data</literal>
</entry>
<entry> The <literal>data</literal> directory is available for use by services that want to
store content in the file system.</entry>
</row>
<row>
<entry>
<literal>deploy</literal>
</entry>
<entry> The <literal>deploy</literal> directory is the default location the hot deployment
service looks to for dynamic deployment content. This may be overridden through the
<literal>URLDeploymentScanner</literal> URLs attribute.</entry>
</row>
<row>
<entry>
<literal>lib</literal>
</entry>
<entry> The <literal>lib</literal> directory is the default location for static Java libraries
that should not be hot deployed. All JARs in this directory are loaded into the shared
classpath at startup.</entry>
</row>
<row>
<entry>
<literal>log</literal>
</entry>
<entry>The <literal>log</literal> directory is the directory log files are written to. This may
be overridden through the <literal>conf/log4j.xml</literal> configuration file.</entry>
</row>
<row>
<entry>
<literal>tmp</literal>
</entry>
<entry>The <literal>tmp</literal> directory is used by JBoss to store temporarily files such as
unpacked deployments.</entry>
</row>
</tbody>
</tgroup>
</table>
<para> The contents of the <literal>conf</literal> and <literal>deploy</literal> directories will be shown in
the following section. </para>
</chapter>
<chapter id="ch1.config.section">
<title>The Default Server Configuration File Set</title>
<para>The <literal>JBOSS_DIST/server</literal> directory contains one or more configuration file sets. The
<literal>default</literal> JBoss configuration file set is located in the
<literal>JBOSS_DIST/server/default</literal> directory. JBoss allows you to add more than one
configuration set so a server can easily be run using alternate configurations. Creating a new configuration
file set typically starts with copying the <literal>default</literal> file set into a new directory name and
then modifying the configuration files as desired. <xref linkend="ch1.exdirs.fig"/> below shows the contents
of the <literal>default</literal> configuration file set.</para>
<figure id="ch1.exdirs.fig">
<title>An expanded view of the default server configuration file set conf and deploy directories</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/default_configuration_fileset.jpg"/>
</imageobject>
</mediaobject>
</figure>
<para>The files in the <literal>conf</literal> directory are explained in the following section. </para>
<variablelist>
<varlistentry>
<term>
<emphasis role="bold">jboss-minimal.xml</emphasis>
</term>
<listitem>
<para>This is a minimalist example of the <literal>jboss-service.xml</literal> configuration file.
It is the <literal>jboss-service.xml</literal> file used in the <literal>minimal</literal>
configuration file set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>jboss-service.xml</literal> defines the core services configurations. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jndi.properties</emphasis>
</term>
<listitem>
<para>The <literal>jndi.properties</literal> file specifies the JNDI
<literal>InitialContext</literal> properties that are used within the JBoss server when an
<literal>InitialContext</literal> is created using the no-arg constructor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">log4j.xml</emphasis>
</term>
<listitem>
<para>This file configures the Apache log4j framework category priorities and appenders used by the
JBoss server code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">login-config.xml</emphasis>
</term>
<listitem>
<para>This file contains sample server side authentication configurations that are applicable when
using JAAS based security. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">props/*</emphasis>
</term>
<listitem>
<para>The <literal>props</literal> directory contains the users and roles property files for the
<literal>jmx-console</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">standardjaws.xml</emphasis>
</term>
<listitem>
<para>This file provides the default configuration for the legacy EJB 1.1 CMP engine. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">standardjboss.xml</emphasis>
</term>
<listitem>
<para>This file provides the default container configurations. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">standardjbosscmp-jdbc.xml</emphasis>
</term>
<listitem>
<para>This file provides a default configuration file for the JBoss CMP engine.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">xmdesc/*-mbean.xml</emphasis>
</term>
<listitem>
<para> The <literal>xmdesc</literal> directory contains XMBean descriptors for several services
configured in the <literal>jboss-service.xml</literal> file. </para>
</listitem>
</varlistentry>
</variablelist>
<para> The following are the files in the deploy directory and their function. </para>
<variablelist>
<varlistentry>
<term>
<emphasis role="bold">bsh-deployer.xml</emphasis>
</term>
<listitem>
<para>This file configures the bean shell deployer, which deploys bean shell scripts as JBoss
services. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">cache-invalidation-service.xml</emphasis>
</term>
<listitem>
<para>This is a service that allows for custom invalidation of the EJB caches via JMS notifications.
It is disabled by default.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">client-deployer-service.xml</emphasis>
</term>
<listitem>
<para>This is a service that provides support for J2EE application clients. It manages the
<literal>java:comp/env</literal> enterprise naming context for client applications based on
the <literal>application-client.xml</literal> descriptor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">ear-deployer.xml</emphasis>
</term>
<listitem>
<para>The EAR deployer is the service responsible for deploying J2EE EAR files. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">ejb-deployer.xml</emphasis>
</term>
<listitem>
<para>The EJB deployer is the service responsible for deploying J2EE EJB JAR files.</para>
</listitem>
</varlistentry>
<!--
<varlistentry>
<term>
<emphasis role="bold">ejb3-interceptors-aop.xml</emphasis>
</term>
<listitem>
<para>This file contains the AOP interceptors that implement EJB3 functionality.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">ejb3.deployer</emphasis>
</term>
<listitem>
<para>This service responsible for deploying EJB3 JAR files.</para>
</listitem>
</varlistentry>
-->
<varlistentry>
<term>
<emphasis role="bold">hsqldb-ds.xml</emphasis>
</term>
<listitem>
<para>
<literal>hsqldb-ds.xml</literal> configures the Hypersonic embedded database service
configuration file. It sets up the embedded database and related connection factories. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">http-invoker.sar</emphasis>
</term>
<listitem>
<para>
<literal>http-invoker.sar</literal> contains the detached invoker that supports RMI over HTTP.
It also contains the proxy bindings for accessing JNDI over HTTP. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-aop.deployer</emphasis>, </term>
<listitem>
<para> This service configure the <literal>AspectManagerService</literal> and deploys JBoss AOP
applications. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-bean.deployer</emphasis>
</term>
<listitem>
<para>
<literal>jboss-bean.deployer</literal> provides the JBoss microcontainer, which deploys POJO
services wrapped in <literal>.beans</literal> files. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-ha-local-jdbc.rar</emphasis>
</term>
<listitem>
<para>
<literal>jboss-ha-local-jdbc.rar</literal> is an experimental version of
<literal>jboss-local-jdbc.rar</literal> that supports datasource failover.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-ha-xa-jdbc.rar</emphasis>
</term>
<listitem>
<para>
<literal>jboss-ha-xa-jdbc.rar</literal> is an experimental version of
<literal>jboss-xa-jdbc.rar</literal> that supports datasource failover.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-local-jdbc.rar</emphasis>
</term>
<listitem>
<para>
<literal>jboss-local-jdbc.rar</literal> is a JCA resource adaptor that implements the JCA
<literal>ManagedConnectionFactory</literal> interface for JDBC drivers that support the
<literal>DataSource</literal> interface but not JCA.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-xa-jdbc.rar</emphasis>
</term>
<listitem>
<para>
<literal>jboss-xa-jdbc.rar</literal> is a JCA resource adaptor that implements the JCA
<literal>ManagedConnectionFactory</literal> interface for JDBC drivers that support the
<literal>XADataSource</literal> interface.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jbossjca-service.sar</emphasis>
</term>
<listitem>
<para>
<literal>jbossjca-service.sar</literal> is the application server implementation of the JCA
specification. It provides the connection management facilities for integrating resource
adaptors into the JBoss server. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jbossweb-tomcat55.sar</emphasis>
</term>
<listitem>
<para>The <literal>jbossweb-tomcat55.sar</literal> directory provides the Tomcat 5.5 servlet engine.
The SAR is unpacked rather than deployed as a JAR archive so that the tomcat configuration files
can be easily edited.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jbossws14.sar</emphasis>
</term>
<listitem>
<para><literal>jbossws14.sar</literal> provides J2EE web services support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/hsqldb-jdbc-state-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>hsqldb-jdbc-state-service.xml</literal> provides JMS state management using Hypersonic.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/hsqldb-jdbc2-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>hsqldb-jdbc2-service.xml</literal> configures JMS persistence and caching using
Hypersonic. It also contains the <literal>DestinationManager</literal> MBean, which is the core
service for the JMS implementation. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/jbossmq-destinations-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>jbossmq-destinations-service.xml</literal> configures a number of JMS queues and topics
used by the JMS unit tests. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/jbossmq-httpil.sar</emphasis>
</term>
<listitem>
<para>
<literal>jbossmq-httpil.sar</literal> provides a JMS invocation layer that allows the use of JMS
over HTTP.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/jbossmq-service.xml</emphasis>
</term>
<listitem>
<para>The <literal>jbossmq-service.xml</literal> file configures the core JBossMQ JMS service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/jms-ds.xml</emphasis>
</term>
<listitem>
<para>The <literal>jms-ds.xml</literal> file configures the JBossMQ JMS provider for use with the
<literal>jms-ra.rar</literal> JCA resource adaptor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/jms-ra.rar</emphasis>
</term>
<listitem>
<para>
<literal>jms-ra.rar</literal> is a JCA resource adaptor that implements the JCA
<literal>ManagedConnectionFactory</literal> interface for JMS connection factories.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/jvm-il-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>jvm-il-service.xml</literal> configures the in-JVM JMS transport invocation layer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jms/uil2-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>uil2-service.xml</literal> configures the JMS version 2 unified invocation layer. Its a
fast and reliable custom socket based transport that should be used for messaging between JVMs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jmx-console.war</emphasis>
</term>
<listitem>
<para>The <literal>jmx-console.war</literal> directory provides the JMX Console. The JMX Console
provides a simple web interface for managing the the MBean server. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jmx-invoker-service.sar</emphasis>
</term>
<listitem>
<para>
<literal>jmx-invoker-service.sar</literal> is an unpacked MBean service archive that exposes a
subset of the JMX <literal>MBeanServer</literal> interface methods as an RMI interface to enable
remote access to the JMX core functionality. This is similar to the legacy
<literal>jmx-rmi-adaptor.sar</literal>, with the difference that the transport is handled by
the detached invoker architecture. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jsr-88-service.xml</emphasis>
</term>
<listitem>
<para>
<literal>jsr-88-service.xml</literal> provides the JSR 88 remote deployment service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">mail-ra.rar</emphasis>
</term>
<listitem>
<para>
<literal>mail-ra.rar</literal> is a resource adaptor that provides a JavaMail connector.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">mail-service.xml</emphasis>
</term>
<listitem>
<para>The <literal>mail-service.xml</literal> file is an MBean service descriptor that provides
JavaMail sessions for use inside the JBoss server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">management/console-mgr.sar</emphasis>
</term>
<listitem>
<para>
<literal>console-mgr.sar</literal> provides the Web Console. It is a web application/applet that
provide a richer view of the JMX server management data than the JMX console. You may view the
console using the URL <literal>http://localhost:8080/web-console/</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">monitoring-service.xml</emphasis>
</term>
<listitem>
<para>The <literal>monitoring-service.xml</literal> file configures alert monitors like the console
listener and email listener used by JMX notifications. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">properties-service.xml</emphasis>
</term>
<listitem>
<para>The <literal>properties-service.xml</literal> file is an MBean service descriptor that allows
for customization of the JavaBeans <literal>PropertyEditor</literal>s as well as the definition
of system properties. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">scheduler-service.xml</emphasis>, <emphasis role="bold"
>schedule-manager-service.xml</emphasis>
</term>
<listitem>
<para>The <literal>scheduler-service.xml</literal> and
<literal>schedule-manager-service.xml</literal> files are MBean service descriptors that provide
a scheduling type of service. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">sqlexception-service.xml</emphasis>
</term>
<listitem>
<para>The <literal>sqlexception-service.xml</literal> file is an MBean service descriptor for the
handling of vendor specific <literal>SQLException</literal>s.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">uuid-key-generator.sar</emphasis>
</term>
<listitem>
<para>The <literal>uuid-key-generator.sar</literal> service provides a UUID-based key generation
facility.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The all configuration contains several addition services.</para>
<variablelist>
<varlistentry>
<term>
<emphasis role="bold">cluster-service.xml</emphasis>
</term>
<listitem>
<para>This service configures clustering communication for most clustered services in JBoss.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">deploy-hasingleton-service.xml</emphasis>
</term>
<listitem>
<para>This provides the HA singleton service, allowing JBoss to manage services that must be active
on only one node of a cluster.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">deploy.last/farm-service.xml</emphasis>
</term>
<listitem>
<para><literal>farm-service.xml</literal> provides the farm service, which allows for cluster-wide
deployment and undeployment of services.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">httpha-invoker.sar</emphasis>
</term>
<listitem>
<para>This service provides HTTP tunneling support for clustered environments.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">iiop-service.xml</emphasis>
</term>
<listitem>
<para>This provides IIOP invocation support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">juddi-service.sar</emphasis>
</term>
<listitem>
<para>This service provides UDDI lookup services.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">snmp-adaptor.sar</emphasis>
</term>
<listitem>
<para>This is a JMX to SNMP adaptor. It allows for the mapping of JMX notifications onto SNMP
traps.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">tc5-cluster.sar</emphasis>
</term>
<listitem>
<para>Provides AOP support for field-level HTTP session replication.</para>
</listitem>
</varlistentry>
</variablelist>
<para>When installing EJB3 support, several additional EJB3 services are made available.</para>
<variablelist>
<varlistentry>
<term>
<emphasis role="bold">ejb3-interceptors-aop.xml</emphasis>
</term>
<listitem>
<para>This service provides the AOP interceptor stack configurations for EJB3 bean types.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">ejb3.deployer</emphasis>
</term>
<listitem>
<para>This service deploys EJB3 applications into JBoss.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jboss-aop-jdk50.deployer</emphasis>
</term>
<listitem>
<para>This is a Java 5 version of the AOP deployer. The AOP deployer configures the
<literal>AspectManagerService</literal> and deploys JBoss AOP applications. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">jbossws.sar</emphasis>
</term>
<listitem>
<para>This services provides Java EE 5 web services support.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Finally, in the EJB3 all configuration adds two additional services to su</para>
<variablelist>
<varlistentry>
<term>
<emphasis role="bold">ejb3-clustered-sfsbcache-service.xml</emphasis>
</term>
<listitem>
<para>This services provides replication and failover for EJB3 stateful session beans.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">ejb3-entity-cache-service.xml</emphasis>
</term>
<listitem>
<para>This services provides a clustered cache for EJB3 entity beans.</para>
</listitem>
</varlistentry>
</variablelist>
</chapter>
<chapter>
<title>Starting and Stopping JBoss</title>
<para>After you have installed the JBoss distribution, it is wise to perform a simple startup test to validate
that there are no major problems with your Java VM/operating system combination. To test your installation,
move to the <literal>bin</literal> directory and execute the <literal>run.bat</literal> or
<literal>run.sh</literal> script, as appropriate for your operating system. Your output should look like the
following and contain no error or exception messages:</para>
<programlisting>[bin]$ sh run.sh
=========================================================================
JBoss Bootstrap Environment
JBOSS_HOME: /tmp/jboss-4.0.3
JAVA: /System/Library/Frameworks/JavaVM.framework/Home//bin/java
JAVA_OPTS: -server -Xms128m -Xmx128m -Dprogram.name=run.sh
CLASSPATH: /tmp/jboss-4.0.3/bin/run.jar:/System/Library/Frameworks/JavaVM.framework/Home
/lib/tools.jar
=========================================================================
15:19:42,557 INFO [Server] Starting JBoss (MX MicroKernel)...
15:19:42,564 INFO [Server] Release ID: JBoss 4.0.3RC2 (build: CVSTag=Branch_4_0
date=200508131954)
15:19:42,570 INFO [Server] Home URL: file:/private/tmp/jboss-4.0.3/
15:19:42,573 INFO [Server] Library URL: file:/private/tmp/jboss-4.0.3/lib/
15:19:42,604 INFO [Server] Patch URL: null
15:19:42,608 INFO [Server] Server Name: default
15:19:42,627 INFO [Server] Server Home Dir: /private/tmp/jboss-4.0.3/server/default
15:19:42,629 INFO [Server] Server Home URL: file:/private/tmp/jboss-4.0.3/server/default/
15:19:42,634 INFO [Server] Server Data Dir: /private/tmp/jboss-4.0.3/server/default/data
15:19:42,636 INFO [Server] Server Temp Dir: /private/tmp/jboss-4.0.3/server/default/tmp
15:19:42,638 INFO [Server] Server Config URL:
file:/private/tmp/jboss-4.0.3/server/default/conf/
15:19:42,640 INFO [Server] Server Library URL:
file:/private/tmp/jboss-4.0.3/server/default/lib/
15:19:42,642 INFO [Server] Root Deployment Filename: jboss-service.xml
15:19:42,657 INFO [Server] Starting General Purpose Architecture (GPA)...
15:19:43,960 INFO [ServerInfo] Java version: 1.4.2_05,Apple Computer, Inc.
15:19:43,963 INFO [ServerInfo] Java VM: Java HotSpot(TM) Client VM 1.4.2-38,"Apple
Computer, Inc."
15:19:43,970 INFO [ServerInfo] OS-System: Mac OS X 10.3.8,ppc
15:19:45,243 INFO [Server] Core system initialized
...
15:20:42,584 INFO [Server] JBoss (MX MicroKernel) [4.0.3RC2 (build: CVSTag=Branch_4_0
date=200508131954)] Started in 58s:659ms</programlisting>
<para>If your output is similar to this (accounting for installation directory differences), you are now be
ready to use JBoss.</para>
<para>Using <literal>run.sh</literal> without any arguments starts the server using the
<literal>default</literal> server configuration file set. To start with an alternate configuration file set,
you pass in the name of the directory under <literal>JBOSS_DIST/server</literal> that you want to use as the
value to the <literal>-c</literal> command line option. For example, to start with the
<literal>minimal</literal> configuration file set you would specify:</para>
<programlisting>[bin]$ ./run.sh -c minimal
...
15:02:02,939 INFO [Server] JBoss (MX MicroKernel) [4.0.3RC2 (build: CVSTag=Branch_4_0
date=200508311658)] Started in 6s:809ms</programlisting>
<para>The <literal>run</literal> script supports the following options:</para>
<programlisting>
usage: run.sh [options]
-h, --help Show this help message
-V, --version Show version information
-- Stop processing options
-D<name>[=<value>] Set a system property
-d, --bootdir=<dir> Set the boot patch directory; Must be absolute or url
-p, --patchdir=<dir> Set the patch directory; Must be absolute or url
-n, --netboot=<url> Boot from net with the given url as base
-c, --configuration=<name> Set the server configuration name
-B, --bootlib=<filename> Add an extra library to the front bootclasspath
-L, --library=<filename> Add an extra library to the loaders classpath
-C, --classpath=<url> Add an extra url to the loaders classpath
-P, --properties=<url> Load system properties from the given url
-b, --host=<host or ip> Bind address for all JBoss services
-g, --partition=<name> HA Partition name (default=DefaultDomain)
-u, --udp=<ip> UDP multicast address
-l, --log=<log4j|jdk> Specify the logger plugin type</programlisting>
<para>To shutdown the server, you simply issue a Ctrl-C sequence in the console in which JBoss was started.
Alternatively, you can use the <literal>shutdown.sh</literal> command.</para>
<programlisting>[bin]$ ./shutdown.sh -S</programlisting>
<para>The <literal>shutdown</literal> script supports the following options:</para>
<programlisting>A JMX client to shutdown (exit or halt) a remote JBoss server.
usage: shutdown [options] <operation>
options:
-h, --help Show this help message (default)
-D<name>[=<value>] Set a system property
-- Stop processing options
-s, --server=<url> Specify the JNDI URL of the remote server
-n, --serverName=<url> Specify the JMX name of the ServerImpl
-a, --adapter=<name> Specify JNDI name of the MBeanServerConnection to use
-u, --user=<name> Specify the username for authentication
-p, --password=<name> Specify the password for authentication
operations:
-S, --shutdown Shutdown the server
-e, --exit=<code> Force the VM to exit with a status code
-H, --halt=<code> Force the VM to halt with a status code</programlisting>
<para>Use of the shutdown command requires a server configuration that contains
<literal>jmx-invoker-service.xml</literal> service, so the shutdown command cannot be used with the
<literal>minimal</literal> configuration. </para>
</chapter>
</book>
More information about the jboss-cvs-commits
mailing list