[jbosstools-commits] JBoss Tools SVN: r5945 - trunk/as/docs/reference/en/modules.

Author: ochikvina Date: 2008-01-24 10:56:02 -0500 (Thu, 24 Jan 2008) New Revision: 5945 Modified: trunk/as/docs/reference/en/modules/perspective.xml Log: http://jira.jboss.com/jira/browse/JBDS-199 - rearranging the JBoss Server View section Modified: trunk/as/docs/reference/en/modules/perspective.xml =================================================================== --- trunk/as/docs/reference/en/modules/perspective.xml 2008-01-24 15:35:07 UTC (rev 5944) +++ trunk/as/docs/reference/en/modules/perspective.xml 2008-01-24 15:56:02 UTC (rev 5945) @@ -15,25 +15,26 @@ <para>This chapter tells how to manage installed JBoss Servers via <property>JBoss AS Perspective</property>.</para> - <para>The <property>JBoss AS</property> Perspective is similar to the Java perspective, but it - contains a few additional views. Two of the additional views are standard views, - specifically the <property>Console view</property> and the <property>Properties - view</property>. The other two views that are added are the <property>Project Archives view</property> - and the <property>JBoss Server view</property>.</para> + <para>The <property>JBoss AS Perspective</property> is similar to the <property>Java + Perspective</property>, but it contains a few additional views. Two of the additional views + are standard views, specifically the <property>Console View</property> and the + <property>Properties View</property>. The other two views that are added are the + <property>Project Archives View</property> and the <property>JBoss Server + View</property>.</para> <section id="JBossServerView"> <?dbhtml filename="JBossServerView.html"?> <title>The JBoss Server View</title> - <para>Let&apos;s have a look at the <property>JBoss Server View</property> and inspect in details all parts it consist of. - </para> - <para>The <property>JBoss Server View</property> is based on the WTP view, Server - View. The top part of the <property>JBoss Servers View</property> essentially embeds - the original Server View directly into it, making slight changes to the context - menu. A second part was added to provide additional information about the server - selected in the top part. In the image provided, categories in the second part - include which modules are currently deployed.</para> - + <para>Let&apos;s have a look at the <property>JBoss Server View</property> and inspect + in details all parts it consist of. </para> + + <para>The <property>JBoss Server View</property> is based on the WTP view, Server View. The + top part of the <property>JBoss Servers View</property> essentially embeds the original + Server View directly into it, making slight changes to the context menu. A second part + was added to provide additional information about the server selected in the top part. + </para> + <figure> <title>The JBoss Server View</title> <mediaobject> @@ -42,83 +43,11 @@ </imageobject> </mediaobject> </figure> - <para>Now, let&apos;s get to know with each of them.</para> - <section> - <title>Top Part of JBoss Server View</title> - <para>In the top part of the <property>JBoss Server view</property> all - declared servers are represented as well as their current states, that is, whether they - are started or stopped. </para> - <figure> - <title>Server Publish Status</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_18.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>It also shows the server's publish status. The fallowing table lists each of them.</para> - - <table> - <title>Server Publish Status</title> - <tgroup cols="2"> - <colspec colnum="1" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> - - - <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>By double-clicking on any 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 relevant to launching the server.</para> - - <figure> - <title>Preferences Page for the Chosen Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_20.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>At the figure above you can see that a username/password is available in the UI when - configuring the server. If you get an 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> - + + <para>The view's toolbar shown below 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> + mode, run mode, or profile mode), restarting a server, stopping a server, or publishing + to a server.</para> <figure> <title>The JBoss Server View Toolbar</title> <mediaobject> @@ -127,315 +56,411 @@ </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>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> - <para>As the JBoss servers have few 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.</para> - <figure> - <title>Launch Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_21.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The following table describes all those additional properties.</para> - <table> - <title>Server Properties through the Context Menu</title> - <tgroup cols="2"> - <colspec colnum="1" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> - - <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>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 synching the publish information between the server - and workspace.</para> - </entry> - </row> - - <row> - <entry> - <para>Clean</para> - </entry> - <entry> - <para>The option for complete redeploying.</para> - </entry> - </row> - - <row> - <entry> - <para>Twiddle Server</para> - </entry> - <entry> - <para>The option provides a dialog for running Twiddle commands against - the Twiddle Server.</para> - </entry> - </row> - - <row> - <entry> - <para>Edit Launch Configuration</para> - </entry> - <entry> - <para>The option that provides an editor for editing launch - configuration properties of the proper server.</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> - </tbody> - </tgroup> - </table> - - <para>Mentioned above 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> - </section> - <section> - <title>Bottom Part of JBoss Server View</title> - - <para>In order to access the view's preferences, you should access <emphasis> - <property>Window &gt; Preferences &gt; JBoss Tools &gt; JBoss - Servers &gt; View</property> - </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> - - <figure> - <title>View Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_2.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>Extender is meant to provide additional functionality relevant to the server - selected in the top part of the view. If a standard server element is selected from - above, some of the extensions may still provide the additional information. Others - may not. So, let&apos;s look at the currently available extensions to the - <property>JBoss Server View</property>.</para> - - <figure> - <title>View Extensions</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <emphasis> - <property>Modules</property></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> - - <figure> - <title>Modules Action</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <emphasis> - <property>Event Log</property></emphasis> will show relevant information to your - server&apos;s startup, shutdown, and publish processes. This allows you to keep - an eye on what&apos;s going on (such as automatic incremental deployment if you - have it enabled). The only action available is to clear the <emphasis> - <property>Event - Log</property></emphasis>. However, if the <property>Properties view</property> is opened, you - can receive further information on each <emphasis> - <property>Event Log</property></emphasis> item (when - available).</para> - - <figure> - <title>Event Log Actions</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_5.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Stopping the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <emphasis> - <property>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>XML Configuration</property></emphasis> includes XML XPaths where - a XPath is a path used to access some specific part of an xml document. Besides, its - use requires the <property>Properties view</property>. </para> - - <figure> - <title>XML Configuration and Properties View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The category itself contains only a list of categories. By right-clicking on <emphasis> - <property>XML Configuration</property> - </emphasis>, you can create a new category. Ports are provided by default and is - filled with many of the most commonly used ports in the <property>JBoss + <para>Now, let&apos;s get to know with both of the <property>JBoss Server + View</property> parts.</para> + <section> + <title>Top Part of JBoss Server View</title> + <para>In the top part of the <property>JBoss Server View</property> all declared servers + are represented as well as their current states, that is, whether they are started + or stopped. </para> + <figure> + <title>Server Publish Status</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_18.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The top part also shows the server&apos;s publish status. The fallowing table + lists possible statuses.</para> + + <table> + <title>Server Publish Status</title> + <tgroup cols="2"> + <colspec colnum="1" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + + <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>By double-clicking on any 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 relevant to + launching the server.</para> + + <para>On the figure below you can see that a username/password is available in the UI + when configuring the server. If you get an 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> + + <figure> + <title>Preferences Page for the Chosen Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_20.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As the JBoss servers have few 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.</para> + + <figure> + <title>Launch Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes all these additional properties.</para> + <table> + <title>Server Properties through the Context Menu</title> + <tgroup cols="2"> + <colspec colnum="1" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + <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>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 synching the publish information between the + server and workspace.</para> + </entry> + </row> + + <row> + <entry> + <para>Clean</para> + </entry> + <entry> + <para>The option for complete redeploying the resources.</para> + </entry> + </row> + + <row> + <entry> + <para>Twiddle Server</para> + </entry> + <entry> + <para>The option provides a dialog for running Twiddle commands + against the Twiddle Server.</para> + </entry> + </row> + + <row> + <entry> + <para>Edit Launch Configuration</para> + </entry> + <entry> + <para>The option that provides an editor for editing launch + configuration properties of the proper server.</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> + </tbody> + </tgroup> + </table> + + <para>Mentioned above 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> + </section> + + <section> + <title>Bottom Part of JBoss Server View</title> + + <para>Here, we dwell on the bottom part of the <property>JBoss Server View</property>.</para> + <para>First, we should say that the bottom part is meant to provide additional + functionality relevant to the server selected in the top part of the view. If a + standard server element is selected from above, some of the extensions may still + provide the additional information. Others may not. So, let&apos;s look at the + currently available extensions to the bottom part of the <property>JBoss Server + View</property>.</para> + + <figure> + <title>View Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In order to access the view's preferences, you should access <emphasis> + <property>Window &gt; Preferences &gt; JBoss Tools &gt; JBoss + Servers &gt; View</property> + </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> + + <figure> + <title>View Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_2.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>The first view extension is <emphasis> + <property>Modules</property> + </emphasis> section. It shows which 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> + + <figure> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property>Event Log</property> + </emphasis> will show relevant information to your server&apos;s startup, + shutdown, and publish processes. This allows you to keep an eye on what&apos;s + going on (such as automatic incremental deployment if you have it enabled). The only + action available is to clear the <emphasis> + <property>Event Log</property> + </emphasis>. However, if the <property>Properties View</property> is opened, you can + receive further information on each <emphasis> + <property>Event Log</property> + </emphasis> item (when available).</para> + + <figure> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Stopping the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property>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>XML Configuration</property> + </emphasis> includes XML XPaths where a XPath is a path used to access some specific + part of an xml document. Besides, its use requires the <property>Properties + view</property>. </para> + + <figure> + <title>XML Configuration and Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The category itself contains only a list of categories. By right-clicking on <emphasis> + <property>XML Configuration</property> + </emphasis>, you can create a new category. Ports are provided by default and is + filled with many of the most commonly used ports in the <property>JBoss Server</property>.</para> - - <figure> - <title>Adding New Category</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>By right-clicking on <emphasis> - <property>Ports</property> - </emphasis>, you can create a new XPaths.</para> - - <figure> - <title>Adding New XPath</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>After that, the dialog shown below will appear.</para> - - <figure> - <title>Adding New XPath</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_10.png"/> - </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, then the final field Attribute Name should be left blank and - your xpath should end with port. If, on the other hand, your desired field is the - port attribute of &lt;fieldName port="35"&gt;, then your xpath will end with - fieldName and your Attribute Name will be "port". When finished, you can click <emphasis> - <property>Preview</property> - </emphasis> to see how many matches you have for that particular xpath, as shown - below.</para> - <figure> - <title>XPath Preview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_11.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As part of the JBoss Server view there is a <emphasis> - <property>JMX Console</property> - </emphasis> section which allows you to browse and use the JMX exposed beans on the - server.</para> - <figure> - <title>JMX Console</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_17.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - + + <figure> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>By right-clicking on <emphasis> + <property>Ports</property> + </emphasis>, you can create a new XPaths.</para> + + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After that, the dialog shown below will appear.</para> + + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_10.png"/> + </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, then the final field Attribute Name should be left blank and + your XPath should end with port. If, on the other hand, your desired field is the + port attribute of &lt;fieldName port="35"&gt;, then your XPath will end with + fieldName and your Attribute Name will be "port". When finished, you can click <emphasis> + <property>Preview</property> + </emphasis> to see how many matches you have for that particular XPath, as shown + below.</para> + <figure> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As part of the <property>JBoss Server View</property> there is a <emphasis> + <property>JMX Console</property> + </emphasis> section which allows you to browse and use the JMX exposed beans on the + server.</para> + <figure> + <title>JMX Console</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_17.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> </section> - </section> - + <section id="Project_archivesView"> <title>Project Archives View</title> <para>Every application, whether Plain Old Java, J2EE, or some other language altogether,