January 2011 - jbosstools-commits

JBoss Tools SVN: r28744 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 23:23:37 -0500 (Sun, 30 Jan 2011) New Revision: 28744 Modified: trunk/as/docs/reference/en-US/modules.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/modules.xml =================================================================== --- trunk/as/docs/reference/en-US/modules.xml 2011-01-31 04:11:32 UTC (rev 28743) +++ trunk/as/docs/reference/en-US/modules.xml 2011-01-31 04:23:37 UTC (rev 28744) @@ -1,24 +1,21 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="modules"> <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> - + <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> + + <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>Run As > Run on Server</property> - </emphasis>. The resulting dialog allows you to select which supporting server the - project can be published to.</para> + <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 <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server</guimenuitem></menuchoice>. The resulting dialog allows you to select which supporting server the project can be published to. + </para> <figure> <title>Define a New Server</title> <mediaobject> @@ -27,10 +24,7 @@ </imageobject> </mediaobject> </figure> - <para>Click <emphasis> - <property>Next</property> - </emphasis> button to see add or remove projects page where you can choose projects - to configure them on server.</para> + <para>Click the <guibutton>Next</guibutton> button to see add or remove projects page where you can choose projects to configure them on server.</para> <figure id="add_rem_proj"> <title>Add or Remove Projects</title> <mediaobject> @@ -39,42 +33,24 @@ </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> < 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>.war</property> - </emphasis>, <emphasis> - <property>.jar</property> - </emphasis>, or <emphasis> - <property>.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> + <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 the <guibutton> < Remove</guibutton>. 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 <filename>.war</filename>, <filename>.jar</filename>, or <filename>.ear</filename> as appropriate, and then copies that file into the proper deploy directory. For quicker smarter deployment, you will need to create archives using the Project Archives view (see <xref linkend="Project_archivesView"/>) 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>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>-ds.xml</property></emphasis>, <emphasis> - <property>.ear</property></emphasis>, <emphasis> - <property>.jar</property></emphasis> etc.) and select <emphasis> - <property>Deploy To Server</property> - </emphasis> and it will be automatically deployed.</para> + + <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 <guimenuitem>Deploy To Server</guimenuitem> option is provided that allows a single file deployment. To deploy these non-WTP files/projects right click on the file (<filename>-ds.xml</filename>, <filename>.ear</filename>, <filename>.jar</filename> etc.) and select <guimenuitem>Deploy To Server</guimenuitem> and it will be automatically deployed. + </para> <figure> <title>Deploy to Sever</title> <mediaobject> @@ -83,8 +59,7 @@ </imageobject> </mediaobject> </figure> - <para>The deployed files are listed side-by-side with other modules that are deployed to - the server.</para> + <para>The deployed files are listed side-by-side with other modules that are deployed to the server.</para> <figure> <title>Deployed files on the Server</title> @@ -94,21 +69,20 @@ </imageobject> </mediaobject> </figure> - + </section> - + </section> <section> <title>Deploying with Servers View</title> - <para>As it has been already mentioned <property>Servers</property> view 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> + <para> + As it has been already mentioned <guilabel>Servers</guilabel> view 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 Servers view</title> - <para>In the top part of the <property>Servers</property> view you should right click on a server and select the <emphasis> - <property>Add and Remove</property> - </emphasis> menu item.</para> + <para> + In the top part of the <guilabel>Servers</guilabel> view you should right click on a server and select the <guimenuitem>Add and Remove</guimenuitem> menu item. + </para> <figure> <title>Add and Remove Projects</title> <mediaobject> @@ -117,28 +91,17 @@ </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>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> + + <para> + This will bring up a dialog (see <xref linkend="add_rem_proj"/>) that allows 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 <guilabel>Run on Server</guilabel> wizard, with a best-guess full package. If, however, the selected element is an archive from the Project Archives view (see <xref linkend="Project_archivesView"/>), it will be published according to the rules of that module type. + </para> </section> - + <section> <title>Bottom part of Servers view</title> - <para>In the bottom part of <emphasis> - <property>Servers</property> view - </emphasis> there is a category called <emphasis> - <property>Modules</property> - </emphasis> which should display all currently-published modules on the server. - Right-clicking on the desired module and selecting <emphasis> - <property>Full Publish</property> - </emphasis> will force a full rebuild of the entire module.</para> + <para> + In the bottom part of <guilabel>Servers</guilabel> view there is a category called <guilabel>Modules</guilabel> which should display all currently-published modules on the server. Right-clicking on the desired module and selecting <guimenuitem>Full Publish</guimenuitem> will force a full rebuild of the entire module. + </para> <figure> <title>Full Publish</title> <mediaobject> @@ -147,19 +110,17 @@ </imageobject> </mediaobject> </figure> - - <para>Here, <emphasis> - <property>Incremental Publish</property> - </emphasis> is meant to enable publishing of only those parts where changes have - been made.</para> + + <para> + Here, <guilabel>Incremental Publish</guilabel> 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>Project Archives View</property> you can right-click on any declared - archive and select the <emphasis> - <property>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> + <para> + In the <guilabel>Project Archives View</guilabel> you can right-click on any declared archive and select the <guilabel>Publish To Server</guilabel> element. For more on this subject, see <xref linkend="PublishToServer"/> in the Project Archives View section. + </para> <figure> <title>Publish to Server</title> <mediaobject> @@ -168,16 +129,9 @@ </imageobject> </mediaobject> </figure> - <para> The only way to ensure an <emphasis> - <property>Incremental Build</property> - </emphasis>, such as changes to one <emphasis> - <property>.jsp</property>, </emphasis> - <emphasis> - <property>.html</property>, </emphasis> or <emphasis> - <property>.class</property> - </emphasis> file, is to enable the builder for that project. This is done by either - changing the global preferences for the <property>Archives View</property>, or by - enabling project-specific preferences and ensuring the builder is on.</para> + <para> + The only way to ensure an <guilabel>Incremental Build</guilabel>, such as changes to one <filename>.jsp</filename>, <filename>.html</filename>, or <filename>.class</filename> file, is to enable the builder for that project. This is done by either changing the global preferences for the <guilabel>Archives View</guilabel>, 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> @@ -187,11 +141,12 @@ <imagedata fileref="images/modules/modules_8_finger_touch.png"/> </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> + </figure> - - <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a - server.</para> + <para> + The "Finger" touches descriptors dependent on project (i.e. <filename>web.xml</filename> for WAR, <filename>application.xml</filename> for EAR, <filename>jboss-esb.xml</filename> 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>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28743 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 23:11:32 -0500 (Sun, 30 Jan 2011) New Revision: 28743 Modified: trunk/as/docs/reference/en-US/webtools.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/webtools.xml =================================================================== --- trunk/as/docs/reference/en-US/webtools.xml 2011-01-31 03:44:52 UTC (rev 28742) +++ trunk/as/docs/reference/en-US/webtools.xml 2011-01-31 04:11:32 UTC (rev 28743) @@ -1,48 +1,36 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="webtools"> <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>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> - + <para> + The most popular of the projects we deal with are the J2EE ones, such as Dynamic Web Project, EJB Project, or EAR project. <productname>JBoss Tools</productname> web projects include Struts, JSF and Seam projects. These are referred to as faceted projects. This chapter will cover facets, which are used to provide provide a consistent structure and packaging features to 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> + <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. These facets either add to the project's classpath, enable a builder, or watch the project in some other fashion. Typically every project concerned has at least one facet when it is 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 been criticized for being over-engineered 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 <emphasis>should</emphasis> be trivial. 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 Archives plugin (see <xref linkend="Project_archivesView"/>). + </para> </section> - + <section> <title>Adding Facets to a Project</title> - - <para>In this section we're going to consider the facets added by <property>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>Dynamic Web Project</property> by - selecting <emphasis> - <property>File > New > Other...</property> - </emphasis> and then <emphasis> - <property>Web > Dynamic Web Project</property>. </emphasis></para> + + <para> + This section will cover the facets added by <property>JBoss Tools</property> and show how you can configure them in a project by adding new ones or modifying existing facet configurations. + </para> + + <para> + One way to configure the facets is doing it while organizing a new project. To demonstrate this let's create a new <guilabel>Dynamic Web Project</guilabel> by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other...</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>. + </para> <figure> <title>New Dynamic Web Project</title> <mediaobject> @@ -51,17 +39,15 @@ </imageobject> </mediaobject> </figure> - <para>Click <emphasis> - <property>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> - + <para>Click the <guibutton>Next</guibutton> button and you will see a 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, which represents 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 required facet. + </para> + <para> + Selecting the runtime allows the project to install the proper classpaths to the project so it knows what code to compile against. + </para> + <figure id="dyn_web_project"> <title>New Dynamic Web Project</title> <mediaobject> @@ -70,12 +56,10 @@ </imageobject> </mediaobject> </figure> - <para>Click on the <emphasis> - <property>Modify</property> - </emphasis> button next to <property>Configuration</property> section in order to open - the wizard which allows you to modify a chosen configuration. The wizard looks as - follows.</para> - + <para> + Click the <guibutton>Modify</guibutton> button next to the <guilabel>Configuration</guilabel> section to open a wizard which allows you to modify the chosen configuration. The wizard is shown in the image below. + </para> + <figure id="project_facets"> <title>Project Facets Wizard</title> <mediaobject> @@ -84,9 +68,8 @@ </imageobject> </mediaobject> </figure> - - <para>Here part of the listed facets are those which are provided by WTP. Some of them are - added by <property>JBoss Tools</property>. They are:</para> + + <para>Here part of the listed facets are those which are provided by WTP. Some of them are added by <property>JBoss Tools</property>. They are:</para> <itemizedlist> <listitem> <para>BIRT Charting Runtime Component</para> @@ -107,11 +90,10 @@ <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> + + <para> + On this wizard page you can enable or disable any facet as well as change its version. What you should note here is that some facets or facets versions may conflict with each other. In case of incompatibility you will be notified in the combo box underneath. + </para> <figure> <title>Facet Constraints</title> <mediaobject> @@ -120,9 +102,7 @@ </imageobject> </mediaobject> </figure> - <para>When switching on the <emphasis> - <property>Runtimes</property> - </emphasis> tab on the right you'll see the current server Runtime.</para> + <para>When switching on the <guilabel>Runtimes</guilabel> tab on the right you will see the current server Runtime.</para> <figure> <title>Runtimes on the Project Facets Wizard</title> <mediaobject> @@ -131,33 +111,27 @@ </imageobject> </mediaobject> </figure> - <para>On this tab you can also create a new Server Runtime and make it primary by pressing <emphasis> - <property>Make Primary</property> - </emphasis> button after enabling it.</para> + <para> + On this tab you can also create a new Server Runtime and make it primary by enabling it and then clicking the <guibutton>Make Primary</guibutton> button. + </para> + + <para> + Clicking on the <guibutton>OK</guibutton> button will save the chosen configuration of the facets and return you to the Dynamic Web Project wizard (see <xref linkend="dyn_web_project"/>). Additional pages in the wizard are specific to either the project type or the facets selected. + </para> - <para>Clicking on <emphasis> - <property>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>Properties</property> - </emphasis> and then <emphasis> - <property>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> + If you need to configure the facets for an existing project, right click on the project, select <guimenuitem>Properties</guimenuitem> and then select <guilabel>Project Facets</guilabel>. This will bring up the Project Facets wizard (see <xref linkend="project_facets"/>), where you can create your own custom facets configuration. + </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.jst.j2ee.do..." - >eclipse help</ulink>.</para> + + <para> + More information on the WTP facets can be found in the <ulink url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.jst.j2ee.do...">Eclipse help</ulink>. + </para> </section> </chapter>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28742 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 22:44:52 -0500 (Sun, 30 Jan 2011) New Revision: 28742 Modified: trunk/as/docs/reference/en-US/perspective.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/perspective.xml =================================================================== --- trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 03:00:32 UTC (rev 28741) +++ trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 03:44:52 UTC (rev 28742) @@ -749,12 +749,11 @@ </mediaobject> </figure> - <para>If for some reason you have a launch configuration without this container, <emphasis> - <property>Restore Default Entries</property> - </emphasis> should add it properly. Also, <emphasis> - <property>Restore Default Entries</property> - </emphasis> will also remove any extra entries you added yourself.</para> - <para>Using <emphasis>Deployment tab</emphasis> you configure local deployment settings.</para> + <para> + If for some reason you have a launch configuration without this container, the <guibutton>Restore Default Entries</guibutton> button should add it properly. Also, the <guibutton>Restore Default Entries</guibutton> button will remove any extra entries you added yourself. + </para> + + <para>Using <guilabel>Deployment tab</guilabel> you configure local deployment settings.</para> <figure> @@ -765,49 +764,41 @@ </imageobject> </mediaobject> </figure> - <para>Using the group of radio buttons in <property>Default Settings section</property> - a user can set where the application will - be deployed to.By default it is deployed to the user's workspace folder, - exactly to <property>[workspaceDirecotry]\.metadata\.plugins</property>.If you would like the application to be deployed to your Jboss - server deploy folder select <emphasis><property>Use the JBoss deploy folder</property> - </emphasis>. - The option to specify your custom deploy folder is also available.</para> + <para> + Using the group of radio buttons in the <guilabel>Default Settings</guilabel> section a user can set where the application will be deployed to. By default it is deployed to the user's workspace folder, <filename>[workspaceDirecotry]\.metadata\.plugins</filename>. If you would like the application to be deployed to your JBoss server deploy folder select the <guilabel>Use the JBoss deploy folder</guilabel> option. The option to specify your custom deploy folder is also available. + </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> + <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> + <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> + <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>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>Project Archives view</property>, to set up each - packaging configuration.</para> - <para>So far, let's look through all functionality that the <property>Project - Archives view</property> provides.</para> + <para> + But <productname>JBoss Tools</productname> comes with our own Archives tool with simpler and less-verbose XML and a handy user interface. The Project Archives plugin consists primarily of the <guilabel>Project Archives</guilabel> view to set up each packaging configuration. + </para> + + <para>Let's look through all functionality that the <guilabel>Project Archives</guilabel> view 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>.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> + <para> + The packaging configuration for each project is stored in the project's root folder in a file named <filename>.packages</filename>, which has a fairly simple XML structure. Modifying the file by hand is neither required nor recommended, as the UI is the only supported way to modify your packaging structure. + </para> <figure> <title>Archives View</title> @@ -818,24 +809,21 @@ </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> + 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 a 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>Project > Build Packages</property> - </emphasis> when a project is selected in the <property>Packages View</property> to - build all declared packages in that project's <emphasis> - <property>.packages</property> - </emphasis> file. This will execute a full build on all declared archives.</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 <menuchoice><guimenuitem>Project</guimenuitem><guimenuitem>Build Packages</guimenuitem></menuchoice> when a project is selected in the <guilabel>Packages View</guilabel> to build all declared packages in that project's <filename>.packages</filename> 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>Project archives view</property> for the first time, - it asks you to select the project for what you want to create an archive.</para> + <para> + When you open the <guilabel>Project archives</guilabel> view for the first time, it asks you to select the project for which you want to create an archive. + </para> <figure> <title>Archives View</title> @@ -846,10 +834,9 @@ </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>New Archive</property> - </emphasis> to see your archive type options.</para> + <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 <guimenuitem>New Archive</guimenuitem> to see your archive type options. + </para> <figure> <title>Create an Archive</title> @@ -862,25 +849,22 @@ <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> + <para> + If you see only JAR from the list of available archive types, you should verify whether AS Tools plugins are installed. EAR, EJB JAR and WAR options are contributed by the AS Tools independently from webtools and the virtual project model. So without them only the JAR option will show up. + </para> </note> <para> - <property>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> + <filename>JAR</filename> 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>WAR</property> archive, the archive will be created with a few - filesets relevant to the known structure of the project.</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 <filename>WAR</filename> 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>New Jar wizard</property>.</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 <guilabel>New JAR</guilabel> wizard. + </para> <figure> <title>New WAR Wizard</title> <mediaobject> @@ -890,22 +874,11 @@ </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 page is pretty simple. First it prompts you 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>workspace</property> - </emphasis> or <emphasis> - <property> 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>Workspace</property> - </emphasis> button. At the bottom of the list, you'll see archives that - have been declared in the workspace.</para> + <para> + The destination of an archive can be anywhere on the file system, anywhere in the workspace, inside another archive, or inside a folder declared inside an archive. Select the appropriate checkbox (either <guilabel>workspace</guilabel> or <guilabel>file system</guilabel>) to specify that the destination is related to either the workspace or filesystem. 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 click the <guibutton>Workspace</guibutton> button. At the bottom of the list, you will see the archives that have been declared in the workspace. + </para> <figure> <title>Selecting the destination in the workspace</title> @@ -916,13 +889,11 @@ </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>Archive type</property> - </emphasis> section.</para> - <para>If a build or incremental update fails Project Archives will show an error - dialog:</para> + <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 <guilabel>Archive type</guilabel> section. + </para> + + <para>If a build or incremental update fails Project Archives will show an error dialog:</para> <figure> <title>Selecting the destination in the workspace</title> <mediaobject> @@ -931,12 +902,9 @@ </imageobject> </mediaobject> </figure> - <para>Click in <emphasis> - <property>Details</property> - </emphasis> to see detailed information about what caused the error.</para> + <para>Click the <guibutton>Details</guibutton> button to view detailed information about the cause of the error.</para> - <para>In the <property>Package Explorer</property> you can observe the created - archive.</para> + <para>In the <guilabel>Package Explorer</guilabel> you can view the created archive.</para> <figure> <title>The Archive in the Package Explorer</title> <mediaobject> @@ -946,9 +914,10 @@ </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>Package - Explorer</property>.</para> + <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 <guilabel>Package Explorer</guilabel>. + </para> + <figure> <title>The Exploded Archive in the Package Explorer</title> <mediaobject> @@ -960,19 +929,18 @@ <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> + <para> + To create a folder right-click on an archive or folder you want your new folder to be a child of. The only piece of required information the folder name. + </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>New Fileset</property>. </emphasis> + <para> + To create a new fileset, right click on an available target location such as an archive, a nested archive, or a folder within an archive, and select the <guimenuitem>New Fileset</guimenuitem> option. + </para> + <para> + The <guilabel>New Fileset</guilabel> wizard requires a destination (where the files will be located), 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> - <para>The <property>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> <title>Adding a New FileSet</title> @@ -983,12 +951,11 @@ </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> + Below that, the fileset requires only an <guilabel>Includes</guilabel> and <guilabel>excludes</guilabel> pattern. As you type in either of these fields, the preview viewer will list those files that are matched. + </para> - <para>You can create a Fileset with flattening or without it. Look at the difference - on the figure below.</para> + <para>You can create a Fileset with flattening or without it. Look at the difference on the figure below.</para> <figure> <title>The FileSet with flattening and without it</title> @@ -1004,8 +971,12 @@ <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> + <para> + If you make use of user libraries in your projects you can also refer to these from project archives and have all the JAR and ZIP files they refer included into the archive. + </para> + <para> + To add a new user libraries file set, right-click on the necessary archive and select the <guimenuitem>New User Libraries FileSet</guimenuitem> option. + </para> <figure> <title>Adding New User Library Fileset</title> @@ -1016,7 +987,9 @@ </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> + <para> + You can edit the existing user libraries as well using <guilabel>User Libraries Fileset</guilabel> Wizard. Right-click on the library fileset and select the <guimenuitem>Edit Fileset</guimenuitem> option. + </para> <figure> <title>Editing User Library Fileset</title> @@ -1041,8 +1014,7 @@ </imageobject> </mediaobject> </figure> - <para>The context menu on the items in the view is extendable, but there are several - that come standard.</para> + <para>There are a number of variable options in the context menu, but there are also several that come standard.</para> <table> <title>Context Menu on the Item</title> @@ -1071,8 +1043,7 @@ </entry> <entry> - <para>The action enabled only on top-level archives, which initiates - a full build on that archive</para> + <para>This action is enabled only on top-level archives, and initiates a full build on that archive</para> </entry> </row> @@ -1082,8 +1053,7 @@ </entry> <entry> - <para>Standard action that brings up the wizard associated with that - particular node type and allows the details to be changed</para> + <para>Standard action that brings up the wizard associated with that particular node type and allows the details to be changed</para> </entry> </row> @@ -1093,8 +1063,7 @@ </entry> <entry> - <para>Deleting node is standard action with deletion not needing an - explanation</para> + <para>This option deletes the selected node</para> </entry> </row> @@ -1104,8 +1073,7 @@ </entry> <entry> - <para>The action means the ability to publish to a declared - server</para> + <para>This action will publish to a declared server</para> </entry> </row> @@ -1115,7 +1083,7 @@ </entry> <entry> - <para>Gives possibility to edit an archive publish settings</para> + <para>This option edits the archives publish settings</para> </entry> </row> @@ -1131,9 +1099,8 @@ <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>Archives View</property>. </emphasis> + <para> + Finally, you will need to publish your application to a server. This section describes how to do it with the help of the <guilabel>Archives</guilabel> View. </para> <figure> @@ -1144,30 +1111,26 @@ </imageobject> </mediaobject> </figure> - <para>The dialog above appears after selecting <emphasis> - <property>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>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> + <para> + The dialog shown above appears after selecting the <guilabel>Publish To Server</guilabel> option. To publish once, select the server(s) that you want and click the <guibutton>Finish</guibutton> button. If you want the <guilabel>Publish to Server</guilabel> action on that particular Archive to always publish to that set of servers, then check the appropriate checkbox. 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 need 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> + Refer to the <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> to find more on how to build your applications using Ant. + </para> - <para>We also recommend you to watch the <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm">movie</ulink> which demonstrates a powerful archiving functionality in - <property>JBoss Tools</property>.</para> + <para> + We also recommend that you watch this <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm">movie</ulink> which demonstrates the powerful archiving functionality in <productname>JBoss Tools</productname>. + </para> - <para>At this point, you are guessed to be familiar with <property>JBoss AS - perspective</property> and your next step now is to explore how to work with - different kinds of projects.</para> + <para> + This chapter has covered the functionality provided by the <property>JBoss AS perspective</property>. The next chapter will explore working with different kinds of projects. + </para> </section> </section>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28741 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 22:00:32 -0500 (Sun, 30 Jan 2011) New Revision: 28741 Modified: trunk/as/docs/reference/en-US/perspective.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/perspective.xml =================================================================== --- trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 02:22:45 UTC (rev 28740) +++ trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 03:00:32 UTC (rev 28741) @@ -420,7 +420,7 @@ what its current value is.</para--> <para> - By right-clicking on the <guilabel>XML Configuration</guilabel> node you can create a new category. Besides, context menu for <emphasis> <property>XML Configuration</property></emphasis> category makes possible to disable it. You can disable any category in the bottom part of the <guilabel>Servers</guilabel> view. Look for them in the <guilabel>Inactive Categories</guilabel> afterwards to re-enable. + By right-clicking on the <guilabel>XML Configuration</guilabel> node you can create a new category. Besides, context menu for <guilabel>XML Configuration</guilabel> category makes possible to disable it. You can disable any category in the bottom part of the <guilabel>Servers</guilabel> view. Look for them in the <guilabel>Inactive Categories</guilabel> afterwards to re-enable. </para> <figure> @@ -432,11 +432,9 @@ </mediaobject> </figure> - <para>By right-clicking on <emphasis> - <property>Ports</property> - </emphasis> or any other category in <emphasis> - <property>XML Configuration</property> - </emphasis>, you can create a new xpath.</para> + <para> + By right-clicking on the <guilabel>Ports</guilabel> category, or any other category in <guilabel>XML Configuration</guilabel>, you can create a new XPath. + </para> <figure> <title>Adding New XPath</title> @@ -458,14 +456,9 @@ </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>XPath Patten</property> - </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> - <property>Attribute Name</property> - </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> + <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 <code>name</code> attribute in the element <code><mbean></code>, then your <guilabel>XPath Patten</guilabel> should end with <code>mbean</code> and your <guilabel>Attribute Name</guilabel> should be <code>name</code>, as demonstrated in the next figure. + </para> <programlisting role="XML"><![CDATA[... <server> @@ -492,20 +485,14 @@ </mediaobject> </figure> - <tip> + <note> <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>Notice when you type the fields autocomplete to help you locate exactly what XPath you're looking for.</para> + </note> - <para>Then, on the other hand, if your desired field is the text of an element - <code><description></code>, your <emphasis> - <property>XPath Patten</property> - </emphasis> should end with <emphasis>description</emphasis> and <emphasis> - <property>Attribute Name</property> - </emphasis> field should be left blank. When finished, click <emphasis> - <property>Preview</property> - </emphasis> to see how many matches you have for that particular XPath.</para> + <para> + If your desired field is the text of an element <code><description></code>, your <guilabel>XPath Patten</guilabel> should end with <code>description</code> and <guilabel>Attribute Name</guilabel> field should be left blank. When finished, click the <guibutton>Preview</guibutton> button to see how many matches are found for that particular XPath. + </para> <figure> <title>XPath Preview</title> @@ -522,9 +509,9 @@ <section id="dragndrop_to_jboss_server_view"> <title>Drag-n-Drop to Servers view</title> - <para>Starting from 2.0.0.CR2 version of <property>JBoss AS Tools</property> the - <property>Servers</property> view supports drag-n-drop of deployable and - runnable projects/resources.</para> + <para> + Starting from <productname>JBoss AS Tools</productname> 2.0.0.CR2 the <guilabel>Servers</guilabel> view supports drag-n-drop of deployable and runnable projects and resources. + </para> <figure> <title>Dragging to the Servers view</title> @@ -539,48 +526,37 @@ <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> + <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>.xhtml</property> - </emphasis> file from <emphasis> - <property>WebContent</property> - </emphasis> will do the same and show the corresponding page in a - browser</para> + <para> + Dragging an <filename>.xhtml</filename> file from the <filename>WebContent</filename> folder 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>-ds.xml</property> - </emphasis>) file that has been made deployable) will simply deploy that - resource directly to the server</para> + <para> + Dragging a deployable resource (i.e. a datasource <filename>-ds.xml</filename> 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>Run On Server</property> - </emphasis> option or <emphasis> - <property>Add and Remove Projects</property> - </emphasis> option in the context menu of the server.</para> + <para> + In short, the feature does the same thing as if you used the <guimenuitem>Run On Server</guimenuitem> or <guimenuitem>Add and Remove Projects</guimenuitem> 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>Server - Log</property>. To open a server in the <property>Server Log view</property> you - should right-click on the server and follow to <emphasis> - <property>Open in > Server Log</property>.</emphasis> + <para> + You can monitor the current server behavior with the help of the <property>Server Log</property>. To open a server in the <property>Server Log view</property> you should right-click on the server and follow to <menuchoice><guimenuitem>Open in</guimenuitem><guimenuitem>Server Log</guimenuitem></menuchoice>. </para> - <para>The <emphasis> - <property>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> + <para> + The <guilabel>Server Log</guilabel> view 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> <title>Event Log Actions</title> @@ -591,8 +567,7 @@ </mediaobject> </figure> - <para>The <property>Server Log</property> toolbar contains several icons that perform - the following actions:</para> + <para>The <guilabel>Server Log</guilabel> view toolbar contains several icons that perform the following actions:</para> <table> <title>Server Log Toolbar Icons</title> @@ -618,7 +593,7 @@ <para>Export Log</para> </entry> <entry> - <para>Possibility to export the log into a text file</para> + <para>Allows you to export the log into a text file</para> </entry> </row> @@ -627,7 +602,7 @@ <para>Clear Log Viewer</para> </entry> <entry> - <para>The option clears the current server log</para> + <para>This option clears the current server log</para> </entry> </row> @@ -666,8 +641,7 @@ <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> + <para>By double-clicking on any server, an window will appear allowing you to edit the servers settings.</para> <figure> <title>Preferences Page for the Chosen Server</title> @@ -678,28 +652,20 @@ </mediaobject> </figure> - <tip> + <note> <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> + On the figure you can see that the username and password fields are available. If you get a SecurityException when trying to launch the server, it is most likely because your server is protected, which requires that you need to fill the username and password fields with appropriate values. + </para> + </note> - <para>Under the <emphasis> - <property>Publishing</property> - </emphasis> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</para> + <para> + Under the <guilabel>Publishing</guilabel> section it is possible to disable or enable 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>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>Server Ports</property> - </emphasis> section in the <property>Server editor</property> is provided where the - port settings are configurable. Click the <emphasis> - <property>Configure...</property> - </emphasis> link to bring up the wizard for adjusting the settings for the - ports.</para> + <para> + It should be pointed out that the server adapter tries to automatically detect the ports it needs for integrating with a <property>JBoss Server</property> by default. Sometimes it is necessary to override this automatic detection if you are using a custom configuration. The <guilabel>Server Ports</guilabel> section in the <guilabel>Server editor</guilabel> provides fields to customize port settings. Click the <guilabel>Configure...</guilabel> link to bring up the wizard for adjusting the settings for the ports. + </para> <figure> <title>Server Ports Preferences</title> @@ -710,9 +676,7 @@ </mediaobject> </figure> - <para>Press <emphasis> - <property>Edit XPath</property> - </emphasis> button for the chosen port to configure its XPath's values.</para> + <para>Click the <guilabel>Edit XPath</guilabel> button for the chosen port to configure its XPath's values.</para> <figure> <title>XPath Pattern for a Server Port</title> @@ -723,26 +687,18 @@ </mediaobject> </figure> - <para>In the <property>Server editor</property> you are able to edit the timeouts and the server pollers to use.</para> + <para>In the <guilabel>Server editor</guilabel> 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>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>"Started"</property> - </emphasis> after your startup timeout is reached.</para> + <para> + By default, the Startup poller is set to JMX Poller. If you change the Startup poller to Timeout Poller (which may be required if you are using the minimal configuration for your server), this will do no polling at all and will only set the server state to <guilabel>"Started"</guilabel> after your startup timeout is reached. + </para> </note> <para id="com_line_arg"> - <property>Server editor</property> makes it also possible to - modify the server's launch configuration. It's just after clicking <emphasis> - <property>Open launch configuration</property> - </emphasis> 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.</para> + The <guilabel>Server editor</guilabel> window also allows you to modify the server's launch configuration. The settings is available by clicking the the <guilabel>Open launch configuration</guilabel> link. The resulting window provides tabs for setting command line arguments, main, classpaths and other things that are relevant to launching the server. + </para> <figure> <title>Launch Configuration Properties</title> @@ -755,37 +711,34 @@ <para>The first tab shows the Jboss server arguments</para> - <para>Look up <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html">AS Installation Guide </ulink> to find parameters which can be specified for <property>JBoss - Server</property>.</para> + <para> + See the <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html">AS Installation Guide </ulink> to find the parameters that can be specified for <productname>JBoss Server</productname>. + </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> + Please note that the values in the Launch Configurations for JBoss Servers are strictly enforced 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> + For example, if you change the launch configuration program arguments to <code>"-c myConfig"</code> but do not change the targeted runtime configuration, then your program arguments will be ignored. The configuration of 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> + <para>Values are not controlled by the server and its runtime setup will be passed on unaltered.</para> </note> - <para>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. </para> + <para> + On the second tab you find the main class used for launching JBoss AS (the default is <code>org.jboss.Main</code>). this value can be changed if necessary. + </para> - <para>Until 3.0.0.GA release of <property>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> + Until <property>JBoss Tools</property> 3.0.0.GA the servers classpath was read only, 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> + <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> <title>Server Classpaths</title>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28740 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 21:22:45 -0500 (Sun, 30 Jan 2011) New Revision: 28740 Modified: trunk/as/docs/reference/en-US/perspective.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/perspective.xml =================================================================== --- trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 01:54:21 UTC (rev 28739) +++ trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 02:22:45 UTC (rev 28740) @@ -1,519 +1,473 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="perspective" xreflabel="perspective" role="updated"> - <?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> + <?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> + <title>JBoss AS Perspective</title> - <para>This chapter tells how to manage installed <property>JBoss Server</property> via - <property>JBoss AS perspective</property>.</para> + <para>This chapter describes how to manage installed <productname>JBoss Servers</productname> via the <guilabel>JBoss AS</guilabel> perspective.</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>Servers - </property> view.</para> + <para> + The <guilabel>JBoss AS</guilabel> perspective is similar to the <guilabel>Java</guilabel> perspective, but it contains a few additional views. The <guilabel>Console view</guilabel> and the <guilabel>Properties view</guilabel> are standard views. The other two views that are added are the <guilabel>Project archives</guilabel> view and the <guilabel>Servers</guilabel> view. + </para> - <section id="JBossServerView" role="updated"> - <?dbhtml filename="JBossServerView.html"?> - <title>The Servers view</title> + <section id="JBossServerView" role="updated"> + <?dbhtml filename="JBossServerView.html"?> + <title>The Servers view</title> - <para>The <property>Servers</property> view 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> + The <guilabel>Servers</guilabel> view is built on the Common Navigator Framework allowing extensions and is using label decorators that make the UI compact enough without loosing the vital information. + </para> - <para>Let's have a look at the <property>Servers</property> view and inspect - in detail all parts it consists of. </para> - <figure> - <title>The Servers view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_1.png"/> - </imageobject> - </mediaobject> - </figure> + <para>Let's have a detailed look at the <guilabel>Servers</guilabel> view and its constituent components.</para> + <figure> + <title>The Servers view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"/> + </imageobject> + </mediaobject> + </figure> - <section id="jbossserver_view_toolbar"> - <title>Servers view Toolbar</title> - <para>In the right top corner of the <property>Servers</property> view 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> + <section id="jbossserver_view_toolbar"> + <title>Servers view Toolbar</title> + <para> + In the right top corner of the <guilabel>Servers</guilabel> view there is a special toolbar which provides a quick access for starting a server (in the debug mode, run mode, or profile mode), restarting a server, stopping a server and a publishing to a server. + </para> - <figure> - <title>The Servers view Toolbar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_2.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>The Servers view Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_2.png"/> + </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> + In order to debug your applications or EJB's that are deployed to the server, the server must be started 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>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>JBoss Tools</property> - refer to <link linkend="tptp_support">TPTP Support</link> chapter.</para> + <para> + The <guibutton>Start the server in profiling mode</guibutton> button allows you to enable profiling actions for your application. For more details on how to start using TPTP profiling with <property>JBoss Tools</property> see <xref linkend="tptp_support"/>. + </para> - <para><emphasis> - <property>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> + <para> + The <guibutton>Publish to the server</guibutton> button will republish any modules where it has determined that the workspace is out of sync with the server. It will attempt to do an incremental publish if the module in question is capable of doing one. + </para> - </section> + </section> - <section id="jbossserver_view_structure"> - <title>Servers view Structure</title> - <para>The <property>Servers</property> view 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> + <section id="jbossserver_view_structure"> + <title>Servers view Structure</title> + <para> + The <guilabel>Servers</guilabel> view displays all defined servers as well as their current status (that is whether they are started or stopped) in square brackets next to the server name. + </para> - <figure> - <title>The Servers view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_1.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>The Servers view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"/> + </imageobject> + </mediaobject> + </figure> - <para>The following table lists possible server statuses.</para> + <para>The following table lists possible server statuses.</para> - <table> - <title>Server Publish Status</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> + <table> + <title>Server Publish Status</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> - <thead> - <row> - <entry align="center">Status</entry> + <thead> + <row> + <entry align="center">Status</entry> - <entry align="center">Description</entry> - </row> - </thead> + <entry align="center">Description</entry> + </row> + </thead> - <tbody> - <row> - <entry align="center"> - <para>Republish</para> - </entry> + <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 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 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> + <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> + <para>You can control a server behavior as well as adjust a number of server preferences through the context menu.</para> - <figure> - <title>Context Menu Commands</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_8.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Context Menu Commands</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_8.png"/> + </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 colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> + <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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> + <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> + <tbody> + <row> + <entry> + <para>New Server</para> + </entry> + <entry> + <para>The option allows you 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>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>Show in</para> + </entry> + <entry> + <para>This option provides easy access to the Console, Debug, Server Log or MBean Explorer views</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>Delete</para> + </entry> + <entry> + <para>Standard option that allows you 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>Start</para> + </entry> + <entry> + <para>This will start the 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>Debug</para> + </entry> + <entry> + <para>This will start the 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>Stop</para> + </entry> + <entry> + <para>this will stop the 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>Publish</para> + </entry> + <entry> + <para>This will synchronize 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>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 and 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>Add and Remove Projects</para> + </entry> + <entry> + <para>This option will 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>Monitoring</para> + </entry> + <entry> + <para>Allows you 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> + <row> + <entry> + <para>Properties</para> + </entry> + <entry> + <para>Opens a window that allows you to adjust the current server preferences</para> + </entry> + </row> - </tbody> - </tgroup> - </table> + </tbody> + </tgroup> + </table> - <para>Under the server element in the <property>Servers</property> view, you can - see currently deployed to the server modules and some server extensions which - provide the additional information on the server.</para> + <para> + Under the server element in the <guilabel>Servers</guilabel> view, you can see modules that are currently deployed to the server and some server extensions that provide 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> + <para>The context menu for any module allows you to remove it from the server, and force a full or incremental republish upon it.</para> - <figure> - <title>Modules Action</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_11.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_11.png"/> + </imageobject> + </mediaobject> + </figure> - <section id="filesets"> - <title>Filesets</title> + <section id="filesets"> + <title>Filesets</title> - <para>The <emphasis> - <property>Filesets</property> - </emphasis> category in the <property>Servers</property> view is intended - for files filtering.</para> + <para>The <guilabel>Filesets</guilabel> category in the <guilabel>Servers</guilabel> view provides a way to filter files.</para> - <para>To add a new file filter, right-click the <emphasis> - <property>Filesets</property> - </emphasis> category and select <emphasis> - <property>Create File Filter</property>.</emphasis></para> - <para id="filefilterWiz">The <property>New File - Filter wizard</property> should appear.</para> + <para> + To add a new file filter, right-click the <guilabel>Filesets</guilabel> category and select the <guimenuitem>Create File Filter</guimenuitem> option. + </para> + <para id="filefilterWiz">The <guilabel>New File Filter wizard</guilabel> should appear.</para> - <figure> - <title>Creating a New File Filter</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets1.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Creating a New File Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets1.png"/> + </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>${jboss_config}</literal>, i. e. you should type in the <emphasis> - <property>Root Directory</property></emphasis> something like <literal>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> - <title>New File Filter Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets2_a.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Notice, that the <emphasis> - <property>Browse</property></emphasis> button still returns an absolute path:</para> + <para> + The wizard asks you to enter the filter name and add includes and excludes patterns. The preview box underneath provides 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 fixed configuration of the server runtime, use the following variable: <filename>${jboss_config}</filename>, i. e. you should enter <filename>server/${jboss_config}/</filename> in the <guilabel>Root Directory</guilabel> option. This allows you to modify the runtime's configuration and not have to manually update paths. + </para> + <figure> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2_a.png"/> + </imageobject> + </mediaobject> + </figure> - <figure> - <title>New File Filter Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets2.png"/> - </imageobject> - </mediaobject> - </figure> + <para>Notice, that the <emphasis> + <property>Browse</property> + </emphasis> button still returns an absolute path:</para> - <para>After the filter is created, you can observe it by expanding the <emphasis> - <property>Filesets</property> - </emphasis> category in the <property>Servers</property> view.</para> + <figure> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2.png"/> + </imageobject> + </mediaobject> + </figure> - <para>It's possible now to edit files directly from the <emphasis> - <property>Filesets</property> - </emphasis> category. Double clicking on a file from <emphasis> - <property>Filesets</property> - </emphasis> opens up the editor automatically or you can use the <emphasis> - <property>Edit File</property> - </emphasis> context menu command.</para> + <para> + After the filter is created, you can explore it by expanding the <guilabel>Filesets</guilabel> category in the <guilabel>Servers</guilabel> view. + </para> - <figure> - <title>Direct Editing from the Filesets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets3.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + It is now possible to edit files directly from the <guilabel>Filesets</guilabel> category. Double clicking on a file from <guilabel>Filesets</guilabel> opens up the editor automatically, or you can use the <guimenuitem>Edit File</guimenuitem> context menu command. + </para> - <para>To delete a file filter (or just a file) from the <emphasis> - <property>Filesets</property>,</emphasis> right-click a file filter (or the - unnecessary file) and select the <emphasis> - <property>Delete File Filter</property> - </emphasis> - <emphasis>(<property>Delete File</property>)</emphasis> command.</para> + <figure> + <title>Direct Editing from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets3.png"/> + </imageobject> + </mediaobject> + </figure> - <figure> - <title>Deleting the File from the Filesets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>If you want to set filesets for some server types, you should open - <emphasis><property>Window>Preferences</property></emphasis> - and then select <emphasis><property>Server > Default Filesets</property></emphasis> - from the categories available on the left.</para> + <para> + To delete a file filter (or just a file) from the <guilabel>Filesets</guilabel>, right-click a file filter or file and select the <guimenuitem>Delete File Filter</guimenuitem> or <guimenuitem>Delete File</guimenuitem> command. + </para> + + <figure> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets4.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + If you want to set filesets for some server types, select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> and then select <menuchoice><guimenuitem>Server</guimenuitem><guimenuitem>Default</guimenuitem></menuchoice> from the categories available on the left. + </para> + + <figure> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets5.png"/> + </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 the <guibutton>Add fileset...</guibutton> button. In the opened <guilabel>New File Filter wizard</guilabel> follow the steps described in <xref linkend="filefilterWiz"/>, and finally click the <guibutton>Apply</guibutton> button on the preference page. + </para> + <para>The defined file filter will be automatically added to new servers during their creation.</para> - <figure> - <title>Deleting the File from the Filesets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/filesets5.png"/> - </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>Add fileset...</property></emphasis> button. - In the opened <property>New File - Filter wizard</property> follow the steps described <link linkend="filefilterWiz">before</link> and finally click <emphasis><property>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>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 an xpath is a path used to access some - specific part of an xml document. </para> + </section> - <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> + <section id="xml_configuration"> + <title>XML Configuration</title> + <para> + The <guilabel>XML Configuration</guilabel> category allows you to quickly browse to descriptor files in your server's deploy directory and check or change the values. Basically, <guilabel>XML Configuration</guilabel> includes XML XPaths, where an XPath is a path used to access some specific part of an XML document. + </para> - <para>The <emphasis> - <property>XML Configuration</property> - </emphasis> category itself contains only a list of categories. <emphasis> - <property>Ports</property> - </emphasis> are provided by default and is filled with many of the most commonly - used ports in the <property>JBoss Server</property>.</para> + <note> + <title>Note:</title> + <para> + This document assumes that you are familiar with XPath. If not, we highly suggested that you look through an appropriate manual or tutorial on the topic. + </para> + </note> - <figure> - <title>XML Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_14.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + The <guilabel>XML Configuration</guilabel> category itself contains only a list of categories. <guilabel>Ports</guilabel> are provided by default, and display many of the most commonly used ports in the <productname>JBoss Server</productname>. + </para> + <figure> + <title>XML Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_14.png"/> + </imageobject> + </mediaobject> + </figure> +  - <para>By right-clicking on <emphasis> - <property>XML Configuration</property>, </emphasis> you can create a new - category. Besides, context menu for <emphasis> - <property>XML Configuration</property> - </emphasis> category makes possible to disable it. You can disable any category - in the bottom part of the <emphasis> - <property>Servers</property> view.</emphasis> Look for them in the <emphasis> - <property>Inactive Categories</property> - </emphasis> afterwards to re-enable.</para> + <para> + By right-clicking on the <guilabel>XML Configuration</guilabel> node you can create a new category. Besides, context menu for <emphasis> <property>XML Configuration</property></emphasis> category makes possible to disable it. You can disable any category in the bottom part of the <guilabel>Servers</guilabel> view. Look for them in the <guilabel>Inactive Categories</guilabel> afterwards to re-enable. + </para> - <figure> - <title>Adding New Category</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_15.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_15.png"/> + </imageobject> + </mediaobject> + </figure> - <para>By right-clicking on <emphasis> + <para>By right-clicking on <emphasis> <property>Ports</property> - </emphasis> or any other category in <emphasis> + </emphasis> or any other category in <emphasis> <property>XML Configuration</property> - </emphasis>, you can create a new xpath.</para> + </emphasis>, you can create a new xpath.</para> - <figure> - <title>Adding New XPath</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_16.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_16.png"/> + </imageobject> + </mediaobject> + </figure> - <para>After that, the dialog shown below will appear.</para> + <para>After that, the dialog shown below will appear.</para> - <figure> - <title>Adding New XPath</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_17.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_17.png"/> + </imageobject> + </mediaobject> + </figure> - <para>The goal here is to get an end result where the XPath matches up with a + <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>XPath Patten</property> - </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> + </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> <property>Attribute Name</property> - </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> + </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> - <programlisting role="XML"><![CDATA[... + <programlisting role="XML"><![CDATA[... <server> ... <mbean code="org.jboss.ejb.EJBDeployer" @@ -529,736 +483,741 @@ </server> ]]></programlisting> - <figure> - <title>XPath Preview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_18.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_18.png"/> + </imageobject> + </mediaobject> + </figure> - <tip> - <title>Tip:</title> - <para>Notice, when you type the fields autocomplete to help you locate exactly + <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> + </tip> - <para>Then, on the other hand, if your desired field is the text of an element + <para>Then, on the other hand, if your desired field is the text of an element <code><description></code>, your <emphasis> <property>XPath Patten</property> - </emphasis> should end with <emphasis>description</emphasis> and <emphasis> + </emphasis> should end with <emphasis>description</emphasis> and <emphasis> <property>Attribute Name</property> - </emphasis> field should be left blank. When finished, click <emphasis> + </emphasis> field should be left blank. When finished, click <emphasis> <property>Preview</property> - </emphasis> to see how many matches you have for that particular XPath.</para> + </emphasis> to see how many matches you have for that particular XPath.</para> - <figure> - <title>XPath Preview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_19.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_19.png"/> + </imageobject> + </mediaobject> + </figure> - </section> - </section> + </section> + </section> - <section id="dragndrop_to_jboss_server_view"> - <title>Drag-n-Drop to Servers view</title> + <section id="dragndrop_to_jboss_server_view"> + <title>Drag-n-Drop to Servers view</title> - <para>Starting from 2.0.0.CR2 version of <property>JBoss AS Tools</property> the + <para>Starting from 2.0.0.CR2 version of <property>JBoss AS Tools</property> the <property>Servers</property> view supports drag-n-drop of deployable and runnable projects/resources.</para> - <figure> - <title>Dragging to the Servers view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/dnd_toJBossServerView.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Dragging to the Servers view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/dnd_toJBossServerView.png"/> + </imageobject> + </mediaobject> + </figure> - <para>With drag-n-drop the following actions can be performed:</para> + <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 + <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> - <listitem> - <para>dragging an <emphasis> + <listitem> + <para>dragging an <emphasis> <property>.xhtml</property> - </emphasis> file from <emphasis> + </emphasis> file from <emphasis> <property>WebContent</property> - </emphasis> will do the same and show the corresponding page in a + </emphasis> will do the same and show the corresponding page in a browser</para> - </listitem> + </listitem> - <listitem> - <para>dragging a deployable resource (i.e. a datasource (<emphasis> + <listitem> + <para>dragging a deployable resource (i.e. a datasource (<emphasis> <property>-ds.xml</property> - </emphasis>) file that has been made deployable) will simply deploy that + </emphasis>) file that has been made deployable) will simply deploy that resource directly to the server</para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> - <para>In short, the feature does the same thing as if you used the <emphasis> + <para>In short, the feature does the same thing as if you used the <emphasis> <property>Run On Server</property> - </emphasis> option or <emphasis> + </emphasis> option or <emphasis> <property>Add and Remove Projects</property> - </emphasis> option in the context menu of the server.</para> - </section> + </emphasis> option in the context menu of the server.</para> + </section> - <section id="server_log"> - <title>Server Log View</title> + <section id="server_log"> + <title>Server Log View</title> - <para>You can monitor the current server behavior with the help of the <property>Server + <para>You can monitor the current server behavior with the help of the <property>Server Log</property>. To open a server in the <property>Server Log view</property> you should right-click on the server and follow to <emphasis> - <property>Open in > Server Log</property>.</emphasis></para> + <property>Open in > Server Log</property>.</emphasis> + </para> - <para>The <emphasis> + <para>The <emphasis> <property>Server Log</property> - </emphasis> shows relevant information to your server's startup, shutdown, + </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> - <title>Event Log Actions</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_12.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_12.png"/> + </imageobject> + </mediaobject> + </figure> - <para>The <property>Server Log</property> toolbar contains several icons that perform + <para>The <property>Server Log</property> toolbar contains several icons that perform the following actions:</para> - <table> - <title>Server Log Toolbar Icons</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> + <table> + <title>Server Log Toolbar Icons</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> + <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> + <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>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>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>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> + <row> + <entry> + <para>Restore Log</para> + </entry> + <entry> + <para>Click to restore the server log</para> + </entry> + </row> - </tbody> - </tgroup> - </table> + </tbody> + </tgroup> + </table> - </section> + </section> - <section id="server_editor"> - <title>Server Editor</title> - <para>By double-clicking on any server, an editor window will appear allowing you to + <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> - <title>Preferences Page for the Chosen Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_4.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Preferences Page for the Chosen Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_4.png"/> + </imageobject> + </mediaobject> + </figure> - <tip> - <title>Tip:</title> - <para>On the figure you can see that a username/password is available in the UI when + <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>Publishing</property></emphasis> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</para> + </tip> - <para>It should be pointed out that our server adapter by default tries to automatically + <para>Under the <emphasis> + <property>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>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>Server Ports</property> - </emphasis> section in the <property>Server editor</property> is provided where the + </emphasis> section in the <property>Server editor</property> is provided where the port settings are configurable. Click the <emphasis> <property>Configure...</property> - </emphasis> link to bring up the wizard for adjusting the settings for the + </emphasis> link to bring up the wizard for adjusting the settings for the ports.</para> - <figure> - <title>Server Ports Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_5.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Server Ports Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_5.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Press <emphasis> + <para>Press <emphasis> <property>Edit XPath</property> - </emphasis> button for the chosen port to configure its XPath's values.</para> + </emphasis> button for the chosen port to configure its XPath's values.</para> - <figure> - <title>XPath Pattern for a Server Port</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_6.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>XPath Pattern for a Server Port</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_6.png"/> + </imageobject> + </mediaobject> + </figure> - <para>In the <property>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>Server Polling</property></emphasis> section). If you change the Startup poller + <para>In the <property>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>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>"Started"</property></emphasis> after your startup timeout is reached.</para> - </note> + <property>"Started"</property> + </emphasis> after your startup timeout is reached.</para> + </note> - <para id="com_line_arg"><property>Server editor</property> makes it also possible to + <para id="com_line_arg"> + <property>Server editor</property> makes it also possible to modify the server's launch configuration. It's just after clicking <emphasis> <property>Open launch configuration</property> - </emphasis> link. In the open window there are the tabs for setting command line + </emphasis> 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.</para> - <figure> - <title>Launch Configuration Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_7.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Launch Configuration Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7.png"/> + </imageobject> + </mediaobject> + </figure> - - <para>The first tab shows the Jboss server arguments</para> - <para>Look up <ulink - url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html" - >AS Installation Guide </ulink> to find parameters which can be specified for <property>JBoss + + <para>The first tab shows the Jboss server arguments</para> + <para>Look up <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html">AS Installation Guide </ulink> to find parameters which can be specified for <property>JBoss Server</property>.</para> - <note> - <title>Note:</title> - <para>Please note, that the Launch Configurations for JBoss Servers are enough + <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 + <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 + <para>Values are not controlled by the server and its runtime setup will be passed on unaltered.</para> - </note> - - <para>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. </para> + </note> - <para>Until 3.0.0.GA release of <property>JBoss Tools</property>, the servers classpath + <para>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. </para> + + <para>Until 3.0.0.GA release of <property>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 + <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> - <title>Server Classpaths</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/server_classpaths.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Server Classpaths</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/server_classpaths.png"/> + </imageobject> + </mediaobject> + </figure> - <para>If for some reason you have a launch configuration without this container, <emphasis> + <para>If for some reason you have a launch configuration without this container, <emphasis> <property>Restore Default Entries</property> - </emphasis> should add it properly. Also, <emphasis> + </emphasis> should add it properly. Also, <emphasis> <property>Restore Default Entries</property> - </emphasis> will also remove any extra entries you added yourself.</para> - <para>Using <emphasis>Deployment tab</emphasis> you configure local deployment settings.</para> + </emphasis> will also remove any extra entries you added yourself.</para> + <para>Using <emphasis>Deployment tab</emphasis> you configure local deployment settings.</para> - - <figure> - <title>Deployment tab</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_7a.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Using the group of radio buttons in <property>Default Settings section</property> + + <figure> + <title>Deployment tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Using the group of radio buttons in <property>Default Settings section</property> a user can set where the application will be deployed to.By default it is deployed to the user's workspace folder, exactly to <property>[workspaceDirecotry]\.metadata\.plugins</property>.If you would like the application to be deployed to your Jboss - server deploy folder select <emphasis><property>Use the JBoss deploy folder</property></emphasis>. + server deploy folder select <emphasis><property>Use the JBoss deploy folder</property> + </emphasis>. The option to specify your custom deploy folder is also available.</para> - </section> + </section> - <section> - <title>Relevant Resources Links</title> - <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath + <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> + </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, + <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 + <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> + </note> - <para>But <property>JBoss Tools</property> come with our own Archives tool with a bit easier + <para>But <property>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>Project Archives view</property>, to set up each packaging configuration.</para> - <para>So far, let's look through all functionality that the <property>Project + <para>So far, let's look through all functionality that the <property>Project Archives view</property> provides.</para> - <section id="archives_overview"> - <title>Overview</title> + <section id="archives_overview"> + <title>Overview</title> - <para>The packaging configuration for each project is stored in the project's root + <para>The packaging configuration for each project is stored in the project's root folder, and is in a file named <emphasis> <property>.packages</property> - </emphasis>, which has a fairly simple XML structure. Modifying the file by hand is + </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> - <title>Archives View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_21.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21.png"/> + </imageobject> + </mediaobject> + </figure> - <para>A project's configuration contains archives. As you can see on the image + <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, + <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>Project > Build Packages</property> - </emphasis> when a project is selected in the <property>Packages View</property> to + </emphasis> when a project is selected in the <property>Packages View</property> to build all declared packages in that project's <emphasis> <property>.packages</property> - </emphasis> file. This will execute a full build on all declared archives.</para> - </section> + </emphasis> file. This will execute a full build on all declared archives.</para> + </section> - <section id="Creating_Archive"> - <title>Creating an Archive</title> + <section id="Creating_Archive"> + <title>Creating an Archive</title> - <para>When you open the <property>Project archives view</property> for the first time, + <para>When you open the <property>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> - <title>Archives View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_21a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21a.png"/> + </imageobject> + </mediaobject> + </figure> - <para>When creating a new archive for selected project, you have some different options + <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>New Archive</property> - </emphasis> to see your archive type options.</para> + </emphasis> to see your archive type options.</para> - <figure> - <title>Create an Archive</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_22.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Create an Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_22.png"/> + </imageobject> + </mediaobject> + </figure> - <note> - <title>Note:</title> - <para>If you see only JAR from the list of available archive types, you should + <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> + </note> - <para><property>JAR</property> is the standard archive type, and does very little + <para> + <property>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, + <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>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 + <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>New Jar wizard</property>.</para> - <figure> - <title>New WAR Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>New WAR Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23.png"/> + </imageobject> + </mediaobject> + </figure> - <para>The page is pretty simple. First it asks to set the name of your new archive and a + <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 + <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>workspace</property> - </emphasis> or <emphasis> + </emphasis> or <emphasis> <property> file system</property> - </emphasis>) for marking the destination as related to either workspace or file + </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>Workspace</property> - </emphasis> button. At the bottom of the list, you'll see archives that + </emphasis> button. At the bottom of the list, you'll see archives that have been declared in the workspace.</para> - <figure> - <title>Selecting the destination in the workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23a.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Also in the wizard for creating a new archive you can choose whether an archive to + <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>Archive type</property> - </emphasis> section.</para> - <para>If a build or incremental update fails Project Archives will show an error + </emphasis> section.</para> + <para>If a build or incremental update fails Project Archives will show an error dialog:</para> - <figure> - <title>Selecting the destination in the workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/projectarchives_error.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click in <emphasis> + <figure> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/projectarchives_error.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click in <emphasis> <property>Details</property> - </emphasis> to see detailed information about what caused the error.</para> + </emphasis> to see detailed information about what caused the error.</para> - <para>In the <property>Package Explorer</property> you can observe the created + <para>In the <property>Package Explorer</property> you can observe the created archive.</para> - <figure> - <title>The Archive in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23b.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>The Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23b.png"/> + </imageobject> + </mediaobject> + </figure> - <para>If you use the exploded type of archiving, instead of a single file archive the + <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>Package Explorer</property>.</para> - <figure> - <title>The Exploded Archive in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_23c.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>The Exploded Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23c.png"/> + </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 + <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 + </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>New Fileset</property>. </emphasis></para> - <para>The <property>New Fileset wizard</property> requires a destination (where the + <property>New Fileset</property>. </emphasis> + </para> + <para>The <property>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> - <title>Adding a New FileSet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_24.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding a New FileSet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Below that, the fileset requires only an includes pattern and an excludes + <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 + <para>You can create a Fileset with flattening or without it. Look at the difference on the figure below.</para> - <figure> - <title>The FileSet with flattening and without it</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_24a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>The FileSet with flattening and without it</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24a.png"/> + </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> - <title>Adding New User Library Fileset</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/userlibraryfileset1.png"/> - </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> - <title>Editing User Library Fileset</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/userlibraryfileset2.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - </section> + </section> - <section id="View_Actions"> - <title>Archive Actions</title> - <figure> - <title>Context Menu on the Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_25.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The context menu on the items in the view is extendable, but there are several + <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> + <title>Adding New User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset1.png"/> + </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> + <title>Editing User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset2.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + + <section id="View_Actions"> + <title>Archive Actions</title> + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_25.png"/> + </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 colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> + <table> + <title>Context Menu on the Item</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> - <tbody> + <tbody> - <row> - <entry> - <para>Build Archive (Full)</para> - </entry> + <row> + <entry> + <para>Build Archive (Full)</para> + </entry> - <entry> - <para>The action enabled only on top-level archives, which initiates + <entry> + <para>The action enabled only on top-level archives, which initiates a full build on that archive</para> - </entry> - </row> + </entry> + </row> - <row> - <entry> - <para>Edit Archive</para> - </entry> + <row> + <entry> + <para>Edit Archive</para> + </entry> - <entry> - <para>Standard action that brings up the wizard associated with that + <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> + </entry> + </row> - <row> - <entry> - <para>Delete Archive</para> - </entry> + <row> + <entry> + <para>Delete Archive</para> + </entry> - <entry> - <para>Deleting node is standard action with deletion not needing an + <entry> + <para>Deleting node is standard action with deletion not needing an explanation</para> - </entry> - </row> + </entry> + </row> - <row> - <entry> - <para>Publish To Server</para> - </entry> + <row> + <entry> + <para>Publish To Server</para> + </entry> - <entry> - <para>The action means the ability to publish to a declared + <entry> + <para>The action means the ability to publish to a declared server</para> - </entry> - </row> + </entry> + </row> - <row> - <entry> - <para>Edit publish settings</para> - </entry> + <row> + <entry> + <para>Edit publish settings</para> + </entry> - <entry> - <para>Gives possibility to edit an archive publish settings</para> - </entry> - </row> + <entry> + <para>Gives possibility to edit an archive publish settings</para> + </entry> + </row> - </tbody> - </tgroup> - </table> - - <note> - <title>Note:</title> - <para>When editing an archive, it is also updated in all folders and other archives where it is nested.</para> - </note> - </section> + </tbody> + </tgroup> + </table> - <section id="PublishToServer"> - <title>Publishing to Server</title> - <para>Finally, you'll need to publish your application to a server. Here, we + <note> + <title>Note:</title> + <para>When editing an archive, it is also updated in all folders and other archives where it is nested.</para> + </note> + </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>Archives View</property>. </emphasis></para> + <property>Archives View</property>. </emphasis> + </para> - <figure> - <title>Context Menu on the Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_26.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The dialog above appears after selecting <emphasis> + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_26.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The dialog above appears after selecting <emphasis> <property>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>Publish to Server</property> - </emphasis> action on that particular Archive to publish always to that set of + </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 + <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> + </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.htm" - >movie</ulink> which demonstrates a powerful archiving functionality in + <para>We also recommend you to watch the <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm">movie</ulink> which demonstrates a powerful archiving functionality in <property>JBoss Tools</property>.</para> - <para>At this point, you are guessed to be familiar with <property>JBoss AS + <para>At this point, you are guessed to be familiar with <property>JBoss AS perspective</property> and your next step now is to explore how to work with different kinds of projects.</para> - </section> + </section> - </section> + </section> </chapter>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28739 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 20:54:21 -0500 (Sun, 30 Jan 2011) New Revision: 28739 Modified: trunk/as/docs/reference/en-US/runtimes_servers.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/runtimes_servers.xml =================================================================== --- trunk/as/docs/reference/en-US/runtimes_servers.xml 2011-01-31 00:43:03 UTC (rev 28738) +++ trunk/as/docs/reference/en-US/runtimes_servers.xml 2011-01-31 01:54:21 UTC (rev 28739) @@ -1,405 +1,372 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="runtimes_servers" 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 is 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>runtime</property> and <property>server</property> instances.</para> - - <section> - <title>Runtimes</title> - <para>In <property>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>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>Window > Preferences </property> - </emphasis> menu, and then select <emphasis> - <property>Server > Runtime Environments</property> - </emphasis> from the categories available on the left.</para> - <figure> - <title>Installed Runtimes</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"/> - </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>Add</property> - </emphasis> button and choose a necessary type of runtime from the <emphasis> - <property>JBoss Community</property> - </emphasis> category.</para> - - <figure> - <title>Adding a Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>Now there is a separation between .org servers (the <emphasis> - <property>JBoss Community</property> - </emphasis> category) and product server that comes with JBoss EAP in JBDS ( the <emphasis> - <property>JBoss Enterprise Middleware</property> - </emphasis> category).</para> - </note> - - <para>As you can see, <property>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 5.0 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 id="add_runtime_figure"> - <title>Adding a JBoss 5.0 Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"/> - </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 colnum="1" align="left" 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>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>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>Overview>Runtime Environment</property> </emphasis> - ,make sure that necessary configuration is chosen,click <emphasis><property>Finish</property> </emphasis> and then <emphasis><property>Save</property></emphasis> button.</para> - </note> - </section> - <section id="Detecting_an_existing_runtime"> - <title>Detecting an existing runtime</title> - <para> - JBoss Tools features the ability to search, detect and add existing JBoss server runtimes installed on your system. If you don't have an existing runtime <xref linkend="InstNewRuntime"/> will guide you through the creation process. To begin searching for your existing JBoss runtime navigate to <menuchoice> - <guimenuitem>Window</guimenuitem> - <guimenuitem>Preferences</guimenuitem> - <guimenuitem>JBoss Tools</guimenuitem> - <guimenuitem>JBoss Runtimes</guimenuitem> - </menuchoice>. + <?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 is 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>runtime</property> and <property>server</property> instances. + </para> + + <section> + <title>Runtimes</title> + <para> + In <property>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. It can then be used for two primary purposes: + </para> + <itemizedlist> + <listitem> + <para>Providing classpath additions to WTP projects that require them.</para> + </listitem> + <listitem> + <para> + For <property>JBoss server</property> at least, it provides the necessary information to allow the server to be started and stopped, and provides information on 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 by selecting <menuchoice><guimenuitem>Window</guimenuitem> + <guimenuitem>Preferences</guimenuitem> + </menuchoice> menu, and then selecting <menuchoice><guimenuitem>Server</guimenuitem> + <guimenuitem>Runtime Environments</guimenuitem> + </menuchoice> from the categories available on the left. + </para> + <figure> + <title>Installed Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + From this preference page you can see all declared runtimes along with their types. Here, it is possible to edit or remove existing runtimes, as well as add a new one. + </para> + + <para> + To create a JBoss runtime click the <guibutton>Add</guibutton> button and choose the appropriate type of runtime from the <guilabel>JBoss Community</guilabel> category. + </para> + + <figure> + <title>Adding a Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para> + Now there is a separation between .org servers (the <guilabel>JBoss Community</guilabel> category) and product server that comes with JBoss EAP in JBDS ( the <guilabel>JBoss Enterprise Middleware</guilabel> category). + </para> + </note> + + <para> + As you can see, <productname>JBoss Tools</productname> provide its own adapters such as JBoss 3.2, 4.0, 4.2 and 5.0 as well. The last one comes a new safer incremental deployment feature, 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 5.0 server adapter.</para> + </note> + + <para> + You will also note a Deploy-Only Runtime type. This type does not provide a classpath for WTP projects. It is used solely by its server type for the purpose of setting up a deploy directory for users who do not wish to make use of starting, stopping, or debugging their projects inside Eclipse. + </para> + + <figure id="add_runtime_figure"> + <title>Adding a JBoss 5.0 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"/> + </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 colnum="1" align="left" 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>Name</para> + </entry> + <entry> + <para> + The name of a new Runtime for a chosen server. We suggest that you do not leave the default value for this field. It is 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. So rather than forcing you to copy your entire JBoss installation, the structure of the wizard allows to create 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), which 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 will create several different runtimes to test each of your configurations. So 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>Click the <guibutton>Finish</guibutton> button 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, select <menuchoice><guimenuitem>Overview</guimenuitem> + <guimenuitem>Runtime Environment</guimenuitem> + </menuchoice>, make sure that necessary configuration is chosen, click the <guibutton>Finish</guibutton> button and then <guibutton>Save</guibutton> button. + </para> + </note> + </section> + <section id="Detecting_an_existing_runtime"> + <title>Detecting an existing runtime</title> + <para> + JBoss Tools features the ability to search, detect and add existing JBoss server runtimes installed on your system. If you don't have an existing runtime <xref linkend="InstNewRuntime"/> will guide you through the creation process. To begin searching for your existing JBoss runtime select <menuchoice><guimenuitem>Window</guimenuitem> + <guimenuitem>Preferences</guimenuitem> + <guimenuitem>JBoss Tools</guimenuitem> + <guimenuitem>JBoss Runtimes</guimenuitem> + </menuchoice>. </para> - <figure> - <title>Preference page for JBoss Runtimes</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers-detecting_new_runtime_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para> + <figure> + <title>Preference page for JBoss Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers-detecting_new_runtime_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> The JBoss Runtimes preference page allows you to perform three different actions: <guibutton>Search</guibutton> for a JBoss runtime installation, <guibutton>Export</guibutton> a JBoss runtime configuration and <guibutton>Import</guibutton> the configuration of a JBoss runtime. </para> - <para> - The <guibutton>Search</guibutton> button opens a file system browser window. Select a directory where you wish JBoss Tools to begin recursively searching for JBoss runtimes and upon completion it will return all those found. From the returned list, choose the runtimes you wish to make available to your JBoss Tools instance by clicking the box beside each runtime and clicking the <guibutton>OK</guibutton> button. + <para> + The <guibutton>Search</guibutton> button opens a file system browser window. Select the directory where you wish JBoss Tools to begin recursively searching for JBoss runtimes and upon completion it will return all those found. From the returned list, choose the runtimes you wish to make available to your JBoss Tools instance by clicking the box beside each runtime and clicking the <guibutton>OK</guibutton> button. </para> - <figure> - <title>JBoss Runtime search results</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers-detecting_new_runtime_2.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="Exporting_and_Importing_runtime_preferences"> - <title>Exporting and Importing runtime preferences</title> - <para> - The <guimenuitem>JBoss Runtimes</guimenuitem> <guilabel>Preferences</guilabel> interface seen in <xref linkend="Detecting_an_existing_runtime"/> also allows you to export and import your runtime preferences. You can navigate to the page through <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Runtimes</guimenuitem></menuchoice>. + <figure> + <title>JBoss Runtime search results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers-detecting_new_runtime_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="Exporting_and_Importing_runtime_preferences"> + <title>Exporting and Importing runtime preferences</title> + <para> + The <guimenuitem>JBoss Runtimes</guimenuitem> + <guilabel>Preferences</guilabel> interface seen in <xref linkend="Detecting_an_existing_runtime"/> also allows you to export and import your runtime preferences. You can navigate to the page by selecting <menuchoice><guimenuitem>Window</guimenuitem> + <guimenuitem>Preferences</guimenuitem> + <guimenuitem>JBoss Tools</guimenuitem> + <guimenuitem>JBoss Runtimes</guimenuitem> + </menuchoice>. </para> - <para> - The <guibutton>Export</guibutton> button opens the <guilabel>Export Preferences</guilabel> dialog. The <guilabel>Export all</guilabel> box will automatically be selected, however you can choose to only export specific preference settings (such as only those related to your JBoss runtime) by selecting individual entries from the displayed list. + <para> + The <guibutton>Export</guibutton> button opens the <guilabel>Export Preferences</guilabel> dialog. The <guilabel>Export all</guilabel> box will automatically be selected, however you can choose to only export specific preference settings (such as only those related to your JBoss runtime) by selecting individual entries from the displayed list. </para> - <figure> - <title>Export Preferences dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers-export_runtime_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para> - To export the preference settings you must specify a preference file that the information will be written to. This file, once exported, can be used to reapply your settings by clicking on the <guilabel>Import</guilabel> button. + <figure> + <title>Export Preferences dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers-export_runtime_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + To export the preference settings you must specify the preference file that the information will be written to. This file, once exported, can be used to reapply your settings by clicking on the <guilabel>Import</guilabel> button. </para> - <para> - The <guibutton>Import</guibutton> button opens the <guilabel>Import Preferences</guilabel> dialog. The <guilabel>Import all</guilabel> box will automatically be selected, however you can choose to only import specific preference settings (such as only those related to your JBoss runtime) by selecting individual entries from the list that displays after using the <guibutton>Browse</guibutton> button to select your exported preference file (for example: preference_file.epf). + <para> + The <guibutton>Import</guibutton> button opens the <guilabel>Import Preferences</guilabel> dialog. The <guilabel>Import all</guilabel> box will automatically be selected, however you can choose to only import specific preference settings (such as only those related to your JBoss runtime) by selecting individual entries from the list that displays after using the <guibutton>Browse</guibutton> button to select your exported preference file (for example: preference_file.epf). </para> - <figure> - <title>Import Preferences dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers-import_runtime_1.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="CopyRuntime"> - <title>Duplicating a 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>Finish</property></emphasis> - in the New Server Runtime Environment menu . + <figure> + <title>Import Preferences dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers-import_runtime_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="CopyRuntime"> + <title>Duplicating a 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 <xref linkend="InstNewRuntime"/>, with the exception of clicking the <guibutton>Finish</guibutton> button 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>Copy</property></emphasis>.The next dialog should appear. + <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 appropriate Configuration from the list and click the <guibutton>Copy</guibutton> button.The next dialog should appear. </para> - <figure> - <title>Copy the existing configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_4a.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Change the name Click on <emphasis> - <property>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. + <figure> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4a.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + Change the name, click the <guibutton>Browse</guibutton> button, and select your configuration location or leave as it is if you want it to be located together with other runtime configurations. </para> - <figure> - <title>Copy the existing configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_4b.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Click<emphasis> - <property> Ok </property></emphasis>and you should see the next wizard with the just added copied configuration. - + <figure> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click the <guibutton>OK</guibutton> button and you should see the next wizard with the newly copied configuration.</para> + <figure> + <title>Runtime with copied configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4c.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Click the <guibutton>Finish</guibutton> button and you will see your new runtime in the list. </para> - <figure> - <title>Runtime with copied configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_4c.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Press <emphasis> - <property>Finish</property> - </emphasis> and you will see your new runtime in the list. + <para> + You can also change the configuration of existing runtime to a copied one in the same way by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Runtime Environments</guimenuitem></menuchoice> and clicking the <guibutton>Edit</guibutton> button. </para> - <para>You can also change a configuration of existing runtime to a copied one in the same way from the <emphasis> - <property> Window > Preferences </property></emphasis> - menu <emphasis> - <property>Server > Runtime Environments </property></emphasis> - and clicking <emphasis> - <property>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> + </section> + <section> + <title>Servers</title> + <para> + WTP servers are Eclipse-representations of a back end 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 <xref linkend="run_on_server_wizard"/>). + </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 select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other...</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>. This should show the wizard like below. + </para> + <figure> + <title>Adding a JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + A server object keeps track of things like command line arguments when starting or stopping, and the runtimes keep track of the location of the installation. Thus, each server instance must be backed by an appropriate runtime. + </para> + + <para> + The <guilabel>New server wizard</guilabel> allows you to name the server via the <guilabel>Server name</guilabel> field, or you can use a generated default name .If it is necessary to restore the default name, click the <guibutton>Reset default</guibutton> button (<inlinemediaobject> <imageobject><imagedata fileref="images/runtimes_servers/runtimes_servers_4d.png"/></imageobject></inlinemediaobject>). + </para> + <para> + You can select the appropriate runtime you from the <guilabel>Server runtime environment</guilabel> combobox. If there is no runtime that matches your needs just press the <guilabel>Add...</guilabel> link nearby to bring up the wizard for creating a new runtime (see <xref linkend="add_runtime_figure"/>). To configure an existing runtimes you should go to server preferences by pressing the <guilabel>Configure runtime environments...</guilabel> link. + </para> + + <para>If the server you want to create does not have any installed runtime yet, the combo box and the links are absent.</para> + + <figure> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In this case the next page of the wizard which has the same form as in <link linkend="add_runtime_figure">the previous section</link>, and 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 presents a summary of the selected options, giving you a chance to verify that you have selected the appropriate runtime. + </para> + + <figure> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click the <guibutton>Finish</guibutton> button to complete the process of the server creation.</para> + <para>Now that we have created our runtimes and servers, we can explore the services and tools provided by the JBoss Server Manager.</para> + + <para> + We hope this guide helped you to get started with the JBoss Tools server manager. For additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>. + </para> + </section> + </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 <emphasis> - <property>File > New > Other... </property> - </emphasis> and then <emphasis> - <property>Server</property> - </emphasis>. This should show the wizard like below.</para> - <figure> - <title>Adding a JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"/> - </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> New server wizard </property></emphasis> allows to name the server appropriately in the <emphasis><property>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"/> - </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>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>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> - <title>Installed Server Runtime Environments</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"/> - </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> - <title>Installed Server Runtime Environments</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Press <emphasis> - <property>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&f=201">JBoss forum</ulink>.</para> - </section> - </section> - - </chapter>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28738 - trunk/as/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 19:43:03 -0500 (Sun, 30 Jan 2011) New Revision: 28738 Modified: trunk/as/docs/reference/en-US/quick_start.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/quick_start.xml =================================================================== --- trunk/as/docs/reference/en-US/quick_start.xml 2011-01-30 22:38:37 UTC (rev 28737) +++ trunk/as/docs/reference/en-US/quick_start.xml 2011-01-31 00:43:03 UTC (rev 28738) @@ -1,293 +1,290 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="quick_start" role="updated"> - <title>Quick Start with JBoss Server</title> + <title>Quick Start with JBoss Server</title> - <para>This chapter covers the basics of working with the <property>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 colnum="1" align="left" colwidth="2*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" align="left" colwidth="2*"/> - - <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 Servers 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>This chapter covers the basics of working with the <property>JBoss Server</property>.</para> + + <section id="JBoss_server_key_features"> + <title>Key Features of JBoss Server</title> + <para>The table below lists the main features included in JBoss Server:</para> + + <table> + + <title>Key Functionality for JBoss AS and Archive Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <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, the JBoss AS plugin allows you to work 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 allows for easy management of an installed JBoss Server and includes the standard Console and Properties views, and the specially added Project archives and Servers views. + </para> + </entry> + <entry> + <link linkend="perspective">JBoss AS perspective</link> + </entry> + </row> + + <row> + <entry> + <para>Modules Deployment</para> + </entry> + <entry> + <para>Provides a number of ways, using 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> + If you already have installed the JBoss server and runtime this document will show you how to configure, start and stop the server, as well as the deployment and archiving processes. Installing runtimes and servers is covered in more detail in <xref linkend="runtimes_servers"/>. + </para> - <para>To start working with JBoss AS, select a <property>JBoss AS Perspective</property> via - <emphasis><property>Window > Show View > Other > Server > Servers</property>.</emphasis></para> - </section> + <para> + To start working with JBoss AS, select the <guilabel>JBoss AS</guilabel> Perspective via <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>. + </para> + </section> - <section id="starting"> - <title>Starting JBoss Server</title> + <section id="starting"> + <title>Starting JBoss Server</title> - <para>Starting <property>JBoss Server</property> is quite simple. You can control the server - behaviour with the help of a special toolbar in the <property>Servers</property> view - where you could <emphasis> - <property>start</property> - </emphasis> it in a regular or debug mode, <emphasis> - <property>stop</property> - </emphasis> it or <emphasis> - <property>restart</property> - </emphasis> it and <emphasis> - <property>publish</property> - </emphasis> to the server.</para> + <para> + Starting <productname>JBoss Server</productname> is quite simple. You can control the server behavior with the help of a special toolbar in the <guilabel>Servers</guilabel> view where you can <guibutton>start</guibutton> it in a regular or debug mode, <guibutton>stop</guibutton> or <guibutton>restart</guibutton> it, and <guibutton>publish</guibutton> to the server. + </para> - <figure> - <title>Servers Toolbar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_1.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Servers Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_1.png"/> + </imageobject> + </mediaobject> + </figure> - <para>To launch the server click the green-with-white-arrow icon on the <property>Servers - </property> view or right click server name in this view and select <emphasis> - <property>Start</property>. </emphasis> If this view is not open, select - <emphasis><property>Window > Show View > Other > Server > - Servers</property>.</emphasis></para> + <para> + To launch the server click the green-with-white-arrow icon on the <guilabel>Servers</guilabel> view or right click server name in this view and select <guimenuitem>Start</guimenuitem>. If this view is not open, select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>. + </para> - <figure> - <title>Start JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_2.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Start JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_2.png"/> + </imageobject> + </mediaobject> + </figure> - </section> + </section> - <section id="stopping"> - <title>Stopping JBoss Server</title> + <section id="stopping"> + <title>Stopping JBoss Server</title> - <para>To stop the server, click the <emphasis> - <property>Stop</property> - </emphasis> icon in the <property>Servers</property> view or right click the server name - and press <emphasis><property>Stop</property>.</emphasis></para> + <para> + To stop the server, click the <guibutton>Stop</guibutton> icon in the <guilabel>Servers</guilabel> view or right click the server name + and select the <guimenuitem>Stop</guimenuitem> option. + </para> - <figure> - <title>Stop JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_3.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Stop JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_3.png"/> + </imageobject> + </mediaobject> + </figure> - <para>When the server is stopped you will see <emphasis> - <property>Stopped</property> - </emphasis> state next to its name in the square brackets.</para> - <para>Learn more about the <property>Servers</property> view - <link linkend="JBossServerView">here</link>.</para> - </section> + <para>When the server is stopped you will see <guilabel>Stopped</guilabel> state next to its name in the square brackets.</para> + <para>Learn more about the <guilabel>Servers</guilabel> view in <xref linkend="JBossServerView"/>.</para> + </section> - <section id="archiving"> + <section id="archiving"> - <title>Project Archiving</title> + <title>Project Archiving</title> - <para><property>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>Window > Show View > Other > JBoss Tools > Project archives</property>). - </emphasis></para> - <para>Right clicking in the <property>Project archives</property> view you can create War, - EJB War, EAR or JAR archive.</para> + <para> + <property>JBoss Tools</property> comes with our own archives tool. The Project Archives plugin consists primarily of a view to set up each packaging configuration (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tool</guimenuitem><guimenuitem>Project archives</guimenuitem></menuchoice>). + </para> + <para>Right clicking in the <guilabel>Project archives</guilabel> view you can create a War, EJB War, EAR or JAR archive.</para> - <figure> - <title>Archive Creating</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_7.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Archive Creating</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_7.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Using the context menu on the item you can initiate a <emphasis><property>full build</property></emphasis> on - archive, <emphasis><property>edit</property>,</emphasis> <emphasis><property>delete</property></emphasis> or - <emphasis><property>publish</property></emphasis> it.</para> + <para> + Using the context menu on the item you can initiate a <emphasis><property>full build</property></emphasis> on an archive, <emphasis><property>edit</property>,</emphasis><emphasis><property>delete</property></emphasis> or <emphasis><property>publish</property></emphasis> it. + </para> - <figure> - <title>Context Menu on the Item</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_8.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_8.png"/> + </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>Window > Preferences > General > Keys</property>.</emphasis></para> + <para> + If you wish, you can assign a hotkey for the Build Project Archive action. A key binding can be added by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>General</guimenuitem><guimenuitem>Keys</guimenuitem></menuchoice>. + </para> - <figure> - <title>Setting the Hotkey for Build Project Archive Action</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/hotkeys.png" scale="80"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Setting the Hotkey for Build Project Archive Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/hotkeys.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> - <para>To perform the building of the project archives, select the project in the <property>Package Explorer</property> view and execute the hotkey combination - you assigned for this action.</para> + <para> + To build a project archive, select the project in the <guilabel>Package Explorer</guilabel> view and execute the hotkey combination + you assigned for this action. + </para> - <para>Learn more about the <property>Project Archives</property> view - <link linkend="Project_archivesView">here</link>.</para> - </section> - - <section id="deployment"> - <title>Deploying an Application to a Server</title> + <para>More information about the <guilabel>Project Archives</guilabel> view can be found in <xref linkend="Project_archivesView"/>.</para> + </section> - <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> + <section id="deployment"> + <title>Deploying an Application to a Server</title> - <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>Target Runtime</property> - </emphasis> and <emphasis> - <property>Target Server</property> - </emphasis> sections. You can deploy the application through the appropriate selection in - these sections.</para> + <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> - <figure> - <title>Runtime and Server Sections in the New Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_4a.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + When you create a new project (Seam, JSF or Struts) with the New Project or Import Project wizards, they will include the <guilabel>Target Runtime</guilabel> and <guilabel>Target Server</guilabel> sections. You can deploy the application through the appropriate configuration in these sections. + </para> - <figure> - <title>Runtime and Server Sections in the Import Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_4b.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Runtime and Server Sections in the New Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4a.png"/> + </imageobject> + </mediaobject> + </figure> - <para>You can deploy an existing application to a server by right-clicking the target defined - server in the <property>Servers</property> view and then selecting <emphasis><property>Add and - Remove Projects</property></emphasis> from the context menu.</para> + <figure> + <title>Runtime and Server Sections in the Import Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4b.png"/> + </imageobject> + </mediaobject> + </figure> - <figure> - <title>Add and Remove Projects From the Context Menu.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_5.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + You can deploy an existing application to a server by right-clicking the target defined server in the <guilabel>Servers</guilabel> view and then selecting <guimenuitem>Add and Remove Projects</guimenuitem> from the context menu. + </para> - <para>If this application is not assigned to a server, it will be in the left-hand available - projects list. Clicking on the <property>Add ></property> button will add it to the right-hand - configured projects list and deploy the application to this server.</para> + <figure> + <title>Add and Remove Projects From the Context Menu.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_5.png"/> + </imageobject> + </mediaobject> + </figure> - <figure> - <title>Modifying The Projects that are Configured on the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start_6.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + <para> + If this application is not assigned to a server, it will be in the left-hand available projects list. Clicking on the <guibutton>Add ></guibutton> button will add it to the right-hand configured projects list and deploy the application to this server. + </para> + + <figure> + <title>Modifying The Projects that are Configured on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_6.png"/> + </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>Publish to Server</property></emphasis> (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/quick_start/publish_button.png"/> - </imageobject> - </inlinemediaobject>) button which initiates an incremental publish. + <para> + Automatically publishing changes made to the workspace is enabled by default, allowing the workspace to remain in sync with the publish folder. If you need to control when to publish the changes, just disable the automatic publish in the Server Editor (see <xref linkend="server_editor"/>) and use the <guibutton>Publish to Server</guibutton> (<inlinemediaobject><imageobject><imagedata fileref="images/quick_start/publish_button.png"/></imageobject></inlinemediaobject>) button which will incrementally publish the workspace. </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> + <para> + This section has provided some basic information that will allow you to use the common features provided by the JBoss server. However, JBoss server includes a great deal more functionality, which will be discussed in subsequent chapters. + </para> </section> - <section> - <title>Other relevant resources on the topic</title> + <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://community.jboss.org/wiki/JBossAS5FAQ">JBossAS5FAQ</ulink>. + <para> + All JBoss Developer Studio/JBoss Tools documentation can be found on the <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 from the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly builds documentation page</ulink>. + </para> + + <para> + Find answers to frequently asked questions about JBoss AS 5 usage in the <ulink url="http://community.jboss.org/wiki/JBossAS5FAQ">JBossAS5FAQ</ulink>. </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/MonitorARemoteJbossServerFromEclipse">wiki article</ulink>.</para> - </section> + <para> + Information on how to monitor a remote JBoss Server from Eclipse can be found in this <ulink url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFromEclipse">wiki article</ulink>.</para> + </section> </chapter>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28737 - trunk/jsf/docs/userguide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 17:38:37 -0500 (Sun, 30 Jan 2011) New Revision: 28737 Modified: trunk/jsf/docs/userguide/en-US/Book_Info.xml Log: General Updates Modified: trunk/jsf/docs/userguide/en-US/Book_Info.xml =================================================================== --- trunk/jsf/docs/userguide/en-US/Book_Info.xml 2011-01-30 22:37:12 UTC (rev 28736) +++ trunk/jsf/docs/userguide/en-US/Book_Info.xml 2011-01-30 22:38:37 UTC (rev 28737) @@ -7,7 +7,7 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>5</pubsnumber> + <pubsnumber>6</pubsnumber> <abstract> <para>The Visual Web Tools Reference Guide explains extensive collection of specialized wizards, editors and views that can be used in various scenarios while developing Web applications.</para> </abstract>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28736 - trunk/smooks/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 17:37:12 -0500 (Sun, 30 Jan 2011) New Revision: 28736 Modified: trunk/smooks/docs/reference/en-US/Book_Info.xml Log: General Updates Modified: trunk/smooks/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Book_Info.xml 2011-01-30 22:36:42 UTC (rev 28735) +++ trunk/smooks/docs/reference/en-US/Book_Info.xml 2011-01-30 22:37:12 UTC (rev 28736) @@ -7,7 +7,7 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>6</pubsnumber> + <pubsnumber>7</pubsnumber> <abstract> <para>The Smooks Developer Tools Reference Guide explains how to use Smooks Tools to graphically edit Smooks configuration files.</para> </abstract>

13 years, 3 months

1
0
0 / 0

JBoss Tools SVN: r28735 - trunk/smooks/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-30 17:36:42 -0500 (Sun, 30 Jan 2011) New Revision: 28735 Modified: trunk/smooks/docs/reference/en-US/Book_Info.xml Log: General Updates Modified: trunk/smooks/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Book_Info.xml 2011-01-30 22:36:13 UTC (rev 28734) +++ trunk/smooks/docs/reference/en-US/Book_Info.xml 2011-01-30 22:36:42 UTC (rev 28735) @@ -7,7 +7,7 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>5</pubsnumber> + <pubsnumber>6</pubsnumber> <abstract> <para>The Smooks Developer Tools Reference Guide explains how to use Smooks Tools to graphically edit Smooks configuration files.</para> </abstract>

13 years, 3 months

1
0
0 / 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits January 2011