Author: irooskov(a)redhat.com Date: 2012-07-03 12:37:07 -0400 (Tue, 03 Jul 2012) New Revision: 42351 Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Author_Group.xml branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Book_Info.xml branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Revision_History.xml branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/The_interface.xml branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/Eclipse_welcome_screen.png branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/JBoss_AS_Overview.png branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/JBoss_AS_localhost.png branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/Server_Started.png branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/Start_Stop_Server.png Log: updated with files from trunk for JBT 3.3.1 and JBDS 5.0.1 Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Author_Group.xml 2012-07-03 16:28:44 UTC (rev 42350) +++ branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Author_Group.xml 2012-07-03 16:37:07 UTC (rev 42351) @@ -7,11 +7,6 @@ <surname>Rooskov</surname> <email&gt;irooskov(a)redhat.com&lt;/email&gt; </author> - <author> - <firstname>Sean</firstname> - <surname>Rogers</surname> - <email&gt;serogers(a)redhat.com&lt;/email&gt; - </author> <editor> <firstname>Andrew</firstname> <surname>Ross</surname> Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Book_Info.xml 2012-07-03 16:28:44 UTC (rev 42350) +++ branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Book_Info.xml 2012-07-03 16:37:07 UTC (rev 42351) @@ -11,9 +11,9 @@ <productnumber>5.0</productnumber> - <edition>5.0.0</edition> + <edition>5.0.1</edition> - <pubsnumber>2</pubsnumber> + <pubsnumber>4</pubsnumber> <abstract> <para> Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Revision_History.xml 2012-07-03 16:28:44 UTC (rev 42350) +++ branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/Revision_History.xml 2012-07-03 16:37:07 UTC (rev 42351) @@ -5,6 +5,20 @@ <simpara> <revhistory> <revision> + <revnumber>2-1</revnumber> + <date>Wed Jul 04 2012</date> + <author> + <firstname>Isaac</firstname> + <surname>Rooskov</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Major updates and restructuring</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>1-2</revnumber> <date>Wed Jan 12 2011</date> <author> Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/The_interface.xml =================================================================== --- branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/The_interface.xml 2012-07-03 16:28:44 UTC (rev 42350) +++ branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/The_interface.xml 2012-07-03 16:37:07 UTC (rev 42351) @@ -6,18 +6,18 @@ This chapter discusses the interface to the <application>JBoss Developer Studio</application> IDE. </para> <section id="sect-Beginners_Guide-The_interface-Eclipse"> - <title>Eclipse</title> + <title>JBoss Developer Studio</title> <para> - Eclipse provides a container for all development work performed with <application>JBoss Developer Studio</application>. It provides control over the application server, the applications on it and provides an interface through which you can develop your own applications. + Providing a container for all development work performed with <application>JBoss Developer Studio</application> allows for control over the application server, the applications on it and the interface through which you can develop your own applications. </para> <para> - Eclipse is started by double-clicking on the <filename>jbdevstudio</filename> executable in your installation directory. + Start JBoss Developer Studio by double-clicking on the <filename>jbdevstudio</filename> executable in your installation directory. </para> <para> - Following this you will be asked to specify a workspace. A workspace is the location on your computer where your files relating to your Eclipse projects be stored. If you wish to change your workspace location after this step you can do so by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Switch Workspace</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice>. + Following this you will be asked to specify a workspace. A workspace is the location on your computer where your project files will be stored. If you wish to change your workspace location after this step you can do so by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Switch Workspace</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice>. </para> <figure id="figu-Beginners_Guide-Eclipse-Eclipse_Workspace_launcher"> - <title>Eclipse Workspace launcher</title> + <title>Workspace launcher</title> <mediaobject> <imageobject> <imagedata fileref="images/Eclipse_workspace.png" format="PNG" /> @@ -25,17 +25,17 @@ </mediaobject> </figure> <para> - After selecting the location of the workspace, you will be greeted with the <guilabel>Welcome</guilabel> screen. This screen provides a few pathway options, including the <guilabel>Getting Started</guilabel> link, which will take you to a page that provides some JBDS documentation, an option to create a new project with the <guilabel>Create New...</guilabel> option and an option to skip straight to your <guilabel>Workbench</guilabel>. + After selecting the location of the workspace, you will be greeted with the <guilabel>Welcome</guilabel> screen and a button that will take you to <guilabel>JBoss Central</guilabel> and your workbench. </para> <figure id="figu-Beginners_Guide-Eclipse-Eclipse_welcome_screen"> - <title>Eclipse welcome screen</title> + <title>Welcome screen</title> <mediaobject> <imageobject> <imagedata fileref="images/Eclipse_welcome_screen.png" format="PNG" /> </imageobject> </mediaobject> </figure> - <para> +<!-- <para> Skipping straight to your workbench, you will see a screen with a number of default views and the JBoss Application Server listed in the bottom area of the interface. </para> <figure id="figu-Beginners_Guide-Eclipse-Eclipse_Workbench"> @@ -62,12 +62,12 @@ </para> <para> Refer to the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/4.0/ht... to JBoss Developer Studio</ulink> section of the <citetitle pubwork="book">Getting Started with JBoss Developer Studio</citetitle> guide for further details. - </para> + </para> --> </section> <section id="sect-Beginners_Guide-The_interface-JBoss_Central"> <title>JBoss Central</title> <para> - When starting the JBoss Developer Studio you will see <guilabel>JBoss Central</guilabel> in the workspace. From <guilabel>JBoss Central</guilabel> you can quickly <guilabel>Create Projects</guilabel>, run <guilabel>Project Examples</guilabel>, view <guilabel>Documentation</guilabel>, read the latest <guilabel>News</guilabel> and <guilabel>Blogs</guilabel>, and change <guilabel>JBoss Central</guilabel> + When starting JBoss Developer Studio you will see <guilabel>JBoss Central</guilabel> in the workspace. From <guilabel>JBoss Central</guilabel> you can quickly <guilabel>Create Projects</guilabel>, run <guilabel>Project Examples</guilabel>, view <guilabel>Documentation</guilabel>, read the latest <guilabel>News</guilabel> and <guilabel>Blogs</guilabel>, and change <guilabel>JBoss Central</guilabel> <guilabel>Settings</guilabel>. </para> <figure id="figu-Beginners_Guide-JBoss_Central"> @@ -83,14 +83,95 @@ </para> </section> <section id="sect-Beginners_Guide-The_interface-JBoss_Application_Server"> - <title>JBoss Application Server</title> + <title>Setting up a JBoss server</title> <para> - The JBoss Application Server Server provides the full range of Java EE 5 features as well as extended enterprise services including clustering, caching, and persistence. + The JBoss Enterprise Application Server provides the full range of Java EE 5 features as well as extended enterprise services including clustering, caching, and persistence. </para> + <section id="sect-Beginners_Guide-JBoss_Application_Server-Adding_a_new_application_server_for_use_with_the_JBoss_Developer_Studio"> + <title>Adding a new application server for use with the JBoss Developer Studio</title> + <para> + To add a new server runtime follow these steps: + </para> + <orderedlist> + <listitem> + <para> + From your workbench, click on <menuchoice> + <guimenuitem>Window</guimenuitem> + <guimenuitem>Preferences</guimenuitem> + <guimenuitem>Server</guimenuitem> + <guimenuitem>Runtime Environments</guimenuitem> + </menuchoice>. + </para> + </listitem> + <listitem> + <para> + Click on the <guibutton>Add...</guibutton> button. + </para> + </listitem> + <listitem> + <para> + Select the runtime environment type of your application server from the list provided. + </para> + </listitem> + <listitem> + <para> + Tick the box for the <guilabel>Create a new local server</guilabel> option. + </para> + </listitem> + <listitem> + <para> + Click on the <guibutton>Next &gt;</guibutton> button. + </para> + </listitem> + <listitem> + <para> + Provide a name for your server runtime and then click on the <guibutton>Browse...</guibutton> button, next to the <guilabel>Home Directory</guilabel> location space. + </para> + </listitem> + <listitem> + <para> + Navigate to the directory where the server you wish to add is installed and click on the <guibutton>OK</guibutton> button. + </para> + </listitem> + <listitem> + <para> + Select the Java Runtime Environment (JRE) you wish to use for this server from the drop-down menu. If the required JRE is not listed, click on the <guibutton>JRE</guibutton> button beside the list, click the <guibutton>Add...</guibutton> button in the <guimenuitem>Installed JREs</guimenuitem> + <guilabel>Preferences</guilabel> dialog box, and follow the prompts to install the correct JRE. + </para> + </listitem> + <listitem> + <para> + The <guilabel>Configuration</guilabel> section should automatically list the profiles available for your server. Select the server configuration you wish to use by clicking on its name in the list. + </para> + <para> + If the profile you wish to use is not listed click on the <guibutton>Browse...</guibutton> button, navigate to the profile location and click the <guibutton>OK</guibutton> button. + </para> + </listitem> + <listitem> + <para> + If all the information is correct click the <guibutton>Finish</guibutton> button. + </para> + <para> + If you need to change any information click the <guibutton>&lt; Back</guibutton> button until you reach the screen with the information that needs to be altered and then navigate back to the <guilabel>JBoss RunTime</guilabel> screen and click the <guibutton>Finish</guibutton> button. + </para> + </listitem> + </orderedlist> + <para> + Once the new sever has been added, you can select it for use by clicking on its name in the <guilabel>Server Runtime Environment</guilabel> list and then clicking the <guibutton>OK</guibutton> button, which will then take you back to the main interface. + </para> + <para> + To start your new server, select it from those available in the <guimenu>Servers</guimenu> view and click the button displaying a white arrow in a green circle. + </para> + <note> + <para> + If the <guimenu>Servers</guimenu> view is not displayed at the bottom of your Workbench, you can activate it through <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>JBoss Server View</guimenuitem></menuchoice> and then click the <guibutton>OK</guibutton> button. + </para> + </note> + </section> <section id="sect-Beginners_Guide-JBoss_Application_Server-Using_the_application_server_shipped_with_the_JBoss_Developer_Studio"> - <title>Using the Application Server shipped with the JBoss Developer Studio</title> + <title>Using the JBoss application server with the JBoss Developer Studio</title> <para> - This section discusses the use of the JBoss Application Server through Eclipse. Once you have started the Eclipse interface for the <application>JBoss Developer Studio</application>, the JBoss Application Server can be started by selecting it in the Servers view, which can be found in the lower part of the window, and then clicking the green arrow to the right. + The JBoss Application Server can be started by selecting it in the Servers view, which can be found in the lower part of the window, and then clicking the green arrow to the right. </para> <figure id="figu-Beginners_Guide-Use_of_the_application_server_shipped_with_JBoss_Tools_or_JBoss_Developer_Studio-Starting_and_stopping_the_server"> <title>Starting and stopping the server</title> @@ -100,11 +181,6 @@ </imageobject> </mediaobject> </figure> - <note> - <para> - If the <guimenu>Servers</guimenu> view is not displayed at the bottom of your Workbench, you can activate it through <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice> and then clicking the <guibutton>OK</guibutton> button. - </para> - </note> <para> After the server has been successfully started the status field next to the server name will change from <emphasis>Stopped</emphasis> to <emphasis>Started, Synchronized</emphasis>. </para> @@ -117,7 +193,7 @@ </mediaobject> </figure> <para> - Once Eclipse and the server are started, double click on the server name in Eclipse to see an <guilabel>Overview</guilabel> screen in the center. + Once the server has started, double click on the server name to see an <guilabel>Overview</guilabel> screen. </para> <figure id="figu-Beginners_Guide-Use_of_the_application_server_shipped_with_JBoss_Tools_or_JBoss_Developer_Studio-JBoss_Application_Server_overview"> <title>JBoss Application Server overview</title> @@ -128,24 +204,30 @@ </mediaobject> </figure> <para> - The <guilabel>Overview</guilabel> section contains six subsections: <guilabel>General Information</guilabel>, <guilabel>Login Credentials</guilabel>, <guilabel>Publishing</guilabel>, <guilabel>Timeouts</guilabel>, <guilabel>Server Polling</guilabel> and <guilabel>Server Ports</guilabel>. + The <guilabel>Overview</guilabel> section contains the subsections: <guilabel>General Information</guilabel>, <guilabel>Management Login Credentials</guilabel>, <guilabel>Server Behaviour</guilabel>, <guilabel>Publishing</guilabel>, <guilabel>Timeouts</guilabel>, <guilabel>Application Reload Behavior</guilabel>, <guilabel>Server State Detectors</guilabel> and <guilabel>Server Ports</guilabel>. </para> <para> The <guilabel>General Information</guilabel> subsection allows you to change the value for the <guilabel>Server name</guilabel> and <guilabel>Host name</guilabel>. By clicking on the <guilabel>Runtime Environment</guilabel> label a dialog box will be shown with options to change the name of the server runtime, the home directory, the Java Runtime and the server configuration that will be used when running the application server. The <guibutton>Open launch configuration</guibutton> button displays a dialog box that allows you to configure the technical details of the application server instance. </para> <para> - Below the <guilabel>General Information</guilabel> subsection is the <guilabel>Login Credentials</guilabel> subsection. Here you can set the <guilabel>User Name</guilabel> and <guilabel>Password</guilabel> that will be used to provide secure access to your server. + Below the <guilabel>General Information</guilabel> subsection is the <guilabel>Management Login Credentials</guilabel> subsection. Here you can set the <guilabel>User Name</guilabel> and <guilabel>Password</guilabel> that will be used to provide secure access to your server. </para> <para> + The last subsection on the left is dedicated to <guilabel>Server Behaviour</guilabel>. This section allows you to specify how JBoss Developer Studio should interact with the server and whether it is local or remote. + </para> + <para> The <guilabel>Publishing</guilabel> subsection at the top right of the <guilabel>Overview</guilabel> section allows you to specify when applications will be published to the location specified (whether the applications will be made available through the application server depends on the server running and if it is configured to recognize dynamic changes). You can select to either never have an application be published automatically or for a check of new applications yet to be published to occur at a certain timed interval. </para> <para> The <guilabel>Timeouts</guilabel> subsection below the <guilabel>Publishing</guilabel> subsections allows you to set the start and stop times (in seconds) in which the server should complete all of its operations. This setting is made available in order to decrease the chance of the server freezing or hanging. </para> <para> - Below the <guilabel>Timeouts</guilabel> subsection is the <guilabel>Server Polling</guilabel> subsection. A server poller gathers information about the server at certain points in time, capturing information about processes and applications. This section allows you to select between either the <literal>JMX Poller</literal> or <literal>Timeout Poller</literal> for startup and the <literal>Process Terminated Poller</literal> or <literal>Timeout Poller</literal> for shutdown. + The <guilabel>Application Reload Behavior</guilabel> subsection allows you to specify how and when applications associated with the server, are reloaded. </para> <para> + Below the <guilabel>Application Reload Behavior</guilabel> subsection is the <guilabel>Server State Detectors</guilabel> subsection. A server poller gathers information about the server at certain points in time, capturing information about processes and applications. This section allows you to select the pollers to be used during server startup and shutdown. + </para> + <para> The final subsection is called <guilabel>Server Ports</guilabel>, below the <guilabel>Server Polling</guilabel> subsection. This section allows you to alter the port numbers that the server pollers gather their information from. The two settings <guilabel>JNDI Port</guilabel> and <guilabel>Web Port</guilabel> are set to be automatically detected by default; normally there should be no reason to manually select the port numbers. </para> <note> @@ -165,90 +247,9 @@ </mediaobject> </figure> <para> - Refer to the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/4.0/ht... JBoss AS from JBoss Developer Studio</ulink> chapter of the <citetitle pubwork="book">Getting Started with JBoss Developer Studio</citetitle> guide for further details. + Refer to the JBoss Server Manager guide for further details. </para> - </section> - - <section id="sect-Beginners_Guide-JBoss_Application_Server-Adding_a_new_application_server_for_use_with_the_JBoss_Developer_Studio"> - <title>Adding a new application server for use with the JBoss Developer Studio</title> - <para> - Though the JBoss Developer Studio may come with a preconfigured application server, you can still add your own servers. This section details how to add additional servers for use with the JBoss Developer Studio. - </para> - <para> - To add a new server runtime follow these steps: - </para> - <orderedlist> - <listitem> - <para> - In the Eclipse interface click on <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Runtime Environments</guimenuitem></menuchoice>. - </para> - </listitem> - <listitem> - <para> - Click on the <guibutton>Add...</guibutton> button. - </para> - </listitem> - <listitem> - <para> - Select the runtime environment type of your application server from the list provided. - </para> - </listitem> - <listitem> - <para> - Tick the box for the <guilabel>Create a new local server</guilabel> option. - </para> - </listitem> - <listitem> - <para> - Click on the <guibutton>Next &gt;</guibutton> button. - </para> - </listitem> - <listitem> - <para> - Provide a name for your server runtime and then click on the <guibutton>Browse...</guibutton> button, next to the <guilabel>Home Directory</guilabel> location space. - </para> - </listitem> - <listitem> - <para> - Navigate to the directory where the server you wish to add is installed and click on the <guibutton>OK</guibutton> button. - </para> - </listitem> - <listitem> - <para> - Select the Java Runtime Environment (JRE) you wish to use for this server from the drop-down menu. If the required JRE is not listed, click on the <guibutton>JRE</guibutton> button beside the list, click the <guibutton>Add...</guibutton> button in the <guimenuitem>Installed JREs</guimenuitem> - <guilabel>Preferences</guilabel> dialog box, and follow the prompts to install the correct JRE. - </para> - </listitem> - <listitem> - <para> - The <guilabel>Configuration</guilabel> section should automatically list the profiles available for your server. Select the server configuration you wish to use by clicking on its name in the list. - </para> - <para> - If the profile you wish to use is not listed click on the <guibutton>Browse...</guibutton> button, navigate to the profile location and click the <guibutton>OK</guibutton> button. - </para> - </listitem> - <listitem> - <para> - If all the information is correct click the <guibutton>Finish</guibutton> button. - </para> - <para> - If you need to change any information click the <guibutton>&lt; Back</guibutton> button until you reach the screen with the information that needs to be altered and then navigate back to the <guilabel>JBoss RunTime</guilabel> screen and click the <guibutton>Finish</guibutton> button. - </para> - </listitem> - </orderedlist> - <para> - Once the new sever has been added, you can select it for use by clicking on its name in the <guilabel>Server Runtime Environment</guilabel> list and then clicking the <guibutton>OK</guibutton> button, which will then take you back to the main Eclipse interface. - </para> - <para> - To start your new server, select it from those available in the <guimenu>Servers</guimenu> view and click the button displaying a white arrow in a green circle. - </para> - <note> - <para> - If the <guimenu>Servers</guimenu> view is not displayed at the bottom of your Workbench, you can activate it through <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>JBoss Server View</guimenuitem></menuchoice> and then click the <guibutton>OK</guibutton> button. - </para> - </note> - </section> - + </section> </section> </chapter> Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/Eclipse_welcome_screen.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/JBoss_AS_Overview.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/JBoss_AS_localhost.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/Server_Started.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.3.x/documentation/guides/Beginners_Guide/en-US/images/Start_Stop_Server.png =================================================================== (Binary files differ)