Author: smukhina
Date: 2009-05-08 08:36:11 -0400 (Fri, 08 May 2009)
New Revision: 15138
Modified:
trunk/as/docs/reference/en/master_output.xml
trunk/documentation/guides/Exadel-migration/en/master_output.xml
trunk/documentation/guides/GettingStartedGuide/pom.xml
trunk/drools/docs/reference/en/master_output.xml
trunk/esb/docs/esb_ref_guide/en/master_output.xml
trunk/hibernatetools/docs/reference/en/master_output.xml
trunk/jbpm/docs/converter_ref/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 correcting syntax errors in release
documentation
Modified: trunk/as/docs/reference/en/master_output.xml
===================================================================
--- trunk/as/docs/reference/en/master_output.xml 2009-05-08 12:20:47 UTC (rev 15137)
+++ trunk/as/docs/reference/en/master_output.xml 2009-05-08 12:36:11 UTC (rev 15138)
@@ -22,2069 +22,2069 @@
<!ENTITY strutstutoriallink
"../../struts_tools_tutorial/html_single/index.html">
-]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>JBoss Server Manager Reference Guide</title>
-
-
<author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
-
<author><firstname>Olga</firstname><surname>Chikvina</surname></author>
-
<author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author>
-
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat</holder>
- </copyright>
- <releaseinfo>
- Version: 2.0.0.GA
- </releaseinfo>
-<abstract>
- <title></title>
- <para>
- <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_...
version</ulink>
- </para>
-</abstract>
-
- </bookinfo>
-
-
- <toc></toc>
-
-<chapter id="quick_start" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/quick_start.xml">
- <title>Quick Start with JBoss Server</title>
-
- <para>This chapter covers the basics of working with the <property
moreinfo="none">JBoss Server</property>. If you
- already have installed JBoss server and runtime you can quickly learn how to
configure, start,
- stop the server, to know deployment and archiving processes. How to install runtimes
and servers
- read in the <link linkend="runtimes_servers">Runtimes and Servers in
the JBoss AS plugin</link>
- chapter.</para>
-
- <para>To start working with JBoss AS, select a <property
moreinfo="none">JBoss AS Perspective</property> via
- <emphasis><property moreinfo="none">Window > Open
Perspective > Other > JBoss
- AS</property>.</emphasis></para>
-
- <section id="starting">
- <title>Starting JBoss Server</title>
-
- <para>Starting <property moreinfo="none">JBoss
Server</property> is quite simple. You can control the server
- behaviour with the help of a special toolbar in the <property
moreinfo="none">JBoss Server View</property>
- where you could <emphasis>
- <property moreinfo="none">start</property>
- </emphasis> it in a regular or debug mode, <emphasis>
- <property moreinfo="none">stop</property>
- </emphasis> it or <emphasis>
- <property moreinfo="none">restart</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> it and
</diffmk:wrapper><emphasis>
- <property moreinfo="none">publish</property>
- </emphasis><diffmk:wrapper diffmk:change="added"> to the
server.</diffmk:wrapper></para>
-
- <figure float="0">
- <title>JBoss Server Toolbar</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To launch the server click the green-with-white-arrow icon on the
<property moreinfo="none">JBoss Server
- View </property>or right click server name in this view and select
<emphasis>
- <property moreinfo="none">Start</property>.
</emphasis> If this view is not open, select
- <emphasis><property moreinfo="none">Window > Show
View > Other > Server >
- JBoss Server View</property>.</emphasis></para>
-
- <figure float="0">
- <title>Start JBoss Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="stopping">
- <title>Stopping JBoss Server</title>
-
- <para>To stop the server, click the <emphasis>
- <property moreinfo="none">Stop</property>
- </emphasis> icon in the <property moreinfo="none">JBoss
Server View</property> or right click the server name
- and press <emphasis><property
moreinfo="none">Stop</property>.</emphasis></para>
-
- <figure float="0">
- <title>Stop JBoss Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When the server is stopped you will see <emphasis>
- <property moreinfo="none">Stopped</property>
- </emphasis> state next to its name in the square brackets.</para>
- <para>Learn more about the <property moreinfo="none">JBoss
Server View</property>
- <link linkend="JBossServerView">here</link>.</para>
- </section>
-
- <section id="archiving">
-
- <title>Project Archiving</title>
-
- <para><property moreinfo="none">JBoss Tools</property>
comes with our own archives tool. The Project Archives
- plugin consists primarily of a view to set up each packaging configuration
<emphasis>(
- <property moreinfo="none">Window > Show View >
Other > JBoss Tools > Project archives</property>).
- </emphasis></para>
- <para>Right clicking in the <property moreinfo="none">Project
archives view</property> you can create War,
- EJB War, EAR or JAR archive.</para>
-
- <figure float="0">
- <title>Archive Creating</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Using the context menu on the item you can initiate a
<emphasis><property moreinfo="none">full
build</property></emphasis> on
- archive, <emphasis><property
moreinfo="none">edit</property>,</emphasis>
<emphasis><property
moreinfo="none">delete</property></emphasis> or
- <emphasis><property
moreinfo="none">publish</property></emphasis> it.</para>
-
- <figure float="0">
- <title>Context Menu on the Item</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Learn more about the <property moreinfo="none">Project
Archives View</property>
- <link
linkend="Project_archivesView">here</link>.</para>
-
- </section>
- <section id="deployment">
- <title>Deploying an Application to a Server</title>
-
- <para>There are two times to deploy your application:</para>
- <itemizedlist>
- <listitem>
- <para>While creating it</para>
- </listitem>
- <listitem>
- <para>After it already exists</para>
- </listitem>
- </itemizedlist>
-
- <para>When you create a new project (Seam, JSF or Struts) with the New Project
or Import Project
- wizards, the one of wizards steps has a <emphasis>
- <property moreinfo="none">Target Runtime</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">Target Server</property>
- </emphasis> sections. You can deploy the application through the appropriate
selection in
- these sections.</para>
-
- <figure float="0">
- <title>Runtime and Server Sections in the New Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_4a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Runtime and Server Sections in the Import Project
Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_4b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can deploy an existing application to a server by right-clicking the
target defined
- server in the <property moreinfo="none">JBoss Servers
View</property> and then selecting <emphasis><property
moreinfo="none">Add and
- Remove Projects</property></emphasis> from the context
menu.</para>
-
- <figure float="0">
- <title>Add and Remove Projects From the Context Menu.</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If this application is not assigned to a server, it will be in the
left-hand available
- projects list. Clicking on the <property moreinfo="none">Add
></property> button will add it to the right-hand
- configured projects list and deploy the application to this server.</para>
-
- <figure float="0">
- <title>Modifying The Projects that are Configured on the
Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/quick_start/quick_start_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Here, we have just performed the basic steps you should know to quick
start with JBoss
- server. In fact, there are more functionalities which you can make use of. Further
we will
- talk about them in detail.</para>
- </section>
-
-
- <section>
- <title>Other relevant resources on the topic</title>
-
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find
<ulink
url="http://docs.jboss.org/tools/2.1.0.GA">here</ulink>...
- <para>The latest documentation builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">her...
-
- </section>
-
-</chapter>
-
-
-<chapter id="runtimes_servers"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/runtimes_servers.xml"
xreflabel="runtimes_servers">
- <?dbhtml filename="runtimes_servers.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Deploy</keyword>
- <keyword>Deployment</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
- <title>Runtimes and Servers in the JBoss AS plugin</title>
-
- <para>In this chapter we will discuss how to install runtimes and
servers.</para>
-
- <para>First of all it's necessary to mention that the JBoss AS plugin makes
use of WTP.
- This includes starting and stopping servers in run or debug mode. It also includes
targeting WTP
- projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure
that the
- proper jars from a specific server are added to the project's classpath
- properly.</para>
- <para>In order to get started creating, running, and debugging J2EE applications,
we should create
- our <property moreinfo="none">runtime</property> and
<property moreinfo="none">server</property> instances.</para>
-
- <section>
- <title>Runtimes</title>
- <para>In <property moreinfo="none">JBoss
Tools</property>, the main purpose of Server Runtimes is to point to a
- server installation somewhere on disk. In our case, this will be a JBoss
installation, and it
- can then be used for two primary purposes:</para>
- <itemizedlist>
- <listitem>
- <para>it provides classpath additions to WTP projects that require
them.</para>
- </listitem>
- <listitem>
- <para>for <property moreinfo="none">JBoss
server</property> at least, it provides information necessary for
- the starting and stopping of the server, it tells which jars to run and which
- configuration to use.</para>
- </listitem>
- </itemizedlist>
-
- <section id="InstNewRuntime">
- <title>Installing a New Runtime</title>
- <para>You can install runtimes into eclipse from the <emphasis>
- <property moreinfo="none">Window > Preferences
</property>
- </emphasis> menu, and then select <emphasis>
- <property moreinfo="none">Server > Runtime
Environments</property>
- </emphasis> from the categories available on the left.</para>
- <figure float="0">
- <title>Installed Runtimes</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>From this preference page you can see all declared runtimes and their
types as well.
- Here, it's possible to edit or remove existing runtimes as well as add a new
- one.</para>
-
- <para>To create a JBoss runtime click <emphasis>
- <property moreinfo="none">Add</property>
- </emphasis> button and choose a necessary type of runtime from the
<emphasis>
- <property moreinfo="none">JBoss Community</property>
- </emphasis> category.</para>
-
- <figure float="0">
- <title>Adding a Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>Now there is a separation between .org servers (the <emphasis>
- <property moreinfo="none">JBoss Community</property>
- </emphasis> category) and product server that comes with JBoss EAP in
JBDS ( the <emphasis>
- <property moreinfo="none">JBoss Enterprise
Middleware</property>
- </emphasis> category).</para>
- </note>
-
- <para>As you can see, <property moreinfo="none">JBoss
Tools</property> provide its own adapters such as JBoss
- 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that
is a safer
- incremental deployment, which prevents partial deployments to be picked up by the
server. It
- means that scanning for auto-deployment is suspended while files are being copied
to the
- deployment location and resumed when the copy is completed.</para>
-
- <note>
- <title>Note:</title>
- <para>Currently we recommend you to use a fully supported JBoss 4.2 server
adapter.</para>
- </note>
-
- <para>You'll also note a Deploy-Only Runtime type. This type provides no
classpath
- for WTP projects. It is used solely by its server type for the purpose of setting
up a
- deploy directory for users who don't wish to make use of starting, stopping,
or
- debugging their projects inside eclipse.</para>
-
- <figure float="0" id="add_runtime_figure">
- <title>Adding a JBoss 4.2 Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The following table describes all the available options of the currant
wizard
- page.</para>
- <table>
- <title>Server Runtime Wizard Parameters</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Name</para>
- </entry>
- <entry>
- <para>The name of a new Runtime for a chosen server. We suggest
that you
- don't leave a default value. It's better to give descriptive
- names that will help to distinguish one runtime from
another.</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Home directory</para>
- </entry>
- <entry>
- <para>The path to a directory where the runtime is
installed.</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para><diffmk:wrapper
diffmk:change="changed">JRE</diffmk:wrapper></para>
- </entry>
- <entry>
- <para>The proper Java Runtime Environment. Because of the
open-source nature of
- JBoss, a user is likely to want to modify and repackage some of the
- configuration-specific jboss jars and create their own configuration.
Thus, rather
- than forcing you to copy his entire JBoss installation, the structure
of the
- wizard allows to create only a new configuration instead.</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Configuration</para>
- </entry>
- <entry>
- <para>The list of configurations (all, default, minimal) that is
updated as soon as
- you browse to a valid runtime installation folder. After the runtime is
created
- the configuration becomes an unchanging property of that runtime. To
compile
- against a different configuration's jars, you will need to create a
new runtime
- from that configuration.</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <para>As a result of having each runtime represent a specific configuration
rather than the
- server installation as a whole, it is very likely you'll create several
different
- runtimes to test each of your configurations. It becomes important to ensure your
runtimes,
- and later your servers, are given descriptive names that help you remember which
is
- which.</para>
-
- <para>Press <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to see your new runtime in the list.</para>
- </section>
-
- </section>
-
- <section>
- <title>Servers</title>
- <para>WTP servers are eclipse-representations of a backing server installation.
They are used to
- start or stop servers, deploy to servers, or debug code that will run on the
server. They keep
- track of the modules (jars, wars, etc) you deploy to the server and also allow you
to undeploy
- those modules (see <link linkend="run_on_server_wizard">Deploying
with Run On Server
- Wizard</link> section). </para>
- <para>Servers can be started or stopped with different <link
linkend="com_line_arg">command-line
- arguments</link>. They are often backed by a runtime object representing
that server's
- location.</para>
-
- <section>
- <title>Creating a New Server</title>
-
- <para>There are many ways to get to the new server wizard. One way is to use
the old standard <emphasis>
- <property moreinfo="none">File > New > Other...
</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">Server</property>
- </emphasis>. This should show the wizard like below.</para>
- <figure float="0">
- <title>Adding a JBoss Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>A server object is that keeps track of things like command line
arguments when starting
- or stopping, and runtimes keep track of the location of the installation. Thus,
each server
- instance must be backed by an appropriate runtime. </para>
-
- <para>From the list of already declared runtimes in the combo box below the
view it's
- possible to select which runtime you want your server to be backed by. If there
is no
- runtime that matches your needs just press the <emphasis>
- <property moreinfo="none">Add...</property>
- </emphasis> link nearby to bring up the wizard for creating a new runtime
(see the <link linkend="add_runtime_figure">previous
section</link>). To configure the already installed
- runtimes you should go to server preferences that you can easily do by pressing
the <emphasis>
- <property moreinfo="none">Configure runtime
environments...</property></emphasis> link.</para>
-
- <para>If the server you want to create doesn't have any installed runtime
yet, the combo box
- and the links are absent.</para>
-
- <figure float="0">
- <title>Installed Server Runtime Environments</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In this case the next page in the wizard which has the same form as in
<link linkend="add_runtime_figure">the previous section</link> will
ask you to create the
- associated runtime.</para>
- <para>Either way, after targeting your server to a runtime, the final screen
in this wizard is
- largely confirmational, giving you a chance to verify that you've selected
the
- appropriate runtime. It also allows to name the server appropriately.
</para>
-
- <figure float="0">
- <title>Installed Server Runtime Environments</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Press <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to complete the process of the server creation.</para>
- <para><diffmk:wrapper diffmk:change="added">Now that
we've created our runtimes and servers, we can dwell on all services
- and tools that JBoss Server Manager provides.</diffmk:wrapper></para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss Tools server manager. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
- </section>
-
- </section>
-
-</chapter>
-
-
-<chapter id="perspective" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/perspective.xml"
xreflabel="perspective">
- <?dbhtml filename="perspective.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Deploy</keyword>
- <keyword>Deployment</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>JBoss AS Perspective</title>
-
- <para>This chapter tells how to manage installed <property
moreinfo="none">JBoss Server</property> via
- <property moreinfo="none">JBoss AS
perspective</property>.</para>
-
- <para>The <property moreinfo="none">JBoss AS
perspective</property> is similar to the <property
moreinfo="none">Java
- perspective</property>, but it contains a few additional views. Two of
the additional
- views are standard views, specifically the <property
moreinfo="none">Console view</property> and the
- <property moreinfo="none">Properties view</property>.
The other two views that are added are the
- <property moreinfo="none">Project archives
view</property> and the <property moreinfo="none">JBoss Server
- View</property>.</para>
-
- <section id="JBossServerView" role="updated">
- <?dbhtml filename="JBossServerView.html"?>
- <title>The JBoss Server View</title>
-
- <para>The <property moreinfo="none">JBoss Server
View</property> is built on Common Navigator Framework
- allowing extensions and is using label decorators what makes the UI enough
compact
- without loosing the vital information.</para>
-
- <para>Let's have a look at the <property
moreinfo="none">JBoss Server View</property> and inspect
- in detail all parts it consists of. </para>
- <figure float="0">
- <title>The JBoss Server View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <section id="jbossserver_view_toolbar">
- <title>JBoss Server View Toolbar</title>
- <para>In the right top corner of the <property
moreinfo="none">JBoss Server View</property><diffmk:wrapper
diffmk:change="changed"> there is a
- special toolbar which provides a quick access to starting a server (in
the debug mode,
- run mode, or profile mode), restarting a server, stopping a server and a
possibility to publish to a
- server.</diffmk:wrapper></para>
-
- <figure float="0">
- <title>The JBoss Server View Toolbar</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In order to debug your applications or EJB's that are
deployed to the server, you
- must start the server in debug mode. By starting the server in debug
mode, eclipse
- will allow you to set breakpoints on code in your workspace and step
through the
- code.</para>
-
- <para><emphasis>
- <property moreinfo="none">Start the server in
profiling mode</property>
- </emphasis> button allows to enable profiling actions for your
application. For more
- details on how to start using TPTP profiling with <property
moreinfo="none">JBoss Tools</property>
- refer to <link linkend="tptp_support">TPTP
Support</link> chapter.</para>
-
- <para><emphasis>
- <property moreinfo="none">Publish to the
server</property>
- </emphasis> button will republish any modules where it has
determined the workspace
- is out of sync with the server. It will attempt to do an incremental
publish if it
- turns out that the module in question is capable of doing
one.</para>
-
- </section>
-
- <section id="jbossserver_view_structure">
- <title>JBoss Server View Structure</title>
- <para>The <property moreinfo="none">JBoss Server
View</property> displays all declared servers as well
- as their current states (that is whether they are started or stopped) and
statuses
- in the square brackets next to a server name.</para>
-
- <figure float="0">
- <title>The JBoss Server View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The following table lists possible server statuses.</para>
-
- <table>
- <title>Server Publish Status</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
- <colspec colnum="2"
colwidth="3*"></colspec>
-
-
- <thead>
- <row>
- <entry align="center">Status</entry>
-
- <entry
align="center">Description</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry align="center">
- <para>Republish</para>
- </entry>
-
- <entry align="center">
- <para>The status which allows you to see if changes
are
- awaiting</para>
- </entry>
- </row>
- <row>
- <entry align="center">
- <para>Publishing...</para>
- </entry>
-
- <entry align="center">
- <para>The status which shows if changes are being
updated</para>
- </entry>
- </row>
- <row>
- <entry align="center">
- <para>Synchronized</para>
- </entry>
-
- <entry align="center">
- <para>The status which allows you to see if changes
are
- in-sync</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>You can control a server behavior as well as adjust some server
preferences with
- the help of the context menu commands.</para>
-
- <figure float="0">
- <title>Context Menu Commands</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>All available context menu commands are described in the
following table.</para>
- <table>
- <title>Server Properties through the Context Menu</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
- <colspec colnum="2"
colwidth="3*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>New Server</para>
- </entry>
- <entry>
- <para>The option allows to define a new
server</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Open</para>
- </entry>
- <entry>
- <para>The option opens the Server
editor</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Show in</para>
- </entry>
- <entry>
- <para>This option gives an easy access to the next
views: Console,
- Debug view, Server Log or MBean
Explorer</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Delete</para>
- </entry>
- <entry>
- <para>Standard option that allows to delete the
chosen server</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Start</para>
- </entry>
- <entry>
- <para>The action for stating a server in a run
mode</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Debug</para>
- </entry>
- <entry>
- <para>The action for stating a server in a debug
mode</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Stop</para>
- </entry>
- <entry>
- <para>The action for stopping a declared
server</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Publish</para>
- </entry>
- <entry>
- <para><diffmk:wrapper
diffmk:change="added">The action for synchronizing the publish information
between
- the server and
workspace</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Explore</para>
- </entry>
- <entry>
- <para>This action uses the native OS file explorer
to browse the
- deploy destination. Note: The option is also
available for
- deployed resources/projects (see the figure
below).</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Add and Remove Projects</para>
- </entry>
- <entry>
- <para>The option allows to publish a new project to
the server (if
- its type is supported)</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Monitoring</para>
- </entry>
- <entry>
- <para>Possibility to add ports to be monitored on
the current
- server</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Properties</para>
- </entry>
- <entry>
- <para>Opens the window to adjust the current
server
- preferences</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <para>Under the server element in the <property
moreinfo="none">JBoss Server View</property>, you can
- see currently deployed to the server modules and some server extensions
which
- provide the additional information on the server.</para>
-
- <para>The context menu for any module allows you to remove it from the
server, force a
- full or incremental republish upon it.</para>
-
- <figure float="0">
- <title>Modules Action</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <section id="filesets">
- <title>Filesets</title>
-
- <para>The <emphasis>
- <property
moreinfo="none">Filesets</property>
- </emphasis> category in the <property
moreinfo="none">JBoss Server View</property> is intended
- for files filtering.</para>
-
- <para>To add a new file filter, right-click the <emphasis>
- <property
moreinfo="none">Filesets</property>
- </emphasis> category and select <emphasis>
- <property moreinfo="none">Create File
Filter</property>.</emphasis>The <property moreinfo="none">New
File
- Filter wizard</property> should appear.</para>
-
- <figure float="0">
- <title>Creating a New File Filter</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/filesets1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The wizard asks you to enter the filter name and add includes
and excludes
- patterns. The preview box underneath gives a list of files matched to
the
- defined patterns.</para>
-
- <figure float="0">
- <title>New File Filter Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/filesets2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After the filter is created, you can observe it by expanding
the <emphasis>
- <property
moreinfo="none">Filesets</property>
- </emphasis> category in the <property
moreinfo="none">JBoss Server View</property>.</para>
-
- <para>It's possible now to edit files directly from the
<emphasis>
- <property
moreinfo="none">Filesets</property>
- </emphasis> category. Double clicking on a file from
<emphasis>
- <property
moreinfo="none">Filesets</property>
- </emphasis> opens up the editor automatically or you can use
the <emphasis>
- <property moreinfo="none">Edit
File</property>
- </emphasis> context menu command.</para>
-
- <figure float="0">
- <title>Direct Editing from the Filesets</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/filesets3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To delete a file filter (or just a file) from the
<emphasis>
- <property
moreinfo="none">Filesets</property>,</emphasis> right-click a
file filter (or the
- unnecessary file) and select the <emphasis>
- <property moreinfo="none">Delete File
Filter</property>
- </emphasis>
- <emphasis>(<property moreinfo="none">Delete
File</property>)</emphasis> command.</para>
-
- <figure float="0">
- <title>Deleting the File from the Filesets</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/filesets4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="xml_configuration">
- <title>XML Configuration</title>
- <para>The <emphasis>
- <property moreinfo="none">XML
Configuration</property>
- </emphasis> category allows you to quickly browse to descriptor
files in your
- server's deploy directory and check or change the values.
Basically, <emphasis>
- <property moreinfo="none">XML
Configuration</property>
- </emphasis><diffmk:wrapper
diffmk:change="changed"> includes XML XPaths where an xpath is a path used to
access some
- specific part of an xml document.
</diffmk:wrapper></para>
-
- <note>
- <title>Note:</title>
- <para>You are assumed to be familiar with XPath. If not, we
highly suggested
- that you look through an appropriate manual or tutorial on the
topic.</para>
- </note>
-
- <para>The <emphasis>
- <property moreinfo="none">XML
Configuration</property>
- </emphasis> category itself contains only a list of categories.
<emphasis>
- <property moreinfo="none">Ports</property>
- </emphasis> are provided by default and is filled with many of
the most commonly
- used ports in the <property moreinfo="none">JBoss
Server</property>.</para>
-
- <figure float="0">
- <title>XML Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_14.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <!--para>In the <property>Properties
- view</property> you can see an identifier and nested files
underneath in which
- that xpath can be found as well as its current value. The details of the
xpath are
- hidden as all you need to see is only which file you're
referring to and
- what its current value is.</para-->
-
- <para>By right-clicking on <emphasis>
- <property moreinfo="none">XML
Configuration</property>, </emphasis> you can create a new
- category. Besides, context menu for <emphasis>
- <property moreinfo="none">XML
Configuration</property>
- </emphasis> category makes possible to disable it. You can
disable any category
- in the bottom part of the <emphasis>
- <property moreinfo="none">JBoss Server
View</property>.</emphasis> Look for them in the <emphasis>
- <property moreinfo="none">Inactive
Categories</property>
- </emphasis> afterwards to re-enable.</para>
-
- <figure float="0">
- <title>Adding New Category</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_15.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>By right-clicking on <emphasis>
- <property moreinfo="none">Ports</property>
- </emphasis> or any other category in <emphasis>
- <property moreinfo="none">XML
Configuration</property>
- </emphasis>, you can create a new xpath.</para>
-
- <figure float="0">
- <title>Adding New XPath</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_16.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After that, the dialog shown below will appear.</para>
-
- <figure float="0">
- <title>Adding New XPath</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_17.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The goal here is to get an end result where the XPath matches
up with a
- necessary property. With that in mind, let's look how it works.
If the
- property you want to reach is the value of the
<emphasis>name</emphasis>
- attribute in the element <code
diffmk:change="added"><mbean></code>, then your
<emphasis>
- <property moreinfo="none">XPath
Patten</property>
- </emphasis>should end with
<emphasis>mbean</emphasis> and your <emphasis>
- <property moreinfo="none">Attribute
Name</property>
- </emphasis> should be <emphasis>name</emphasis>
like on the next figure.</para>
-
- <programlisting format="linespecific"
role="XML"><![CDATA[...
-<server>
-...
- <mbean code="org.jboss.ejb.EJBDeployer"
- name="jboss.ejb:service=EJBDeployer"
xmbean-dd="">
-
- <!-- Inline XMBean Descriptor BEGIN -->
- <xmbean>
- <description>
- The EJBDeployer responsible for ejb jar
deployment</description>
- ...
- </xmbean>
- </mbean>
-</server>
-]]></programlisting>
-
- <figure float="0">
- <title>XPath Preview</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_18.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
- <para>Notice, when you type the fields autocomplete to help you
locate exactly
- what xpath you're looking for.</para>
- </tip>
-
- <para>Then, on the other hand, if your desired field is the text of
an element
- <code
diffmk:change="added"><description></code>, your
<emphasis>
- <property moreinfo="none">XPath
Patten</property>
- </emphasis> should end with
<emphasis>description</emphasis> and <emphasis>
- <property moreinfo="none">Attribute
Name</property>
- </emphasis> field should be left blank. When finished, click
<emphasis>
- <property
moreinfo="none">Preview</property>
- </emphasis> to see how many matches you have for that
particular XPath.</para>
-
- <figure float="0">
- <title>XPath Preview</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_19.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
- </section>
-
- <section id="dragndrop_to_jboss_server_view">
- <title>Drag-n-Drop to JBoss Server View</title>
-
- <para>Starting from 2.0.0.CR2 version of <property
moreinfo="none">JBoss AS Tools</property> the
- <property moreinfo="none">JBoss Server
View</property><diffmk:wrapper diffmk:change="changed"> supports
drag-n-drop of deployable and
- runnable projects/resources.</diffmk:wrapper></para>
-
- <figure float="0">
- <title>Dragging to the JBoss Server View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/dnd_toJBossServerView.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>With drag-n-drop the following actions can be
performed:</para>
-
- <itemizedlist>
- <listitem>
- <para>dragging a project to a server will deploy it to the
server and run it by
- showing the main page in a browser</para>
- </listitem>
-
- <listitem>
- <para>dragging an <emphasis>
- <property
moreinfo="none">.xhtml</property>
- </emphasis> file from <emphasis>
- <property
moreinfo="none">WebContent</property>
- </emphasis> will do the same and show the corresponding
page in a
- browser</para>
- </listitem>
-
- <listitem>
- <para>dragging a deployable resource (i.e. a datasource
(<emphasis>
- <property
moreinfo="none">-ds.xml</property>
- </emphasis><diffmk:wrapper
diffmk:change="changed">) file that has been made deployable) will simply
deploy that
- resource directly to the
server</diffmk:wrapper></para>
- </listitem>
- </itemizedlist>
-
- <para>In short, the feature does the same thing as if you used the
<emphasis>
- <property moreinfo="none">Run On
Server</property>
- </emphasis> option or <emphasis>
- <property moreinfo="none">Add and Remove
Projects</property>
- </emphasis> option in the context menu of the server.</para>
- </section>
-
- <section id="server_log">
- <title>Server Log View</title>
-
- <para>You can monitor the current server behavior with the help of the
<property moreinfo="none">Server
- Log</property>. To open a server in the <property
moreinfo="none">Server Log view</property> you
- should right-click on the server and follow to <emphasis>
- <property moreinfo="none">Open in > Server
Log</property>.</emphasis></para>
-
- <para>The <emphasis>
- <property moreinfo="none">Server
Log</property>
- </emphasis> shows relevant information to your server's
startup, shutdown,
- and publish processes. This allows you to keep an eye on what's going
on
- (such as automatic incremental deployment if you have it
enabled).</para>
-
- <figure float="0">
- <title>Event Log Actions</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_12.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <property moreinfo="none">Server
Log</property> toolbar contains several icons that perform
- the following actions:</para>
-
- <table>
- <title>Server Log Toolbar Icons</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
- <colspec colnum="2"
colwidth="3*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Export Log</para>
- </entry>
- <entry>
- <para>Possibility to export the log into a text
file</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Clear Log Viewer</para>
- </entry>
- <entry>
- <para>The option clears the current server
log</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Delete Log</para>
- </entry>
- <entry>
- <para>Click to delete the server log</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Open Log</para>
- </entry>
- <entry>
- <para>Click to open the server log text
file</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Restore Log</para>
- </entry>
- <entry>
- <para>Click to restore the server log</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- <section id="server_editor">
- <title>Server Editor</title>
- <para>By double-clicking on any server, an editor window will appear
allowing you to
- edit parts of that server.</para>
-
- <figure float="0">
- <title>Preferences Page for the Chosen Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
- <para><diffmk:wrapper diffmk:change="changed">On
the figure you can see that a username/password is available in the UI when
- configuring the server. If you get a SecurityException when trying to
launch the
- server, it is most likely because your server is protected and hence
you need to
- fill the username/password fields with appropriate
values.</diffmk:wrapper></para>
- </tip>
-
- <para>It should be pointed out that our server adapter by default tries
to automatically
- detect the ports it needs for integrating with a <property
moreinfo="none">JBoss Server</property>.
- Sometimes it can though be relevant to override this automatic detection
if you are
- using some custom configuration. For this purposes the <emphasis>
- <property moreinfo="none">Server
Ports</property>
- </emphasis> section in the <property
moreinfo="none">Server editor</property> is provided where the
- port settings are configurable. Click the <emphasis>
- <property
moreinfo="none">Configure...</property>
- </emphasis> link to bring up the wizard for adjusting the settings
for the
- ports.</para>
-
- <figure float="0">
- <title>Server Ports Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Press <emphasis>
- <property moreinfo="none">Edit
XPath</property>
- </emphasis> button for the chosen port to configure its XPath's
values.</para>
-
- <figure float="0">
- <title>XPath Pattern for a Server Port</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The settings related to <emphasis>
- <property
moreinfo="none">Publishing</property>
- </emphasis>, <emphasis>
- <property moreinfo="none">Timeouts</property>
- </emphasis> or <emphasis>
- <property moreinfo="none">Server
Polling</property>
- </emphasis> can be also adjusted in the <property
moreinfo="none">Server editor</property>.</para>
-
- <para id="com_line_arg"><property
moreinfo="none">Server editor</property> makes it also possible to
- modify the server's launch configuration. It's just after
clicking <emphasis>
- <property moreinfo="none">Open launch
configuration</property>
- </emphasis><diffmk:wrapper diffmk:change="changed">
link. In the open window there are the tabs for setting command line
- arguments, classpaths and other things that are relevant to launching
the
- server.</diffmk:wrapper></para>
-
- <figure float="0">
- <title>Launch Configuration Properties</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Look up <ulink
url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/st...
to find parameters which can be specified for <property
moreinfo="none">JBoss
- Server</property>.</para>
-
- <note diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Note:</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Please note, that the Launch Configurations for JBoss
Servers are enough
- strict in enforcing the configured values in the server in order to
avoid
- inconsistencies between server's and their configured
runtime.</diffmk:wrapper></para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">For example, if you change the launch configuration
program arguments to
- </diffmk:wrapper><emphasis
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">"-c
myConfig"</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> but do not change the
- targeted runtime configuration, then your program arguments will be
ignored. The
- server runtime "wins" so to speak. This ensures
consistency
- and if you change the location of the runtime, your launch
configurations will
- automatically pick that up.</diffmk:wrapper></para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Values are not controlled by the server and its runtime
setup will be passed
- on unaltered.</diffmk:wrapper></para>
- </note>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Until 3.0.0.GA release of
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss
Tools</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, the servers classpath was readonly, but that caused
- problems for users wanting to add their own jars in the startup
classpath. That is
- relevant if you need to patch the server, add a custom charset or other
tweaks that
- require early access to the
classpath.</diffmk:wrapper></para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Now all servers have a custom 'server runtime
classpath
- container', which is there by default and point to the default jars
in
- JBoss. You can now adjust the classpath. Then just make sure this
container is there
- if you want the classpath to be picked
up.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Server Classpaths</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/perspective/server_classpaths.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">If for some reason you have a launch configuration
without this container, </diffmk:wrapper><emphasis
diffmk:change="added">
- <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Restore
- Default
Entries</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> should add it properly. Also,
</diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Restore
- Default
Entries</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> will also remove any
- extra entries you added yourself.</diffmk:wrapper></para>
- </section>
-
- <section>
- <title>Relevant Resources Links</title>
- <para>Find more about XPath in the <ulink
url="http://www.w3.org/TR/xpath20/">XPath
- Documentation</ulink>.</para>
- </section>
- </section>
-
- <section id="Project_archivesView" role="updated">
- <title>Project Archives View</title>
- <para>Every application, whether Plain Old Java, J2EE, or some other
language altogether,
- needs to be packaged in some way. In Java-related projects, many people use
ANT. </para>
- <note>
- <title>Note:</title>
- <para>Those who use ANT will appreciate how the Project Archives Ant
task is now
- improved: it supports variables and gives more informative error/logging
messages
- when something goes wrong.</para>
- </note>
-
- <para>But <property moreinfo="none">JBoss
Tools</property> come with our own Archives tool with a bit easier
- and less-verbose XML and a handy user interface. The Project Archives plugin
consists
- primarily of a view, that is <property
moreinfo="none">Project Archives view</property>, to set up each
- packaging configuration.</para>
- <para>So far, let's look through all functionality that the
<property moreinfo="none">Project
- Archives view</property> provides.</para>
-
- <section id="archives_overview">
- <title>Overview</title>
-
- <para>The packaging configuration for each project is stored in the
project's root
- folder, and is in a file named <emphasis>
- <property moreinfo="none">.packages</property>
- </emphasis>, which has a fairly simple XML structure. Modifying the
file by hand is
- neither required nor recommended, and using the UI is the official way of
modifying
- your packaging structure.</para>
-
- <figure float="0">
- <title>Archives View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_21.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>A project's configuration contains archives. As you can see
on the image
- above a project can contain more than one archive. Internal archives and
filesets
- can be directly inside of an archive, or in some sub-folder of that
archive.</para>
-
- <para>In the upper right corner of the view you can see an icon which,
when clicked,
- will build the selected top-level archive. Additionally, you can select
<emphasis>
- <property moreinfo="none">Project > Build
Packages</property>
- </emphasis> when a project is selected in the <property
moreinfo="none">Packages View</property> to
- build all declared packages in that project's <emphasis>
- <property moreinfo="none">.packages</property>
- </emphasis> file. This will execute a full build on all declared
archives.</para>
- </section>
-
- <section id="Creating_Archive">
- <title>Creating an Archive</title>
-
- <para>When you open the <property
moreinfo="none">Project archives view</property> for the first time,
- it asks you to select the project for what you want to create an
archive.</para>
-
- <figure float="0">
- <title>Archives View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_21a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When creating a new archive for selected project, you have some
different options
- at your disposal. You need right-click inside the view and select
<emphasis>
- <property moreinfo="none">New
Archive</property>
- </emphasis> to see your archive type options.</para>
-
- <figure float="0">
- <title>Create an Archive</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_22.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
- <para>If you see only JAR from the list of available archive types,
you should
- verify whether AS Tools plugins/features are in place. EAR, EJB JAR
and WAR
- options are contributed by the AS Tools independently from webtools
and the
- virtual project model. Thus, without them only JAR will show
up.</para>
- </note>
-
- <para><property moreinfo="none">JAR</property> is
the standard archive type, and does very little
- configuration, leaving most of the work up to you. You can customize the
name, add
- folders, filesets, and inner jars to it.</para>
-
- <para>The other types, for the most part, simply start off with a
default setting,
- usually the jar with some specific children based on an expected
structure of the
- project. For example, if the project is a Dynamic Web Project, and you
create a
- <property moreinfo="none">WAR</property>
archive, the archive will be created with a few
- filesets relevant to the known structure of the project.</para>
-
- <para>Here is the first page of all New archive wizards. It is the same
for any archive
- type and the only page in the <property
moreinfo="none">New Jar wizard</property>.</para>
- <figure float="0">
- <title>New WAR Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_23.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The page is pretty simple. First it asks to set the name of your
new archive and a
- destination.</para>
-
- <para>The destination of an archive can be anywhere on the file system,
anywhere in the
- workspace, inside some other archive, or inside a folder declared inside
an archive.
- Select the necessary checkbox (either <emphasis>
- <property moreinfo="none">workspace</property>
- </emphasis> or <emphasis>
- <property moreinfo="none"> file
system</property>
- </emphasis>) for marking the destination as related to either
workspace or file
- system. You can browse to workspace or filesystem destinations by
clicking on their
- respective buttons. To select a destination inside some other archive,
you'll need
- to press the <emphasis>
- <property moreinfo="none">Workspace</property>
- </emphasis> button. At the bottom of the list, you'll see
archives that
- have been declared in the workspace.</para>
-
- <figure float="0">
- <title>Selecting the destination in the workspace</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_23a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Also in the wizard for creating a new archive you can choose
whether an archive to
- be compressed or exploded into a folder (without compression). You need
just select
- proper chechbox in the <emphasis>
- <property moreinfo="none">Archive
type</property>
- </emphasis> section.</para>
- <para>If a build or incremental update fails Project Archives will show
an error
- dialog:</para>
- <figure float="0">
- <title>Selecting the destination in the workspace</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/projectarchives_error.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click in <emphasis>
- <property moreinfo="none">Details</property>
- </emphasis> to see detailed information about what caused the
error.</para>
-
- <para>In the <property moreinfo="none">Package
Explorer</property> you can observe the created
- archive.</para>
- <figure float="0">
- <title>The Archive in the Package Explorer</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_23b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you use the exploded type of archiving, instead of a single
file archive the
- result put into a folder is displayed in the <property
moreinfo="none">Package
- Explorer</property>.</para>
- <figure float="0">
- <title>The Exploded Archive in the Package Explorer</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_23c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <section id="CreatingaFolder">
- <title>Creating a Folder</title>
- <para>Creating a folder is much easier. You simply right-click on
an archive or
- folder you want your new folder to be a child under. The only piece
of required
- information is naming the file.</para>
- </section>
- <section id="CreatingaFileSet">
- <title>Creating a FileSet</title>
- <para>To create a new fileset, you click on an available target
location such as an
- archive, a nested archive, or a folder within an archive, and select
<emphasis>
- <property moreinfo="none">New
Fileset</property>. </emphasis></para>
- <para>The <property moreinfo="none">New Fileset
wizard</property> requires a destination (where the
- files will go), and a root directory (or where the files are coming
from). The
- source can be anywhere in the workspace or from the filesystem at
large.</para>
-
- <figure float="0">
- <title>Adding a New FileSet</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_24.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Below that, the fileset requires only an includes pattern and
an excludes
- pattern. As you type in either of these fields, the preview viewer
should update
- itself with which files are matched.</para>
-
- <para><diffmk:wrapper diffmk:change="changed">You
can create a Fileset with flattening or without it. Look at the difference
- on the figure below.</diffmk:wrapper></para>
-
- <figure float="0">
- <title><diffmk:wrapper
diffmk:change="changed">The FileSet with flattening and without
it</diffmk:wrapper></title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_24a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
- </section>
-
- <section id="View_Actions">
- <title>Archive Actions</title>
- <figure float="0">
- <title>Context Menu on the Item</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_25.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The context menu on the items in the view is extendable, but
there are several
- that come standard.</para>
-
- <table>
- <title>Context Menu on the Item</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
- <colspec colnum="2"
colwidth="3*"></colspec>
-
-
- <thead>
- <row>
- <entry align="center">
- <para>Name</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>Build Archive (Full)</para>
- </entry>
-
- <entry>
- <para>The action enabled only on top-level
archives, which initiates
- a full build on that archive</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Edit Archive</para>
- </entry>
-
- <entry>
- <para>Standard action that brings up the wizard
associated with that
- particular node type and allows the details to be
changed</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Delete Archive</para>
- </entry>
-
- <entry>
- <para>Deleting node is standard action with
deletion not needing an
- explanation</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Publish To Server</para>
- </entry>
-
- <entry>
- <para>The action means the ability to publish to a
declared
- server</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Edit publish settings</para>
- </entry>
-
- <entry>
- <para>Gives possibility to edit an archive publish
settings</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section id="PublishToServer">
- <title>Publishing to Server</title>
- <para>Finally, you'll need to publish your application to a server.
Here, we
- show you how to do it with the help of <emphasis>
- <property moreinfo="none">Archives
View</property>. </emphasis></para>
-
- <figure float="0">
- <title>Context Menu on the Item</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_26.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The dialog above appears after selecting <emphasis>
- <property moreinfo="none">Publish To
Server</property>. </emphasis> To simply publish once, you
- just select the server(s) that you want, and finish. If you want the
<emphasis>
- <property moreinfo="none">Publish to
Server</property>
- </emphasis> action on that particular Archive to publish always to
that set of
- servers, then check the appropriate checkbox. And finally, to enable
automatic
- publishing upon build events, check the last checkbox.</para>
- <para>The automatic publishing feature is nice if, for example, your
package's
- destination (where it is built) is a temporary folder and you want the
archive
- published to several servers. If you only really want your archive
published to one
- server, it might be easier to have the archive's destination folder
be the deploy
- folder of the server.</para>
- </section>
- <section id="rel_res_links_archiving">
- <title>Relevant Resources Links</title>
- <para>Refer to <ulink
url="http://ant.apache.org/manual/index.html">Ant manual</ulink>
- to find more on how to build your applications with help of
Ant.</para>
-
- <para>We also recommend you to watch the <ulink
url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.ht...
which demonstrates a powerful archiving functionality in
- <property moreinfo="none">JBoss
Tools</property>.</para>
-
- <para>At this point, you are guessed to be familiar with <property
moreinfo="none">JBoss AS
- perspective</property> and your next step now is to explore how
to work with
- different kinds of projects.</para>
- </section>
-
- </section>
-
-
-</chapter>
-
-
-<chapter id="webtools"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/webtools.xml">
- <title>Projects</title>
- <para>The most popular of the projects we deal with are the J2EE ones, such as
Dynamic Web
- Project, EJB Project, or EAR project. Web projects of <property
moreinfo="none">JBoss Tools</property> are
- Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this
- chapter we are going to tell you about facets the main benefit of which to provide
proper
- structuring and packaging for any type of project.</para>
-
- <section>
- <title>Faceted Projects Overview</title>
- <para>The idea behind faceted projects is that each project can accept units of
- functionality, or facets, which can be added or removed by the user. Most often,
these
- facets either add to the project's classpath, enable a builder, or watch the
project in
- some other fashion. Generally, every project concerned has at least one facet when
- it's created. As an example, a Web project has a WebDoclet facet, or an EJB
- Project has an EJB Module facet as prerequisites.</para>
-
- <para> WTP projects have undergone some criticism as being
- <emphasis>over-engineered</emphasis> or too restrictive in their design.
WTP projects
- are set up in a tree-relationship to each other, where one project can be a child of
- another. For example, an EAR project may have a Web Project child, an EJB project
child,
- or other types.</para>
-
- <para> However, the benefit of this is that the structure of your projects is
then known,
- and packaging it up *should* be trivial. Apparently, if your project is non-standard,
or
- you feel too confined by such rigid structural requirements, you can still choose to
- package your project using the <link
linkend="Project_archivesView">Archives
- plugin</link>.</para>
- </section>
-
-
- <section>
- <title>Adding Facets to a Project</title>
-
- <para>In this section we're going to consider the facets added by
<property moreinfo="none">JBoss
- Tools</property> and show how you can configure them in a project: add new ones
or
- modify already existing configuration of the facets.</para>
-
- <para>One way to configure the facets is doing it while organizing a new project.
To
- demonstrate this let's create a new <property
moreinfo="none">Dynamic Web Project</property> by
- selecting <emphasis>
- <property moreinfo="none">File > New >
Other...</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">Web > Dynamic Web
Project</property>. </emphasis></para>
- <figure float="0">
- <title>New Dynamic Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/webtools/webtools_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> and you will see Dynamic Web Project page like on the figure
below.</para>
-
- <para><diffmk:wrapper diffmk:change="changed"> The first page of
most WTP projects allows you to target a specific runtime,
- representing a server's library location. It will also provide you the ability to
add
- this project to an EAR project, and select a preselected default set of facets,
called
- a configuration, rather than manually select each facet you might
want.</diffmk:wrapper></para>
- <para> Selecting the runtime, again, allows the project to install the proper
classpaths to
- the project so it knows what code to compile against.</para>
-
- <figure float="0" id="dyn_web_project">
- <title>New Dynamic Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/webtools/webtools_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button next to <property
moreinfo="none">Configuration</property> section in order to open
- the wizard which allows you to modify a chosen configuration. The wizard looks as
- follows.</para>
-
- <figure float="0" id="project_facets">
- <title>Project Facets Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/webtools/webtools_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Here part of the listed facets are those which are provided by WTP. Some of
them are
- added by <property moreinfo="none">JBoss Tools</property>. They
are:</para>
- <itemizedlist>
- <listitem>
- <para>BIRT Charting Runtime Component</para>
- </listitem>
- <listitem>
- <para>BIRT Reporting Runtime Component</para>
- </listitem>
- <listitem>
- <para>JBoss ESB</para>
- </listitem>
- <listitem>
- <para>JBoss Portlets</para>
- </listitem>
- <listitem>
- <para>JBoss Web Services</para>
- </listitem>
- <listitem>
- <para>Seam</para>
- </listitem>
- </itemizedlist>
-
- <para>On this wizard page you can enable or disable any facet as well as change
it version.
- What you should note here is that some facets or facets versions may conflict with
each
- other. In case of incompatibility you'll be prompted about this in the combo
- box underneath.</para>
- <figure float="0">
- <title>Facet Constraints</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/webtools/webtools_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>When switching on the <emphasis>
- <property moreinfo="none">Runtimes</property>
- </emphasis> tab on the right you'll see the current server
Runtime.</para>
- <figure float="0">
- <title>Runtimes on the Project Facets Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/webtools/webtools_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On this tab you can also create a new Server Runtime and make it primary by
pressing <emphasis>
- <property moreinfo="none">Make Primary</property>
- </emphasis> button after enabling it.</para>
-
- <para>Clicking on <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> will save the chosen configuration of the facets and return you to
the <link linkend="dyn_web_project">Dynamic Web Project
wizard</link>. Further pages in the
- wizard are specific to either the project type or the facets selected.</para>
-
-
- <para>If you need to configure the facets for the existing project, you should
bring up the
- context menu for selected project and click <emphasis>
- <property moreinfo="none">Properties</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">Project Facets</property>.
</emphasis> This will bring up the familiar
- <link linkend="project_facets">Project Facets wizard</link>,
where you can create
- your own custom facets configuration.</para>
-
- <para></para>
-
- </section>
- <section id="rel_resources_links">
- <title>Relevant Resources Links</title>
-
- <para>More on the WTP facets you can read in the <ulink
url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.j...
help</ulink>.</para>
- </section>
-</chapter>
-
-
-<chapter id="modules"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/modules.xml">
- <title>Deploying Modules</title>
-
- <para>In this chapter it will be described how to deploy modules onto the
server.</para>
- <para> First of all it is necessary to say that deploying to a server is mostly
painless. There
- are several ways to do it provided by WTP, and some additional methods provided by
JBoss
- Tools. These methods are described further in this chapter.</para>
-
- <section>
- <title>Deploying on the Package Explorer</title>
-
- <para><diffmk:wrapper diffmk:change="changed">On the package
explorer it is possible to publish either a project to a server or just
- a single file. Let's look at how to do this.</diffmk:wrapper></para>
- <section id="run_on_server_wizard">
- <title>Deploying with Run On Server Wizard</title>
- <para> The first WTP method is to right-click on a project, such as a Dynamic
Web
- project, EJB project, or EAR project and then select <emphasis>
- <property moreinfo="none">Run As > Run on
Server</property>
- </emphasis>. The resulting dialog allows you to select which supporting server
the
- project can be published to.</para>
- <figure float="0">
- <title>Define a New Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> button to see add or remove projects page where you can choose
projects
- to configure them on server.</para>
- <figure float="0" id="add_rem_proj">
- <title>Add or Remove Projects</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This page of the wizard also allows to undeploy modules from the server.
For that
- choose proper module(s) from the right and click <emphasis>
- <property moreinfo="none"> < Remove</property>
- </emphasis>. The modules will be completely undeployed after restarting your
server
- or republishing.</para>
- <para>Generally, for the JBoss AS Server Adapters, publishing using this method
will
- force a default, best-guess, packaging configuration for your project. This
- best-guess does not publish incrementally, but instead repackages your entire
- project into a <emphasis>
- <property moreinfo="none">.war</property>
- </emphasis>, <emphasis>
- <property moreinfo="none">.jar</property>
- </emphasis>, or <emphasis>
- <property moreinfo="none">.ear</property>
- </emphasis> as appropriate, and then copies that file into the proper deploy
- directory. For quicker smarter deployment, you will need to create archives using
- the <link linkend="Project_archivesView">Project Archives
view</link> and customize
- packaging yourself.</para>
- </section>
-
- <section id="single_file_deployment">
- <?dbhtml filename="DeployToServer.html"?>
- <title>Deploying single files</title>
-
- <para>Sometimes it becomes necessary to deploy one or more files to a server.
For
- that in order not to do a full republish in the context menu of files a
<emphasis><property moreinfo="none">Deploy To
Server</property></emphasis>
- option is provided that allows a single file deployment. To deploy these non-WTP
files/projects
- right click on the file (<emphasis>
- <property moreinfo="none">-ds.xml</property></emphasis>,
<emphasis>
- <property moreinfo="none">.ear</property></emphasis>,
<emphasis>
- <property moreinfo="none">.jar</property></emphasis>
etc.) and select <emphasis>
- <property moreinfo="none">Deploy To Server</property>
- </emphasis> and it will be automatically deployed.</para>
- <figure float="0">
- <title>Deploy to Sever</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The deployed files are listed side-by-side with other modules that are
deployed to
- the server.</para>
-
- <figure float="0">
- <title>Deployed files on the Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- </section>
- <section>
- <title>Deploying with JBoss Server View</title>
- <para>As it has been already mentioned <property
moreinfo="none">JBoss Server View</property> contains two
- parts: the top part that displays all defined servers and the bottom part which
provides
- categories with additional information. Thus, in this section we suggest two more
ways
- to deploy resources onto the server.</para>
- <section>
- <title>Top part of JBoss Server View</title>
- <para>In the top part of the <property moreinfo="none">JBoss
Servers View</property> like in the Servers
- View you should right click on a server and select the <emphasis>
- <property moreinfo="none">Add and Remove Projects</property>
- </emphasis> menu item.</para>
- <figure float="0">
- <title>Add and Remove Projects</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>This will bring up a <link linkend="add_rem_proj">familiar
dialog</link> allowing
- you to either publish projects or modules to a server, or remove them from the
- server. If the selected module is a project like a Dynamic Web project, EJB project,
- or EAR project, it will be published as through <emphasis>
- <property moreinfo="none">Run on Server</property>
- </emphasis> wizard, with a best-guess full package. If, however, the selected
- element is an archive from the <link
linkend="Project_archivesView">Project Archives
- view</link>, it will be published according to the rules of that module
- type.</para>
- </section>
-
- <section>
- <title>Bottom part of JBoss Server View</title>
- <para>In the bottom part of <emphasis>
- <property moreinfo="none">JBoss Server View</property>
- </emphasis> there is a category called <emphasis>
- <property moreinfo="none">Modules</property>
- </emphasis> which should display all currently-published modules on the
server.
- Right-clicking on the desired module and selecting <emphasis>
- <property moreinfo="none">Full Publish</property>
- </emphasis> will force a full rebuild of the entire module.</para>
- <figure float="0">
- <title>Full Publish</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Here, <emphasis>
- <property moreinfo="none">Incremental Publish</property>
- </emphasis> is meant to enable publishing of only those parts where changes
have
- been made.</para>
- </section>
- </section>
- <section>
- <title>Deploying with Project Archives View</title>
- <para>In the <property moreinfo="none">Project Archives
View</property> you can right-click on any declared
- archive and select the <emphasis>
- <property moreinfo="none">Publish To Server</property>
- </emphasis> element. For more on this subject, see <link
linkend="PublishToServer">Publishing to Server</link> in the Project
Archives View section.</para>
- <figure float="0">
- <title>Publish to Server</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> The only way to ensure an <emphasis>
- <property moreinfo="none">Incremental Build</property>
- </emphasis>, such as changes to one <emphasis>
- <property moreinfo="none">.jsp</property>, </emphasis>
- <emphasis>
- <property moreinfo="none">.html</property>, </emphasis>
or <emphasis>
- <property moreinfo="none">.class</property>
- </emphasis> file, is to enable the builder for that project. This is done by
either
- changing the global preferences for the <property
moreinfo="none">Archives View</property>, or by
- enabling project-specific preferences and ensuring the builder is on.</para>
- <para>The last chapter covers a variety of methods on how you can deploy needed
modules onto a
- server.</para>
- </section>
-</chapter>
-
-
-<chapter id="tptp_support"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/tptp_support.xml">
- <title>TPTP Support</title>
- <para>This chapter provides an overview on how to enable TPTP Profiling for
<property moreinfo="none">JBoss
- AS</property> adapters in <property moreinfo="none">JBoss
Tools</property>.</para>
-
- <section>
- <title>TPTP Profiling</title>
-
- <para>To get TPTP profiling work on <property
moreinfo="none">JBoss Application Server</property> you should
- first download <ulink
url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/...
4.5.0 Runtime</ulink> and install it, i. e. just add the content of
<emphasis>
- <property
moreinfo="none">plugins/features</property>
- </emphasis> folders from downloaded directory to the same folders in
your eclipse
- installation directory.</para>
-
- <para>And now all profile actions should work for you. To start
<property moreinfo="none">JBoss
- AS</property> in profiling mode use <emphasis>
- <property moreinfo="none">Start the server in profiling
mode</property>
- </emphasis> button or <emphasis>
- <property moreinfo="none">Profile As > Profile on
Server</property>
- </emphasis> option in the context menu of the project.</para>
-
- <figure float="0">
- <title>Start the Server in Profiling mode</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/tptp_support/tptp_support_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To enable TPTP features in your workbench use <property
moreinfo="none">Profiling and Logging
- Perspective</property> that you can find in the list of proposed
perspectives: <emphasis>
- <property moreinfo="none">Window > Open
Perspective > Other…</property>
- </emphasis>
- </para>
-
- <figure float="0">
- <title>Profiling and Logging Perspective</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/tptp_support/tptp_support_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section>
- <title>Relevant Resources Links</title>
- <para>All additional information on TPTP(Test and Performance Tools
Platform) you can find
- in <ulink
url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quic...
documentation</ulink>.</para>
- <para>In summary, this reference should help you to start with <ulink
url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know
with functionality
- for work with it.</para>
- </section>
-</chapter>
-
-
-</book>
+]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JBoss Server Manager Reference Guide</title>
+
+
<author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+
<author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+
<author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author>
+
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo>
+ Version: 2.0.0.GA
+ </releaseinfo>
+<abstract>
+ <title></title>
+ <para>
+ <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_...
version</ulink>
+ </para>
+</abstract>
+
+ </bookinfo>
+
+
+ <toc></toc>
+
+<chapter id="quick_start" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/quick_start.xml">
+ <title>Quick Start with JBoss Server</title>
+
+ <para>This chapter covers the basics of working with the <property
moreinfo="none">JBoss Server</property>. If you
+ already have installed JBoss server and runtime you can quickly learn how to
configure, start,
+ stop the server, to know deployment and archiving processes. How to install runtimes
and servers
+ read in the <link linkend="runtimes_servers">Runtimes and Servers in
the JBoss AS plugin</link>
+ chapter.</para>
+
+ <para>To start working with JBoss AS, select a <property
moreinfo="none">JBoss AS Perspective</property> via
+ <emphasis><property moreinfo="none">Window > Open
Perspective > Other > JBoss
+ AS</property>.</emphasis></para>
+
+ <section id="starting">
+ <title>Starting JBoss Server</title>
+
+ <para>Starting <property moreinfo="none">JBoss
Server</property> is quite simple. You can control the server
+ behaviour with the help of a special toolbar in the <property
moreinfo="none">JBoss Server View</property>
+ where you could <emphasis>
+ <property moreinfo="none">start</property>
+ </emphasis> it in a regular or debug mode, <emphasis>
+ <property moreinfo="none">stop</property>
+ </emphasis> it or <emphasis>
+ <property moreinfo="none">restart</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> it and
</diffmk:wrapper><emphasis>
+ <property moreinfo="none">publish</property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> to the
server.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>JBoss Server Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To launch the server click the green-with-white-arrow icon on the
<property moreinfo="none">JBoss Server
+ View </property>or right click server name in this view and select
<emphasis>
+ <property moreinfo="none">Start</property>.
</emphasis> If this view is not open, select
+ <emphasis><property moreinfo="none">Window > Show
View > Other > Server >
+ JBoss Server View</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Start JBoss Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="stopping">
+ <title>Stopping JBoss Server</title>
+
+ <para>To stop the server, click the <emphasis>
+ <property moreinfo="none">Stop</property>
+ </emphasis> icon in the <property moreinfo="none">JBoss
Server View</property> or right click the server name
+ and press <emphasis><property
moreinfo="none">Stop</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Stop JBoss Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When the server is stopped you will see <emphasis>
+ <property moreinfo="none">Stopped</property>
+ </emphasis> state next to its name in the square brackets.</para>
+ <para>Learn more about the <property moreinfo="none">JBoss
Server View</property>
+ <link linkend="JBossServerView">here</link>.</para>
+ </section>
+
+ <section id="archiving">
+
+ <title>Project Archiving</title>
+
+ <para><property moreinfo="none">JBoss Tools</property>
comes with our own archives tool. The Project Archives
+ plugin consists primarily of a view to set up each packaging configuration
<emphasis>(
+ <property moreinfo="none">Window > Show View >
Other > JBoss Tools > Project archives</property>).
+ </emphasis></para>
+ <para>Right clicking in the <property moreinfo="none">Project
archives view</property> you can create War,
+ EJB War, EAR or JAR archive.</para>
+
+ <figure float="0">
+ <title>Archive Creating</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Using the context menu on the item you can initiate a
<emphasis><property moreinfo="none">full
build</property></emphasis> on
+ archive, <emphasis><property
moreinfo="none">edit</property>,</emphasis>
<emphasis><property
moreinfo="none">delete</property></emphasis> or
+ <emphasis><property
moreinfo="none">publish</property></emphasis> it.</para>
+
+ <figure float="0">
+ <title>Context Menu on the Item</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Learn more about the <property moreinfo="none">Project
Archives View</property>
+ <link
linkend="Project_archivesView">here</link>.</para>
+
+ </section>
+ <section id="deployment">
+ <title>Deploying an Application to a Server</title>
+
+ <para>There are two times to deploy your application:</para>
+ <itemizedlist>
+ <listitem>
+ <para>While creating it</para>
+ </listitem>
+ <listitem>
+ <para>After it already exists</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>When you create a new project (Seam, JSF or Struts) with the New Project
or Import Project
+ wizards, the one of wizards steps has a <emphasis>
+ <property moreinfo="none">Target Runtime</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">Target Server</property>
+ </emphasis> sections. You can deploy the application through the appropriate
selection in
+ these sections.</para>
+
+ <figure float="0">
+ <title>Runtime and Server Sections in the New Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_4a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Runtime and Server Sections in the Import Project
Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_4b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can deploy an existing application to a server by right-clicking the
target defined
+ server in the <property moreinfo="none">JBoss Servers
View</property> and then selecting <emphasis><property
moreinfo="none">Add and
+ Remove Projects</property></emphasis> from the context
menu.</para>
+
+ <figure float="0">
+ <title>Add and Remove Projects From the Context Menu.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>If this application is not assigned to a server, it will be in the
left-hand available
+ projects list. Clicking on the <property moreinfo="none">Add
></property> button will add it to the right-hand
+ configured projects list and deploy the application to this server.</para>
+
+ <figure float="0">
+ <title>Modifying The Projects that are Configured on the
Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/quick_start_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here, we have just performed the basic steps you should know to quick
start with JBoss
+ server. In fact, there are more functionalities which you can make use of. Further
we will
+ talk about them in detail.</para>
+ </section>
+
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <para>All JBoss Developer Studio/JBoss Tools documentation you can find
<ulink
url="http://docs.jboss.org/tools/2.1.0.GA">here</ulink>...
+ <para>The latest documentation builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">her...
+
+ </section>
+
+</chapter>
+
+
+<chapter id="runtimes_servers"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/runtimes_servers.xml"
xreflabel="runtimes_servers">
+ <?dbhtml filename="runtimes_servers.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Deploy</keyword>
+ <keyword>Deployment</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Runtimes and Servers in the JBoss AS plugin</title>
+
+ <para>In this chapter we will discuss how to install runtimes and
servers.</para>
+
+ <para>First of all it's necessary to mention that the JBoss AS plugin makes
use of WTP.
+ This includes starting and stopping servers in run or debug mode. It also includes
targeting WTP
+ projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure
that the
+ proper jars from a specific server are added to the project's classpath
+ properly.</para>
+ <para>In order to get started creating, running, and debugging J2EE applications,
we should create
+ our <property moreinfo="none">runtime</property> and
<property moreinfo="none">server</property> instances.</para>
+
+ <section>
+ <title>Runtimes</title>
+ <para>In <property moreinfo="none">JBoss
Tools</property>, the main purpose of Server Runtimes is to point to a
+ server installation somewhere on disk. In our case, this will be a JBoss
installation, and it
+ can then be used for two primary purposes:</para>
+ <itemizedlist>
+ <listitem>
+ <para>it provides classpath additions to WTP projects that require
them.</para>
+ </listitem>
+ <listitem>
+ <para>for <property moreinfo="none">JBoss
server</property> at least, it provides information necessary for
+ the starting and stopping of the server, it tells which jars to run and which
+ configuration to use.</para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="InstNewRuntime">
+ <title>Installing a New Runtime</title>
+ <para>You can install runtimes into eclipse from the <emphasis>
+ <property moreinfo="none">Window > Preferences
</property>
+ </emphasis> menu, and then select <emphasis>
+ <property moreinfo="none">Server > Runtime
Environments</property>
+ </emphasis> from the categories available on the left.</para>
+ <figure float="0">
+ <title>Installed Runtimes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>From this preference page you can see all declared runtimes and their
types as well.
+ Here, it's possible to edit or remove existing runtimes as well as add a new
+ one.</para>
+
+ <para>To create a JBoss runtime click <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button and choose a necessary type of runtime from the
<emphasis>
+ <property moreinfo="none">JBoss Community</property>
+ </emphasis> category.</para>
+
+ <figure float="0">
+ <title>Adding a Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>Now there is a separation between .org servers (the <emphasis>
+ <property moreinfo="none">JBoss Community</property>
+ </emphasis> category) and product server that comes with JBoss EAP in
JBDS ( the <emphasis>
+ <property moreinfo="none">JBoss Enterprise
Middleware</property>
+ </emphasis> category).</para>
+ </note>
+
+ <para>As you can see, <property moreinfo="none">JBoss
Tools</property> provide its own adapters such as JBoss
+ 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that
is a safer
+ incremental deployment, which prevents partial deployments to be picked up by the
server. It
+ means that scanning for auto-deployment is suspended while files are being copied
to the
+ deployment location and resumed when the copy is completed.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>Currently we recommend you to use a fully supported JBoss 4.2 server
adapter.</para>
+ </note>
+
+ <para>You'll also note a Deploy-Only Runtime type. This type provides no
classpath
+ for WTP projects. It is used solely by its server type for the purpose of setting
up a
+ deploy directory for users who don't wish to make use of starting, stopping,
or
+ debugging their projects inside eclipse.</para>
+
+ <figure float="0" id="add_runtime_figure">
+ <title>Adding a JBoss 4.2 Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The following table describes all the available options of the currant
wizard
+ page.</para>
+ <table>
+ <title>Server Runtime Wizard Parameters</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Name</para>
+ </entry>
+
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>Name</para>
+ </entry>
+ <entry>
+ <para>The name of a new Runtime for a chosen server. We suggest
that you
+ don't leave a default value. It's better to give descriptive
+ names that will help to distinguish one runtime from
another.</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Home directory</para>
+ </entry>
+ <entry>
+ <para>The path to a directory where the runtime is
installed.</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">JRE</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para>The proper Java Runtime Environment. Because of the
open-source nature of
+ JBoss, a user is likely to want to modify and repackage some of the
+ configuration-specific jboss jars and create their own configuration.
Thus, rather
+ than forcing you to copy his entire JBoss installation, the structure
of the
+ wizard allows to create only a new configuration instead.</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Configuration</para>
+ </entry>
+ <entry>
+ <para>The list of configurations (all, default, minimal) that is
updated as soon as
+ you browse to a valid runtime installation folder. After the runtime is
created
+ the configuration becomes an unchanging property of that runtime. To
compile
+ against a different configuration's jars, you will need to create a
new runtime
+ from that configuration.</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>As a result of having each runtime represent a specific configuration
rather than the
+ server installation as a whole, it is very likely you'll create several
different
+ runtimes to test each of your configurations. It becomes important to ensure your
runtimes,
+ and later your servers, are given descriptive names that help you remember which
is
+ which.</para>
+
+ <para>Press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to see your new runtime in the list.</para>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Servers</title>
+ <para>WTP servers are eclipse-representations of a backing server installation.
They are used to
+ start or stop servers, deploy to servers, or debug code that will run on the
server. They keep
+ track of the modules (jars, wars, etc) you deploy to the server and also allow you
to undeploy
+ those modules (see <link linkend="run_on_server_wizard">Deploying
with Run On Server
+ Wizard</link> section). </para>
+ <para>Servers can be started or stopped with different <link
linkend="com_line_arg">command-line
+ arguments</link>. They are often backed by a runtime object representing
that server's
+ location.</para>
+
+ <section>
+ <title>Creating a New Server</title>
+
+ <para>There are many ways to get to the new server wizard. One way is to use
the old standard <emphasis>
+ <property moreinfo="none">File > New > Other...
</property>
+ </emphasis> and then <emphasis>
+ <property moreinfo="none">Server</property>
+ </emphasis>. This should show the wizard like below.</para>
+ <figure float="0">
+ <title>Adding a JBoss Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>A server object is that keeps track of things like command line
arguments when starting
+ or stopping, and runtimes keep track of the location of the installation. Thus,
each server
+ instance must be backed by an appropriate runtime. </para>
+
+ <para>From the list of already declared runtimes in the combo box below the
view it's
+ possible to select which runtime you want your server to be backed by. If there
is no
+ runtime that matches your needs just press the <emphasis>
+ <property moreinfo="none">Add...</property>
+ </emphasis> link nearby to bring up the wizard for creating a new runtime
(see the <link linkend="add_runtime_figure">previous
section</link>). To configure the already installed
+ runtimes you should go to server preferences that you can easily do by pressing
the <emphasis>
+ <property moreinfo="none">Configure runtime
environments...</property></emphasis> link.</para>
+
+ <para>If the server you want to create doesn't have any installed runtime
yet, the combo box
+ and the links are absent.</para>
+
+ <figure float="0">
+ <title>Installed Server Runtime Environments</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In this case the next page in the wizard which has the same form as in
<link linkend="add_runtime_figure">the previous section</link> will
ask you to create the
+ associated runtime.</para>
+ <para>Either way, after targeting your server to a runtime, the final screen
in this wizard is
+ largely confirmational, giving you a chance to verify that you've selected
the
+ appropriate runtime. It also allows to name the server appropriately.
</para>
+
+ <figure float="0">
+ <title>Installed Server Runtime Environments</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to complete the process of the server creation.</para>
+ <para><diffmk:wrapper diffmk:change="added">Now that
we've created our runtimes and servers, we can dwell on all services
+ and tools that JBoss Server Manager provides.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss Tools server manager. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="perspective" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/perspective.xml"
xreflabel="perspective">
+ <?dbhtml filename="perspective.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Deploy</keyword>
+ <keyword>Deployment</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>JBoss AS Perspective</title>
+
+ <para>This chapter tells how to manage installed <property
moreinfo="none">JBoss Server</property> via
+ <property moreinfo="none">JBoss AS
perspective</property>.</para>
+
+ <para>The <property moreinfo="none">JBoss AS
perspective</property> is similar to the <property
moreinfo="none">Java
+ perspective</property>, but it contains a few additional views. Two of
the additional
+ views are standard views, specifically the <property
moreinfo="none">Console view</property> and the
+ <property moreinfo="none">Properties view</property>.
The other two views that are added are the
+ <property moreinfo="none">Project archives
view</property> and the <property moreinfo="none">JBoss Server
+ View</property>.</para>
+
+ <section id="JBossServerView" role="updated">
+ <?dbhtml filename="JBossServerView.html"?>
+ <title>The JBoss Server View</title>
+
+ <para>The <property moreinfo="none">JBoss Server
View</property> is built on Common Navigator Framework
+ allowing extensions and is using label decorators what makes the UI enough
compact
+ without loosing the vital information.</para>
+
+ <para>Let's have a look at the <property
moreinfo="none">JBoss Server View</property> and inspect
+ in detail all parts it consists of. </para>
+ <figure float="0">
+ <title>The JBoss Server View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="jbossserver_view_toolbar">
+ <title>JBoss Server View Toolbar</title>
+ <para>In the right top corner of the <property
moreinfo="none">JBoss Server View</property><diffmk:wrapper
diffmk:change="changed"> there is a
+ special toolbar which provides a quick access to starting a server (in
the debug mode,
+ run mode, or profile mode), restarting a server, stopping a server and a
possibility to publish to a
+ server.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>The JBoss Server View Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In order to debug your applications or EJB's that are
deployed to the server, you
+ must start the server in debug mode. By starting the server in debug
mode, eclipse
+ will allow you to set breakpoints on code in your workspace and step
through the
+ code.</para>
+
+ <para><emphasis>
+ <property moreinfo="none">Start the server in
profiling mode</property>
+ </emphasis> button allows to enable profiling actions for your
application. For more
+ details on how to start using TPTP profiling with <property
moreinfo="none">JBoss Tools</property>
+ refer to <link linkend="tptp_support">TPTP
Support</link> chapter.</para>
+
+ <para><emphasis>
+ <property moreinfo="none">Publish to the
server</property>
+ </emphasis> button will republish any modules where it has
determined the workspace
+ is out of sync with the server. It will attempt to do an incremental
publish if it
+ turns out that the module in question is capable of doing
one.</para>
+
+ </section>
+
+ <section id="jbossserver_view_structure">
+ <title>JBoss Server View Structure</title>
+ <para>The <property moreinfo="none">JBoss Server
View</property> displays all declared servers as well
+ as their current states (that is whether they are started or stopped) and
statuses
+ in the square brackets next to a server name.</para>
+
+ <figure float="0">
+ <title>The JBoss Server View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The following table lists possible server statuses.</para>
+
+ <table>
+ <title>Server Publish Status</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2"
colwidth="3*"></colspec>
+
+
+ <thead>
+ <row>
+ <entry align="center">Status</entry>
+
+ <entry
align="center">Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry align="center">
+ <para>Republish</para>
+ </entry>
+
+ <entry align="center">
+ <para>The status which allows you to see if changes
are
+ awaiting</para>
+ </entry>
+ </row>
+ <row>
+ <entry align="center">
+ <para>Publishing...</para>
+ </entry>
+
+ <entry align="center">
+ <para>The status which shows if changes are being
updated</para>
+ </entry>
+ </row>
+ <row>
+ <entry align="center">
+ <para>Synchronized</para>
+ </entry>
+
+ <entry align="center">
+ <para>The status which allows you to see if changes
are
+ in-sync</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>You can control a server behavior as well as adjust some server
preferences with
+ the help of the context menu commands.</para>
+
+ <figure float="0">
+ <title>Context Menu Commands</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>All available context menu commands are described in the
following table.</para>
+ <table>
+ <title>Server Properties through the Context Menu</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2"
colwidth="3*"></colspec>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Name</para>
+ </entry>
+
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>New Server</para>
+ </entry>
+ <entry>
+ <para>The option allows to define a new
server</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Open</para>
+ </entry>
+ <entry>
+ <para>The option opens the Server
editor</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Show in</para>
+ </entry>
+ <entry>
+ <para>This option gives an easy access to the next
views: Console,
+ Debug view, Server Log or MBean
Explorer</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Delete</para>
+ </entry>
+ <entry>
+ <para>Standard option that allows to delete the
chosen server</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Start</para>
+ </entry>
+ <entry>
+ <para>The action for stating a server in a run
mode</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Debug</para>
+ </entry>
+ <entry>
+ <para>The action for stating a server in a debug
mode</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Stop</para>
+ </entry>
+ <entry>
+ <para>The action for stopping a declared
server</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Publish</para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="added">The action for synchronizing the publish information
between
+ the server and
workspace</diffmk:wrapper></para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Explore</para>
+ </entry>
+ <entry>
+ <para>This action uses the native OS file explorer
to browse the
+ deploy destination. Note: The option is also
available for
+ deployed resources/projects (see the figure
below).</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Add and Remove Projects</para>
+ </entry>
+ <entry>
+ <para>The option allows to publish a new project to
the server (if
+ its type is supported)</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Monitoring</para>
+ </entry>
+ <entry>
+ <para>Possibility to add ports to be monitored on
the current
+ server</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Properties</para>
+ </entry>
+ <entry>
+ <para>Opens the window to adjust the current
server
+ preferences</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>Under the server element in the <property
moreinfo="none">JBoss Server View</property>, you can
+ see currently deployed to the server modules and some server extensions
which
+ provide the additional information on the server.</para>
+
+ <para>The context menu for any module allows you to remove it from the
server, force a
+ full or incremental republish upon it.</para>
+
+ <figure float="0">
+ <title>Modules Action</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="filesets">
+ <title>Filesets</title>
+
+ <para>The <emphasis>
+ <property
moreinfo="none">Filesets</property>
+ </emphasis> category in the <property
moreinfo="none">JBoss Server View</property> is intended
+ for files filtering.</para>
+
+ <para>To add a new file filter, right-click the <emphasis>
+ <property
moreinfo="none">Filesets</property>
+ </emphasis> category and select <emphasis>
+ <property moreinfo="none">Create File
Filter</property>.</emphasis>The <property moreinfo="none">New
File
+ Filter wizard</property> should appear.</para>
+
+ <figure float="0">
+ <title>Creating a New File Filter</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/filesets1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The wizard asks you to enter the filter name and add includes
and excludes
+ patterns. The preview box underneath gives a list of files matched to
the
+ defined patterns.</para>
+
+ <figure float="0">
+ <title>New File Filter Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/filesets2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After the filter is created, you can observe it by expanding
the <emphasis>
+ <property
moreinfo="none">Filesets</property>
+ </emphasis> category in the <property
moreinfo="none">JBoss Server View</property>.</para>
+
+ <para>It's possible now to edit files directly from the
<emphasis>
+ <property
moreinfo="none">Filesets</property>
+ </emphasis> category. Double clicking on a file from
<emphasis>
+ <property
moreinfo="none">Filesets</property>
+ </emphasis> opens up the editor automatically or you can use
the <emphasis>
+ <property moreinfo="none">Edit
File</property>
+ </emphasis> context menu command.</para>
+
+ <figure float="0">
+ <title>Direct Editing from the Filesets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/filesets3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To delete a file filter (or just a file) from the
<emphasis>
+ <property
moreinfo="none">Filesets</property>,</emphasis> right-click a
file filter (or the
+ unnecessary file) and select the <emphasis>
+ <property moreinfo="none">Delete File
Filter</property>
+ </emphasis>
+ <emphasis>(<property moreinfo="none">Delete
File</property>)</emphasis> command.</para>
+
+ <figure float="0">
+ <title>Deleting the File from the Filesets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/filesets4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="xml_configuration">
+ <title>XML Configuration</title>
+ <para>The <emphasis>
+ <property moreinfo="none">XML
Configuration</property>
+ </emphasis> category allows you to quickly browse to descriptor
files in your
+ server's deploy directory and check or change the values.
Basically, <emphasis>
+ <property moreinfo="none">XML
Configuration</property>
+ </emphasis><diffmk:wrapper
diffmk:change="changed"> includes XML XPaths where an xpath is a path used to
access some
+ specific part of an xml document.
</diffmk:wrapper></para>
+
+ <note>
+ <title>Note:</title>
+ <para>You are assumed to be familiar with XPath. If not, we
highly suggested
+ that you look through an appropriate manual or tutorial on the
topic.</para>
+ </note>
+
+ <para>The <emphasis>
+ <property moreinfo="none">XML
Configuration</property>
+ </emphasis> category itself contains only a list of categories.
<emphasis>
+ <property moreinfo="none">Ports</property>
+ </emphasis> are provided by default and is filled with many of
the most commonly
+ used ports in the <property moreinfo="none">JBoss
Server</property>.</para>
+
+ <figure float="0">
+ <title>XML Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <!--para>In the <property>Properties
+ view</property> you can see an identifier and nested files
underneath in which
+ that xpath can be found as well as its current value. The details of the
xpath are
+ hidden as all you need to see is only which file you're
referring to and
+ what its current value is.</para-->
+
+ <para>By right-clicking on <emphasis>
+ <property moreinfo="none">XML
Configuration</property>, </emphasis> you can create a new
+ category. Besides, context menu for <emphasis>
+ <property moreinfo="none">XML
Configuration</property>
+ </emphasis> category makes possible to disable it. You can
disable any category
+ in the bottom part of the <emphasis>
+ <property moreinfo="none">JBoss Server
View</property>.</emphasis> Look for them in the <emphasis>
+ <property moreinfo="none">Inactive
Categories</property>
+ </emphasis> afterwards to re-enable.</para>
+
+ <figure float="0">
+ <title>Adding New Category</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_15.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>By right-clicking on <emphasis>
+ <property moreinfo="none">Ports</property>
+ </emphasis> or any other category in <emphasis>
+ <property moreinfo="none">XML
Configuration</property>
+ </emphasis>, you can create a new xpath.</para>
+
+ <figure float="0">
+ <title>Adding New XPath</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_16.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After that, the dialog shown below will appear.</para>
+
+ <figure float="0">
+ <title>Adding New XPath</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_17.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The goal here is to get an end result where the XPath matches
up with a
+ necessary property. With that in mind, let's look how it works.
If the
+ property you want to reach is the value of the
<emphasis>name</emphasis>
+ attribute in the element <code
diffmk:change="added"><mbean></code>, then your
<emphasis>
+ <property moreinfo="none">XPath
Patten</property>
+ </emphasis>should end with
<emphasis>mbean</emphasis> and your <emphasis>
+ <property moreinfo="none">Attribute
Name</property>
+ </emphasis> should be <emphasis>name</emphasis>
like on the next figure.</para>
+
+ <programlisting format="linespecific"
role="XML"><![CDATA[...
+<server>
+...
+ <mbean code="org.jboss.ejb.EJBDeployer"
+ name="jboss.ejb:service=EJBDeployer"
xmbean-dd="">
+
+ <!-- Inline XMBean Descriptor BEGIN -->
+ <xmbean>
+ <description>
+ The EJBDeployer responsible for ejb jar
deployment</description>
+ ...
+ </xmbean>
+ </mbean>
+</server>
+]]></programlisting>
+
+ <figure float="0">
+ <title>XPath Preview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_18.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Notice, when you type the fields autocomplete to help you
locate exactly
+ what xpath you're looking for.</para>
+ </tip>
+
+ <para>Then, on the other hand, if your desired field is the text of
an element
+ <code
diffmk:change="added"><description></code>, your
<emphasis>
+ <property moreinfo="none">XPath
Patten</property>
+ </emphasis> should end with
<emphasis>description</emphasis> and <emphasis>
+ <property moreinfo="none">Attribute
Name</property>
+ </emphasis> field should be left blank. When finished, click
<emphasis>
+ <property
moreinfo="none">Preview</property>
+ </emphasis> to see how many matches you have for that
particular XPath.</para>
+
+ <figure float="0">
+ <title>XPath Preview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_19.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+ </section>
+
+ <section id="dragndrop_to_jboss_server_view">
+ <title>Drag-n-Drop to JBoss Server View</title>
+
+ <para>Starting from 2.0.0.CR2 version of <property
moreinfo="none">JBoss AS Tools</property> the
+ <property moreinfo="none">JBoss Server
View</property><diffmk:wrapper diffmk:change="changed"> supports
drag-n-drop of deployable and
+ runnable projects/resources.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Dragging to the JBoss Server View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/dnd_toJBossServerView.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>With drag-n-drop the following actions can be
performed:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>dragging a project to a server will deploy it to the
server and run it by
+ showing the main page in a browser</para>
+ </listitem>
+
+ <listitem>
+ <para>dragging an <emphasis>
+ <property
moreinfo="none">.xhtml</property>
+ </emphasis> file from <emphasis>
+ <property
moreinfo="none">WebContent</property>
+ </emphasis> will do the same and show the corresponding
page in a
+ browser</para>
+ </listitem>
+
+ <listitem>
+ <para>dragging a deployable resource (i.e. a datasource
(<emphasis>
+ <property
moreinfo="none">-ds.xml</property>
+ </emphasis><diffmk:wrapper
diffmk:change="changed">) file that has been made deployable) will simply
deploy that
+ resource directly to the
server</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <para>In short, the feature does the same thing as if you used the
<emphasis>
+ <property moreinfo="none">Run On
Server</property>
+ </emphasis> option or <emphasis>
+ <property moreinfo="none">Add and Remove
Projects</property>
+ </emphasis> option in the context menu of the server.</para>
+ </section>
+
+ <section id="server_log">
+ <title>Server Log View</title>
+
+ <para>You can monitor the current server behavior with the help of the
<property moreinfo="none">Server
+ Log</property>. To open a server in the <property
moreinfo="none">Server Log view</property> you
+ should right-click on the server and follow to <emphasis>
+ <property moreinfo="none">Open in > Server
Log</property>.</emphasis></para>
+
+ <para>The <emphasis>
+ <property moreinfo="none">Server
Log</property>
+ </emphasis> shows relevant information to your server's
startup, shutdown,
+ and publish processes. This allows you to keep an eye on what's going
on
+ (such as automatic incremental deployment if you have it
enabled).</para>
+
+ <figure float="0">
+ <title>Event Log Actions</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The <property moreinfo="none">Server
Log</property> toolbar contains several icons that perform
+ the following actions:</para>
+
+ <table>
+ <title>Server Log Toolbar Icons</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2"
colwidth="3*"></colspec>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Name</para>
+ </entry>
+
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>
+ <para>Export Log</para>
+ </entry>
+ <entry>
+ <para>Possibility to export the log into a text
file</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Clear Log Viewer</para>
+ </entry>
+ <entry>
+ <para>The option clears the current server
log</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Delete Log</para>
+ </entry>
+ <entry>
+ <para>Click to delete the server log</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Open Log</para>
+ </entry>
+ <entry>
+ <para>Click to open the server log text
file</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Restore Log</para>
+ </entry>
+ <entry>
+ <para>Click to restore the server log</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section id="server_editor">
+ <title>Server Editor</title>
+ <para>By double-clicking on any server, an editor window will appear
allowing you to
+ edit parts of that server.</para>
+
+ <figure float="0">
+ <title>Preferences Page for the Chosen Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para><diffmk:wrapper diffmk:change="changed">On
the figure you can see that a username/password is available in the UI when
+ configuring the server. If you get a SecurityException when trying to
launch the
+ server, it is most likely because your server is protected and hence
you need to
+ fill the username/password fields with appropriate
values.</diffmk:wrapper></para>
+ </tip>
+
+ <para>It should be pointed out that our server adapter by default tries
to automatically
+ detect the ports it needs for integrating with a <property
moreinfo="none">JBoss Server</property>.
+ Sometimes it can though be relevant to override this automatic detection
if you are
+ using some custom configuration. For this purposes the <emphasis>
+ <property moreinfo="none">Server
Ports</property>
+ </emphasis> section in the <property
moreinfo="none">Server editor</property> is provided where the
+ port settings are configurable. Click the <emphasis>
+ <property
moreinfo="none">Configure...</property>
+ </emphasis> link to bring up the wizard for adjusting the settings
for the
+ ports.</para>
+
+ <figure float="0">
+ <title>Server Ports Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Press <emphasis>
+ <property moreinfo="none">Edit
XPath</property>
+ </emphasis> button for the chosen port to configure its XPath's
values.</para>
+
+ <figure float="0">
+ <title>XPath Pattern for a Server Port</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The settings related to <emphasis>
+ <property
moreinfo="none">Publishing</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">Timeouts</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">Server
Polling</property>
+ </emphasis> can be also adjusted in the <property
moreinfo="none">Server editor</property>.</para>
+
+ <para id="com_line_arg"><property
moreinfo="none">Server editor</property> makes it also possible to
+ modify the server's launch configuration. It's just after
clicking <emphasis>
+ <property moreinfo="none">Open launch
configuration</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">
link. In the open window there are the tabs for setting command line
+ arguments, classpaths and other things that are relevant to launching
the
+ server.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Launch Configuration Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Look up <ulink
url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/st...
to find parameters which can be specified for <property
moreinfo="none">JBoss
+ Server</property>.</para>
+
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Note:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Please note, that the Launch Configurations for JBoss
Servers are enough
+ strict in enforcing the configured values in the server in order to
avoid
+ inconsistencies between server's and their configured
runtime.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">For example, if you change the launch configuration
program arguments to
+ </diffmk:wrapper><emphasis
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">"-c
myConfig"</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> but do not change the
+ targeted runtime configuration, then your program arguments will be
ignored. The
+ server runtime "wins" so to speak. This ensures
consistency
+ and if you change the location of the runtime, your launch
configurations will
+ automatically pick that up.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Values are not controlled by the server and its runtime
setup will be passed
+ on unaltered.</diffmk:wrapper></para>
+ </note>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Until 3.0.0.GA release of
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss
Tools</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, the servers classpath was readonly, but that caused
+ problems for users wanting to add their own jars in the startup
classpath. That is
+ relevant if you need to patch the server, add a custom charset or other
tweaks that
+ require early access to the
classpath.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Now all servers have a custom 'server runtime
classpath
+ container', which is there by default and point to the default jars
in
+ JBoss. You can now adjust the classpath. Then just make sure this
container is there
+ if you want the classpath to be picked
up.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Server Classpaths</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/perspective/server_classpaths.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">If for some reason you have a launch configuration
without this container, </diffmk:wrapper><emphasis
diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Restore
+ Default
Entries</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> should add it properly. Also,
</diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Restore
+ Default
Entries</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> will also remove any
+ extra entries you added yourself.</diffmk:wrapper></para>
+ </section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para>Find more about XPath in the <ulink
url="http://www.w3.org/TR/xpath20/">XPath
+ Documentation</ulink>.</para>
+ </section>
+ </section>
+
+ <section id="Project_archivesView" role="updated">
+ <title>Project Archives View</title>
+ <para>Every application, whether Plain Old Java, J2EE, or some other
language altogether,
+ needs to be packaged in some way. In Java-related projects, many people use
ANT. </para>
+ <note>
+ <title>Note:</title>
+ <para>Those who use ANT will appreciate how the Project Archives Ant
task is now
+ improved: it supports variables and gives more informative error/logging
messages
+ when something goes wrong.</para>
+ </note>
+
+ <para>But <property moreinfo="none">JBoss
Tools</property> come with our own Archives tool with a bit easier
+ and less-verbose XML and a handy user interface. The Project Archives plugin
consists
+ primarily of a view, that is <property
moreinfo="none">Project Archives view</property>, to set up each
+ packaging configuration.</para>
+ <para>So far, let's look through all functionality that the
<property moreinfo="none">Project
+ Archives view</property> provides.</para>
+
+ <section id="archives_overview">
+ <title>Overview</title>
+
+ <para>The packaging configuration for each project is stored in the
project's root
+ folder, and is in a file named <emphasis>
+ <property moreinfo="none">.packages</property>
+ </emphasis>, which has a fairly simple XML structure. Modifying the
file by hand is
+ neither required nor recommended, and using the UI is the official way of
modifying
+ your packaging structure.</para>
+
+ <figure float="0">
+ <title>Archives View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_21.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>A project's configuration contains archives. As you can see
on the image
+ above a project can contain more than one archive. Internal archives and
filesets
+ can be directly inside of an archive, or in some sub-folder of that
archive.</para>
+
+ <para>In the upper right corner of the view you can see an icon which,
when clicked,
+ will build the selected top-level archive. Additionally, you can select
<emphasis>
+ <property moreinfo="none">Project > Build
Packages</property>
+ </emphasis> when a project is selected in the <property
moreinfo="none">Packages View</property> to
+ build all declared packages in that project's <emphasis>
+ <property moreinfo="none">.packages</property>
+ </emphasis> file. This will execute a full build on all declared
archives.</para>
+ </section>
+
+ <section id="Creating_Archive">
+ <title>Creating an Archive</title>
+
+ <para>When you open the <property
moreinfo="none">Project archives view</property> for the first time,
+ it asks you to select the project for what you want to create an
archive.</para>
+
+ <figure float="0">
+ <title>Archives View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_21a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When creating a new archive for selected project, you have some
different options
+ at your disposal. You need right-click inside the view and select
<emphasis>
+ <property moreinfo="none">New
Archive</property>
+ </emphasis> to see your archive type options.</para>
+
+ <figure float="0">
+ <title>Create an Archive</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_22.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>If you see only JAR from the list of available archive types,
you should
+ verify whether AS Tools plugins/features are in place. EAR, EJB JAR
and WAR
+ options are contributed by the AS Tools independently from webtools
and the
+ virtual project model. Thus, without them only JAR will show
up.</para>
+ </note>
+
+ <para><property moreinfo="none">JAR</property> is
the standard archive type, and does very little
+ configuration, leaving most of the work up to you. You can customize the
name, add
+ folders, filesets, and inner jars to it.</para>
+
+ <para>The other types, for the most part, simply start off with a
default setting,
+ usually the jar with some specific children based on an expected
structure of the
+ project. For example, if the project is a Dynamic Web Project, and you
create a
+ <property moreinfo="none">WAR</property>
archive, the archive will be created with a few
+ filesets relevant to the known structure of the project.</para>
+
+ <para>Here is the first page of all New archive wizards. It is the same
for any archive
+ type and the only page in the <property
moreinfo="none">New Jar wizard</property>.</para>
+ <figure float="0">
+ <title>New WAR Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_23.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The page is pretty simple. First it asks to set the name of your
new archive and a
+ destination.</para>
+
+ <para>The destination of an archive can be anywhere on the file system,
anywhere in the
+ workspace, inside some other archive, or inside a folder declared inside
an archive.
+ Select the necessary checkbox (either <emphasis>
+ <property moreinfo="none">workspace</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none"> file
system</property>
+ </emphasis>) for marking the destination as related to either
workspace or file
+ system. You can browse to workspace or filesystem destinations by
clicking on their
+ respective buttons. To select a destination inside some other archive,
you'll need
+ to press the <emphasis>
+ <property moreinfo="none">Workspace</property>
+ </emphasis> button. At the bottom of the list, you'll see
archives that
+ have been declared in the workspace.</para>
+
+ <figure float="0">
+ <title>Selecting the destination in the workspace</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_23a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Also in the wizard for creating a new archive you can choose
whether an archive to
+ be compressed or exploded into a folder (without compression). You need
just select
+ proper chechbox in the <emphasis>
+ <property moreinfo="none">Archive
type</property>
+ </emphasis> section.</para>
+ <para>If a build or incremental update fails Project Archives will show
an error
+ dialog:</para>
+ <figure float="0">
+ <title>Selecting the destination in the workspace</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/projectarchives_error.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click in <emphasis>
+ <property moreinfo="none">Details</property>
+ </emphasis> to see detailed information about what caused the
error.</para>
+
+ <para>In the <property moreinfo="none">Package
Explorer</property> you can observe the created
+ archive.</para>
+ <figure float="0">
+ <title>The Archive in the Package Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_23b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>If you use the exploded type of archiving, instead of a single
file archive the
+ result put into a folder is displayed in the <property
moreinfo="none">Package
+ Explorer</property>.</para>
+ <figure float="0">
+ <title>The Exploded Archive in the Package Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_23c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="CreatingaFolder">
+ <title>Creating a Folder</title>
+ <para>Creating a folder is much easier. You simply right-click on
an archive or
+ folder you want your new folder to be a child under. The only piece
of required
+ information is naming the file.</para>
+ </section>
+ <section id="CreatingaFileSet">
+ <title>Creating a FileSet</title>
+ <para>To create a new fileset, you click on an available target
location such as an
+ archive, a nested archive, or a folder within an archive, and select
<emphasis>
+ <property moreinfo="none">New
Fileset</property>. </emphasis></para>
+ <para>The <property moreinfo="none">New Fileset
wizard</property> requires a destination (where the
+ files will go), and a root directory (or where the files are coming
from). The
+ source can be anywhere in the workspace or from the filesystem at
large.</para>
+
+ <figure float="0">
+ <title>Adding a New FileSet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_24.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Below that, the fileset requires only an includes pattern and
an excludes
+ pattern. As you type in either of these fields, the preview viewer
should update
+ itself with which files are matched.</para>
+
+ <para><diffmk:wrapper diffmk:change="changed">You
can create a Fileset with flattening or without it. Look at the difference
+ on the figure below.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper
diffmk:change="changed">The FileSet with flattening and without
it</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_24a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+ </section>
+
+ <section id="View_Actions">
+ <title>Archive Actions</title>
+ <figure float="0">
+ <title>Context Menu on the Item</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_25.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The context menu on the items in the view is extendable, but
there are several
+ that come standard.</para>
+
+ <table>
+ <title>Context Menu on the Item</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2"
colwidth="3*"></colspec>
+
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Name</para>
+ </entry>
+
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>Build Archive (Full)</para>
+ </entry>
+
+ <entry>
+ <para>The action enabled only on top-level
archives, which initiates
+ a full build on that archive</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Edit Archive</para>
+ </entry>
+
+ <entry>
+ <para>Standard action that brings up the wizard
associated with that
+ particular node type and allows the details to be
changed</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Delete Archive</para>
+ </entry>
+
+ <entry>
+ <para>Deleting node is standard action with
deletion not needing an
+ explanation</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Publish To Server</para>
+ </entry>
+
+ <entry>
+ <para>The action means the ability to publish to a
declared
+ server</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Edit publish settings</para>
+ </entry>
+
+ <entry>
+ <para>Gives possibility to edit an archive publish
settings</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="PublishToServer">
+ <title>Publishing to Server</title>
+ <para>Finally, you'll need to publish your application to a server.
Here, we
+ show you how to do it with the help of <emphasis>
+ <property moreinfo="none">Archives
View</property>. </emphasis></para>
+
+ <figure float="0">
+ <title>Context Menu on the Item</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_26.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The dialog above appears after selecting <emphasis>
+ <property moreinfo="none">Publish To
Server</property>. </emphasis> To simply publish once, you
+ just select the server(s) that you want, and finish. If you want the
<emphasis>
+ <property moreinfo="none">Publish to
Server</property>
+ </emphasis> action on that particular Archive to publish always to
that set of
+ servers, then check the appropriate checkbox. And finally, to enable
automatic
+ publishing upon build events, check the last checkbox.</para>
+ <para>The automatic publishing feature is nice if, for example, your
package's
+ destination (where it is built) is a temporary folder and you want the
archive
+ published to several servers. If you only really want your archive
published to one
+ server, it might be easier to have the archive's destination folder
be the deploy
+ folder of the server.</para>
+ </section>
+ <section id="rel_res_links_archiving">
+ <title>Relevant Resources Links</title>
+ <para>Refer to <ulink
url="http://ant.apache.org/manual/index.html">Ant manual</ulink>
+ to find more on how to build your applications with help of
Ant.</para>
+
+ <para>We also recommend you to watch the <ulink
url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.ht...
which demonstrates a powerful archiving functionality in
+ <property moreinfo="none">JBoss
Tools</property>.</para>
+
+ <para>At this point, you are guessed to be familiar with <property
moreinfo="none">JBoss AS
+ perspective</property> and your next step now is to explore how
to work with
+ different kinds of projects.</para>
+ </section>
+
+ </section>
+
+
+</chapter>
+
+
+<chapter id="webtools"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/webtools.xml">
+ <title>Projects</title>
+ <para>The most popular of the projects we deal with are the J2EE ones, such as
Dynamic Web
+ Project, EJB Project, or EAR project. Web projects of <property
moreinfo="none">JBoss Tools</property> are
+ Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this
+ chapter we are going to tell you about facets the main benefit of which to provide
proper
+ structuring and packaging for any type of project.</para>
+
+ <section>
+ <title>Faceted Projects Overview</title>
+ <para>The idea behind faceted projects is that each project can accept units of
+ functionality, or facets, which can be added or removed by the user. Most often,
these
+ facets either add to the project's classpath, enable a builder, or watch the
project in
+ some other fashion. Generally, every project concerned has at least one facet when
+ it's created. As an example, a Web project has a WebDoclet facet, or an EJB
+ Project has an EJB Module facet as prerequisites.</para>
+
+ <para> WTP projects have undergone some criticism as being
+ <emphasis>over-engineered</emphasis> or too restrictive in their design.
WTP projects
+ are set up in a tree-relationship to each other, where one project can be a child of
+ another. For example, an EAR project may have a Web Project child, an EJB project
child,
+ or other types.</para>
+
+ <para> However, the benefit of this is that the structure of your projects is
then known,
+ and packaging it up *should* be trivial. Apparently, if your project is non-standard,
or
+ you feel too confined by such rigid structural requirements, you can still choose to
+ package your project using the <link
linkend="Project_archivesView">Archives
+ plugin</link>.</para>
+ </section>
+
+
+ <section>
+ <title>Adding Facets to a Project</title>
+
+ <para>In this section we're going to consider the facets added by
<property moreinfo="none">JBoss
+ Tools</property> and show how you can configure them in a project: add new ones
or
+ modify already existing configuration of the facets.</para>
+
+ <para>One way to configure the facets is doing it while organizing a new project.
To
+ demonstrate this let's create a new <property
moreinfo="none">Dynamic Web Project</property> by
+ selecting <emphasis>
+ <property moreinfo="none">File > New >
Other...</property>
+ </emphasis> and then <emphasis>
+ <property moreinfo="none">Web > Dynamic Web
Project</property>. </emphasis></para>
+ <figure float="0">
+ <title>New Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/webtools/webtools_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> and you will see Dynamic Web Project page like on the figure
below.</para>
+
+ <para><diffmk:wrapper diffmk:change="changed"> The first page of
most WTP projects allows you to target a specific runtime,
+ representing a server's library location. It will also provide you the ability to
add
+ this project to an EAR project, and select a preselected default set of facets,
called
+ a configuration, rather than manually select each facet you might
want.</diffmk:wrapper></para>
+ <para> Selecting the runtime, again, allows the project to install the proper
classpaths to
+ the project so it knows what code to compile against.</para>
+
+ <figure float="0" id="dyn_web_project">
+ <title>New Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/webtools/webtools_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button next to <property
moreinfo="none">Configuration</property> section in order to open
+ the wizard which allows you to modify a chosen configuration. The wizard looks as
+ follows.</para>
+
+ <figure float="0" id="project_facets">
+ <title>Project Facets Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/webtools/webtools_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here part of the listed facets are those which are provided by WTP. Some of
them are
+ added by <property moreinfo="none">JBoss Tools</property>. They
are:</para>
+ <itemizedlist>
+ <listitem>
+ <para>BIRT Charting Runtime Component</para>
+ </listitem>
+ <listitem>
+ <para>BIRT Reporting Runtime Component</para>
+ </listitem>
+ <listitem>
+ <para>JBoss ESB</para>
+ </listitem>
+ <listitem>
+ <para>JBoss Portlets</para>
+ </listitem>
+ <listitem>
+ <para>JBoss Web Services</para>
+ </listitem>
+ <listitem>
+ <para>Seam</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>On this wizard page you can enable or disable any facet as well as change
it version.
+ What you should note here is that some facets or facets versions may conflict with
each
+ other. In case of incompatibility you'll be prompted about this in the combo
+ box underneath.</para>
+ <figure float="0">
+ <title>Facet Constraints</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/webtools/webtools_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>When switching on the <emphasis>
+ <property moreinfo="none">Runtimes</property>
+ </emphasis> tab on the right you'll see the current server
Runtime.</para>
+ <figure float="0">
+ <title>Runtimes on the Project Facets Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/webtools/webtools_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On this tab you can also create a new Server Runtime and make it primary by
pressing <emphasis>
+ <property moreinfo="none">Make Primary</property>
+ </emphasis> button after enabling it.</para>
+
+ <para>Clicking on <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> will save the chosen configuration of the facets and return you to
the <link linkend="dyn_web_project">Dynamic Web Project
wizard</link>. Further pages in the
+ wizard are specific to either the project type or the facets selected.</para>
+
+
+ <para>If you need to configure the facets for the existing project, you should
bring up the
+ context menu for selected project and click <emphasis>
+ <property moreinfo="none">Properties</property>
+ </emphasis> and then <emphasis>
+ <property moreinfo="none">Project Facets</property>.
</emphasis> This will bring up the familiar
+ <link linkend="project_facets">Project Facets wizard</link>,
where you can create
+ your own custom facets configuration.</para>
+
+ <para></para>
+
+ </section>
+ <section id="rel_resources_links">
+ <title>Relevant Resources Links</title>
+
+ <para>More on the WTP facets you can read in the <ulink
url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.j...
help</ulink>.</para>
+ </section>
+</chapter>
+
+
+<chapter id="modules"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/modules.xml">
+ <title>Deploying Modules</title>
+
+ <para>In this chapter it will be described how to deploy modules onto the
server.</para>
+ <para> First of all it is necessary to say that deploying to a server is mostly
painless. There
+ are several ways to do it provided by WTP, and some additional methods provided by
JBoss
+ Tools. These methods are described further in this chapter.</para>
+
+ <section>
+ <title>Deploying on the Package Explorer</title>
+
+ <para><diffmk:wrapper diffmk:change="changed">On the package
explorer it is possible to publish either a project to a server or just
+ a single file. Let's look at how to do this.</diffmk:wrapper></para>
+ <section id="run_on_server_wizard">
+ <title>Deploying with Run On Server Wizard</title>
+ <para> The first WTP method is to right-click on a project, such as a Dynamic
Web
+ project, EJB project, or EAR project and then select <emphasis>
+ <property moreinfo="none">Run As > Run on
Server</property>
+ </emphasis>. The resulting dialog allows you to select which supporting server
the
+ project can be published to.</para>
+ <figure float="0">
+ <title>Define a New Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> button to see add or remove projects page where you can choose
projects
+ to configure them on server.</para>
+ <figure float="0" id="add_rem_proj">
+ <title>Add or Remove Projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>This page of the wizard also allows to undeploy modules from the server.
For that
+ choose proper module(s) from the right and click <emphasis>
+ <property moreinfo="none"> < Remove</property>
+ </emphasis>. The modules will be completely undeployed after restarting your
server
+ or republishing.</para>
+ <para>Generally, for the JBoss AS Server Adapters, publishing using this method
will
+ force a default, best-guess, packaging configuration for your project. This
+ best-guess does not publish incrementally, but instead repackages your entire
+ project into a <emphasis>
+ <property moreinfo="none">.war</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">.jar</property>
+ </emphasis>, or <emphasis>
+ <property moreinfo="none">.ear</property>
+ </emphasis> as appropriate, and then copies that file into the proper deploy
+ directory. For quicker smarter deployment, you will need to create archives using
+ the <link linkend="Project_archivesView">Project Archives
view</link> and customize
+ packaging yourself.</para>
+ </section>
+
+ <section id="single_file_deployment">
+ <?dbhtml filename="DeployToServer.html"?>
+ <title>Deploying single files</title>
+
+ <para>Sometimes it becomes necessary to deploy one or more files to a server.
For
+ that in order not to do a full republish in the context menu of files a
<emphasis><property moreinfo="none">Deploy To
Server</property></emphasis>
+ option is provided that allows a single file deployment. To deploy these non-WTP
files/projects
+ right click on the file (<emphasis>
+ <property moreinfo="none">-ds.xml</property></emphasis>,
<emphasis>
+ <property moreinfo="none">.ear</property></emphasis>,
<emphasis>
+ <property moreinfo="none">.jar</property></emphasis>
etc.) and select <emphasis>
+ <property moreinfo="none">Deploy To Server</property>
+ </emphasis> and it will be automatically deployed.</para>
+ <figure float="0">
+ <title>Deploy to Sever</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The deployed files are listed side-by-side with other modules that are
deployed to
+ the server.</para>
+
+ <figure float="0">
+ <title>Deployed files on the Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ </section>
+ <section>
+ <title>Deploying with JBoss Server View</title>
+ <para>As it has been already mentioned <property
moreinfo="none">JBoss Server View</property> contains two
+ parts: the top part that displays all defined servers and the bottom part which
provides
+ categories with additional information. Thus, in this section we suggest two more
ways
+ to deploy resources onto the server.</para>
+ <section>
+ <title>Top part of JBoss Server View</title>
+ <para>In the top part of the <property moreinfo="none">JBoss
Servers View</property> like in the Servers
+ View you should right click on a server and select the <emphasis>
+ <property moreinfo="none">Add and Remove Projects</property>
+ </emphasis> menu item.</para>
+ <figure float="0">
+ <title>Add and Remove Projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>This will bring up a <link linkend="add_rem_proj">familiar
dialog</link> allowing
+ you to either publish projects or modules to a server, or remove them from the
+ server. If the selected module is a project like a Dynamic Web project, EJB project,
+ or EAR project, it will be published as through <emphasis>
+ <property moreinfo="none">Run on Server</property>
+ </emphasis> wizard, with a best-guess full package. If, however, the selected
+ element is an archive from the <link
linkend="Project_archivesView">Project Archives
+ view</link>, it will be published according to the rules of that module
+ type.</para>
+ </section>
+
+ <section>
+ <title>Bottom part of JBoss Server View</title>
+ <para>In the bottom part of <emphasis>
+ <property moreinfo="none">JBoss Server View</property>
+ </emphasis> there is a category called <emphasis>
+ <property moreinfo="none">Modules</property>
+ </emphasis> which should display all currently-published modules on the
server.
+ Right-clicking on the desired module and selecting <emphasis>
+ <property moreinfo="none">Full Publish</property>
+ </emphasis> will force a full rebuild of the entire module.</para>
+ <figure float="0">
+ <title>Full Publish</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here, <emphasis>
+ <property moreinfo="none">Incremental Publish</property>
+ </emphasis> is meant to enable publishing of only those parts where changes
have
+ been made.</para>
+ </section>
+ </section>
+ <section>
+ <title>Deploying with Project Archives View</title>
+ <para>In the <property moreinfo="none">Project Archives
View</property> you can right-click on any declared
+ archive and select the <emphasis>
+ <property moreinfo="none">Publish To Server</property>
+ </emphasis> element. For more on this subject, see <link
linkend="PublishToServer">Publishing to Server</link> in the Project
Archives View section.</para>
+ <figure float="0">
+ <title>Publish to Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> The only way to ensure an <emphasis>
+ <property moreinfo="none">Incremental Build</property>
+ </emphasis>, such as changes to one <emphasis>
+ <property moreinfo="none">.jsp</property>, </emphasis>
+ <emphasis>
+ <property moreinfo="none">.html</property>, </emphasis>
or <emphasis>
+ <property moreinfo="none">.class</property>
+ </emphasis> file, is to enable the builder for that project. This is done by
either
+ changing the global preferences for the <property
moreinfo="none">Archives View</property>, or by
+ enabling project-specific preferences and ensuring the builder is on.</para>
+ <para>The last chapter covers a variety of methods on how you can deploy needed
modules onto a
+ server.</para>
+ </section>
+</chapter>
+
+
+<chapter id="tptp_support"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/tptp_support.xml">
+ <title>TPTP Support</title>
+ <para>This chapter provides an overview on how to enable TPTP Profiling for
<property moreinfo="none">JBoss
+ AS</property> adapters in <property moreinfo="none">JBoss
Tools</property>.</para>
+
+ <section>
+ <title>TPTP Profiling</title>
+
+ <para>To get TPTP profiling work on <property
moreinfo="none">JBoss Application Server</property> you should
+ first download <ulink
url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/...
4.5.0 Runtime</ulink> and install it, i. e. just add the content of
<emphasis>
+ <property
moreinfo="none">plugins/features</property>
+ </emphasis> folders from downloaded directory to the same folders in
your eclipse
+ installation directory.</para>
+
+ <para>And now all profile actions should work for you. To start
<property moreinfo="none">JBoss
+ AS</property> in profiling mode use <emphasis>
+ <property moreinfo="none">Start the server in profiling
mode</property>
+ </emphasis> button or <emphasis>
+ <property moreinfo="none">Profile As > Profile on
Server</property>
+ </emphasis> option in the context menu of the project.</para>
+
+ <figure float="0">
+ <title>Start the Server in Profiling mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/tptp_support/tptp_support_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To enable TPTP features in your workbench use <property
moreinfo="none">Profiling and Logging
+ Perspective</property> that you can find in the list of proposed
perspectives: <emphasis>
+ <property moreinfo="none">Window > Open
Perspective > Other…</property>
+ </emphasis>
+ </para>
+
+ <figure float="0">
+ <title>Profiling and Logging Perspective</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/tptp_support/tptp_support_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para>All additional information on TPTP(Test and Performance Tools
Platform) you can find
+ in <ulink
url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quic...
documentation</ulink>.</para>
+ <para>In summary, this reference should help you to start with <ulink
url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know
with functionality
+ for work with it.</para>
+ </section>
+</chapter>
+
+
+</book>
Modified: trunk/documentation/guides/Exadel-migration/en/master_output.xml
===================================================================
--- trunk/documentation/guides/Exadel-migration/en/master_output.xml 2009-05-08 12:20:47
UTC (rev 15137)
+++ trunk/documentation/guides/Exadel-migration/en/master_output.xml 2009-05-08 12:36:11
UTC (rev 15138)
@@ -20,408 +20,408 @@
<!ENTITY strutstutoriallink
"../../struts_tools_tutorial/html_single/index.html">
<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html">
-]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
- <bookinfo>
- <title>Exadel Studio Migration Guide</title>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
-Version: 2.0.1.GA
-</diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/Exadel-mig...
version</ulink>
- </para>
-</abstract>
-
-
- </bookinfo>
-
- <toc></toc>
-
-<chapter id="introduction"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/introduction.xml"
xreflabel="introduction">
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JBDS</keyword>
- <keyword>Exadel Studio Pro</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Introduction </title>
- <para><diffmk:wrapper diffmk:change="changed">This document is
intended to help you to migrate an existing Exadel JSF or Struts projects
- into </diffmk:wrapper><property moreinfo="none">JBoss Developer
Studio</property><diffmk:wrapper diffmk:change="changed">.
Preferences can be exported from Eclipse 3.2.0
- (3.2.1 or 3.2.2) and imported in Eclipse 3.4.x by the standard Eclipse
means.</diffmk:wrapper></para>
- <section diffmk:change="added">
- <title>Other relevant resources on the topic</title>
- <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer
Studio/JBoss Tools release documentation you can find
at</diffmk:wrapper><diffmk:wrapper
diffmk:change="changed">http://docs.jboss.org/tools</diff...
diffmk:change="changed"> in the corresponding release
directory.</diffmk:wrapper></para>
- <para><diffmk:wrapper diffmk:change="changed">The latest
documentation builds are available at </diffmk:wrapper><ulink
url="http://download.jboss.org/jbosstools/nightly-docs/"><...
diffmk:change="changed">http://download.jboss.org/jbosstools...
-
- </section>
-
-</chapter>
-
-
-<chapter id="workspace"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/workspace.xml"
xreflabel="workspace">
- <?dbhtml filename="workspace.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JBDS</keyword>
- <keyword>Exadel Studio Pro</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Migrate workspace</title>
- <para>You will not be able to run projects in JBoss Developer Studio
- using <property moreinfo="none">Exadel Studio
workspace</property>. In this case, project capabilities and settings specified in
Exadel Studio will be lost. The simplest way to avoid this, is to copy your projects in
<property moreinfo="none">JBoss Developer Studio
workspace</property> and make an import as it is described in the following
chapters.</para>
-</chapter>
-
-
-<chapter id="jsf_struts"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts.xml"
xreflabel="jsf_struts">
- <?dbhtml filename="jsf_struts.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JBDS</keyword>
- <keyword>Exadel Studio Pro</keyword>
- <keyword>Migration</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Migration of JSF and Struts Projects</title>
- <para>In this chapter you can find concise description of migration of JSF and
Struts Projects.</para>
- <section id="import_jsf">
- <title>JSF</title>
- <para>JBoss Developer Studio includes an Import <property
moreinfo="none">JSF Project</property> Wizard that radically simplifies
the process of bringing your existing JSF applications
- into your JBoss Developer Studio workspace as JSF projects. You just need to follow
these four steps:</para>
- <itemizedlist>
- <listitem><para><emphasis><property
moreinfo="none">Select File >
Import...</property></emphasis> from the menu bar, and then select
<emphasis><property moreinfo="none">Other > JSF Project
</property></emphasis>from the Import dialog box that
appears.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Selecting the Import Menu Item</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Selecting the Import JSF Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>In the first screen of the wizard, select the
<emphasis><property
moreinfo="none">Change...</property></emphasis> button next to
the <emphasis><property moreinfo="none">web.xml
Location</property></emphasis> field. Browse to the location of the web.xml
file for the application you
- want to import as a <property moreinfo="none">JSF
project</property>. Once you select it, you'll be returned to the dialog box to
see a project name derived from the web.xml file you selected.
- You can edit this project name, if you wish.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Selecting the Web.xml File in the Project Location Screen</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist id="import_jsf_screen">
- <listitem><para>In the <emphasis><property
moreinfo="none">Project Folders</property></emphasis> screen, you
can configure the rest of your project. Afterwards click on the
<emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para></listitem>
- </itemizedlist>
- <para>On this step JBoss Developer Studio will try to determine your project
- structure and set the values for: <emphasis><property
moreinfo="none">Web Root</property></emphasis>,
<emphasis><property moreinfo="none">Source
Folder</property></emphasis>, <emphasis><property
moreinfo="none">Classes Folder</property></emphasis>,
<emphasis><property moreinfo="none">Lib
Folder</property></emphasis>. If your project has a custom structure, some
values might not be
- set. If this is the case, you can manually set those values by clicking the
<emphasis><property
moreinfo="none">Change...</property></emphasis>
button.</para>
- <para>After dealing with these settings, you have to work through a few more
configuration settings. These settings deal primarily with how the project will be
deployed within JBoss Developer Studio.</para>
- <para>First, if the project you are importing is not already a JSF project,
select the <emphasis><property moreinfo="none">Add
Libraries</property></emphasis> check box to add all the JSF-related libraries
to your project. </para>
- <para>Then, you may select the JavaServer Faces implementation
(<emphasis><property
moreinfo="none">Environment</property></emphasis>) and
<emphasis><property moreinfo="none">Servlet
Version</property></emphasis>.</para>
- <para>The <emphasis><property moreinfo="none">Context
Path</property></emphasis> is the name under which the application will be
deployed. </para>
- <para>The <emphasis><property
moreinfo="none">Runtime</property></emphasis> value tells Eclipse
where to find Web libraries in order to build the project. It is not possible to finish
the importing of a project without selecting a Runtime. If you don't have any choices
displayed for this, select <emphasis><property
moreinfo="none">New...</property></emphasis> to add a new
Runtime.</para>
- <para>Finally, <emphasis><property moreinfo="none">Target
Server</property></emphasis> sets the server to deploy the application under.
The Target Server corresponds to the Runtime value selected above. If you don't want
to deploy the application, uncheck this value.</para>
-
-
- <figure float="0">
- <title>The Project Folders Screen</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>Once the project is imported, it will appear in the
Package Explorer view.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Imported Project in the Package Explorer View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
- <section>
- <title>Struts</title>
- <itemizedlist>
- <listitem><para><emphasis><property
moreinfo="none">Select File >
Import...</property></emphasis> from the menu bar, and then select
<emphasis><property moreinfo="none">Other > Struts
Project</property></emphasis> from the Import dialog box that
appears.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Selecting the Import Menu Item</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Selecting the Import Struts Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>In the Project Location screen of the wizard, select the
<emphasis><property moreinfo="none">Change...
</property></emphasis>button next to the <emphasis><property
moreinfo="none">web.xml Location</property></emphasis> field.
Browse the location of the web.xml file for the application you
- want to import as a <property moreinfo="none">Struts
project</property>. Once you select it, you'll be returned to the dialog box to
see a project name derived from the web.xml file you selected.
- You can edit this project name, if you wish.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>The Project Location Screen</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>In the next screen, JBoss Developer Studio will try to
determine your project structure. The upper pane shows the modules in this project.
- The lower pane allows you to edit the details of the select module. If the project
structure is non-standard, some values might be left blank.
- You can edit any values by hand or by using the <emphasis><property
moreinfo="none">Change...</property></emphasis>
button.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>The Project Modules Screen</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>In the <emphasis><property
moreinfo="none">Project Folders</property></emphasis> screen, you
can configure the rest of your project. Afterwards click on the
<emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para>
- </listitem>
- </itemizedlist>
- <para>On this step JBoss Developer Studio will try to determine your project
structure and set the values for: <emphasis><property
moreinfo="none">Classes Folder</property></emphasis>,
<emphasis><property moreinfo="none">Lib
Folder</property></emphasis>, and <emphasis><property
moreinfo="none">Ant Build File</property></emphasis>. If your
project has a custom structure, some values might not be set. If this is the case, you can
manually set those values by clicking <emphasis><property
moreinfo="none">Change</property></emphasis>.</para>
- <para>After dealing with these settings, you have to work through a few more
configuration settings. These settings deal primarily with how the project will be
deployed within JBoss Developer Studio.</para>
- <para>First, if the project you are importing is not already a Struts project,
select the <emphasis><property moreinfo="none">Add
Libraries</property></emphasis> check box to add all the Struts-related
libraries to your project. </para>
- <para>Then, you may select the Struts <emphasis><property
moreinfo="none">Environment</property></emphasis> and
<emphasis><property moreinfo="none">Servlet
Version</property></emphasis>.</para>
- <para>The <emphasis><property moreinfo="none">Context
Path</property></emphasis> is the name under which the application will be
deployed. </para>
- <para>The <emphasis><property
moreinfo="none">Runtime</property></emphasis> value tells Eclipse
where to find Web libraries in order to build the project. It is not possible to finish
the importing of a project without selecting a Runtime. If you don't have any choices
displayed for this, select<emphasis><property moreinfo="none">
New...</property></emphasis> to add a new Runtime.</para>
- <para>Finally, <emphasis><property moreinfo="none">Target
Server</property></emphasis> sets the server to deploy the application under.
The Target Server corresponds to the Runtime value selected above. If you don't want
to deploy the application, uncheck this value.</para>
-
-
- <figure float="0">
- <title>The Project Folders Screen</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>Once the project is imported, it will appear in the
Package Explorer view.</para></listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Imported Project in the Package Explorer View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts/migration_9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-</chapter>
-
-
-<chapter id="jsf_struts_war"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts_war.xml"
xreflabel="jsf_struts_war">
- <?dbhtml filename="jsf_struts_war.html"?>
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
-
- <keyword>JBDS</keyword>
-
- <keyword>Exadel Studio Pro</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Migrate JSF and Struts projects from *.war file</title>
- <para>After you familiarized oneself with last chapter you can read this chapter.
It looks as if you read in last chapter.</para>
- <section>
- <title>JSF</title>
-
- <itemizedlist>
- <listitem>
- <para>Select <emphasis><property moreinfo="none">File
> Import...</property></emphasis> from the menu bar, and then select
- <emphasis><property moreinfo="none">Other > JSF
Project From *.war</property></emphasis> from the Import dialog box that
- appears.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Selecting the Import Menu Item</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts_war/migration_war_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Selecting the JSF Project From *.war Import Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts_war/migration_war_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>In the wizard screen, select the <emphasis><property
moreinfo="none">Change...</property></emphasis> button next to
- the <emphasis><property moreinfo="none">*.war
Location</property></emphasis> field. Browse to the location of the *.war file
for
- the application you want to import as a JSF project. Once you select
- it, you'll be returned to the dialog box to see a project name
- derived from the *.war file you selected. You can edit this name, if
- you wish.</para>
-
- <para>Uncheck the <emphasis><property
moreinfo="none">Use Default Path</property></emphasis> check box
if you want to import
- your project outside of the Eclipse workspace. In this case, you would
- use <emphasis><property moreinfo="none"> Change...
</property></emphasis> button next to the <emphasis><property
moreinfo="none">Location</property></emphasis> field to choose a
- location.</para>
-
- <para><emphasis><property moreinfo="none">Context
Path</property></emphasis> is the name under which the application will be
- deployed.</para>
-
- <para>The <emphasis><property
moreinfo="none">Runtime</property></emphasis> value tells Eclipse
where to find Web libraries in
- order to build the project. It is not possible to finish project
- import without selecting Runtime. If you don't have any options
- here, select <emphasis><property
moreinfo="none">New...</property></emphasis> to add a new
Runtime.</para>
-
- <para>Finally, <emphasis><property
moreinfo="none">Target Server</property></emphasis> sets the
server to deploy the application
- under. The Target Server corresponds to the Runtime value selected
- above. If you don't want to deploy the application, uncheck this
- value.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>The JSF Project From *.war Import Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts_war/migration_war_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>Struts</title>
-
- <itemizedlist>
- <listitem>
- <para>Select <emphasis><property moreinfo="none">File
> Import...</property></emphasis> from the menu bar, and then select
- <emphasis><property moreinfo="none">Other > Struts
Project From *.war</property></emphasis> from the Import dialog box that
- appears.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Selecting the Import Menu Item</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts_war/migration_war_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Selecting the Struts Project From *.war Import Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts_war/migration_war_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Follow the same steps as with the JSF Project From <property
moreinfo="none">*.war</property> import
- wizard.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>The Struts Project From *.war Import Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/jsf_struts_war/migration_war_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Click on the <emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para>
- </listitem>
- </itemizedlist>
- <para>The migration process is completed</para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">If there's anything we didn't cover or you
can't figure
- out, please feel free to visit our </diffmk:wrapper><ulink
diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss Developer Studio Users
Forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added"> or </diffmk:wrapper><ulink
diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss Tools Users
Forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added"> to ask questions. There we are also looking for
- your suggestions and comments.</diffmk:wrapper></para>
- </section>
-
-</chapter>
-
-
-</book>
+]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+ <bookinfo>
+ <title>Exadel Studio Migration Guide</title>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+Version: 2.0.1.GA
+</diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/Exadel-mig...
version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+
+ <toc></toc>
+
+<chapter id="introduction"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/introduction.xml"
xreflabel="introduction">
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JBDS</keyword>
+ <keyword>Exadel Studio Pro</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Introduction </title>
+ <para><diffmk:wrapper diffmk:change="changed">This document is
intended to help you to migrate an existing Exadel JSF or Struts projects
+ into </diffmk:wrapper><property moreinfo="none">JBoss Developer
Studio</property><diffmk:wrapper diffmk:change="changed">.
Preferences can be exported from Eclipse 3.2.0
+ (3.2.1 or 3.2.2) and imported in Eclipse 3.4.x by the standard Eclipse
means.</diffmk:wrapper></para>
+ <section diffmk:change="added">
+ <title>Other relevant resources on the topic</title>
+ <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer
Studio/JBoss Tools release documentation you can find
at</diffmk:wrapper><diffmk:wrapper
diffmk:change="changed">http://docs.jboss.org/tools</diff...
diffmk:change="changed"> in the corresponding release
directory.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The latest
documentation builds are available at </diffmk:wrapper><ulink
url="http://download.jboss.org/jbosstools/nightly-docs/"><...
diffmk:change="changed">http://download.jboss.org/jbosstools...
+
+ </section>
+
+</chapter>
+
+
+<chapter id="workspace"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/workspace.xml"
xreflabel="workspace">
+ <?dbhtml filename="workspace.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JBDS</keyword>
+ <keyword>Exadel Studio Pro</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Migrate workspace</title>
+ <para>You will not be able to run projects in JBoss Developer Studio
+ using <property moreinfo="none">Exadel Studio
workspace</property>. In this case, project capabilities and settings specified in
Exadel Studio will be lost. The simplest way to avoid this, is to copy your projects in
<property moreinfo="none">JBoss Developer Studio
workspace</property> and make an import as it is described in the following
chapters.</para>
+</chapter>
+
+
+<chapter id="jsf_struts"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts.xml"
xreflabel="jsf_struts">
+ <?dbhtml filename="jsf_struts.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>JBDS</keyword>
+ <keyword>Exadel Studio Pro</keyword>
+ <keyword>Migration</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Migration of JSF and Struts Projects</title>
+ <para>In this chapter you can find concise description of migration of JSF and
Struts Projects.</para>
+ <section id="import_jsf">
+ <title>JSF</title>
+ <para>JBoss Developer Studio includes an Import <property
moreinfo="none">JSF Project</property> Wizard that radically simplifies
the process of bringing your existing JSF applications
+ into your JBoss Developer Studio workspace as JSF projects. You just need to follow
these four steps:</para>
+ <itemizedlist>
+ <listitem><para><emphasis><property
moreinfo="none">Select File >
Import...</property></emphasis> from the menu bar, and then select
<emphasis><property moreinfo="none">Other > JSF Project
</property></emphasis>from the Import dialog box that
appears.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Selecting the Import Menu Item</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Selecting the Import JSF Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>In the first screen of the wizard, select the
<emphasis><property
moreinfo="none">Change...</property></emphasis> button next to
the <emphasis><property moreinfo="none">web.xml
Location</property></emphasis> field. Browse to the location of the web.xml
file for the application you
+ want to import as a <property moreinfo="none">JSF
project</property>. Once you select it, you'll be returned to the dialog box to
see a project name derived from the web.xml file you selected.
+ You can edit this project name, if you wish.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Selecting the Web.xml File in the Project Location Screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist id="import_jsf_screen">
+ <listitem><para>In the <emphasis><property
moreinfo="none">Project Folders</property></emphasis> screen, you
can configure the rest of your project. Afterwards click on the
<emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para></listitem>
+ </itemizedlist>
+ <para>On this step JBoss Developer Studio will try to determine your project
+ structure and set the values for: <emphasis><property
moreinfo="none">Web Root</property></emphasis>,
<emphasis><property moreinfo="none">Source
Folder</property></emphasis>, <emphasis><property
moreinfo="none">Classes Folder</property></emphasis>,
<emphasis><property moreinfo="none">Lib
Folder</property></emphasis>. If your project has a custom structure, some
values might not be
+ set. If this is the case, you can manually set those values by clicking the
<emphasis><property
moreinfo="none">Change...</property></emphasis>
button.</para>
+ <para>After dealing with these settings, you have to work through a few more
configuration settings. These settings deal primarily with how the project will be
deployed within JBoss Developer Studio.</para>
+ <para>First, if the project you are importing is not already a JSF project,
select the <emphasis><property moreinfo="none">Add
Libraries</property></emphasis> check box to add all the JSF-related libraries
to your project. </para>
+ <para>Then, you may select the JavaServer Faces implementation
(<emphasis><property
moreinfo="none">Environment</property></emphasis>) and
<emphasis><property moreinfo="none">Servlet
Version</property></emphasis>.</para>
+ <para>The <emphasis><property moreinfo="none">Context
Path</property></emphasis> is the name under which the application will be
deployed. </para>
+ <para>The <emphasis><property
moreinfo="none">Runtime</property></emphasis> value tells Eclipse
where to find Web libraries in order to build the project. It is not possible to finish
the importing of a project without selecting a Runtime. If you don't have any choices
displayed for this, select <emphasis><property
moreinfo="none">New...</property></emphasis> to add a new
Runtime.</para>
+ <para>Finally, <emphasis><property moreinfo="none">Target
Server</property></emphasis> sets the server to deploy the application under.
The Target Server corresponds to the Runtime value selected above. If you don't want
to deploy the application, uncheck this value.</para>
+
+
+ <figure float="0">
+ <title>The Project Folders Screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>Once the project is imported, it will appear in the
Package Explorer view.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Imported Project in the Package Explorer View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+ <section>
+ <title>Struts</title>
+ <itemizedlist>
+ <listitem><para><emphasis><property
moreinfo="none">Select File >
Import...</property></emphasis> from the menu bar, and then select
<emphasis><property moreinfo="none">Other > Struts
Project</property></emphasis> from the Import dialog box that
appears.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Selecting the Import Menu Item</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Selecting the Import Struts Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>In the Project Location screen of the wizard, select the
<emphasis><property moreinfo="none">Change...
</property></emphasis>button next to the <emphasis><property
moreinfo="none">web.xml Location</property></emphasis> field.
Browse the location of the web.xml file for the application you
+ want to import as a <property moreinfo="none">Struts
project</property>. Once you select it, you'll be returned to the dialog box to
see a project name derived from the web.xml file you selected.
+ You can edit this project name, if you wish.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>The Project Location Screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>In the next screen, JBoss Developer Studio will try to
determine your project structure. The upper pane shows the modules in this project.
+ The lower pane allows you to edit the details of the select module. If the project
structure is non-standard, some values might be left blank.
+ You can edit any values by hand or by using the <emphasis><property
moreinfo="none">Change...</property></emphasis>
button.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>The Project Modules Screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>In the <emphasis><property
moreinfo="none">Project Folders</property></emphasis> screen, you
can configure the rest of your project. Afterwards click on the
<emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para>
+ </listitem>
+ </itemizedlist>
+ <para>On this step JBoss Developer Studio will try to determine your project
structure and set the values for: <emphasis><property
moreinfo="none">Classes Folder</property></emphasis>,
<emphasis><property moreinfo="none">Lib
Folder</property></emphasis>, and <emphasis><property
moreinfo="none">Ant Build File</property></emphasis>. If your
project has a custom structure, some values might not be set. If this is the case, you can
manually set those values by clicking <emphasis><property
moreinfo="none">Change</property></emphasis>.</para>
+ <para>After dealing with these settings, you have to work through a few more
configuration settings. These settings deal primarily with how the project will be
deployed within JBoss Developer Studio.</para>
+ <para>First, if the project you are importing is not already a Struts project,
select the <emphasis><property moreinfo="none">Add
Libraries</property></emphasis> check box to add all the Struts-related
libraries to your project. </para>
+ <para>Then, you may select the Struts <emphasis><property
moreinfo="none">Environment</property></emphasis> and
<emphasis><property moreinfo="none">Servlet
Version</property></emphasis>.</para>
+ <para>The <emphasis><property moreinfo="none">Context
Path</property></emphasis> is the name under which the application will be
deployed. </para>
+ <para>The <emphasis><property
moreinfo="none">Runtime</property></emphasis> value tells Eclipse
where to find Web libraries in order to build the project. It is not possible to finish
the importing of a project without selecting a Runtime. If you don't have any choices
displayed for this, select<emphasis><property moreinfo="none">
New...</property></emphasis> to add a new Runtime.</para>
+ <para>Finally, <emphasis><property moreinfo="none">Target
Server</property></emphasis> sets the server to deploy the application under.
The Target Server corresponds to the Runtime value selected above. If you don't want
to deploy the application, uncheck this value.</para>
+
+
+ <figure float="0">
+ <title>The Project Folders Screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>Once the project is imported, it will appear in the
Package Explorer view.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Imported Project in the Package Explorer View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts/migration_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+</chapter>
+
+
+<chapter id="jsf_struts_war"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts_war.xml"
xreflabel="jsf_struts_war">
+ <?dbhtml filename="jsf_struts_war.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+
+ <keyword>JBDS</keyword>
+
+ <keyword>Exadel Studio Pro</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Migrate JSF and Struts projects from *.war file</title>
+ <para>After you familiarized oneself with last chapter you can read this chapter.
It looks as if you read in last chapter.</para>
+ <section>
+ <title>JSF</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis><property moreinfo="none">File
> Import...</property></emphasis> from the menu bar, and then select
+ <emphasis><property moreinfo="none">Other > JSF
Project From *.war</property></emphasis> from the Import dialog box that
+ appears.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Selecting the Import Menu Item</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts_war/migration_war_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Selecting the JSF Project From *.war Import Wizard</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts_war/migration_war_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>In the wizard screen, select the <emphasis><property
moreinfo="none">Change...</property></emphasis> button next to
+ the <emphasis><property moreinfo="none">*.war
Location</property></emphasis> field. Browse to the location of the *.war file
for
+ the application you want to import as a JSF project. Once you select
+ it, you'll be returned to the dialog box to see a project name
+ derived from the *.war file you selected. You can edit this name, if
+ you wish.</para>
+
+ <para>Uncheck the <emphasis><property
moreinfo="none">Use Default Path</property></emphasis> check box
if you want to import
+ your project outside of the Eclipse workspace. In this case, you would
+ use <emphasis><property moreinfo="none"> Change...
</property></emphasis> button next to the <emphasis><property
moreinfo="none">Location</property></emphasis> field to choose a
+ location.</para>
+
+ <para><emphasis><property moreinfo="none">Context
Path</property></emphasis> is the name under which the application will be
+ deployed.</para>
+
+ <para>The <emphasis><property
moreinfo="none">Runtime</property></emphasis> value tells Eclipse
where to find Web libraries in
+ order to build the project. It is not possible to finish project
+ import without selecting Runtime. If you don't have any options
+ here, select <emphasis><property
moreinfo="none">New...</property></emphasis> to add a new
Runtime.</para>
+
+ <para>Finally, <emphasis><property
moreinfo="none">Target Server</property></emphasis> sets the
server to deploy the application
+ under. The Target Server corresponds to the Runtime value selected
+ above. If you don't want to deploy the application, uncheck this
+ value.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>The JSF Project From *.war Import Wizard</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts_war/migration_war_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Struts</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select <emphasis><property moreinfo="none">File
> Import...</property></emphasis> from the menu bar, and then select
+ <emphasis><property moreinfo="none">Other > Struts
Project From *.war</property></emphasis> from the Import dialog box that
+ appears.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Selecting the Import Menu Item</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts_war/migration_war_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Selecting the Struts Project From *.war Import Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts_war/migration_war_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Follow the same steps as with the JSF Project From <property
moreinfo="none">*.war</property> import
+ wizard.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>The Struts Project From *.war Import Wizard</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/jsf_struts_war/migration_war_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis><property
moreinfo="none">Finish</property></emphasis>
button.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The migration process is completed</para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">If there's anything we didn't cover or you
can't figure
+ out, please feel free to visit our </diffmk:wrapper><ulink
diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss Developer Studio Users
Forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added"> or </diffmk:wrapper><ulink
diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss Tools Users
Forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added"> to ask questions. There we are also looking for
+ your suggestions and comments.</diffmk:wrapper></para>
+ </section>
+
+</chapter>
+
+
+</book>
Modified: trunk/documentation/guides/GettingStartedGuide/pom.xml
===================================================================
--- trunk/documentation/guides/GettingStartedGuide/pom.xml 2009-05-08 12:20:47 UTC (rev
15137)
+++ trunk/documentation/guides/GettingStartedGuide/pom.xml 2009-05-08 12:36:11 UTC (rev
15138)
@@ -94,11 +94,11 @@
</cssResource>
<formats>
- <!--format>
+ <format>
<formatName>pdf</formatName>
<stylesheetResource>${xsl-pdf}</stylesheetResource>
<finalName>${pom.name}.pdf</finalName>
- </format-->
+ </format>
<format>
<formatName>html</formatName>
<stylesheetResource>${xsl-chunked}</stylesheetResource>
Modified: trunk/drools/docs/reference/en/master_output.xml
===================================================================
--- trunk/drools/docs/reference/en/master_output.xml 2009-05-08 12:20:47 UTC (rev 15137)
+++ trunk/drools/docs/reference/en/master_output.xml 2009-05-08 12:36:11 UTC (rev 15138)
@@ -21,752 +21,752 @@
<!ENTITY strutsreflink
"../../struts_tools_ref_guide/html_single/index.html">
<!ENTITY strutstutoriallink
"../../struts_tools_tutorial/html_single/index.html">
-]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>Drools Tools Reference Guide</title>
-
-
<author><firstname>Olga</firstname><surname>Chikvina</surname></author>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 5.0.0.CR1
- </diffmk:wrapper></releaseinfo>
-<abstract>
- <title></title>
- <para>
- <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_...
version</ulink>
- </para>
-</abstract>
-
- </bookinfo>
-
-
- <toc></toc>
-
-<chapter id="introduction"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/introduction.xml"
xreflabel="introduction">
- <title>Introduction</title>
-
- <section id="whatisDrools">
- <title>What is Drools?</title>
-
- <para><property moreinfo="none">Drools</property> is
a business rule management system (BRMS) with a forward
- chaining inference based rules engine, more correctly known as a production
rule system,
- using an enhanced implementation of the Rete algorithm.</para>
-
- <para><diffmk:wrapper diffmk:change="changed"> In this
guide we are going to get you familiar with Drools Eclipse plugin which
- provides development tools for creating, executing and debugging Drools
processes and
- rules from within Eclipse.</diffmk:wrapper></para>
-
- <note>
- <title>Note:</title>
- <para>It is assumed that you has some familiarity with rule engines and
Drools in
- particular. If no, we suggest that you look carefully through the
<ulink
url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_sing...
Documentation</ulink>.</para>
- </note>
-
- <para><property moreinfo="none">Drools
Tools</property> come bundled with <property moreinfo="none">JBoss
Tools</property>
- set of Eclipse plugins. How to install <property
moreinfo="none">JBoss Tools</property><diffmk:wrapper
diffmk:change="changed"> you can find in
- the </diffmk:wrapper><ulink
url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">Getting
Started Guide</ulink>.</para>
- </section>
-
- <section id="drools_key_features">
- <title>Drools Tools Key Features</title>
-
- <para>The following table lists all valuable features of the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Drools
- Tools</diffmk:wrapper></property>.</para>
- <table>
- <title>Key Functionality of Drools Tools</title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
- <colspec colnum="2"
colwidth="5*"></colspec>
- <colspec align="left" colnum="3"
colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>Wizard for creating a new Drools
Project</para>
- </entry>
- <entry>
- <para>The wizard allows to create a sample project to
easy get started
- with Drools</para>
- </entry>
- <entry>
- <link
linkend="sample_drools_project">Creating a Sample Drools
- Project</link>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Wizards for creation new Drools
resources</para>
- </entry>
- <entry>
- <para>A set of wizards are provided with the Drools
Eclipse tools to
- quickly create a new Rule resource, a new Domain Specific
language,
- Decision Table and Business rule</para>
- </entry>
- <entry>
- <link linkend="creating_rule">Creating a New
Rule</link>
- <!--link linkend="creating_dsl">Creating a
New DSL</link>
- <link
linkend="creating_decision_table">Creating a New Decision
- Table</link>
- <link
linkend="creating_business_rule">Creating a New Business
- Rule</link-->
- </entry>
- </row>
-
- <row>
- <entry>
- <para>The Rule editor</para>
- </entry>
- <entry>
- <para>An editor that is aware of DRL syntax and
provides content
- assistance and synchronizing with the Outline
view</para>
- </entry>
- <entry>
- <link linkend="textual_rule_editor">The Rule
Editor</link>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>The Domain Specific Language editor</para>
- </entry>
- <entry>
- <para>The editor allows to create and manage mappings
from users
- language to the rule language</para>
- </entry>
- <entry>
- <!--link linkend="dsl_editor">The Domain
Specific Language Editor</link-->
- </entry>
- </row>
-
- <row>
- <entry>
- <para>The Guided editor</para>
- </entry>
- <entry>
- <para>This guided editor for rules allows you to build
rules in a GUI
- driven fashion based on your object model</para>
- </entry>
- <entry>
- <!--link linkend="guided_editor">The Guided
Editor</link-->
- </entry>
- </row>
-
- <row>
- <entry>
- <para>The Rule Flow graphical editor</para>
- </entry>
- <entry>
- <para>The editor is meant for editing visual graphs
which represent a
- process (a rule flow)</para>
- </entry>
- <entry>
- <!--link linkend="ruleflow_editor">The Rule
Flow Graphical Editor</link-->
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section>
- <title>Other relevant resources on the topic</title>
-
- <itemizedlist>
- <listitem>
- <para>Drools on <ulink
url="http://www.jboss.org/drools/">JBoss.org</ulink>&l...
- </listitem>
-
- <listitem>
- <para>
- <ulink
url="http://www.jboss.org/tools/">JBoss Tools
Home Page</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
- JBossTools/JBDS documentation builds</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para><diffmk:wrapper diffmk:change="added">All
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss
Tools/JBDS</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> documentation you can find on the
- </diffmk:wrapper><ulink diffmk:change="added"
url="http://docs.jboss.org/tools/"><diffmk:wrapper
diffmk:change="added">documentation release
- page</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
- </listitem>
- </itemizedlist>
-
- </section>
-</chapter>
-
-
-<chapter id="create_new_project"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/create_new_project.xml"
xreflabel="create_new_project">
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Drools Tools</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Creating a New Drools Project</title>
-
- <para>In this chapter we are going to show you how to setup an executable
sample Drools project
- to start using rules immediately.</para>
-
-
-
- <section id="sample_drools_project">
- <title>Creating a Sample Drools Project</title>
-
- <para>First, we suggest that you use <property
moreinfo="none">Drools perspective</property> which is aimed
- at work with Drools specific resources.</para>
-
- <para>To create a new Drools project follow to <emphasis>
- <property moreinfo="none">File > New >
Drools Project</property>. </emphasis> This will open
- <property moreinfo="none">New Drools Project
wizard</property> like on the figure below.</para>
-
- <para>On the first page type the project name and click
- <emphasis><property
moreinfo="none">Next</property>.</emphasis></para>
-
- <figure float="0">
- <title>Creating a New Drools Project</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next you have a choice to add some default artifacts to it like
sample rules, decision
- tables or ruleflows and Java classes for them. Let's select first two
check
- boxes and press <emphasis>
- <property moreinfo="none">Next</property>.
</emphasis></para>
-
- <figure float="0">
- <title>Selecting Drools Project Elements</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next page asks you to specify a Drools runtime. If you have not yet
set it up, you
- should do this now by clicking the <emphasis>
- <property moreinfo="none">Configure Workspace
Settings</property>
- </emphasis> link.</para>
-
- <figure float="0">
- <title>Configuring Drools Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You should see the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Preferences
window</diffmk:wrapper></property> where you can configure the
- workspace settings for Drools runtimes. To create a new runtime, press the
<emphasis>
- <property moreinfo="none">Add</property>
- </emphasis> button. The appeared dialog prompts you to enter a
- name for a new runtime and a path to the Drools runtime on your file
system.</para>
-
- <note>
- <title>Note:</title>
- <para>A Drools runtime is a collection of jars on your file system that
represent one
- specific release of the Drools project jars. While creating a new
runtime, you must
- either point to the release of your choice, or you can simply create a
new runtime
- on your file system from the jars included in the Drools Eclipse
plugin.</para>
- </note>
-
- <figure float="0">
- <title>Adding a New Drools Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Let's simply create a new Drools 5 runtime from the jars embedded
in the
- Drools Eclipse plugin. Thus, you should press <emphasis>
- <property moreinfo="none">Create a new Drools 5
runtime</property>
- </emphasis> button and select the folder where you want this runtime to
be created and
- hit <emphasis>
- <property
moreinfo="none">OK</property>.</emphasis></para>
-
- <para>You will see the newly created runtime show up in your list of Drools
runtimes. Check
- it and press <emphasis>
- <property
moreinfo="none">OK</property>.</emphasis></para>
-
- <figure float="0">
- <title>Selecting a Drools Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now press <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to complete the project creation.</para>
-
- <figure float="0">
- <title>Completing the Drools Project Creation</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>This will setup a basic structure, classpath and sample rules and
test case to get you
- started.</para>
- </section>
-
-
- <section id="structure_overview">
- <title>Drools Project Structure Overview</title>
-
- <para>Now let's look at the structure of the organized project. In the
- <property moreinfo="none">Package
Explorer</property> you should see the following:</para>
-
- <figure float="0">
- <title>Drools Project in the Package Explorer</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The newly created project contains an example rule file
<emphasis>
- <property moreinfo="none">Sample.drl</property>
- </emphasis> in the <emphasis>
- <property
moreinfo="none">src/main/rules</property>
- </emphasis> directory and an example java file <emphasis>
- <property
moreinfo="none">DroolsTest.java</property>
- </emphasis> that can be used to execute the rules in a Drools engine in
the folder <emphasis>
- <property moreinfo="none">src/main/java</property>
- </emphasis>, in the <emphasis>
- <property moreinfo="none">com.sample</property>
- </emphasis> package. All the others jar's that are necessary during
execution
- are also added to the classpath in a custom classpath container called
<property moreinfo="none">Drools
- Library</property>.</para>
-
- <tip>
- <title>Tip:</title>
- <para>Rules do not have to be kept in Java projects at all, this is
just a convenience
- for people who are already using eclipse as their Java IDE.</para>
- </tip>
-
- </section>
-
- <section id="creating_rule">
- <title>Creating a New Rule</title>
-
- <para>Now we are going to add a new Rule resource to the
project.</para>
-
- <para>You can either create an empty text <emphasis>
- <property moreinfo="none">.drl</property>
- </emphasis> file or make use of the special <property
moreinfo="none">New Rule Resource
- wizard</property> to do it.</para>
-
- <para>To open the wizard follow to <emphasis>
- <property moreinfo="none">File > New > Rule
Resource</property>
- </emphasis> or use the menu with the JBoss Drools icon on the
toolbar.</para>
-
- <figure float="0">
- <title>Opening the New Rule Resource Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the wizard page first select <emphasis>
- <property moreinfo="none">/rules</property>
- </emphasis> as a top level directory to store your rules and type the
rule name. Next
- it's mandatory to specify the rule package name. It defines a namespace
that
- groups rules together.</para>
-
- <figure float="0">
- <title>New Rule Resource Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As a result the wizard generates a rule skeleton to get you
started.</para>
-
- <figure float="0">
- <title>New Rule</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_project/create_new_project10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
-</chapter>
-
-
-<chapter id="debugging_rules"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/debugging_rules.xml"
xreflabel="debugging_rules">
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Drools Tools</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Debugging rules</title>
-
- <para>This chapter describes how to debug rules during the execution of your
Drools application.</para>
-
- <section id="creating_breakpoints">
- <title>Creating Breakpoints</title>
-
- <para>At first, we'll focus on how to add
- breakpoints in the consequences of your rules.</para>
-
- <para>Whenever such a breakpoint is uncounted
- during the execution of the rules, the execution is halted. It's possible then
inspect the
- variables known at that point and use any of the default debugging actions to decide
what
- should happen next (step over, continue, etc). To inspect
- the content of the working memory and agenda the Debug views can be
used.</para>
-
- <para>You can add/remove rule breakpoints in <emphasis>
- <property moreinfo="none">.drl</property>
- </emphasis> files in two ways, similar to adding breakpoints to Java
files:</para>
-
- <itemizedlist>
- <listitem>
- <para>Double-click the ruler in the <property
moreinfo="none">Rule editor</property> at the line
- where you want to add a breakpoint.</para>
- <tip>
- <title>Tip:</title>
- <para>Note that rule breakpoints can only be created in the consequence of a
- rule. Double-clicking on a line where no breakpoint is allowed will do
- nothing.</para>
- </tip>
- <para>A breakpoint can be removed by double-clicking the ruler once more.
</para>
- </listitem>
-
- <listitem>
- <para>Right-click the ruler. Select <emphasis>
- <property moreinfo="none">Toggle Breakpoint</property>
- </emphasis> action in the appeared popup menu. Clicking the action will add a
- breakpoint at the selected line or remove it if there is one already.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Adding Breakpoints</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/debugging_rules/debugging_rules1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <property moreinfo="none">Debug
perspective</property> contains a <property
moreinfo="none">Breakpoints
- view</property> which can be used to see all defined breakpoints, get their
- properties, enable/disable or remove them, etc. You can switch to it by navigating to
<emphasis>
- <property moreinfo="none">Window > Perspective > Others
> Debug</property>.</emphasis></para>
- </section>
-
- <section id="debugging">
- <title>Debugging</title>
-
- <para>Drools breakpoints are only enabled if you debug your application as a
Drools
- Application. To do this you should perform one of the actions:</para>
-
- <itemizedlist>
- <listitem>
- <para>Select the main class of your application. Right click it and select
<emphasis>
- <property moreinfo="none">Debug As > Drools
Application</property>.</emphasis></para>
- </listitem>
- </itemizedlist>
- <figure float="0">
- <title>Debugging Drools Application</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/debugging_rules/debugging_rules2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>Alternatively, you can also go to <emphasis>
- <property moreinfo="none">Debug As > Debug
Configuration</property>
- </emphasis> to open a new dialog for creating, managing and running debug
- configurations.</para>
-
- <para>Select the <emphasis>
- <property moreinfo="none">Drools Application</property>
- </emphasis> item in the left tree and click the <emphasis>
- <property moreinfo="none">New launch
configuration</property>
- </emphasis> button (leftmost icon in the toolbar above the tree). This will
- create a new configuration and already fill in some of the properties (like the
- Project and Main class) based on main class you selected in the beginning. All
- properties shown here are the same as any standard Java program.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>New Debug Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/debugging_rules/debugging_rules3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
- <para>Remember to change the name of your debug configuration to something
meaningful.</para>
- </tip>
-
- <para>Next
- click the <emphasis>
- <property moreinfo="none">Debug</property>
- </emphasis> button on the bottom to start debugging your application.
</para>
-
- <para>After enabling the debugging, the application starts executing and will
halt if
- any breakpoint is encountered. This can be a Drools rule breakpoint, or any other
- standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the
- corresponding <emphasis>
- <property moreinfo="none">.drl</property></emphasis> file
is opened and the active line is highlighted. The Variables view
- also contains all rule parameters and their value. You can then use the default Java
- debug actions to decide what to do next (resume, terminate, step over, etc.). The
debug
- views can also be used to determine the contents of the working memory and agenda at
- that time as well (you don't have to select a working memory now, the current
executing
- working memory is automatically shown).</para>
-
-
- </section>
-</chapter>
-
-
-<chapter id="editors"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/editors.xml"
xreflabel="editors">
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Drools Tools</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Editors</title>
-
- <section id="textual_rule_editor">
- <title>The Rule Editor</title>
-
- <para>The <property moreinfo="none">Rule
editor</property> works on files that have a <emphasis>
- <property moreinfo="none">.drl</property>
- </emphasis> (or <emphasis>
- <property moreinfo="none">.rule</property>
- </emphasis> in the case of spreading rules across multiple rule files)
extension.</para>
-
- <figure float="0">
- <title>New Rule</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The editor follows the pattern of a normal text editor in eclipse,
with all the normal
- features of a text editor:</para>
-
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="rules_editor_content_assist">Content
Assist</link>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <link linkend="rules_editor_code_folding">Code
Folding</link>
- </para>
- </listitem>
-
- <!-- <listitem>
- <para>
- <link linkend="rules_editor_error_reporting">Error
Reporting</link>
- </para>
- </listitem>-->
-
- <listitem>
- <para>
- <link
linkend="rules_editor_sync_with_outline">Synchronization with Outline
- View</link>
- </para>
- </listitem>
- </itemizedlist>
-
- <section id="rules_editor_content_assist">
- <title>Content Assist</title>
-
- <para>While working in the <property
moreinfo="none">Rule editor</property> you can get a content
- assistance the usual way by pressing <emphasis>
- <property moreinfo="none">Ctrl +
Space</property>.</emphasis></para>
-
- <para>Content Assist shows all possible keywords for the current cursor
position.</para>
-
- <figure float="0">
- <title>Content Assist Demonstration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Content Assist inside of the <emphasis>
- <property moreinfo="none">Message</property>
- </emphasis> suggests all available fields.</para>
-
- <figure float="0">
- <title>Content Assist Demonstration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="rules_editor_code_folding">
- <title>Code Folding</title>
-
- <para>Code folding is also available in the <property
moreinfo="none">Rule editor</property>. To
- hide/show sections of the file use the icons with minus/plus on the left
vertical
- line of the editor.</para>
-
- <figure float="0">
- <title>Code Folding</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <!--section id="rules_editor_error_reporting">
- <title>Error Reporting</title>
-
- </section-->
-
- <section id="rules_editor_sync_with_outline">
- <title>Synchronization with Outline View</title>
-
- <para>The <property moreinfo="none">Rule
editor</property> works in synchronization with the
- <property moreinfo="none">Outline
view</property> which shows the structure of the rules,
- imports in the file and also globals and functions if the file has
them.</para>
-
- <figure float="0">
- <title>Synchronization with Outline View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The view is updated on save. It provides a quick way of
navigating around rules by
- names in a file which may have hundreds of rules. The items are sorted
- alphabetically by default.</para>
- </section>
-
- <section id="rete_view">
- <title>The Rete Tree View</title>
-
- <para>The <property moreinfo="none">Rete Tree
view</property> shows you the current Rete Network for
- your <emphasis>
- <property moreinfo="none">.drl</property>
- </emphasis> file. Just click on the <emphasis>
- <property moreinfo="none">Rete Tree
tab</property>
- </emphasis> at the bottom of the <property
moreinfo="none">Rule editor</property>.</para>
-
- <figure float="0">
- <title>Rete Tree</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Afterwards you can generate the current Rete Network
visualization. You can push
- and pull the nodes to arrange your optimal network
overview.</para>
- <para>If you got hundreds of nodes, select some of them with a frame.
Then you can pull
- groups of them.</para>
-
- <figure float="0">
- <title>Selecting the nodes in the Rete Tree with
Frame</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can zoom in and out the Rete tree in case not all nodes are
shown in the
- current view. For this use the combo box or "+" and
"-" icons on the toolbar.</para>
-
- <figure float="0">
- <title>Rete Tree Zooming</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/editors/editors8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>The <property moreinfo="none">Rete Tree
view</property> works only in Drools Rule Projects,
- where the Drools Builder is set in the project
properties.</para>
- </note>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss BPMN Convert module. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
- </section>
-
- </section>
-
-</chapter>
-
-
-
-</book>
+]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>Drools Tools Reference Guide</title>
+
+
<author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 5.0.0.CR1
+ </diffmk:wrapper></releaseinfo>
+<abstract>
+ <title></title>
+ <para>
+ <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_...
version</ulink>
+ </para>
+</abstract>
+
+ </bookinfo>
+
+
+ <toc></toc>
+
+<chapter id="introduction"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/introduction.xml"
xreflabel="introduction">
+ <title>Introduction</title>
+
+ <section id="whatisDrools">
+ <title>What is Drools?</title>
+
+ <para><property moreinfo="none">Drools</property> is
a business rule management system (BRMS) with a forward
+ chaining inference based rules engine, more correctly known as a production
rule system,
+ using an enhanced implementation of the Rete algorithm.</para>
+
+ <para><diffmk:wrapper diffmk:change="changed"> In this
guide we are going to get you familiar with Drools Eclipse plugin which
+ provides development tools for creating, executing and debugging Drools
processes and
+ rules from within Eclipse.</diffmk:wrapper></para>
+
+ <note>
+ <title>Note:</title>
+ <para>It is assumed that you has some familiarity with rule engines and
Drools in
+ particular. If no, we suggest that you look carefully through the
<ulink
url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_sing...
Documentation</ulink>.</para>
+ </note>
+
+ <para><property moreinfo="none">Drools
Tools</property> come bundled with <property moreinfo="none">JBoss
Tools</property>
+ set of Eclipse plugins. How to install <property
moreinfo="none">JBoss Tools</property><diffmk:wrapper
diffmk:change="changed"> you can find in
+ the </diffmk:wrapper><ulink
url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">Getting
Started Guide</ulink>.</para>
+ </section>
+
+ <section id="drools_key_features">
+ <title>Drools Tools Key Features</title>
+
+ <para>The following table lists all valuable features of the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Drools
+ Tools</diffmk:wrapper></property>.</para>
+ <table>
+ <title>Key Functionality of Drools Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2"
colwidth="5*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="1*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>Wizard for creating a new Drools
Project</para>
+ </entry>
+ <entry>
+ <para>The wizard allows to create a sample project to
easy get started
+ with Drools</para>
+ </entry>
+ <entry>
+ <link
linkend="sample_drools_project">Creating a Sample Drools
+ Project</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Wizards for creation new Drools
resources</para>
+ </entry>
+ <entry>
+ <para>A set of wizards are provided with the Drools
Eclipse tools to
+ quickly create a new Rule resource, a new Domain Specific
language,
+ Decision Table and Business rule</para>
+ </entry>
+ <entry>
+ <link linkend="creating_rule">Creating a New
Rule</link>
+ <!--link linkend="creating_dsl">Creating a
New DSL</link>
+ <link
linkend="creating_decision_table">Creating a New Decision
+ Table</link>
+ <link
linkend="creating_business_rule">Creating a New Business
+ Rule</link-->
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>The Rule editor</para>
+ </entry>
+ <entry>
+ <para>An editor that is aware of DRL syntax and
provides content
+ assistance and synchronizing with the Outline
view</para>
+ </entry>
+ <entry>
+ <link linkend="textual_rule_editor">The Rule
Editor</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>The Domain Specific Language editor</para>
+ </entry>
+ <entry>
+ <para>The editor allows to create and manage mappings
from users
+ language to the rule language</para>
+ </entry>
+ <entry>
+ <!--link linkend="dsl_editor">The Domain
Specific Language Editor</link-->
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>The Guided editor</para>
+ </entry>
+ <entry>
+ <para>This guided editor for rules allows you to build
rules in a GUI
+ driven fashion based on your object model</para>
+ </entry>
+ <entry>
+ <!--link linkend="guided_editor">The Guided
Editor</link-->
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>The Rule Flow graphical editor</para>
+ </entry>
+ <entry>
+ <para>The editor is meant for editing visual graphs
which represent a
+ process (a rule flow)</para>
+ </entry>
+ <entry>
+ <!--link linkend="ruleflow_editor">The Rule
Flow Graphical Editor</link-->
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Drools on <ulink
url="http://www.jboss.org/drools/">JBoss.org</ulink>&l...
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink
url="http://www.jboss.org/tools/">JBoss Tools
Home Page</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
+ JBossTools/JBDS documentation builds</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">All
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss
Tools/JBDS</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> documentation you can find on the
+ </diffmk:wrapper><ulink diffmk:change="added"
url="http://docs.jboss.org/tools/"><diffmk:wrapper
diffmk:change="added">documentation release
+ page</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+</chapter>
+
+
+<chapter id="create_new_project"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/create_new_project.xml"
xreflabel="create_new_project">
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Drools Tools</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Creating a New Drools Project</title>
+
+ <para>In this chapter we are going to show you how to setup an executable
sample Drools project
+ to start using rules immediately.</para>
+
+
+
+ <section id="sample_drools_project">
+ <title>Creating a Sample Drools Project</title>
+
+ <para>First, we suggest that you use <property
moreinfo="none">Drools perspective</property> which is aimed
+ at work with Drools specific resources.</para>
+
+ <para>To create a new Drools project follow to <emphasis>
+ <property moreinfo="none">File > New >
Drools Project</property>. </emphasis> This will open
+ <property moreinfo="none">New Drools Project
wizard</property> like on the figure below.</para>
+
+ <para>On the first page type the project name and click
+ <emphasis><property
moreinfo="none">Next</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Creating a New Drools Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next you have a choice to add some default artifacts to it like
sample rules, decision
+ tables or ruleflows and Java classes for them. Let's select first two
check
+ boxes and press <emphasis>
+ <property moreinfo="none">Next</property>.
</emphasis></para>
+
+ <figure float="0">
+ <title>Selecting Drools Project Elements</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next page asks you to specify a Drools runtime. If you have not yet
set it up, you
+ should do this now by clicking the <emphasis>
+ <property moreinfo="none">Configure Workspace
Settings</property>
+ </emphasis> link.</para>
+
+ <figure float="0">
+ <title>Configuring Drools Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You should see the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Preferences
window</diffmk:wrapper></property> where you can configure the
+ workspace settings for Drools runtimes. To create a new runtime, press the
<emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button. The appeared dialog prompts you to enter a
+ name for a new runtime and a path to the Drools runtime on your file
system.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>A Drools runtime is a collection of jars on your file system that
represent one
+ specific release of the Drools project jars. While creating a new
runtime, you must
+ either point to the release of your choice, or you can simply create a
new runtime
+ on your file system from the jars included in the Drools Eclipse
plugin.</para>
+ </note>
+
+ <figure float="0">
+ <title>Adding a New Drools Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Let's simply create a new Drools 5 runtime from the jars embedded
in the
+ Drools Eclipse plugin. Thus, you should press <emphasis>
+ <property moreinfo="none">Create a new Drools 5
runtime</property>
+ </emphasis> button and select the folder where you want this runtime to
be created and
+ hit <emphasis>
+ <property
moreinfo="none">OK</property>.</emphasis></para>
+
+ <para>You will see the newly created runtime show up in your list of Drools
runtimes. Check
+ it and press <emphasis>
+ <property
moreinfo="none">OK</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Selecting a Drools Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Now press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to complete the project creation.</para>
+
+ <figure float="0">
+ <title>Completing the Drools Project Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>This will setup a basic structure, classpath and sample rules and
test case to get you
+ started.</para>
+ </section>
+
+
+ <section id="structure_overview">
+ <title>Drools Project Structure Overview</title>
+
+ <para>Now let's look at the structure of the organized project. In the
+ <property moreinfo="none">Package
Explorer</property> you should see the following:</para>
+
+ <figure float="0">
+ <title>Drools Project in the Package Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The newly created project contains an example rule file
<emphasis>
+ <property moreinfo="none">Sample.drl</property>
+ </emphasis> in the <emphasis>
+ <property
moreinfo="none">src/main/rules</property>
+ </emphasis> directory and an example java file <emphasis>
+ <property
moreinfo="none">DroolsTest.java</property>
+ </emphasis> that can be used to execute the rules in a Drools engine in
the folder <emphasis>
+ <property moreinfo="none">src/main/java</property>
+ </emphasis>, in the <emphasis>
+ <property moreinfo="none">com.sample</property>
+ </emphasis> package. All the others jar's that are necessary during
execution
+ are also added to the classpath in a custom classpath container called
<property moreinfo="none">Drools
+ Library</property>.</para>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Rules do not have to be kept in Java projects at all, this is
just a convenience
+ for people who are already using eclipse as their Java IDE.</para>
+ </tip>
+
+ </section>
+
+ <section id="creating_rule">
+ <title>Creating a New Rule</title>
+
+ <para>Now we are going to add a new Rule resource to the
project.</para>
+
+ <para>You can either create an empty text <emphasis>
+ <property moreinfo="none">.drl</property>
+ </emphasis> file or make use of the special <property
moreinfo="none">New Rule Resource
+ wizard</property> to do it.</para>
+
+ <para>To open the wizard follow to <emphasis>
+ <property moreinfo="none">File > New > Rule
Resource</property>
+ </emphasis> or use the menu with the JBoss Drools icon on the
toolbar.</para>
+
+ <figure float="0">
+ <title>Opening the New Rule Resource Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the wizard page first select <emphasis>
+ <property moreinfo="none">/rules</property>
+ </emphasis> as a top level directory to store your rules and type the
rule name. Next
+ it's mandatory to specify the rule package name. It defines a namespace
that
+ groups rules together.</para>
+
+ <figure float="0">
+ <title>New Rule Resource Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As a result the wizard generates a rule skeleton to get you
started.</para>
+
+ <figure float="0">
+ <title>New Rule</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_project/create_new_project10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="debugging_rules"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/debugging_rules.xml"
xreflabel="debugging_rules">
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Drools Tools</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Debugging rules</title>
+
+ <para>This chapter describes how to debug rules during the execution of your
Drools application.</para>
+
+ <section id="creating_breakpoints">
+ <title>Creating Breakpoints</title>
+
+ <para>At first, we'll focus on how to add
+ breakpoints in the consequences of your rules.</para>
+
+ <para>Whenever such a breakpoint is uncounted
+ during the execution of the rules, the execution is halted. It's possible then
inspect the
+ variables known at that point and use any of the default debugging actions to decide
what
+ should happen next (step over, continue, etc). To inspect
+ the content of the working memory and agenda the Debug views can be
used.</para>
+
+ <para>You can add/remove rule breakpoints in <emphasis>
+ <property moreinfo="none">.drl</property>
+ </emphasis> files in two ways, similar to adding breakpoints to Java
files:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Double-click the ruler in the <property
moreinfo="none">Rule editor</property> at the line
+ where you want to add a breakpoint.</para>
+ <tip>
+ <title>Tip:</title>
+ <para>Note that rule breakpoints can only be created in the consequence of a
+ rule. Double-clicking on a line where no breakpoint is allowed will do
+ nothing.</para>
+ </tip>
+ <para>A breakpoint can be removed by double-clicking the ruler once more.
</para>
+ </listitem>
+
+ <listitem>
+ <para>Right-click the ruler. Select <emphasis>
+ <property moreinfo="none">Toggle Breakpoint</property>
+ </emphasis> action in the appeared popup menu. Clicking the action will add a
+ breakpoint at the selected line or remove it if there is one already.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Adding Breakpoints</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/debugging_rules/debugging_rules1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The <property moreinfo="none">Debug
perspective</property> contains a <property
moreinfo="none">Breakpoints
+ view</property> which can be used to see all defined breakpoints, get their
+ properties, enable/disable or remove them, etc. You can switch to it by navigating to
<emphasis>
+ <property moreinfo="none">Window > Perspective > Others
> Debug</property>.</emphasis></para>
+ </section>
+
+ <section id="debugging">
+ <title>Debugging</title>
+
+ <para>Drools breakpoints are only enabled if you debug your application as a
Drools
+ Application. To do this you should perform one of the actions:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select the main class of your application. Right click it and select
<emphasis>
+ <property moreinfo="none">Debug As > Drools
Application</property>.</emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Debugging Drools Application</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/debugging_rules/debugging_rules2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Alternatively, you can also go to <emphasis>
+ <property moreinfo="none">Debug As > Debug
Configuration</property>
+ </emphasis> to open a new dialog for creating, managing and running debug
+ configurations.</para>
+
+ <para>Select the <emphasis>
+ <property moreinfo="none">Drools Application</property>
+ </emphasis> item in the left tree and click the <emphasis>
+ <property moreinfo="none">New launch
configuration</property>
+ </emphasis> button (leftmost icon in the toolbar above the tree). This will
+ create a new configuration and already fill in some of the properties (like the
+ Project and Main class) based on main class you selected in the beginning. All
+ properties shown here are the same as any standard Java program.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>New Debug Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/debugging_rules/debugging_rules3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Remember to change the name of your debug configuration to something
meaningful.</para>
+ </tip>
+
+ <para>Next
+ click the <emphasis>
+ <property moreinfo="none">Debug</property>
+ </emphasis> button on the bottom to start debugging your application.
</para>
+
+ <para>After enabling the debugging, the application starts executing and will
halt if
+ any breakpoint is encountered. This can be a Drools rule breakpoint, or any other
+ standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the
+ corresponding <emphasis>
+ <property moreinfo="none">.drl</property></emphasis> file
is opened and the active line is highlighted. The Variables view
+ also contains all rule parameters and their value. You can then use the default Java
+ debug actions to decide what to do next (resume, terminate, step over, etc.). The
debug
+ views can also be used to determine the contents of the working memory and agenda at
+ that time as well (you don't have to select a working memory now, the current
executing
+ working memory is automatically shown).</para>
+
+
+ </section>
+</chapter>
+
+
+<chapter id="editors"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/drools/docs/reference/en/modules/editors.xml"
xreflabel="editors">
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Drools Tools</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Editors</title>
+
+ <section id="textual_rule_editor">
+ <title>The Rule Editor</title>
+
+ <para>The <property moreinfo="none">Rule
editor</property> works on files that have a <emphasis>
+ <property moreinfo="none">.drl</property>
+ </emphasis> (or <emphasis>
+ <property moreinfo="none">.rule</property>
+ </emphasis> in the case of spreading rules across multiple rule files)
extension.</para>
+
+ <figure float="0">
+ <title>New Rule</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The editor follows the pattern of a normal text editor in eclipse,
with all the normal
+ features of a text editor:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="rules_editor_content_assist">Content
Assist</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="rules_editor_code_folding">Code
Folding</link>
+ </para>
+ </listitem>
+
+ <!-- <listitem>
+ <para>
+ <link linkend="rules_editor_error_reporting">Error
Reporting</link>
+ </para>
+ </listitem>-->
+
+ <listitem>
+ <para>
+ <link
linkend="rules_editor_sync_with_outline">Synchronization with Outline
+ View</link>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="rules_editor_content_assist">
+ <title>Content Assist</title>
+
+ <para>While working in the <property
moreinfo="none">Rule editor</property> you can get a content
+ assistance the usual way by pressing <emphasis>
+ <property moreinfo="none">Ctrl +
Space</property>.</emphasis></para>
+
+ <para>Content Assist shows all possible keywords for the current cursor
position.</para>
+
+ <figure float="0">
+ <title>Content Assist Demonstration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Content Assist inside of the <emphasis>
+ <property moreinfo="none">Message</property>
+ </emphasis> suggests all available fields.</para>
+
+ <figure float="0">
+ <title>Content Assist Demonstration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="rules_editor_code_folding">
+ <title>Code Folding</title>
+
+ <para>Code folding is also available in the <property
moreinfo="none">Rule editor</property>. To
+ hide/show sections of the file use the icons with minus/plus on the left
vertical
+ line of the editor.</para>
+
+ <figure float="0">
+ <title>Code Folding</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <!--section id="rules_editor_error_reporting">
+ <title>Error Reporting</title>
+
+ </section-->
+
+ <section id="rules_editor_sync_with_outline">
+ <title>Synchronization with Outline View</title>
+
+ <para>The <property moreinfo="none">Rule
editor</property> works in synchronization with the
+ <property moreinfo="none">Outline
view</property> which shows the structure of the rules,
+ imports in the file and also globals and functions if the file has
them.</para>
+
+ <figure float="0">
+ <title>Synchronization with Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The view is updated on save. It provides a quick way of
navigating around rules by
+ names in a file which may have hundreds of rules. The items are sorted
+ alphabetically by default.</para>
+ </section>
+
+ <section id="rete_view">
+ <title>The Rete Tree View</title>
+
+ <para>The <property moreinfo="none">Rete Tree
view</property> shows you the current Rete Network for
+ your <emphasis>
+ <property moreinfo="none">.drl</property>
+ </emphasis> file. Just click on the <emphasis>
+ <property moreinfo="none">Rete Tree
tab</property>
+ </emphasis> at the bottom of the <property
moreinfo="none">Rule editor</property>.</para>
+
+ <figure float="0">
+ <title>Rete Tree</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Afterwards you can generate the current Rete Network
visualization. You can push
+ and pull the nodes to arrange your optimal network
overview.</para>
+ <para>If you got hundreds of nodes, select some of them with a frame.
Then you can pull
+ groups of them.</para>
+
+ <figure float="0">
+ <title>Selecting the nodes in the Rete Tree with
Frame</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can zoom in and out the Rete tree in case not all nodes are
shown in the
+ current view. For this use the combo box or "+" and
"-" icons on the toolbar.</para>
+
+ <figure float="0">
+ <title>Rete Tree Zooming</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/editors/editors8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>The <property moreinfo="none">Rete Tree
view</property> works only in Drools Rule Projects,
+ where the Drools Builder is set in the project
properties.</para>
+ </note>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss BPMN Convert module. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+
+ </section>
+
+</chapter>
+
+
+
+</book>
Modified: trunk/esb/docs/esb_ref_guide/en/master_output.xml
===================================================================
--- trunk/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-08 12:20:47 UTC (rev 15137)
+++ trunk/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-08 12:36:11 UTC (rev 15138)
@@ -18,877 +18,877 @@
<!ENTITY strutsreflink
"../../struts_tools_ref_guide/html_single/index.html">
<!ENTITY strutstutoriallink
"../../struts_tools_tutorial/html_single/index.html">
-]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>ESB Tools Reference Guide</title>
-
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
-
<author><firstname>Tatyana</firstname><surname>Romanovich</surname></author>
-
- <pubdate>April 2008</pubdate>
- <copyright>
- <year>2007</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.1.GA
- </diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_gu...
version</ulink>
- </para>
-</abstract>
-
-</bookinfo>
- <toc></toc>
-
-
-<chapter id="introduction"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml">
- <?dbhtml filename="introduction.html"?>
-
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- <keyword>JBoss Tools</keyword>
- <keyword>JBDS</keyword>
- <keyword>ESB</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Introduction</title>
-
- <section>
-
- <title>What is ESB?</title>
-
- <para>ESB (Enterprise Service Bus) - an abstraction layer on top of
implementation of an
- enterprise messaging system that provides the features Service Oriented
- Architectures may be implemented with.</para>
- <para>If you want to develop applications using ESB technology JBoss ESB
also meets your
- needs. The JBoss Tools provide an ESB editor and all necessary wizards for
creating an ESB
- file.</para>
- <para>In this guide we provide you with the information on JBoss ESB
support (installation, configuration and deployment) and usage of ESB Editor which allows
you to
- develop an ESB file much faster and with far fewer errors so sparing your
time.</para>
-
- </section>
-
- <section>
- <title>Other relevant resources on the topic</title>
-
- <para>You can find a set of benefits and other extra information
on:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink
url="http://www.jboss.org/jbossesb">JBoss
ESB</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink
url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink
url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB
- Documentation Library</ulink>
- </para>
- </listitem>
- </itemizedlist>
-
- <para>The latest <property moreinfo="none">JBoss
Tools/JBoss Developer Studio</property> documentation
- builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">her...
-
- </section>
-</chapter>
-
-
-<chapter id="esb_support" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml">
- <?dbhtml filename="esb_support.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>ESB</keyword>
- <keyword>Java</keyword>
- <keyword>JBoss</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>ESB Support</title>
-
- <para>In this section we will focus on all concepts that <property
moreinfo="none">JBoss Tools</property>
- integrate for working with JBoss ESB.</para>
-
- <section>
- <title>ESB Tools Installation</title>
-
- <para>This chapter will provide you with the information on how to
install
- JBoss ESB plugin into Eclipse.</para>
-
- <para>ESB Tools come as one module of JBoss Tools project. Since
ESB Tools have a
- dependence on other JBoss Tools modules we recommend you to
install a bundle
- of all <ulink
url="http://labs.jboss.com/tools/download/index.html">JBoss
- Tools plug-ins</ulink>. You can find all necessary
installation instructions on JBoss Wiki in the <ulink
url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal...
section.</para>
- </section>
-
- <section>
- <title>Creating a ESB Project</title>
- <para>In this chapter we suggest a step-by-step walk-through of
creating a new
- ESB project. Let's try to create a new JBoss ESB
project.</para>
-
- <para>We will show you how to use the ESB Project Creation wizard
for creating a new ESB project and setting basic ESB classpath.</para>
-
- <para>Select <emphasis>
- <property moreinfo="none">File
>New > Project...</property>
- </emphasis> in the main menu bar or context menu for
selected project and
- then <emphasis>
- <property moreinfo="none">ESB >
ESB Project</property>
- </emphasis> in the dialog opened:</para>
-
- <figure float="0">
- <title>Select a Wizard dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/01_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property
moreinfo="none">Next</property>
- </emphasis> brings you to the JBoss ESB Project wizard page
where a project name, ESB version and target JBoss Runtime are to be specified. Specify,
for example, <emphasis>
- <property
moreinfo="none">helloworld</property>
- </emphasis> as a Project name and accept the default ESB
version.</para>
- <figure float="0">
- <title>JBoss ESB Project wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/02_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property
moreinfo="none">Next</property>
- </emphasis><diffmk:wrapper
diffmk:change="changed"> brings you to the ESB facet installation page where
you can
- specify Java Source Directory and ESB Content Directory. ESB
Content Directory is a folder that contains the most of
- artifacts that an ESB archive needs. You also can configure ESB
libraries to the project by selecting a ESB runtime using one of the options:
- </diffmk:wrapper></para>
- <para>1. Use <emphasis>
- <property moreinfo="none">Server Supplied
ESB Runtime</property>
- </emphasis>
-
- </para>
- <para> 2. Select a ESB runtime from the JBoss ESB runtime
list predefined in the preferences
- </para>
- <para>If you choose the first option, make sure that the
project has the Target JBoss Runtime set and this runtime has a ESB runtime installed.
- </para>
- <figure float="0">
- <title>Install ESB facet step</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/03_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click <emphasis>
- <property
moreinfo="none">Finish</property>
- </emphasis> and a ESB project with the default
<emphasis><property
moreinfo="none">jboss-esb.xml</property></emphasis>
- will be created. </para>
-
- <figure float="0">
- <title>The generated ESB project structure</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/04_create_esb_project.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section id="ESB_project_wizard" xreflabel="here">
- <title>Creating ESB Project using JBoss Tools Project Examples
Wizard</title>
- <para>JBoss Tools provides a Project Example wizard that is an easy
way for users to create some kinds of projects to be used as examples with some predefined
structure. Let's start
- creating a ESB project using this wizard.</para>
-
- <para>Before creating a ESB project example create JBoss Runtime
with name <emphasis><property moreinfo="none">
- JBoss 4.2 Runtime</property></emphasis>, it will be used by
your ESB project example. </para>
-
- <para>Select <emphasis>
- <property moreinfo="none">File
>New > Others </property>
- </emphasis> , in the main menu bar or context menu for
selected project and
- then <emphasis>
- <property moreinfo="none">JBoss Tools
> Project Examples</property>
- </emphasis> in the New dialog:</para>
-
- <figure float="0">
- <title>Select a wizard - Project Examples</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/05_esb_project_example.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property
moreinfo="none">Next</property>
- </emphasis><diffmk:wrapper
diffmk:change="changed"> brings you to the wizard page where you can select a
ESB project example from the example list.
- Every ESB example has two projects, one is a ESB project and
another is a Java project used to test the ESB
project.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Here is a list of ready examples
available:</diffmk:wrapper></para>
-
- <itemizedlist diffmk:change="added">
-
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
HelloWorld Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates the minimal files necessary to make a
basic ESB component execute as well as to prove that the ESB os properly
configured.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
HelloWorld Action Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates the use of multiple action invocations
from a single configuration. You can use a single Action class and make multiple method
calls or use multiple Action classes.
</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
HelloWorld File Action Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates using the File gateway feature of the
JBoss ESB. Files that are found in a particular directory with a particular extension are
sent to a JMS queue with actions for
processing.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Web Service consumer1 Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to consume a 181 Web Service in an
ESB action.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Web Service producer Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to deploy a JSR181 Webservice
endpoint on JBossESB using the SOAPProcessor
action.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks CSV -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to transform a comma separated
value (CSV) file to an XML.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks XML -> POJO
Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates the use of Smooks performing a simple
transformation by converting an XML file into Java
POJOs.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks XML -> XML date-manipulation
Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to manually define and apply a
Message Transformation within JBoss
ESB.</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks XML -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - a very basic example of how to manually define and
apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a
SampleOrder.xml message and prints the before and after XML to the console.
</diffmk:wrapper></para></listitem>
-
- </itemizedlist>
-
-
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We will take as our example
</diffmk:wrapper><emphasis diffmk:change="added"><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">JBoss ESB HelloWorld
Example</diffmk:wrapper></property> </emphasis><diffmk:wrapper
diffmk:change="added"> ESB and Client
project:</diffmk:wrapper></para>
-
-
- <figure diffmk:change="added" float="0">
- <title>JBoss Tools ESB Project Examples</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/06_esb_project_example.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para><diffmk:wrapper diffmk:change="changed">Choose
them using the Ctrl button and then click
- </diffmk:wrapper><emphasis><property
moreinfo="none">Finish</property></emphasis><diffmk:wrapper
diffmk:change="changed">. As a result you will get two projects
created:</diffmk:wrapper></para>
- <figure float="0">
- <title>JBoss ESB Project Examples: helloworld and
helloworld_testclient</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/07_esb_project_example.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Deploy the HelloWorld ESB project and run a test class in
the client Java project to see the test result in the Console view.</para>
- </section>
-
- <section>
- <title>Deploying a ESB Project</title>
- <para><diffmk:wrapper diffmk:change="changed">In
this chapter you will see how to deploy a ESB project using the WTP deployment
framework.</diffmk:wrapper></para>
-
- <para>Before deploying the project, open the JBoss Server View by
selecting <emphasis><property moreinfo="none">Window > Show
View > Other >
- Server > JBoss Server View</property></emphasis>,
- create a JBoss Server in the Server view and start it, and then right
click the created JBoss server,
- select <emphasis><property moreinfo="none">
</property> Add and Remove Projects</emphasis>,
- and add the ESB projects you want to deploy from the left side to the
right side in the opened dialog. </para>
-
- <figure float="0">
- <title>Add and Remove Projects</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/08_esb_project_deploy.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click <emphasis><property
moreinfo="none">Finish</property> </emphasis> to add the project
to the server.
- You also can drag the ESB project from the Project View to the
server.</para>
-
- <figure float="0">
- <title>JBoss Server View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/09_esb_runtime_new.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus, you have just added the ESB project to the JBoss server
module list. Right click the JBoss Server and select <emphasis><property
moreinfo="none">Publish</property></emphasis><diffmk:wrapper
diffmk:change="added"> to publish the project on the server.
- You can check the deploying result in the Console
view.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Run</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> and </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Debug</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> options work on ESB projects causing a (re)deploy for
a user designated server.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">You can also use the "Finger touch" for a
quick restart of the project without restarting the
server:</diffmk:wrapper></para>
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Finger Touch
button</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/esb_project/23_finger_touch.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The "Finger" touches descriptors dependent on
project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for
jboss-esb.xml in ESB projects.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">You can also deploy your ESB project as an .esb
archive. Right-click on the project, choose </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Export</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added">:</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Export of ESB
project</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/esb_project/24_export_button.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Choose </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">ESB</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> > </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB
File</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> and click </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added">:</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0"><title
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Choosing ESB File</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/esb_project/25_esb_file.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">And finally export the ESB project to the file system:
choose the destination, choose the target runtime if need a specific one and make the
appropriate settings for the archive. Then click </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Finish</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0"><title
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">ESB Export</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/esb_project/26_esb_export.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Your project is deployed as an .esb
archive.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">An ESB archive can be created for ESB projects only. It
is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB
installed.</diffmk:wrapper></para>
-
-
- </section>
-
- <section>
- <title>Creating a ESB File</title>
- <para>In this chapter we suggest a step-by-step walk-through of
creating your own
- simple file. Let's try to organize a new ESB
file.</para>
-
- <para>We will show you how to use the Creation wizard for creating
a new ESB file.</para>
-
- <para>At first you should open any project. Select
<emphasis>
- <property moreinfo="none">File
>New > Other...</property>
- </emphasis> in the main menu bar or context menu for
selected project and
- then <emphasis>
- <property moreinfo="none">ESB >
ESB File</property>
- </emphasis> in the New dialog:</para>
-
- <figure float="0">
- <title>Select a wizard - ESB File</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_support/01_create_esb.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Clicking <emphasis>
- <property
moreinfo="none">Next</property>
- </emphasis> brings you to the wizard page where a folder, a
name and a version for the file should be specified. Choose, for example,
<emphasis>
- <property
moreinfo="none">jboss-esb.xml</property>
- </emphasis> as the name and accept the selected projects
folder and the default
- version.</para>
- <figure float="0">
- <title>Folder, Name and Version for ESB file</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_support/02_create_esb.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus, your file will be created in the selected projects
folder by default. If
- you want to change the folder for your future file click
<emphasis>
- <property
moreinfo="none">Browse...</property>
- </emphasis> button to set needed folder or simply type
it.</para>
-
- <para>Clicking on <emphasis>
- <property
moreinfo="none">Finish</property>
- </emphasis> results in the file being generated. The wizard
creates one xml
- file.</para>
-
- </section>
-
- <section role="updated">
- <title>Configuring ESB Runtime in Preferences</title>
- <para>In this chapter you will know how to predefine a JBoss ESB
runtime on the Preferences page.</para>
-
- <para>You may already know, there are two ways to set JBoss ESB
runtime when creating a ESB project,
- one is to use the project target JBoss runtime, and another is to select
a JBoss ESB runtime predefined in JBoss Tools preferences.
- Let's configure it.</para>
-
- <para>Select <emphasis>
- <property moreinfo="none">Window
>Preferences > JBoss Tools > JBoss ESB Runtime</property>
- </emphasis>, to open the JBoss ESB Runtime Preferences page
where you can add, remove and Edit a JBoss ESB runtime.</para>
-
- <figure float="0">
- <title>JBoss ESB Runtimes</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/10_esb_runtime.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Select <emphasis><property
moreinfo="none">Add</property></emphasis> to open a dialog where
you can specify the JBoss ESB runtime location, name and version number.
- You also can customize the libraries of the runtime by checking
the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime
jars</property> </emphasis> checkbox. </para>
-
- <figure float="0">
- <title>Configure new JBoss ESB Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/11_esb_runtime_new.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The new JBoss ESB Runtime will be configured. Click <emphasis>
<property moreinfo="none">OK</property> </emphasis> to finish
and save the preferences.
- You can use the configuration when creating a JBoss ESB project. </para>
- <para>When a ESB runtime is configured for your ESB project you
are able to change it to any other using the classpath container page for ESB runtime. To
do that, turn to the Package Explorer view and right-click the "JBoss ESB
Runtime" library. Select <emphasis><property
moreinfo="none">Properties</property></emphasis> and a table
listing all available JBoss ESB runtimes will appear:</para>
-
- <figure float="0">
- <title>Classpath Container Page to change ESB
runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/20_classpath_container.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
-
- <para>Choose one of them to set to the ESB project and click
<emphasis><property
moreinfo="none">Ok</property></emphasis>.</para>
- <para>ESB container allows Source and JavaDoc locations to be set
via the Properties dialog on each contained .jar: right-click on any .jar file, select
<emphasis><property
moreinfo="none">Properties</property></emphasis>. Choose
<emphasis><property moreinfo="none">Java Source
Attachment</property></emphasis> and select location (folder, JAR or zip)
containing new source for the chosen .jar using one of the suggested options (workspace,
external folder or file) or enter the path manually:</para>
-
- <figure float="0">
- <title>Classpath Container: Java Source
Attachment</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/21_source.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis><property
moreinfo="none">Apply</property></emphasis> and then on
<emphasis><property
moreinfo="none">Ok</property></emphasis>.</para>
- <para>To change Javadoc Location choose <emphasis><property
moreinfo="none">Javadoc Location</property></emphasis> and
specify URL to the documentation generated by Javadoc. The Javadoc location will contain a
file called <emphasis><property
moreinfo="none">package-list</property></emphasis>:</para>
-
- <figure float="0">
- <title>Classpath Container: Javadoc
Location</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/22_Javadoc.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis><property
moreinfo="none">Apply</property></emphasis> and then on
<emphasis><property
moreinfo="none">Ok</property></emphasis>.</para>
-
- </section>
-
-
- <section id="using_SOA">
- <title>Using and Configuring SOA Platform</title>
-
- <para>In this chapter you will know what is JBoss Enterprise SOA
Platform and how you can configure it to use for your ESB projects. </para>
-
- <para>JBoss Enterprise SOA Platform delivers a flexible,
standards-based platform to integrate applications, SOA services, business events and
automate business processes. The SOA Platform integrates specific versions of JBoss ESB,
jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work
together in a single supported enterprise distribution.</para>
- <para>Having configured JBoss Enterprise SOA Platform for your ESB
project you don't need to install and configure ESB server and runtime as they are
already included.</para>
-
- <para>Check here to find more details on the platform: <ulink
url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA
Platform</ulink> and <ulink
url="http://www.jboss.com/products/platforms/soa/components">... Enterprise
SOA Platform Component Details</ulink>.</para>
- <para>You can find out what is SOA here: <ulink
url="http://www.jboss.org/jbossesb/resources/SOABasics.html">... of
SOA</ulink> and <ulink
url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and
EOA</ulink>.</para>
-
- <para>To configure the JBoss Enterprise SOA platform select
<emphasis>
- <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Window > Preferences > Server >
Runtime Environments</diffmk:wrapper></property></emphasis>, that will
open the Server Runtime Environments Preferences page where you can add, remove and edit a
Server Runtime Environment.</para>
-
- <figure float="0">
- <title>Configure new Server Runtime
Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select <emphasis><property
moreinfo="none">Add</property></emphasis>, choose
<emphasis><property moreinfo="none">JBoss 4.2
Runtime</property></emphasis> as a type of runtime environment, check the
<emphasis><property moreinfo="none">Create a new local
server</property></emphasis> checkbox and click <emphasis><property
moreinfo="none">Next</property></emphasis>:</para>
- <figure float="0">
- <title>Type of Server Runtime Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/14typeOfRuntime.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para><diffmk:wrapper diffmk:change="changed">On
the next step you can specify a name of the server runtime environment and browse to its
location. Click </diffmk:wrapper><emphasis><property
moreinfo="none">Finish</property></emphasis> to add the server
runtime environment.</para>
-
-
- <figure float="0">
- <title>New Server Runtime Environment
Details</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/15AddNew.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Now you have your SOA platform configured. To check the
configuration create a ESB Project using instructions described <xref
linkend="ESB_project_wizard"></xref>. As a result you will have two
projects created:</para>
-
- <figure float="0">
- <title>Helloworld Projects Created</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/16HelloworldProjects.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then you will need to add JBoss ESB libraries to your
projects to configure the SOA server runtime exactly for your projects. Right-click on
your project, select <emphasis><property moreinfo="none">Build Path
> Add Libraries</property></emphasis>:</para>
-
- <figure float="0">
- <title>Add Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/17_Add_new_libraries.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Choose <emphasis><property
moreinfo="none">JBoss ESB Libraries</property></emphasis> and
click <emphasis><property
moreinfo="none">Next</property></emphasis>:</para>
-
- <figure float="0">
- <title>ESB Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/18_select_libraries.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select the necessary runtime to add to the project
classpath:</para>
-
-
- <figure float="0">
- <title>Select a ESB runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_project/19_select_runtime.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click <emphasis><property
moreinfo="none">Finish</property></emphasis>.</para>
- <para>Now you can deploy your Helloworld project to the server and
run a test class in the client Java project to see the test result in the Console
view.</para>
-
-
-
-</section>
-
-
-
-
-
-
-
-
-
-
-</chapter>
-
-
-<chapter id="esb_editor" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml"
xreflabel="esb_editor">
- <?dbhtml filename="esbEditor.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss ESB</keyword>
- <keyword>Editor</keyword>
- <keyword>ESB</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>ESB Editor</title>
-
- <para> ESB editor has lots of useful features, they are described in details in
this chapter. In
- addition you'll get to know with how <property
moreinfo="none">ESB Editor</property> uses combined
- visual and source editing of esb files.</para>
-
- <section id="esb_file" role="updated">
-
- <title>ESB File Editor</title>
- <para><property moreinfo="none">ESB File
Editor</property> is a powerful and customizable tool. ESB File
- Editor allows developing an application using ESB technology.</para>
-
- <para>ESB file editor has two tabs: Tree and Source.</para>
-
- <para>You can switch to Tree. The Tree view for the editor displays all ESB
artifacts in a
- tree format. By selecting any node you can see and edit its properties which
will appear
- in the right-hand area. For example, a Provider:</para>
- <figure float="0">
- <title>Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/01_esb_tree_view.png"
scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can easily switch from Tree to Source by selecting the Source tab
at the bottom of
- the editor and work in <property moreinfo="none">Source
view</property>.</para>
-
- <figure float="0" id="sourceView">
- <title>Source View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/02_esb_source_view.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Source view for the editor displays a text content of the ESB
file. It is always
- synchronized with <property moreinfo="none">Tree
view</property>, so any changes made in one of the
- views will immediately appear in the other.</para>
-
- <para>No matter what view you select, you get full integration with
<property moreinfo="none">Outline
- view</property>. For example, you can work in the Source view with the
help of the
- Outline view. The Outline view shows a tree structure of the ESB file. Simply
select any
- element in the <property moreinfo="none">Outline
view</property> and it will jump to the same place in
- the Source editor, so you can navigate through the source code with Outline
view.</para>
- <figure float="0">
- <title>Outline View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/03_esb_outline_view.png"
scale="70"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Adding, editing or deleting of some artifacts operations are
available right in the
- <property moreinfo="none">Tree view</property> .
Right-click any node and select one of the
- available actions in the context menu. For example, you can easily add a new
Provider:</para>
- <para></para>
- <figure float="0">
- <title>Adding New Provider</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/04_esb_add_provider.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Then you can add Channels and Properties for the
Providers the same way or using the forms with </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Add</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Edit</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> and
- </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Remove</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> buttons to the
right.</diffmk:wrapper></para>
-
- <para>You can easily add a new Service too:</para>
- <figure float="0">
- <title>Adding New Service</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/05_esb_add_service.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The same way you can create a listener for service and other elements
of ESB:</para>
- <figure float="0">
- <title>Adding New Listener for Service</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/06_esb_add_listener.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The same actions can be done in the right part of <property
moreinfo="none">Tree view</property> tab
- (Form editor) using <property
moreinfo="none">Add</property>, <property
moreinfo="none">Edit</property> and
- <property moreinfo="none">Remove</property>
buttons.</para>
-
-
- <para>In order to add a new generic Action to your ESB XML file you should
select the
- Actions node under the Services, then right-click and choose
<emphasis>
- <property moreinfo="none">New > Generic
Action</property>. </emphasis></para>
-
- <figure float="0">
- <title>Adding New Action in the Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/11_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Or instead make use of <emphasis>
- <property moreinfo="none">Add...</property>
- </emphasis> button in the <property
moreinfo="none">Form editor</property> on the left.</para>
- <figure float="0">
- <title>Adding New Action in the Form Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/12_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you can see on the bath figures above, the context menu will also
prompt you to
- insert one of the Actions that are supplied out-of-the-box with <property
moreinfo="none">JBoss
- ESB</property>. After choosing one an appeared <property
moreinfo="none">New Action wizard</property>
- will ask you to fill out a name field and other fields specific for each
Action
- property. For example, for <emphasis>
- <property moreinfo="none">Content Based
Router</property>
- </emphasis> Action the wizard looks as follows:</para>
-
- <figure float="0">
- <title>New Action Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/13_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After confirming creating the Action you can see it in the Tree under
the <emphasis>
- <property moreinfo="none">Actions</property>
- </emphasis> node and preview as well as edit its settings in the
<property moreinfo="none">Form
- editor</property> on the left.</para>
-
- <figure float="0">
- <title>Form Editor for Content Based Router</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/14_esb_editor.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para><property moreinfo="none">ESB editor</property>
can recognize some specific objects. On the figure you
- can see
<emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the
<emphasis>
- <property moreinfo="none">Class</property>
- </emphasis> section.</para>
-
- </section>
-
- <section id="esb_editors_features">
-
- <title>ESB Editors Features</title>
- <para>JBoss ESB tooling has powerful editor features that help you easily
make use of
- content and code assist.</para>
- <para>This last chapter covers capabilities on how you can use ESB
editor.</para>
-
- <section id="ESBsyntaxvalidation84">
-
- <title>ESB syntax validation</title>
- <para>When working in <property moreinfo="none">JBoss
ESB editor</property> you are constantly provided
- with feedback and contextual error checking as you type. In the Source
viewer, if at
- any point a tag is incorrect or incomplete, an error will be indicated
next to the
- line and also in the <property moreinfo="none">Problems
view</property> below.</para>
- </section>
-
- <section id="ESBSupportXMLSchema">
- <title>Support for XML Schema</title>
-
- <para>JBoss ESB Framework fully <link
linkend="sourceView">supports XML files based on
- schemas as well as DTDs</link>.</para>
- <note><title>Note:</title>
- <para>The schema used behind ESB editor now uses the latest version
available (from SOA-P 4.3). This removes the errors/warnings some users have reported
seeing when using SOA-P specific esb.xml files.</para> </note>
-
- </section>
-
- <!--<section id="OpenOnSelection">
-
- <title>OpenOn</title>
-
- <para><property>OpenOn</property> let's you easily
navigate through your
- project without using the Package Explorer view (project tree). With
OpenOn, you can
- simply click on a reference to another file and that file will be
opened.</para>
-
- <para>OpenOn is available for the XML files </para>
-
- <para>Press and hold down the Ctrl key. As you move the mouse
cursor over different
- file references in the file, they display an underline. When you have
the mouse
- cursor over the name of the file you want to open, click and the file
will open
- in its own editor. In this example the managed bean NameBean will
open.</para>
-
- </section>
- -->
-
- <section id="ESBContentAssist">
-
- <title>Content Assist for ESB XML file</title>
-
- <para>When you work with any ESB XML file <property
moreinfo="none">Content Assist</property> is
- available to help you. It provides pop-up tip to help you complete your
code
- statements. It allows you to write your code faster and with more
accuracy. Content
- assist is always available in the Source mode. Simply type
<emphasis>
- <property
moreinfo="none">Ctrl-Space</property>
- </emphasis> to see what is available.</para>
-
- <para>Content Assist for ESB XML file:</para>
- <figure float="0">
- <title>Content Assist for ESB XML file</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/08_esb_features.png"
scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Content Assist for attributes:</para>
- <figure float="0">
- <title>Content Assist for attributes:</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/09_esb_features.png"
scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <!-- </section>
-
- <section id="ContentAssistWithinTreeEditor">
-
- <title>Content Assist within Tree ESB Editor</title>
-
- <para>JBoss Developer Studio also provides Content Assist
when working within the Tree ESB editor.
- Just click
<emphasis><property>Ctrl-Space</property>.</emphasis></para>
- <figure>
- <title>Content Assist in Tree ESB Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata
-
fileref="images/esb_file/09_editors_features.png" scale="85"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section> -->
- </section>
-
- <section
id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing">
-
- <title>Synchronized Source and Visual Editing</title>
-
- <para>ESB file can be edited in either source or extra visual modes at
the same time.</para>
-
- <para>JBoss Tools provide you two different editors to speed your
development: a
- graphical view (<property
moreinfo="none">Tree</property>) and source (<property
moreinfo="none">Source</property>).
- At the same time, you always have full control over esb source file. Any
changes you
- make in the source view will immediately appear in the tree view. Both
views are
- synchronized, you can edit the file in any view.</para>
-
- <figure float="0">
- <title>Two Views are Synchronized</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/esb_editor/10_esb_features.png"
scale="70"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para><diffmk:wrapper diffmk:change="changed">In
summary, this reference supplies you with all necessary information on the
- functionality that JBoss ESB Editor provides for work with JBoss
ESB.</diffmk:wrapper></para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss ESB Tools. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
-
- </section>
- </section>
-</chapter>
-
-
-</book>
+]><book
xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>ESB Tools Reference Guide</title>
+
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
<author><firstname>Tatyana</firstname><surname>Romanovich</surname></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.1.1.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_gu...
version</ulink>
+ </para>
+</abstract>
+
+</bookinfo>
+ <toc></toc>
+
+
+<chapter id="introduction"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml">
+ <?dbhtml filename="introduction.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ <keyword>JBoss Tools</keyword>
+ <keyword>JBDS</keyword>
+ <keyword>ESB</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Introduction</title>
+
+ <section>
+
+ <title>What is ESB?</title>
+
+ <para>ESB (Enterprise Service Bus) - an abstraction layer on top of
implementation of an
+ enterprise messaging system that provides the features Service Oriented
+ Architectures may be implemented with.</para>
+ <para>If you want to develop applications using ESB technology JBoss ESB
also meets your
+ needs. The JBoss Tools provide an ESB editor and all necessary wizards for
creating an ESB
+ file.</para>
+ <para>In this guide we provide you with the information on JBoss ESB
support (installation, configuration and deployment) and usage of ESB Editor which allows
you to
+ develop an ESB file much faster and with far fewer errors so sparing your
time.</para>
+
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <para>You can find a set of benefits and other extra information
on:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink
url="http://www.jboss.org/jbossesb">JBoss
ESB</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink
url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink
url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB
+ Documentation Library</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The latest <property moreinfo="none">JBoss
Tools/JBoss Developer Studio</property> documentation
+ builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">her...
+
+ </section>
+</chapter>
+
+
+<chapter id="esb_support" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml">
+ <?dbhtml filename="esb_support.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>ESB</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>ESB Support</title>
+
+ <para>In this section we will focus on all concepts that <property
moreinfo="none">JBoss Tools</property>
+ integrate for working with JBoss ESB.</para>
+
+ <section>
+ <title>ESB Tools Installation</title>
+
+ <para>This chapter will provide you with the information on how to
install
+ JBoss ESB plugin into Eclipse.</para>
+
+ <para>ESB Tools come as one module of JBoss Tools project. Since
ESB Tools have a
+ dependence on other JBoss Tools modules we recommend you to
install a bundle
+ of all <ulink
url="http://labs.jboss.com/tools/download/index.html">JBoss
+ Tools plug-ins</ulink>. You can find all necessary
installation instructions on JBoss Wiki in the <ulink
url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal...
section.</para>
+ </section>
+
+ <section>
+ <title>Creating a ESB Project</title>
+ <para>In this chapter we suggest a step-by-step walk-through of
creating a new
+ ESB project. Let's try to create a new JBoss ESB
project.</para>
+
+ <para>We will show you how to use the ESB Project Creation wizard
for creating a new ESB project and setting basic ESB classpath.</para>
+
+ <para>Select <emphasis>
+ <property moreinfo="none">File
>New > Project...</property>
+ </emphasis> in the main menu bar or context menu for
selected project and
+ then <emphasis>
+ <property moreinfo="none">ESB >
ESB Project</property>
+ </emphasis> in the dialog opened:</para>
+
+ <figure float="0">
+ <title>Select a Wizard dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/01_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property
moreinfo="none">Next</property>
+ </emphasis> brings you to the JBoss ESB Project wizard page
where a project name, ESB version and target JBoss Runtime are to be specified. Specify,
for example, <emphasis>
+ <property
moreinfo="none">helloworld</property>
+ </emphasis> as a Project name and accept the default ESB
version.</para>
+ <figure float="0">
+ <title>JBoss ESB Project wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/02_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property
moreinfo="none">Next</property>
+ </emphasis><diffmk:wrapper
diffmk:change="changed"> brings you to the ESB facet installation page where
you can
+ specify Java Source Directory and ESB Content Directory. ESB
Content Directory is a folder that contains the most of
+ artifacts that an ESB archive needs. You also can configure ESB
libraries to the project by selecting a ESB runtime using one of the options:
+ </diffmk:wrapper></para>
+ <para>1. Use <emphasis>
+ <property moreinfo="none">Server Supplied
ESB Runtime</property>
+ </emphasis>
+
+ </para>
+ <para> 2. Select a ESB runtime from the JBoss ESB runtime
list predefined in the preferences
+ </para>
+ <para>If you choose the first option, make sure that the
project has the Target JBoss Runtime set and this runtime has a ESB runtime installed.
+ </para>
+ <figure float="0">
+ <title>Install ESB facet step</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/03_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click <emphasis>
+ <property
moreinfo="none">Finish</property>
+ </emphasis> and a ESB project with the default
<emphasis><property
moreinfo="none">jboss-esb.xml</property></emphasis>
+ will be created. </para>
+
+ <figure float="0">
+ <title>The generated ESB project structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/04_create_esb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="ESB_project_wizard" xreflabel="here">
+ <title>Creating ESB Project using JBoss Tools Project Examples
Wizard</title>
+ <para>JBoss Tools provides a Project Example wizard that is an easy
way for users to create some kinds of projects to be used as examples with some predefined
structure. Let's start
+ creating a ESB project using this wizard.</para>
+
+ <para>Before creating a ESB project example create JBoss Runtime
with name <emphasis><property moreinfo="none">
+ JBoss 4.2 Runtime</property></emphasis>, it will be used by
your ESB project example. </para>
+
+ <para>Select <emphasis>
+ <property moreinfo="none">File
>New > Others </property>
+ </emphasis> , in the main menu bar or context menu for
selected project and
+ then <emphasis>
+ <property moreinfo="none">JBoss Tools
> Project Examples</property>
+ </emphasis> in the New dialog:</para>
+
+ <figure float="0">
+ <title>Select a wizard - Project Examples</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/05_esb_project_example.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property
moreinfo="none">Next</property>
+ </emphasis><diffmk:wrapper
diffmk:change="changed"> brings you to the wizard page where you can select a
ESB project example from the example list.
+ Every ESB example has two projects, one is a ESB project and
another is a Java project used to test the ESB
project.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Here is a list of ready examples
available:</diffmk:wrapper></para>
+
+ <itemizedlist diffmk:change="added">
+
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
HelloWorld Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates the minimal files necessary to make a
basic ESB component execute as well as to prove that the ESB os properly
configured.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
HelloWorld Action Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates the use of multiple action invocations
from a single configuration. You can use a single Action class and make multiple method
calls or use multiple Action classes.
</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
HelloWorld File Action Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates using the File gateway feature of the
JBoss ESB. Files that are found in a particular directory with a particular extension are
sent to a JMS queue with actions for
processing.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Web Service consumer1 Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to consume a 181 Web Service in an
ESB action.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Web Service producer Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to deploy a JSR181 Webservice
endpoint on JBossESB using the SOAPProcessor
action.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks CSV -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to transform a comma separated
value (CSV) file to an XML.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks XML -> POJO
Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates the use of Smooks performing a simple
transformation by converting an XML file into Java
POJOs.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks XML -> XML date-manipulation
Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - demonstrates how to manually define and apply a
Message Transformation within JBoss
ESB.</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para
diffmk:change="added"><emphasis diffmk:change="added"
role="bold"><diffmk:wrapper diffmk:change="added">JBoss ESB
Smooks XML -> XML Example</diffmk:wrapper></emphasis><diffmk:wrapper
diffmk:change="added"> - a very basic example of how to manually define and
apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a
SampleOrder.xml message and prints the before and after XML to the console.
</diffmk:wrapper></para></listitem>
+
+ </itemizedlist>
+
+
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We will take as our example
</diffmk:wrapper><emphasis diffmk:change="added"><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">JBoss ESB HelloWorld
Example</diffmk:wrapper></property> </emphasis><diffmk:wrapper
diffmk:change="added"> ESB and Client
project:</diffmk:wrapper></para>
+
+
+ <figure diffmk:change="added" float="0">
+ <title>JBoss Tools ESB Project Examples</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/06_esb_project_example.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para><diffmk:wrapper diffmk:change="changed">Choose
them using the Ctrl button and then click
+ </diffmk:wrapper><emphasis><property
moreinfo="none">Finish</property></emphasis><diffmk:wrapper
diffmk:change="changed">. As a result you will get two projects
created:</diffmk:wrapper></para>
+ <figure float="0">
+ <title>JBoss ESB Project Examples: helloworld and
helloworld_testclient</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/07_esb_project_example.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Deploy the HelloWorld ESB project and run a test class in
the client Java project to see the test result in the Console view.</para>
+ </section>
+
+ <section>
+ <title>Deploying a ESB Project</title>
+ <para><diffmk:wrapper diffmk:change="changed">In
this chapter you will see how to deploy a ESB project using the WTP deployment
framework.</diffmk:wrapper></para>
+
+ <para>Before deploying the project, open the JBoss Server View by
selecting <emphasis><property moreinfo="none">Window > Show
View > Other >
+ Server > JBoss Server View</property></emphasis>,
+ create a JBoss Server in the Server view and start it, and then right
click the created JBoss server,
+ select <emphasis><property moreinfo="none">
</property> Add and Remove Projects</emphasis>,
+ and add the ESB projects you want to deploy from the left side to the
right side in the opened dialog. </para>
+
+ <figure float="0">
+ <title>Add and Remove Projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/08_esb_project_deploy.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click <emphasis><property
moreinfo="none">Finish</property> </emphasis> to add the project
to the server.
+ You also can drag the ESB project from the Project View to the
server.</para>
+
+ <figure float="0">
+ <title>JBoss Server View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/09_esb_runtime_new.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, you have just added the ESB project to the JBoss server
module list. Right click the JBoss Server and select <emphasis><property
moreinfo="none">Publish</property></emphasis><diffmk:wrapper
diffmk:change="added"> to publish the project on the server.
+ You can check the deploying result in the Console
view.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Run</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> and </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Debug</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> options work on ESB projects causing a (re)deploy for
a user designated server.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">You can also use the "Finger touch" for a
quick restart of the project without restarting the
server:</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Finger Touch
button</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/esb_project/23_finger_touch.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The "Finger" touches descriptors dependent on
project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for
jboss-esb.xml in ESB projects.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">You can also deploy your ESB project as an .esb
archive. Right-click on the project, choose </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Export</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added">:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Export of ESB
project</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/esb_project/24_export_button.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Choose </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">ESB</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> > </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">ESB
File</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> and click </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added">:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0"><title
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Choosing ESB File</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/esb_project/25_esb_file.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">And finally export the ESB project to the file system:
choose the destination, choose the target runtime if need a specific one and make the
appropriate settings for the archive. Then click </diffmk:wrapper><emphasis
diffmk:change="added"><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Finish</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0"><title
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">ESB Export</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/esb_project/26_esb_export.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Your project is deployed as an .esb
archive.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">An ESB archive can be created for ESB projects only. It
is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB
installed.</diffmk:wrapper></para>
+
+
+ </section>
+
+ <section>
+ <title>Creating a ESB File</title>
+ <para>In this chapter we suggest a step-by-step walk-through of
creating your own
+ simple file. Let's try to organize a new ESB
file.</para>
+
+ <para>We will show you how to use the Creation wizard for creating
a new ESB file.</para>
+
+ <para>At first you should open any project. Select
<emphasis>
+ <property moreinfo="none">File
>New > Other...</property>
+ </emphasis> in the main menu bar or context menu for
selected project and
+ then <emphasis>
+ <property moreinfo="none">ESB >
ESB File</property>
+ </emphasis> in the New dialog:</para>
+
+ <figure float="0">
+ <title>Select a wizard - ESB File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_support/01_create_esb.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking <emphasis>
+ <property
moreinfo="none">Next</property>
+ </emphasis> brings you to the wizard page where a folder, a
name and a version for the file should be specified. Choose, for example,
<emphasis>
+ <property
moreinfo="none">jboss-esb.xml</property>
+ </emphasis> as the name and accept the selected projects
folder and the default
+ version.</para>
+ <figure float="0">
+ <title>Folder, Name and Version for ESB file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_support/02_create_esb.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, your file will be created in the selected projects
folder by default. If
+ you want to change the folder for your future file click
<emphasis>
+ <property
moreinfo="none">Browse...</property>
+ </emphasis> button to set needed folder or simply type
it.</para>
+
+ <para>Clicking on <emphasis>
+ <property
moreinfo="none">Finish</property>
+ </emphasis> results in the file being generated. The wizard
creates one xml
+ file.</para>
+
+ </section>
+
+ <section role="updated">
+ <title>Configuring ESB Runtime in Preferences</title>
+ <para>In this chapter you will know how to predefine a JBoss ESB
runtime on the Preferences page.</para>
+
+ <para>You may already know, there are two ways to set JBoss ESB
runtime when creating a ESB project,
+ one is to use the project target JBoss runtime, and another is to select
a JBoss ESB runtime predefined in JBoss Tools preferences.
+ Let's configure it.</para>
+
+ <para>Select <emphasis>
+ <property moreinfo="none">Window
>Preferences > JBoss Tools > JBoss ESB Runtime</property>
+ </emphasis>, to open the JBoss ESB Runtime Preferences page
where you can add, remove and Edit a JBoss ESB runtime.</para>
+
+ <figure float="0">
+ <title>JBoss ESB Runtimes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/10_esb_runtime.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Select <emphasis><property
moreinfo="none">Add</property></emphasis> to open a dialog where
you can specify the JBoss ESB runtime location, name and version number.
+ You also can customize the libraries of the runtime by checking
the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime
jars</property> </emphasis> checkbox. </para>
+
+ <figure float="0">
+ <title>Configure new JBoss ESB Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/11_esb_runtime_new.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The new JBoss ESB Runtime will be configured. Click <emphasis>
<property moreinfo="none">OK</property> </emphasis> to finish
and save the preferences.
+ You can use the configuration when creating a JBoss ESB project. </para>
+ <para>When a ESB runtime is configured for your ESB project you
are able to change it to any other using the classpath container page for ESB runtime. To
do that, turn to the Package Explorer view and right-click the "JBoss ESB
Runtime" library. Select <emphasis><property
moreinfo="none">Properties</property></emphasis> and a table
listing all available JBoss ESB runtimes will appear:</para>
+
+ <figure float="0">
+ <title>Classpath Container Page to change ESB
runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/20_classpath_container.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+
+ <para>Choose one of them to set to the ESB project and click
<emphasis><property
moreinfo="none">Ok</property></emphasis>.</para>
+ <para>ESB container allows Source and JavaDoc locations to be set
via the Properties dialog on each contained .jar: right-click on any .jar file, select
<emphasis><property
moreinfo="none">Properties</property></emphasis>. Choose
<emphasis><property moreinfo="none">Java Source
Attachment</property></emphasis> and select location (folder, JAR or zip)
containing new source for the chosen .jar using one of the suggested options (workspace,
external folder or file) or enter the path manually:</para>
+
+ <figure float="0">
+ <title>Classpath Container: Java Source
Attachment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/21_source.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on <emphasis><property
moreinfo="none">Apply</property></emphasis> and then on
<emphasis><property
moreinfo="none">Ok</property></emphasis>.</para>
+ <para>To change Javadoc Location choose <emphasis><property
moreinfo="none">Javadoc Location</property></emphasis> and
specify URL to the documentation generated by Javadoc. The Javadoc location will contain a
file called <emphasis><property
moreinfo="none">package-list</property></emphasis>:</para>
+
+ <figure float="0">
+ <title>Classpath Container: Javadoc
Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/22_Javadoc.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on <emphasis><property
moreinfo="none">Apply</property></emphasis> and then on
<emphasis><property
moreinfo="none">Ok</property></emphasis>.</para>
+
+ </section>
+
+
+ <section id="using_SOA">
+ <title>Using and Configuring SOA Platform</title>
+
+ <para>In this chapter you will know what is JBoss Enterprise SOA
Platform and how you can configure it to use for your ESB projects. </para>
+
+ <para>JBoss Enterprise SOA Platform delivers a flexible,
standards-based platform to integrate applications, SOA services, business events and
automate business processes. The SOA Platform integrates specific versions of JBoss ESB,
jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work
together in a single supported enterprise distribution.</para>
+ <para>Having configured JBoss Enterprise SOA Platform for your ESB
project you don't need to install and configure ESB server and runtime as they are
already included.</para>
+
+ <para>Check here to find more details on the platform: <ulink
url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA
Platform</ulink> and <ulink
url="http://www.jboss.com/products/platforms/soa/components">... Enterprise
SOA Platform Component Details</ulink>.</para>
+ <para>You can find out what is SOA here: <ulink
url="http://www.jboss.org/jbossesb/resources/SOABasics.html">... of
SOA</ulink> and <ulink
url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and
EOA</ulink>.</para>
+
+ <para>To configure the JBoss Enterprise SOA platform select
<emphasis>
+ <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Window > Preferences > Server >
Runtime Environments</diffmk:wrapper></property></emphasis>, that will
open the Server Runtime Environments Preferences page where you can add, remove and edit a
Server Runtime Environment.</para>
+
+ <figure float="0">
+ <title>Configure new Server Runtime
Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select <emphasis><property
moreinfo="none">Add</property></emphasis>, choose
<emphasis><property moreinfo="none">JBoss 4.2
Runtime</property></emphasis> as a type of runtime environment, check the
<emphasis><property moreinfo="none">Create a new local
server</property></emphasis> checkbox and click <emphasis><property
moreinfo="none">Next</property></emphasis>:</para>
+ <figure float="0">
+ <title>Type of Server Runtime Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/14typeOfRuntime.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">On
the next step you can specify a name of the server runtime environment and browse to its
location. Click </diffmk:wrapper><emphasis><property
moreinfo="none">Finish</property></emphasis> to add the server
runtime environment.</para>
+
+
+ <figure float="0">
+ <title>New Server Runtime Environment
Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/15AddNew.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now you have your SOA platform configured. To check the
configuration create a ESB Project using instructions described <xref
linkend="ESB_project_wizard"></xref>. As a result you will have two
projects created:</para>
+
+ <figure float="0">
+ <title>Helloworld Projects Created</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/16HelloworldProjects.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Then you will need to add JBoss ESB libraries to your
projects to configure the SOA server runtime exactly for your projects. Right-click on
your project, select <emphasis><property moreinfo="none">Build Path
> Add Libraries</property></emphasis>:</para>
+
+ <figure float="0">
+ <title>Add Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/17_Add_new_libraries.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Choose <emphasis><property
moreinfo="none">JBoss ESB Libraries</property></emphasis> and
click <emphasis><property
moreinfo="none">Next</property></emphasis>:</para>
+
+ <figure float="0">
+ <title>ESB Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/18_select_libraries.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select the necessary runtime to add to the project
classpath:</para>
+
+
+ <figure float="0">
+ <title>Select a ESB runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_project/19_select_runtime.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click <emphasis><property
moreinfo="none">Finish</property></emphasis>.</para>
+ <para>Now you can deploy your Helloworld project to the server and
run a test class in the client Java project to see the test result in the Console
view.</para>
+
+
+
+</section>
+
+
+
+
+
+
+
+
+
+
+</chapter>
+
+
+<chapter id="esb_editor" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml"
xreflabel="esb_editor">
+ <?dbhtml filename="esbEditor.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss ESB</keyword>
+ <keyword>Editor</keyword>
+ <keyword>ESB</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>ESB Editor</title>
+
+ <para> ESB editor has lots of useful features, they are described in details in
this chapter. In
+ addition you'll get to know with how <property
moreinfo="none">ESB Editor</property> uses combined
+ visual and source editing of esb files.</para>
+
+ <section id="esb_file" role="updated">
+
+ <title>ESB File Editor</title>
+ <para><property moreinfo="none">ESB File
Editor</property> is a powerful and customizable tool. ESB File
+ Editor allows developing an application using ESB technology.</para>
+
+ <para>ESB file editor has two tabs: Tree and Source.</para>
+
+ <para>You can switch to Tree. The Tree view for the editor displays all ESB
artifacts in a
+ tree format. By selecting any node you can see and edit its properties which
will appear
+ in the right-hand area. For example, a Provider:</para>
+ <figure float="0">
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/01_esb_tree_view.png"
scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can easily switch from Tree to Source by selecting the Source tab
at the bottom of
+ the editor and work in <property moreinfo="none">Source
view</property>.</para>
+
+ <figure float="0" id="sourceView">
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/02_esb_source_view.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Source view for the editor displays a text content of the ESB
file. It is always
+ synchronized with <property moreinfo="none">Tree
view</property>, so any changes made in one of the
+ views will immediately appear in the other.</para>
+
+ <para>No matter what view you select, you get full integration with
<property moreinfo="none">Outline
+ view</property>. For example, you can work in the Source view with the
help of the
+ Outline view. The Outline view shows a tree structure of the ESB file. Simply
select any
+ element in the <property moreinfo="none">Outline
view</property> and it will jump to the same place in
+ the Source editor, so you can navigate through the source code with Outline
view.</para>
+ <figure float="0">
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/03_esb_outline_view.png"
scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Adding, editing or deleting of some artifacts operations are
available right in the
+ <property moreinfo="none">Tree view</property> .
Right-click any node and select one of the
+ available actions in the context menu. For example, you can easily add a new
Provider:</para>
+ <para></para>
+ <figure float="0">
+ <title>Adding New Provider</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/04_esb_add_provider.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Then you can add Channels and Properties for the
Providers the same way or using the forms with </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Add</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Edit</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> and
+ </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Remove</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> buttons to the
right.</diffmk:wrapper></para>
+
+ <para>You can easily add a new Service too:</para>
+ <figure float="0">
+ <title>Adding New Service</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/05_esb_add_service.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The same way you can create a listener for service and other elements
of ESB:</para>
+ <figure float="0">
+ <title>Adding New Listener for Service</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/06_esb_add_listener.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The same actions can be done in the right part of <property
moreinfo="none">Tree view</property> tab
+ (Form editor) using <property
moreinfo="none">Add</property>, <property
moreinfo="none">Edit</property> and
+ <property moreinfo="none">Remove</property>
buttons.</para>
+
+
+ <para>In order to add a new generic Action to your ESB XML file you should
select the
+ Actions node under the Services, then right-click and choose
<emphasis>
+ <property moreinfo="none">New > Generic
Action</property>. </emphasis></para>
+
+ <figure float="0">
+ <title>Adding New Action in the Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/11_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Or instead make use of <emphasis>
+ <property moreinfo="none">Add...</property>
+ </emphasis> button in the <property
moreinfo="none">Form editor</property> on the left.</para>
+ <figure float="0">
+ <title>Adding New Action in the Form Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/12_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As you can see on the bath figures above, the context menu will also
prompt you to
+ insert one of the Actions that are supplied out-of-the-box with <property
moreinfo="none">JBoss
+ ESB</property>. After choosing one an appeared <property
moreinfo="none">New Action wizard</property>
+ will ask you to fill out a name field and other fields specific for each
Action
+ property. For example, for <emphasis>
+ <property moreinfo="none">Content Based
Router</property>
+ </emphasis> Action the wizard looks as follows:</para>
+
+ <figure float="0">
+ <title>New Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/13_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After confirming creating the Action you can see it in the Tree under
the <emphasis>
+ <property moreinfo="none">Actions</property>
+ </emphasis> node and preview as well as edit its settings in the
<property moreinfo="none">Form
+ editor</property> on the left.</para>
+
+ <figure float="0">
+ <title>Form Editor for Content Based Router</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/14_esb_editor.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><property moreinfo="none">ESB editor</property>
can recognize some specific objects. On the figure you
+ can see
<emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the
<emphasis>
+ <property moreinfo="none">Class</property>
+ </emphasis> section.</para>
+
+ </section>
+
+ <section id="esb_editors_features">
+
+ <title>ESB Editors Features</title>
+ <para>JBoss ESB tooling has powerful editor features that help you easily
make use of
+ content and code assist.</para>
+ <para>This last chapter covers capabilities on how you can use ESB
editor.</para>
+
+ <section id="ESBsyntaxvalidation84">
+
+ <title>ESB syntax validation</title>
+ <para>When working in <property moreinfo="none">JBoss
ESB editor</property> you are constantly provided
+ with feedback and contextual error checking as you type. In the Source
viewer, if at
+ any point a tag is incorrect or incomplete, an error will be indicated
next to the
+ line and also in the <property moreinfo="none">Problems
view</property> below.</para>
+ </section>
+
+ <section id="ESBSupportXMLSchema">
+ <title>Support for XML Schema</title>
+
+ <para>JBoss ESB Framework fully <link
linkend="sourceView">supports XML files based on
+ schemas as well as DTDs</link>.</para>
+ <note><title>Note:</title>
+ <para>The schema used behind ESB editor now uses the latest version
available (from SOA-P 4.3). This removes the errors/warnings some users have reported
seeing when using SOA-P specific esb.xml files.</para> </note>
+
+ </section>
+
+ <!--<section id="OpenOnSelection">
+
+ <title>OpenOn</title>
+
+ <para><property>OpenOn</property> let's you easily
navigate through your
+ project without using the Package Explorer view (project tree). With
OpenOn, you can
+ simply click on a reference to another file and that file will be
opened.</para>
+
+ <para>OpenOn is available for the XML files </para>
+
+ <para>Press and hold down the Ctrl key. As you move the mouse
cursor over different
+ file references in the file, they display an underline. When you have
the mouse
+ cursor over the name of the file you want to open, click and the file
will open
+ in its own editor. In this example the managed bean NameBean will
open.</para>
+
+ </section>
+ -->
+
+ <section id="ESBContentAssist">
+
+ <title>Content Assist for ESB XML file</title>
+
+ <para>When you work with any ESB XML file <property
moreinfo="none">Content Assist</property> is
+ available to help you. It provides pop-up tip to help you complete your
code
+ statements. It allows you to write your code faster and with more
accuracy. Content
+ assist is always available in the Source mode. Simply type
<emphasis>
+ <property
moreinfo="none">Ctrl-Space</property>
+ </emphasis> to see what is available.</para>
+
+ <para>Content Assist for ESB XML file:</para>
+ <figure float="0">
+ <title>Content Assist for ESB XML file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/08_esb_features.png"
scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Content Assist for attributes:</para>
+ <figure float="0">
+ <title>Content Assist for attributes:</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/09_esb_features.png"
scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <!-- </section>
+
+ <section id="ContentAssistWithinTreeEditor">
+
+ <title>Content Assist within Tree ESB Editor</title>
+
+ <para>JBoss Developer Studio also provides Content Assist
when working within the Tree ESB editor.
+ Just click
<emphasis><property>Ctrl-Space</property>.</emphasis></para>
+ <figure>
+ <title>Content Assist in Tree ESB Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+
fileref="images/esb_file/09_editors_features.png" scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section> -->
+ </section>
+
+ <section
id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing">
+
+ <title>Synchronized Source and Visual Editing</title>
+
+ <para>ESB file can be edited in either source or extra visual modes at
the same time.</para>
+
+ <para>JBoss Tools provide you two different editors to speed your
development: a
+ graphical view (<property
moreinfo="none">Tree</property>) and source (<property
moreinfo="none">Source</property>).
+ At the same time, you always have full control over esb source file. Any
changes you
+ make in the source view will immediately appear in the tree view. Both
views are
+ synchronized, you can edit the file in any view.</para>
+
+ <figure float="0">
+ <title>Two Views are Synchronized</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/esb_editor/10_esb_features.png"
scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">In
summary, this reference supplies you with all necessary information on the
+ functionality that JBoss ESB Editor provides for work with JBoss
ESB.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss ESB Tools. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+
+ </section>
+ </section>
+</chapter>
+
+
+</book>
Modified: trunk/hibernatetools/docs/reference/en/master_output.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en/master_output.xml 2009-05-08 12:20:47 UTC (rev
15137)
+++ trunk/hibernatetools/docs/reference/en/master_output.xml 2009-05-08 12:36:11 UTC (rev
15138)
@@ -5244,7 +5244,7 @@
<para>The rest chapters have shown the aspects of using the <property
moreinfo="none">Hibernate
Tools</property> via Ant tasks.</para>
- <para>Please, visit <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
+ <para>Please, visit <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
Tools Users Forum</ulink> to leave questions or/and suggestions on the
topic. Your
feedback is always appreciated.</para>
</section>
Modified: trunk/jbpm/docs/converter_ref/en/master_output.xml
===================================================================
--- trunk/jbpm/docs/converter_ref/en/master_output.xml 2009-05-08 12:20:47 UTC (rev
15137)
+++ trunk/jbpm/docs/converter_ref/en/master_output.xml 2009-05-08 12:36:11 UTC (rev
15138)
@@ -159,7 +159,7 @@
</imageobject>
</mediaobject>
</figure>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss BPMN Convert module. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">We hope, this guide helped you to get started with the
JBoss BPMN Convert module. Besides, for additional information you are welcome on
</diffmk:wrapper><ulink diffmk:change="added"
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
diffmk:change="added">JBoss
forum</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
</section>
</chapter>