12:48 p.m.
Author: ochikvina
Date: 2010-02-17 13:48:36 -0500 (Wed, 17 Feb 2010)
New Revision: 20328
Modified:
trunk/as/docs/reference/en/master.xml
trunk/as/docs/reference/en/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1"
/></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected
master_output file</p>
</body></html>
Modified: trunk/as/docs/reference/en/master.xml
===================================================================
--- trunk/as/docs/reference/en/master.xml 2010-02-17 18:47:13 UTC (rev 20327)
+++ trunk/as/docs/reference/en/master.xml 2010-02-17 18:48:36 UTC (rev 20328)
@@ -45,14 +45,14 @@
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
<copyright>
- <year>2007</year>
- <year>2008</year>
- <year>2009</year>
+ <year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
<year>2010</year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 2.1.0.CR1
+ Version: 2.1.0.CR2
</releaseinfo>
<abstract>
<title/>
Modified: trunk/as/docs/reference/en/master_output.xml
===================================================================
--- trunk/as/docs/reference/en/master_output.xml 2010-02-17 18:47:13 UTC (rev 20327)
+++ trunk/as/docs/reference/en/master_output.xml 2010-02-17 18:48:36 UTC (rev 20328)
@@ -22,2329 +22,2336 @@
<!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>
- <corpauthor>
- <inlinemediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/jbosstools_logo.png"
format="PNG"></imagedata>
- </imageobject>
- <imageobject role="html">
- <imagedata></imagedata>
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
-
-
<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 by Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 2.1.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="quick_start" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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>.</para>
-
- <section id="JBoss_server_key_features">
- <title>Key Features of JBoss Server</title>
- <para>For a start, we propose you to look through the table of main features of
JBoss Server:</para>
-
- <table>
-
- <title><diffmk:wrapper diffmk:change="changed">Key
Functionality for JBoss AS and Archive Tools</diffmk:wrapper></title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1"
colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <colspec align="left" colnum="3"
colwidth="2*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>JBoss AS plugin</para></entry>
- <entry><para>Using WTP, JBoss AS plugin allows working with the
server in run or debug mode. You can easily install runtimes and servers, copy the
existing runtime configuration or configure it up to your
needs.</para></entry>
- <entry>
- <link linkend="runtimes_servers">runtimes and
servers</link>
- </entry>
- </row>
-
- <row>
- <entry><para>JBoss AS Perspective</para></entry>
- <entry><para>It makes managing installed JBoss Server quite easy
and includes the standard Console and Properties views, and specially added Project
archives View and JBoss Server View for that purpose. </para></entry>
- <entry>
- <link linkend="perspective">JBoss AS
perspective</link>
- </entry>
- </row>
-
- <row>
- <entry><para>Modules Deployment</para></entry>
- <entry><para>A number of ways, provided by WTP and JBoss Tools,
to deploy either a project or a single file on the server.</para></entry>
- <entry>
- <link linkend="modules">deploying modules</link>
- </entry>
- </row>
-
- <row>
- <entry><para>TPTP Support</para></entry>
- <entry><para>Test and Performance Tools Platform (TPTP)
profiling.</para></entry>
- <entry>
- <link linkend="tptp_support">TPTP support</link>
- </entry>
- </row>
-
- </tbody>
-
- </tgroup>
- </table>
-
- <para><diffmk:wrapper diffmk:change="changed">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 </diffmk:wrapper><link
linkend="runtimes_servers">Runtimes and Servers in the JBoss AS
plugin</link><diffmk:wrapper diffmk:change="changed">
- chapter.</diffmk:wrapper></para>
-
- <para>To start working with JBoss AS, select a <property
moreinfo="none">JBoss AS Perspective</property><diffmk:wrapper
diffmk:change="changed"> via
- </diffmk:wrapper><emphasis><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Window > Open Perspective > Other
> JBoss
- AS</diffmk:wrapper></property>.</emphasis></para>
- </section>
-
- <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> it and <emphasis>
- <property moreinfo="none">publish</property>
- </emphasis> to the server.</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>If you wish, you can assign a hotkey for the Build Project Archive action.
A key binding can be added
- by navigating to <emphasis>
- <property moreinfo="none">Window > Preferences >
General > Keys</property>.</emphasis></para>
-
- <figure float="0">
- <title>Setting the Hotkey for Build Project Archive Action</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/hotkeys.png"
scale="80"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To perform the building of the project archives, select the project in the
<property moreinfo="none">Package Explorer</property> view and
execute the hotkey combination
- you assigned for this action.</para>
-
- <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>
- </section>
-
- <section diffmk:change="added" id="publishing">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Publishing to JBoss
Server</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The publishing of all the modules added to a Server is
performed automatically when starting a Server.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The automatic publish of the changes made to the
workspace is turned on by default in order to permanently keep
- the workspace in sync with the publish folder. If you need to control when to publish
the changes,
- just disable the automatic publish in the </diffmk:wrapper><link
diffmk:change="added" linkend="server_editor"><diffmk:wrapper
diffmk:change="added">Server
Editor</diffmk:wrapper></link><diffmk:wrapper
diffmk:change="added"> and use the </diffmk:wrapper><emphasis
diffmk:change="added">
- <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Publish
to Server</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> (</diffmk:wrapper><inlinemediaobject
diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/quick_start/publish_button.png"></imagedata>
- </imageobject>
- </inlinemediaobject><diffmk:wrapper diffmk:change="added">)
button which initiates an incremental publish.
- </diffmk:wrapper></para>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">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.</diffmk:wrapper></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">on JBoss Tools release
documentation page</ulink>.</para>
- <para>The latest documentation builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly
builds documentation page</ulink>.</para>
-
- <para>Find out the answers on the frequently asked questions about JBoss AS 5
usage in the
- <ulink
url="http://www.jboss.org/community/wiki/jboss5faq">JBoss5FA...;.
- </para>
-
- <para>The information on how to monitor a remote JBoss Server from Eclipse you
can find in the following
- <ulink
url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFr...
article</ulink>.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="runtimes_servers"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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>JRE</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>Directory</para>
- </entry>
- <entry>
- <para>The path to a directory where the configurations are
installed.</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.</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 to remember
which is
- which.</para>
-
- <para>Press <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to see your new runtime in the list.</para>
- <note>
- <title>Note:</title>
- <para>If you edit the configuration of a runtime, the changes don't
affect the settings of the servers that currently use the runtime.
- To apply the changes to them also,you should double right click the server,
<emphasis>
- <property moreinfo="none">Overview>Runtime
Environment</property> </emphasis>
- ,make sure that necessary configuration is chosen,click
<emphasis><property moreinfo="none">Finish</property>
</emphasis> and then <emphasis><property
moreinfo="none">Save</property></emphasis> button.</para>
- </note>
- </section>
- <section id="CopyRuntime">
- <title>Copying the existing runtime configuration</title>
- <para>While installing a new runtime you can copy the configuration from the
existing one.
- To do this you should perform all the steps in the <link
linkend="InstNewRuntime">previous</link> section except pressing
<emphasis>
- <property
moreinfo="none">Finish</property></emphasis>
- in the New Server Runtime Environment menu .
- </para>
- <para>Make sure that you browse to a valid runtime folder and can see the
list of configurations (all, default, minimal) in the Configuration section .
- Then choose necessary Configuration from the list and click <emphasis>
- <property
moreinfo="none">Copy</property></emphasis>.The next dialog should
appear.
- </para>
- <figure float="0">
- <title>Copy the existing configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_4a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Change the name Click on <emphasis>
- <property
moreinfo="none">Browse</property></emphasis> and select your
configuration location or leave as it's if you want it to be located together with
other runtime configurations.
- </para>
- <figure float="0">
- <title>Copy the existing configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_4b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click<emphasis>
- <property moreinfo="none"> Ok </property></emphasis>and
you should see the next wizard with the just added copied configuration.
-
- </para>
- <figure float="0">
- <title>Runtime with copied configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_4c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Press <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> and you will see your new runtime in the list.
- </para>
- <para>You can also change a configuration of existing runtime to a copied one
in the same way from the <emphasis>
- <property moreinfo="none"> Window > Preferences
</property></emphasis>
- menu <emphasis>
- <property moreinfo="none">Server > Runtime Environments
</property></emphasis>
- and clicking <emphasis>
- <property moreinfo="none">Edit</property></emphasis>.
- </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> <emphasis><property moreinfo="none"> New server
wizard </property></emphasis> allows to name the server appropriately in the
<emphasis><property moreinfo="none">Server name field
</property></emphasis>or you can use a generated default name.If it's
nessecary to restore the default name,after you defined yours, click the Reset default
button(<inlinemediaobject> <imageobject>
- <imagedata
fileref="images/runtimes_servers/runtimes_servers_4d.png"></imagedata>
- </imageobject></inlinemediaobject>).
- 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">Installing a New Runtime
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. </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>Now that we've created our runtimes and servers, we can dwell on
all services
- and tools that JBoss Server Manager provides.</para>
-
- <para>We hope, this guide helped you to get started with the JBoss Tools
server manager. Besides, for additional information you are welcome on <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.</para>
- </section>
- </section>
-
-
-</chapter>
-
-
-<chapter id="perspective" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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> 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.</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>The action for synchronizing the publish
information between
- the server and workspace</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></para>
- <para id="filefilterWiz">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 (see the figures bellow).</para>
- <para>In order to set up a default fileset relative to the concrete
configuration of the server runtime, use the following variable:
- <literal moreinfo="none">${jboss_config}</literal>,
i. e. you should type in the <emphasis>
- <property moreinfo="none">Root
Directory</property></emphasis> something like <literal
moreinfo="none">server/${jboss_config}/</literal>.
- This is implemented in order you can modify the runtime's configuration
and not have to manually update paths.</para>
- <figure float="0">
- <title>New File Filter Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/filesets2_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Notice, that the <emphasis>
- <property
moreinfo="none">Browse</property></emphasis> button still returns
an absolute path:</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>
- <para>If you want to set filesets for some server types, you should
open
- <emphasis><property
moreinfo="none">Window>Preferences</property></emphasis>
- and then select <emphasis><property
moreinfo="none">Server > Default
Filesets</property></emphasis>
- from the categories available on the left.</para>
-
- <figure float="0">
- <title>Deleting the File from the Filesets</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/filesets5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On this preference page you can add a fileset
- to any server type or to all servers at once.To do this you should
select the server type in the combo box and click <emphasis><property
moreinfo="none">Add fileset...</property></emphasis> button.
- In the opened <property moreinfo="none">New File
- Filter wizard</property> follow the steps described
<link linkend="filefilterWiz">before</link> and finally click
<emphasis><property
moreinfo="none">Apply</property></emphasis> button on the
preference page.</para>
- <para>The defined file filter will be automatically added
to new servers during creation.</para>
-
-
- </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> includes XML XPaths where an xpath is a path used
to access some
- specific part of an xml document. </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><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><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> supports drag-n-drop of deployable and
- runnable projects/resources.</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>) file that has been made deployable) will
simply deploy that
- resource directly to the server</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>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.</para>
- </tip>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Under the </diffmk:wrapper><emphasis
diffmk:change="added">
- <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Publishing</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> section it' possible to disable/inable the
automatic publishing of the changes in the workspace.</diffmk:wrapper></para>
-
- <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>In the <property moreinfo="none">Server
editor</property> you are able to edit the timeouts and the server pollers to
use.</para>
-
- <note>
- <title>Note:</title>
- <para>By default, the Startup poller is set to JMX Poller (see
the <emphasis>
- <property moreinfo="none">Server
Polling</property></emphasis> section). If you change the Startup poller
- to Timeout Poller (it may need in case, for example, you're using the
minimal configuration for your server), this will do no polling at all and will only set
the server
- state to <emphasis>
- <property
moreinfo="none">"Started"</property></emphasis> after
your startup timeout is reached.</para>
- </note>
-
- <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> 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.</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...
Installation Guide </ulink> to find parameters which can be specified for
<property moreinfo="none">JBoss
- Server</property>.</para>
-
- <note>
- <title>Note:</title>
- <para>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.</para>
-
- <para>For example, if you change the launch configuration program
arguments to
- <emphasis>"-c myConfig"</emphasis> 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.</para>
-
- <para>Values are not controlled by the server and its runtime setup
will be passed
- on unaltered.</para>
- </note>
-
- <para>Until 3.0.0.GA release of <property
moreinfo="none">JBoss Tools</property>, 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.</para>
-
- <para>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.</para>
-
- <figure float="0">
- <title>Server Classpaths</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/server_classpaths.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If for some reason you have a launch configuration without this
container, <emphasis>
- <property moreinfo="none">Restore Default
Entries</property>
- </emphasis> should add it properly. Also, <emphasis>
- <property moreinfo="none">Restore Default
Entries</property>
- </emphasis> will also remove any extra entries you added
yourself.</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>You can create a Fileset with flattening or without it. Look
at the difference
- on the figure below.</para>
-
- <figure float="0">
- <title>The FileSet with flattening and without
it</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/perspective/perspective_24a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
- <section diffmk:change="added"
id="CreatingaUserLibrariesFileSet">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Creating User Library
FileSet</diffmk:wrapper></title>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">If you use user libraries in your projects you can also
refer to these from project archives and have all the .jar/.zip files they refer included
into the archive.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">To add a new user libraries file set, call the
right-click menu on the necessary archive and choose " New User Libraries
FileSet" item</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Adding New User Library
Fileset</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/perspective/userlibraryfileset1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">You can edit the existing user libraries as well using
"User Libraries Fileset Wizard". Call the right-click menu on the library
fileset and choose "Edit Fileset " item</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Editing User Library
Fileset</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/perspective/userlibraryfileset2.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/jbosstools-3.1.0.CR1/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> 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.</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/jbosstools-3.1.0.CR1/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>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.</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>You can also use the "Finger touch" button for a quick restart of
the project without restarting the server:</para>
- <figure float="0">
- <title>Finger Touch button</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/modules/modules_8_finger_touch.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The "Finger" touches descriptors dependent on project (i.e.
web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</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/jbosstools-3.1.0.CR1/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>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/jbosstools_logo.png"
format="PNG"></imagedata>
+ </imageobject>
+ <imageobject role="html">
+ <imagedata></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+
+
<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>
+
+ <copyright>
+ <year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
+ <year >2010</year>
+ <holder>JBoss by Red Hat</holder>
+ </copyright>
+ <releaseinfo>
+ Version: 2.1.0.CR2
+ </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/vchukhutsina/repos/ochik_jboss/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>.</para>
+
+ <section id="JBoss_server_key_features">
+ <title>Key Features of JBoss Server</title>
+ <para>For a start, we propose you to look through the table of main features of
JBoss Server:</para>
+
+ <table>
+
+ <title>Key Functionality for JBoss AS and Archive Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1"
colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="2*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>JBoss AS plugin</para></entry>
+ <entry><para>Using WTP, JBoss AS plugin allows working with the
server in run or debug mode. You can easily install runtimes and servers, copy the
existing runtime configuration or configure it up to your
needs.</para></entry>
+ <entry>
+ <link linkend="runtimes_servers">runtimes and
servers</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>JBoss AS Perspective</para></entry>
+ <entry><para>It makes managing installed JBoss Server quite easy
and includes the standard Console and Properties views, and specially added Project
archives View and JBoss Server View for that purpose. </para></entry>
+ <entry>
+ <link linkend="perspective">JBoss AS
perspective</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>Modules Deployment</para></entry>
+ <entry><para>A number of ways, provided by WTP and JBoss Tools,
to deploy either a project or a single file on the server.</para></entry>
+ <entry>
+ <link linkend="modules">deploying modules</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>TPTP Support</para></entry>
+ <entry><para>Test and Performance Tools Platform (TPTP)
profiling.</para></entry>
+ <entry>
+ <link linkend="tptp_support">TPTP support</link>
+ </entry>
+ </row>
+
+ </tbody>
+
+ </tgroup>
+ </table>
+
+ <para>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>
+
+ <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> it and <emphasis>
+ <property moreinfo="none">publish</property>
+ </emphasis> to the server.</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>If you wish, you can assign a hotkey for the Build Project Archive action.
A key binding can be added
+ by navigating to <emphasis>
+ <property moreinfo="none">Window > Preferences >
General > Keys</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Setting the Hotkey for Build Project Archive Action</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/hotkeys.png"
scale="80"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To perform the building of the project archives, select the project in the
<property moreinfo="none">Package Explorer</property> view and
execute the hotkey combination
+ you assigned for this action.</para>
+
+ <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>
+ </section>
+
+ <section id="publishing">
+ <title>Publishing to JBoss Server</title>
+ <para>The publishing of all the modules added to a Server is performed
automatically when starting a Server.</para>
+ <para>The automatic publish of the changes made to the workspace is turned on by
default in order to permanently keep
+ the workspace in sync with the publish folder. If you need to control when to publish
the changes,
+ just disable the automatic publish in the <link
linkend="server_editor">Server Editor</link> and use the
<emphasis>
+ <property moreinfo="none">Publish to
Server</property></emphasis> (<inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/quick_start/publish_button.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>) button which initiates an incremental publish.
+ </para>
+
+ <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">on JBoss Tools release
documentation page</ulink>.</para>
+ <para>The latest documentation builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly
builds documentation page</ulink>.</para>
+
+ <para>Find out the answers on the frequently asked questions about JBoss AS 5
usage in the
+ <ulink
url="http://www.jboss.org/community/wiki/jboss5faq">JBoss5FA...;.
+ </para>
+
+ <para>The information on how to monitor a remote JBoss Server from Eclipse you
can find in the following
+ <ulink
url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFr...
article</ulink>.</para>
+ </section>
+
+</chapter>
+
+
+<chapter id="runtimes_servers"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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>JRE</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>Directory</para>
+ </entry>
+ <entry>
+ <para>The path to a directory where the configurations are
installed.</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.</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 to remember
which is
+ which.</para>
+
+ <para>Press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to see your new runtime in the list.</para>
+ <note>
+ <title>Note:</title>
+ <para>If you edit the configuration of a runtime, the changes don't
affect the settings of the servers that currently use the runtime.
+ To apply the changes to them also,you should double right click the server,
<emphasis>
+ <property moreinfo="none">Overview>Runtime
Environment</property> </emphasis>
+ ,make sure that necessary configuration is chosen,click
<emphasis><property moreinfo="none">Finish</property>
</emphasis> and then <emphasis><property
moreinfo="none">Save</property></emphasis> button.</para>
+ </note>
+ </section>
+ <section id="CopyRuntime">
+ <title>Copying the existing runtime configuration</title>
+ <para>While installing a new runtime you can copy the configuration from the
existing one.
+ To do this you should perform all the steps in the <link
linkend="InstNewRuntime">previous</link> section except pressing
<emphasis>
+ <property
moreinfo="none">Finish</property></emphasis>
+ in the New Server Runtime Environment menu .
+ </para>
+ <para>Make sure that you browse to a valid runtime folder and can see the
list of configurations (all, default, minimal) in the Configuration section .
+ Then choose necessary Configuration from the list and click <emphasis>
+ <property
moreinfo="none">Copy</property></emphasis>.The next dialog should
appear.
+ </para>
+ <figure float="0">
+ <title>Copy the existing configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_4a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Change the name Click on <emphasis>
+ <property
moreinfo="none">Browse</property></emphasis> and select your
configuration location or leave as it's if you want it to be located together with
other runtime configurations.
+ </para>
+ <figure float="0">
+ <title>Copy the existing configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_4b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click<emphasis>
+ <property moreinfo="none"> Ok </property></emphasis>and
you should see the next wizard with the just added copied configuration.
+
+ </para>
+ <figure float="0">
+ <title>Runtime with copied configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_4c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> and you will see your new runtime in the list.
+ </para>
+ <para>You can also change a configuration of existing runtime to a copied one
in the same way from the <emphasis>
+ <property moreinfo="none"> Window > Preferences
</property></emphasis>
+ menu <emphasis>
+ <property moreinfo="none">Server > Runtime Environments
</property></emphasis>
+ and clicking <emphasis>
+ <property moreinfo="none">Edit</property></emphasis>.
+ </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> <emphasis><property moreinfo="none"> New server
wizard </property></emphasis> allows to name the server appropriately in the
<emphasis><property moreinfo="none">Server name field
</property></emphasis>or you can use a generated default name.If it's
nessecary to restore the default name,after you defined yours, click the Reset default
button(<inlinemediaobject> <imageobject>
+ <imagedata
fileref="images/runtimes_servers/runtimes_servers_4d.png"></imagedata>
+ </imageobject></inlinemediaobject>).
+ 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">Installing a New Runtime
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. </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>Now that we've created our runtimes and servers, we can dwell on
all services
+ and tools that JBoss Server Manager provides.</para>
+
+ <para>We hope, this guide helped you to get started with the JBoss Tools
server manager.
+ Besides, for additional information you are welcome on
+ <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.</para>
+ </section>
+ </section>
+
+
+</chapter>
+
+
+<chapter id="perspective" role="updated"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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> 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.</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>The action for synchronizing the publish
information between
+ the server and workspace</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></para>
+ <para id="filefilterWiz">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 (see the figures bellow).</para>
+ <para>In order to set up a default fileset relative to the concrete
configuration of the server runtime, use the following variable:
+ <literal moreinfo="none">${jboss_config}</literal>,
i. e. you should type in the <emphasis>
+ <property moreinfo="none">Root
Directory</property></emphasis> something like <literal
moreinfo="none">server/${jboss_config}/</literal>.
+ This is implemented in order you can modify the runtime's configuration
and not have to manually update paths.</para>
+ <figure float="0">
+ <title>New File Filter Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/filesets2_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Notice, that the <emphasis>
+ <property
moreinfo="none">Browse</property></emphasis> button still returns
an absolute path:</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>
+ <para>If you want to set filesets for some server types, you should
open
+ <emphasis><property
moreinfo="none">Window>Preferences</property></emphasis>
+ and then select <emphasis><property
moreinfo="none">Server > Default
Filesets</property></emphasis>
+ from the categories available on the left.</para>
+
+ <figure float="0">
+ <title>Deleting the File from the Filesets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/filesets5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On this preference page you can add a fileset
+ to any server type or to all servers at once.To do this you should
select the server type in the combo box and click <emphasis><property
moreinfo="none">Add fileset...</property></emphasis> button.
+ In the opened <property moreinfo="none">New File
+ Filter wizard</property> follow the steps described
<link linkend="filefilterWiz">before</link> and finally click
<emphasis><property
moreinfo="none">Apply</property></emphasis> button on the
preference page.</para>
+ <para>The defined file filter will be automatically added
to new servers during creation.</para>
+
+
+ </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> includes XML XPaths where an xpath is a path used
to access some
+ specific part of an xml document. </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><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><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> supports drag-n-drop of deployable and
+ runnable projects/resources.</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>) file that has been made deployable) will
simply deploy that
+ resource directly to the server</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>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.</para>
+ </tip>
+
+ <para>Under the <emphasis>
+ <property
moreinfo="none">Publishing</property></emphasis> section it'
possible to disable/inable the automatic publishing of the changes in the
workspace.</para>
+
+ <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>In the <property moreinfo="none">Server
editor</property> you are able to edit the timeouts and the server pollers to
use.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>By default, the Startup poller is set to JMX Poller (see
the <emphasis>
+ <property moreinfo="none">Server
Polling</property></emphasis> section). If you change the Startup poller
+ to Timeout Poller (it may need in case, for example, you're using the
minimal configuration for your server), this will do no polling at all and will only set
the server
+ state to <emphasis>
+ <property
moreinfo="none">"Started"</property></emphasis> after
your startup timeout is reached.</para>
+ </note>
+
+ <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, main, 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 diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The first tab shows the Jboss server
arguments</diffmk:wrapper></para>
+ <para>Look up <ulink
url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/st...
Installation Guide </ulink> to find parameters which can be specified for
<property moreinfo="none">JBoss
+ Server</property>.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>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.</para>
+
+ <para>For example, if you change the launch configuration program
arguments to
+ <emphasis>"-c myConfig"</emphasis> 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.</para>
+
+ <para>Values are not controlled by the server and its runtime setup
will be passed
+ on unaltered.</para>
+ </note>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">On the second tab you find the main class used for
launching JBoss AS (default is org.jboss.Main), you can change it, if necessary.
</diffmk:wrapper></para>
+
+ <para>Until 3.0.0.GA release of <property
moreinfo="none">JBoss Tools</property>, 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.</para>
+
+ <para>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.</para>
+
+ <figure float="0">
+ <title>Server Classpaths</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/server_classpaths.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>If for some reason you have a launch configuration without this
container, <emphasis>
+ <property moreinfo="none">Restore Default
Entries</property>
+ </emphasis> should add it properly. Also, <emphasis>
+ <property moreinfo="none">Restore Default
Entries</property>
+ </emphasis> will also remove any extra entries you added
yourself.</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>You can create a Fileset with flattening or without it. Look
at the difference
+ on the figure below.</para>
+
+ <figure float="0">
+ <title>The FileSet with flattening and without
it</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/perspective_24a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="CreatingaUserLibrariesFileSet">
+ <title>Creating User Library FileSet</title>
+
+ <para>If you use user libraries in your projects you can also refer
to these from project archives and have all the .jar/.zip files they refer included into
the archive.</para>
+ <para>To add a new user libraries file set, call the right-click
menu on the necessary archive and choose " New User Libraries FileSet"
item</para>
+
+ <figure float="0">
+ <title>Adding New User Library Fileset</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/userlibraryfileset1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can edit the existing user libraries as well using
"User Libraries Fileset Wizard". Call the right-click menu on the library
fileset and choose "Edit Fileset " item</para>
+
+ <figure float="0">
+ <title>Editing User Library Fileset</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/perspective/userlibraryfileset2.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/vchukhutsina/repos/ochik_jboss/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> 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.</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/vchukhutsina/repos/ochik_jboss/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>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.</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>You can also use the "Finger touch" button for a quick restart of
the project without restarting the server:</para>
+ <figure float="0">
+ <title>Finger Touch button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/modules/modules_8_finger_touch.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The "Finger" touches descriptors dependent on project (i.e.
web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</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/vchukhutsina/repos/ochik_jboss/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>