Author: rob.stryker(a)jboss.com
Date: 2007-05-07 18:25:41 -0400 (Mon, 07 May 2007)
New Revision: 2012
Added:
trunk/as/docs/reference/en/images/asPerspective/
trunk/as/docs/reference/en/images/asPerspective/Thumbs.db
trunk/as/docs/reference/en/images/asPerspective/actionSets.jpg
trunk/as/docs/reference/en/images/asPerspective/eventLogActions.jpg
trunk/as/docs/reference/en/images/asPerspective/filesets.jpg
trunk/as/docs/reference/en/images/asPerspective/filesetsDialog.jpg
trunk/as/docs/reference/en/images/asPerspective/modulesActions.jpg
trunk/as/docs/reference/en/images/asPerspective/theView1.jpg
trunk/as/docs/reference/en/images/asPerspective/twiddleDialog.jpg
trunk/as/docs/reference/en/images/asPerspective/viewAdditions.jpg
trunk/as/docs/reference/en/images/asPerspective/viewMain.jpg
trunk/as/docs/reference/en/images/asPerspective/viewMainMenu.jpg
trunk/as/docs/reference/en/images/asPerspective/viewPreferences.jpg
trunk/as/docs/reference/en/images/asPerspective/viewToolbar.jpg
trunk/as/docs/reference/en/images/asPerspective/xpaths1.jpg
trunk/as/docs/reference/en/images/asPerspective/xpaths2.jpg
trunk/as/docs/reference/en/images/asPerspective/xpaths3.jpg
trunk/as/docs/reference/en/images/asPerspective/xpaths4.jpg
trunk/as/docs/reference/en/images/serverRuntimes/
trunk/as/docs/reference/en/images/serverRuntimes/Thumbs.db
trunk/as/docs/reference/en/images/serverRuntimes/installedRuntimes.JPG
trunk/as/docs/reference/en/images/serverRuntimes/new4.0Runtime.JPG
trunk/as/docs/reference/en/images/serverRuntimes/newRuntime.JPG
trunk/as/docs/reference/en/images/serverRuntimes/newServer.JPG
trunk/as/docs/reference/en/images/serverRuntimes/newServer2.JPG
trunk/as/docs/reference/en/modules/.thePerspective.xml.swo
trunk/as/docs/reference/en/modules/.thePerspective.xml.swp
trunk/as/docs/reference/en/modules/runtimesAndServers.xml
trunk/as/docs/reference/en/modules/thePerspective.xml
Modified:
trunk/as/docs/reference/en/master.xml
Log:
Initial revision for docs. No tutorials have been added, only introduction to the UI.
Added: trunk/as/docs/reference/en/images/asPerspective/Thumbs.db
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/Thumbs.db
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/actionSets.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/actionSets.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/eventLogActions.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/eventLogActions.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/filesets.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/filesets.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/filesetsDialog.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/filesetsDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/modulesActions.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/modulesActions.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/theView1.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/theView1.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/twiddleDialog.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/twiddleDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/viewAdditions.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/viewAdditions.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/viewMain.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/viewMain.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/viewMainMenu.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/viewMainMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/viewPreferences.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/viewPreferences.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/viewToolbar.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/viewToolbar.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/xpaths1.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/xpaths1.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/xpaths2.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/xpaths2.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/xpaths3.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/xpaths3.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/asPerspective/xpaths4.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/asPerspective/xpaths4.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/serverRuntimes/Thumbs.db
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/serverRuntimes/Thumbs.db
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/serverRuntimes/installedRuntimes.JPG
===================================================================
(Binary files differ)
Property changes on:
trunk/as/docs/reference/en/images/serverRuntimes/installedRuntimes.JPG
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/serverRuntimes/new4.0Runtime.JPG
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/serverRuntimes/new4.0Runtime.JPG
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/serverRuntimes/newRuntime.JPG
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/serverRuntimes/newRuntime.JPG
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/serverRuntimes/newServer.JPG
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/serverRuntimes/newServer.JPG
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/serverRuntimes/newServer2.JPG
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/serverRuntimes/newServer2.JPG
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/as/docs/reference/en/master.xml
===================================================================
--- trunk/as/docs/reference/en/master.xml 2007-05-07 20:57:05 UTC (rev 2011)
+++ trunk/as/docs/reference/en/master.xml 2007-05-07 22:25:41 UTC (rev 2012)
@@ -2,9 +2,13 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
"../../resources/support/docbook-dtd/docbookx.dtd"
[
-<!ENTITY setup SYSTEM "modules/setup.xml">
+<!ENTITY runtimesAndServers SYSTEM "modules/runtimesAndServers.xml">
+<!ENTITY asPerspective SYSTEM "modules/thePerspective.xml">
+
]>
+
+
<book>
<bookinfo>
<title>JBoss AS Plugin</title>
@@ -14,9 +18,10 @@
</copyright>
</bookinfo>
- <toc/>
-
-&setup;
+ <toc/>
+
+&runtimesAndServers;
+&asPerspective;
</book>
Added: trunk/as/docs/reference/en/modules/.thePerspective.xml.swo
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/modules/.thePerspective.xml.swo
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/modules/.thePerspective.xml.swp
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/modules/.thePerspective.xml.swp
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/modules/runtimesAndServers.xml
===================================================================
--- trunk/as/docs/reference/en/modules/runtimesAndServers.xml (rev
0)
+++ trunk/as/docs/reference/en/modules/runtimesAndServers.xml 2007-05-07 22:25:41 UTC (rev
2012)
@@ -0,0 +1,197 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="runtimesAndServers">
+ <title>Runtimes and Servers in the JBoss AS plugin</title>
+
+ <para>The JBoss AS plugin makes use of Webtools. This includes
+ starting and stopping servers in run or debug mode. It also includes
+ targeting webtools 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 must start with creating our runtime and
+ server instances.
+ </para>
+
+ <section>
+ <title>Webtools Runtimes</title>
+ <section><title>What is a runtime used for?</title>
+ <para>
+ In RHDS, Server Runtimes have one main purpose:
+ to point to a server installation somewhere on disk.
+ In our case, this will be a JBoss installation, and it
+ can than be used for two primary purposes.
+
+ First,
+ it provides classpath additions to webtools projects that require them.
+ Second, for JBoss server at least, it provides information necessary
+ for the starting and stopping of the server, such as which jars
+ to run and which configuration to use.
+ </para>
+ </section>
+
+
+ <section><title>Installing a new Runtime</title>
+ <para>
+ You can install runtimes into eclipse from the Window -> Preferences...
+ menu, and then selecting Server -> Installed Runtimes from the categories
available.
+ </para>
+ <figure id="installedRuntimeWindow"> <title>Installed
Runtimes</title>
+ <mediaobject>
+ <alt>Installed Server Runtime Preferences</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\serverRuntimes\installedRuntimes.JPG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>
+ From this preference page you can see what runtimes are declared,
+ and what type they are. In the image shown above, there are three declared
+ runtimes, including a Tomcat 5.5 instance and a JBoss 4.2 instance.
+ </para>
+
+ <para>
+ To create a JBoss runtime, we begin by clicking the add button.
+ This will open another dialog that allows us to choose what type
+ of runtime we want to create. Most of the runtime options are provided
+ by webtools, but those provided by RHDS are the ones we will focus on.
+
+ </para>
+
+ <figure id="addRuntimeWindow"> <title>Adding a
Runtime</title>
+ <mediaobject>
+ <alt>Adding a Runtime</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\serverRuntimes\newRuntime.JPG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ As seen above, there appear to be two JBoss categories. The first is
+ contributed by webtools, and is a generic adapter that is not upkept very well.
+ For this reason, RHDS provides updated and supported adapters of our own.
+ There is one for each of JBoss 3.2, 4.0, amd 4.2. You'll also note a deploy-only
+ runtime type. This type provides no classpath for webtools projects.
+ It is used solely by it's 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 id="add40RuntimeWindow"> <title>Adding a JBoss 4.0
Runtime</title>
+ <mediaobject>
+ <alt>Adding a JBoss 4.0 Runtime</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\serverRuntimes\new4.0Runtime.JPG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ As shown above, all you need to do to create the runtime is to name it, browse to
it's install directory,
+ select a Java Runtime Environment, and select which configuration you want.
+ As you browse to a valid installation folder, the list of configurations will
+ update allowing you to select the configuration of your choice.
+ </para>
+ <para>
+ Once the runtime is created, the configuration is an unchanging property
+ of that runtime. This is because many of the jars
+ necessary to provide for classpaths, such as the ejb3 jar locations or the servlet
jar locations,
+ are located in deploy directories of each configurations (depending on which
+ version of JBoss is being used). Because of this, to compile against
+ a different configuration's jars, you will need to create a new runtime from that
configuration.
+ </para>
+ <para>
+ Also, because of the open-source nature of JBoss, it is likely that a user may want
to
+ modify and repackage some of the configuration-specific jboss jars and create
+ their own configuration using those modified jars. Rather than forcing the user to
copy his
+ entire JBoss installation, this structure allows them to create only a new
configuration instead.
+ </para>
+ <para>
+ As a result of having each runtime represent a specific configuration rather than
+ the server installation as a whole, it is very likely you'll create several
different runtimes
+ to test each of your configurations. It becomes important to ensure your runtimes,
+ and later your servers, are given descriptive names that help you remember which is
which.
+ It will do no good to try to remember if "JBoss-runtime 5" is the 4.0
install with ejb3? Or the
+ 4.2 install's custom configuration you decided to create.
+ </para>
+ <para>
+ After pressing finish, you'll see that your new runtime has been added to the
list
+ and can now be targeted by webtools type projects or servers, both of which we'll
get to later.
+ </para>
+ </section>
+ </section>
+
+
+
+
+ <section>
+ <title>Webtools Servers</title>
+ <section>
+ <title>What is a Server used for?</title>
+ <para>
+ Webtools 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 what modules (jars, wars, etc)
+ you deploy to the server and also allow you to undeploy those modules.
</para>
+ <para>
+ Servers can be started or stopped with different command-line arguments.
+ They are often backed by a runtime object representing that server's location.
</para>
+ </section>
+ <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 File -> New -> Other... wizard,
+ and type in Server. This should show the screen below, which
+ does not look that different from the initial screen when
+ creating a new runtime. </para>
+ <figure id="addServerWindow"> <title>Adding a JBoss
Server</title>
+ <mediaobject>
+ <alt>Adding a JBoss Server</alt>
+ <imageobject>
+ <imagedata
+
fileref="..\..\..\..\reference\en\images\serverRuntimes\newServer.JPG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Because the server object is what keeps track of things like command line arguments
+ when starting or stopping, and runtimes keep track of the location of the
installation,
+ each server instance must be backed by an appropriate runtime. </para>
+ <para>
+ Because there may be many runtimes of each type declared, the wizard allows you to
select
+ which runtime you want your server to be backed by. The combo box below the view
lets you
+ select which declared runtime to use. For example, if there were already multiple
JBoss 4.0
+ runtimes declared, the combo box would list all of the 4.0 runtimes available.
</para>
+ <para>
+ If none of the runtimes declared are one you want to use, for example if
+ you declared a default and a minimal runtime before but now want your server
+ to be backed by the ALL configuration, then you can click on the
+ <emphasis>Installed Runtimes... </emphasis> Button to bring up the
preference page
+ shown at the beginning of this chapter. </para>
+ <para>
+ If the server you want to create doesn't have any installed runtime yet, the
combo
+ box and button will disappear, and the next page in the wizard will force you to
create
+ the associated runtime first. </para>
+ <para>
+ Either way, after targeting your server to a runtime, the final screen
+ in this wizard is largely confirmational, giving the user a chance to verify
+ that he's selected the appropriate runtime. It also allows the user
+ to name the server appropriately. </para>
+ </section>
+ </section>
+
+ <section>
+ <title>Well then...</title>
+ <para>Now that we've created our runtimes and servers,
+ we'll explore how to use them in future chapters. </para>
+ </section>
+</chapter>
Added: trunk/as/docs/reference/en/modules/thePerspective.xml
===================================================================
--- trunk/as/docs/reference/en/modules/thePerspective.xml (rev 0)
+++ trunk/as/docs/reference/en/modules/thePerspective.xml 2007-05-07 22:25:41 UTC (rev
2012)
@@ -0,0 +1,338 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="perspective">
+ <title>The JBoss AS Perspective</title>
+
+ <para>The JBoss AS Perspective is similar to the Java perspective, but it
contains
+ a few additional views, as well as an addition to the workbench toolbar. Two of
+ the additional views are standard views, specifically the <emphasis>Console
view</emphasis> and the
+ <emphasis>Properties view</emphasis>.
+ The other two views that are added are the <emphasis>Archives
View</emphasis>
+ and the <emphasis>JBoss Servers View</emphasis>.
+ </para>
+
+ <para> The <emphasis>Archives View</emphasis> will be given it's
own chapter
+ later in this guide. So as not to leave you completely curious, though,
+ the archives view is in charge of setting up specific packaging configurations
+ for your projects and executing them to produce a .jar, .war, or
+ whatever type of zip-standard file you'd like to create.</para>
+
+ <para> Instead, this chapter will focus on the the <emphasis>JBoss
Server's View</emphasis>
+ and it's related workbench toolbar actionsets.</para>
+
+ <section>
+ <title>The JBoss Servers View Introduction</title>
+
+
+
+ <figure id="serversView1"> <title>The JBoss Servers
View</title>
+ <mediaobject>
+ <alt>The JBoss Servers View</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\theView1.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The JBoss Servers View is based on the Webtool's view, <emphasis>Servers
View</emphasis>.
+ The top half of the <emphasis>JBoss Servers View</emphasis> essentially
embeds the
+ original <emphasis>Servers View</emphasis> directly into it, making
slight changes to
+ the context menu.</para>
+ <para>
+ A second half was added to provide additional information about the server selected
+ in the top half. In the image provided, categories in the second half include
+ which modules are currently deployed, an Event Log which keeps track of
+ server-specific events such as startup, shutdown, and publish information,
+ an XPaths category to allow easy editing of your server's various configuration
+ descriptors, and a fileset section to allow you easy access to files that may be
relevent
+ to that server's needs. </para>
+ </section>
+
+ <section><title>Toolbar actions</title>
+ <figure id="serversViewToolbar"> <title>The JBoss Servers View
Toolbar</title>
+ <mediaobject>
+ <alt>The JBoss Servers View Toolbar</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\viewToolbar.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The view's toolbar shown above provides quick access to starting a server
+ (in debug mode, run mode, or profile mode), restarting the server, stopping the
server,
+ or publishing to the server </para>
+
+ <para>
+ In order to debug your applications or EJB's that are deployed to the server,
+ you <emphasis>must</emphasis> 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>
+ The publish icon, on the extreme right, 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><title>The Server Section</title>
+
+
+
+ <figure id="viewMain"> <title>JBoss Servers View: Main
Section</title>
+ <mediaobject>
+ <alt>JBoss Servers View Main Section</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\viewMain.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Server section of the view lists all declared servers and their current
+ status, that is, whether they are started or stopped. By Double-clicking
+ on each server, an editor window will appear allowing you to edit parts of
+ that server. The editor will also link you to modify that server's launch
+ configuration, set command line arguments, and other things that are relevent
+ to launching the server.</para>
+
+ <figure id="viewMainMenu"> <title> JBoss Servers View: Main
Context Menu</title>
+ <mediaobject>
+ <alt>JBoss Servers View: Main Context Menu</alt>
+ <imageobject>
+ <imagedata width="120px" scalefit="0"
+ fileref="..\..\..\..\reference\en\images\asPerspective\viewMainMenu.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Because the JBoss servers have few (if any) properties to edit in the
editor,
+ a shortcut to the launch configuration has been provided in the
+ context menu when right-clicking on a server. This menu also
+ provides the (by now redundant) functionality of starting the
+ server in run or debug mode, stopping it, or
+ synching the publish information between the server and workspace. </para>
+
+ <para>
+ Near the bottom you'll also see the
+ <emphasis>Add and Remove Projects...</emphasis> item, which allows you
+ to publish a new project to the server (if its type is supported).
+ The last menu item I'd like to mention is the one labeled
+ <emphasis>Twiddle Server</emphasis>.</para>
+ <para>
+ The <emphasis>Twiddle Server</emphasis> item will open a dialog
+ and allow you to run <emphasis>Twiddle</emphasis> commands against it.
+ Twiddle is a JMX library that comes with JBoss, and you can use it to
+ access any variables that exposed via the JBoss JMX interfaces. </para>
+
+ <figure id="twiddleDialog"> <title>Twiddle
Dialog</title>
+ <mediaobject>
+ <alt>Twiddle Dialig</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\twiddleDialog.jpg"
width="3in" scalefit="0"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ As you can see above, twiddle can serve as a useful information-gathering tool.
+ </para>
+ </section>
+
+ <section><title>View Extensions</title>
+ <figure id="viewExtensions"> <title>View
Extensions</title>
+ <mediaobject>
+ <alt>View Extensions</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\viewAdditions.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The final part of the JBoss Servers View is extendable, and can be added
to by any extender.
+ It is meant to provide additional functionality relevent to the server selected in
the
+ top half of the view. Currently, most of the extensions apply only to servers
+ created with the JBoss AS Adapter. If a standard server element is selected from
+ above, some of the extensions may still provide the additional information. Others
+ may not.</para>
+ <para>Each category provides its own context menu, it's own sub-elements,
and
+ it's own structure. A few menu items are common to all elements in this
+ part of the view, however. The first two allow the user to refresh parts of the tree
+ if they believe they have become out of sync with the underlying model. Obviously
+ such a loss of synchronization would be a bug, but this at least empowers the user
+ to force a refresh and ensure that what they're seeing is both current and
accurate. </para>
+
+ <para>The third *common* menu item, common only to the categories, is the
ability to disable and hide them.
+ If there's a category you don't think you'll be using much, some
additional functionality who's
+ presence you annoying or in the way, you can disable it. You'll be able to
re-enable any
+ disabled categories if you find you need to via a preference page. </para>
+
+ <para>So, let's look now at the currently available extensions to the JBoss
Server's View.</para>
+ <section><title>Modules</title>
+
+ <figure id="Modules Actions"> <title>Modules
Actions</title>
+ <mediaobject>
+ <alt>Modules</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\modulesActions.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The <emphasis>modules</emphasis> section shows what modules are
currently deployed
+ to the server, and allows you to remove them from the server, or force a full
+ republish upon them. It only shows which modules have been deployed through eclipse,
+ not any and all modules that happen to be in the deploy directory.
+ </para>
+ </section>
+
+ <section><title>Event Log</title>
+ <figure id="Event Log Actions"><title>Event Log
Actions</title>
+ <mediaobject><alt>Event Log</alt>
+ <imageobject><imagedata width="3in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\eventLogActions.jpg"/></imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The Event Log will show relevent 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). The only action
+ available is to clear the event log. However if the properties view is opened,
+ you can receive further information on each event log item (when available).
</para>
+ <para>
+ This section will only appear for server types declared by the JBoss AS Adapter.
+ Webtools adapters (such as the tomcat server) will not show this view
extension.</para>
+ </section>
+
+ <section><title>XML XPaths</title>
+ <para>
+ The XML XPaths category allows you to quickly browse to descriptor files
+ in your server's deploy directory and check or change the values. It's use
+ requires the properties view. If you are not familiar with xpaths,
+ I highly suggest reading the w3c's summaries and tutorials on the topic.
+ Basically, though, an xpath is a path used to access some specific part of an xml
+ document.
+ </para>
+ <figure id="XMLXPaths"><title>XML XPaths And
Properties</title>
+ <mediaobject><alt>XML XPaths and Properties</alt>
+ <imageobject><imagedata width="5in" scalefit="0"
+ fileref="..\..\..\..\reference\en\images\asPerspective\xpaths1.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+ <section><title>What it means...</title>
+
+ <para>
+ The view itself contains only a list of categories.
+ By right-clicking on <emphasis>XML XPaths</emphasis>, you can create a new
+ category. <emphasis>Ports</emphasis> is provided by default and is filled
with
+ many of the most commonly used ports in the JBoss Server</para>
+ <para>
+ By right-clicking on a category in the view, you can either delete that cateogory,
+ or add a new xpath to it. Before we see what adding a new xpath is like, let's
+ quickly see what we can do with them once they *are* declared by looking in the
+ <emphasis>Properties View</emphasis>.</para>
+ <para>
+ In the properties view you'll see an identifier, and nested underneath is
+ the files where that xpath can be found as well as it's current value.
+ The details of the xpath are hidden from the view at the moment so that
+ all you need to see is which file you're referring to, and what its current
+ value is. To change the value, simply double-click on it, change it's value,
+ and press enter. This will modify the value in the file.</para>
+ <para><emphasis>Note: This will only modify the value in your server's
deploy directory.
+ This will NOT modify the value in the workspace. So if you're making use
+ of deployment tools, packaging tools, or other things that copy
+ files into your server's deploy directory, those tools will
+ overwrite whatever changes you make here.</emphasis></para>
+ <figure id="XMLXPaths2"><title>Editing XML XPath
Values</title>
+ <mediaobject><alt>Editing XML XPath Values</alt>
+ <imageobject><imagedata
fileref="..\..\..\..\reference\en\images\asPerspective\xpaths2.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ To edit the entire file manually, rather than just that value, you can right-click on
+ <emphasis>naming-service.xml</emphasis> and select <emphasis>Edit
File</emphasis>.</para>
+ </section>
+ <section><title>Adding an XPath</title></section>
+ <para>To begin, you can either right-click on a category in the view,
+ or when browsing a category in the properties view, right-clicking anywhere. This
will
+ allow you to select <emphasis>New XPath</emphasis>. After that, the
dialog shown
+ below will appear.</para>
+ <figure id="XMLXPaths3"><title>Adding an XPath</title>
+ <mediaobject><alt>Adding an XPath</alt>
+ <imageobject><imagedata width="5in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\xpaths3.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ As you type, the fields autocomplete to help you locate exactly what xpath you're
looking for.
+ The goal here is to get an end result where the xpath matches up with an easily
changed
+ property. With that in mind, if the property you want to change is the text of an
element,
+ for example <port>35<port>, then the final field
<emphasis>Attribute Name</emphasis>
+ should be left blank and your xpath should end with
<emphasis>port</emphasis>.</para>
+ <para>
+ If, on the other hand, your desired field is the port attribute of
+ <fieldName port="35">, then your
<emphasis>xpath</emphasis> will end with
+ fieldName and your <emphasis>Attribute Name</emphasis> will be
"port". </para>
+ <para>
+ When finished, you can click preview to see how many matches you have for that
+ particular xpath, as shown below.</para>
+ <figure id="XMLXPaths4"><title>XPath Preview</title>
+ <mediaobject><alt>XPath Preview</alt>
+ <imageobject><imagedata width="5in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\xpaths4.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+ <section><title>Filesets</title>
+ <para>
+ The Filesets section allows you easy access to groups of files on your
+ hard drive, most likely relevent to the server at hand. It does this
+ to ensure and speed up raw filesystem access with the ability to quickly navigate
+ to descriptor or configuration files and either delete or edit them. </para>
+ <para>
+ This could also be useful if, for some reason, when packaging your application
+ you draw from some non-workspace folder on your machine</para>
+ <para>
+ Creating a new fileset requires only naming it, giving it
+ a root directory, an includes pattern, and an excludes pattern. </para>
+ <figure id="Filesets"><title>Filesets</title>
+ <mediaobject><alt>Filesets</alt>
+ <imageobject><imagedata width="5in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\filesets.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+<figure id="FilesetsDialog"><title>Filesets Dialog</title>
+ <mediaobject><alt>Filesets Dialog</alt>
+ <imageobject><imagedata width="3in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\filesetsDialog.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+</section>
+<section><title>View Preferences</title>
+ <figure id="ViewPreferences"><title>View Preferences
</title>
+ <mediaobject><alt>View Preferences</alt>
+ <imageobject><imagedata width="6in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\viewPreferences.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ In order to access the view's preferences, you should access
+ <emphasis>Window -> Preferences -> JBoss IDE -> JBoss
Servers -> View</emphasis>
+ This preference page allows you to select which view extensions you want on or off,
+ the order they appear in the view, as well as any other extension-specific preferences
+ that may be available.</para>
+</section>
+<section><title>Server Action Set</title>
+ <figure id="ActionSet"><title>Servers Action Set </title>
+ <mediaobject><alt>Servers Action Set</alt>
+ <imageobject><imagedata width="4in" scalefit="0"
fileref="..\..\..\..\reference\en\images\asPerspective\actionSets.jpg"
/></imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The actionset shown above enables quick starting and stopping of a server, in the
event
+ that you do not want to use the view and all of its added functionality.
+ If that's the case, then you simply select a server to be the default from the
pulldown menu.
+ Only one server can be selected at a time. Once a server is selected (with a check
mark),
+ the start, stop, and debug options will become enabled depending on which are
appropriate
+ at the time. (If the server is running, start and debug will not be enabled, but stop
will be.)</para>
+</section>
+</chapter>