Author: ykryvinchanka Date: 2007-11-06 11:24:45 -0500 (Tue, 06 Nov 2007) New Revision: 4746 Added: trunk/as/docs/ServerManagerRef/reference/en/images/DeployingModules/ trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimeEnv.png trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimes.png trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/new4.0Runtime.png trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newRuntime.png trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer.png Removed: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimes.JPG trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/new4.0Runtime.JPG trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newRuntime.JPG trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer.JPG trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer2.JPG Modified: trunk/as/docs/ServerManagerRef/reference/en/modules/RuntimesAndServers.xml Log: http://jira.jboss.com/jira/browse/RHDS-279 Chapter Runtimes and Servers in the JBoss AS plugin updated and screenshots added Added: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimeEnv.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimeEnv.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimes.JPG =================================================================== (Binary files differ) Added: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimes.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/installedRuntimes.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/new4.0Runtime.JPG =================================================================== (Binary files differ) Added: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/new4.0Runtime.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/new4.0Runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newRuntime.JPG =================================================================== (Binary files differ) Added: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newRuntime.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newRuntime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer.JPG =================================================================== (Binary files differ) Added: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: trunk/as/docs/ServerManagerRef/reference/en/images/serverRuntimes/newServer2.JPG =================================================================== (Binary files differ) Modified: trunk/as/docs/ServerManagerRef/reference/en/modules/RuntimesAndServers.xml =================================================================== --- trunk/as/docs/ServerManagerRef/reference/en/modules/RuntimesAndServers.xml 2007-11-06 16:14:42 UTC (rev 4745) +++ trunk/as/docs/ServerManagerRef/reference/en/modules/RuntimesAndServers.xml 2007-11-06 16:24:45 UTC (rev 4746) @@ -10,198 +10,117 @@ <keyword>JBoss</keyword> </keywordset> </chapterinfo> - <title>Runtimes and Servers in the JBoss AS plugin (out of date!)</title> + <title>Runtimes and Servers in the JBoss AS plugin</title> - <para>The JBoss AS plugin makes use of Webtools. This includes - starting and stopping servers in run or debug mode. It also includes - targeting webtools projects, such as dynamic web projects, - to certain server runtimes in order to ensure that the proper jars - from a specific server are added to the project's classpath properly. - </para> - <para> - In order to get started creating, running, and debugging J2EE - applications, we must start with creating our runtime and - server instances. - </para> + <para>The JBoss AS plugin makes use of Webtools. This includes starting and stopping servers in run or debug mode. It also includes + targeting webtools projects, such as dynamic web projects, to certain server runtimes in order to ensure that the proper jars + from a specific server are added to the project's classpath properly.</para> + <para>In order to get started creating, running, and debugging J2EE applications, we must start with creating our <property>runtime</property> and + <property>server</property> instances.</para> <section> <title>Webtools Runtimes</title> - <section><title>What is a runtime used for?</title> - <para> - In RHDS, Server Runtimes have one main purpose: - to point to a server installation somewhere on disk. - In our case, this will be a JBoss installation, and it - can than be used for two primary purposes. - - First, - it provides classpath additions to webtools projects that require them. - Second, for JBoss server at least, it provides information necessary - for the starting and stopping of the server, such as which jars - to run and which configuration to use. - </para> - </section> + <para>In RHDS, Server Runtimes have one main purpose: to point to a server installation somewhere on disk. + In our case, this will be a JBoss installation, and it can than be used for two primary purposes. + First, it provides classpath additions to webtools projects that require them. Second, for JBoss server at least, it provides information necessary + for the starting and stopping of the server, such as which jars to run and which configuration to use. </para> + - <section><title>Installing a new Runtime</title> - <para> - You can install runtimes into eclipse from the Window -&gt; Preferences... - menu, and then selecting Server -&gt; Installed Runtimes from the categories available. - </para> - <figure id="installedRuntimeWindow"> <title>Installed Runtimes</title> + <para>You can install runtimes into eclipse from the <emphasis><property>Window &gt; Preferences... </property></emphasis> + menu, and then selecting <emphasis><property>Server &gt; Installed Runtimes</property></emphasis> from the categories available.</para> + <figure> + <title>Installed Runtimes</title> <mediaobject> - <alt>Installed Server Runtime Preferences</alt> <imageobject> - <imagedata - fileref="..\..\..\..\reference\en\images\serverRuntimes\installedRuntimes.JPG"/> + <imagedata fileref="images/serverRuntimes/installedRuntimes.png"/> </imageobject> </mediaobject> </figure> - - - <para> - From this preference page you can see what runtimes are declared, - and what type they are. In the image shown above, there are three declared - runtimes, including a Tomcat 5.5 instance and a JBoss 4.2 instance. - </para> - - <para> - To create a JBoss runtime, we begin by clicking the add button. - This will open another dialog that allows us to choose what type - of runtime we want to create. Most of the runtime options are provided - by webtools, but those provided by RHDS are the ones we will focus on. - - </para> - - <figure id="addRuntimeWindow"> <title>Adding a Runtime</title> + <para>From this preference page you can see what runtimes are declared, and what type they are. In the image shown above, there are two declared + runtimes, including a JBoss 4.2 instance.</para> + <para>To create a JBoss runtime, we begin by clicking the <emphasis><property>Add</property></emphasis> button. This will open another dialog that allows us to choose what type + of runtime we want to create. Most of the runtime options are provided by webtools, but those provided by RHDS are the ones we will focus on.</para> + <figure> + <title>Adding a Runtime</title> <mediaobject> - <alt>Adding a Runtime</alt> <imageobject> - <imagedata - fileref="..\..\..\..\reference\en\images\serverRuntimes\newRuntime.JPG"/> + <imagedata fileref="images/serverRuntimes/newRuntime.png"/> </imageobject> </mediaobject> </figure> - - <para> - As seen above, there appear to be two JBoss categories. The first is - contributed by webtools, and is a generic adapter that is not upkept very well. - For this reason, RHDS provides updated and supported adapters of our own. - There is one for each of JBoss 3.2, 4.0, amd 4.2. You'll also note a deploy-only - runtime type. This type provides no classpath for webtools projects. - It is used solely by it's server type for the purpose of setting up a deploy directory - for users who don't wish to make use of starting, stopping, or debugging their projects - inside eclipse. - </para> - - - <figure id="add40RuntimeWindow"> <title>Adding a JBoss 4.0 Runtime</title> + <para>As seen above, there appear to be two JBoss categories. The first is contributed by webtools, and is a generic adapter that is not upkept very well. + For this reason, RHDS provides updated and supported adapters of our own. There is one for each of JBoss 3.2, 4.0, amd 4.2. You'll also note a deploy-only + runtime type. This type provides no classpath for webtools projects. It is used solely by it's server type for the purpose of setting up a deploy directory + for users who don't wish to make use of starting, stopping, or debugging their projects inside eclipse.</para> + <figure> + <title>Adding a JBoss 4.2 Runtime</title> <mediaobject> - <alt>Adding a JBoss 4.0 Runtime</alt> <imageobject> - <imagedata - fileref="..\..\..\..\reference\en\images\serverRuntimes\new4.0Runtime.JPG"/> + <imagedata fileref="images/serverRuntimes/new4.0Runtime.png"/> </imageobject> </mediaobject> </figure> - - <para> - As shown above, all you need to do to create the runtime is to name it, browse to it's install directory, - select a Java Runtime Environment, and select which configuration you want. - As you browse to a valid installation folder, the list of configurations will - update allowing you to select the configuration of your choice. - </para> - <para> - Once the runtime is created, the configuration is an unchanging property - of that runtime. This is because many of the jars - necessary to provide for classpaths, such as the ejb3 jar locations or the servlet jar locations, - are located in deploy directories of each configurations (depending on which - version of JBoss is being used). Because of this, to compile against - a different configuration's jars, you will need to create a new runtime from that configuration. - </para> - <para> - Also, because of the open-source nature of JBoss, it is likely that a user may want to - modify and repackage some of the configuration-specific jboss jars and create - their own configuration using those modified jars. Rather than forcing the user to copy his - entire JBoss installation, this structure allows them to create only a new configuration instead. - </para> - <para> - As a result of having each runtime represent a specific configuration rather than - the server installation as a whole, it is very likely you'll create several different runtimes - to test each of your configurations. It becomes important to ensure your runtimes, - and later your servers, are given descriptive names that help you remember which is which. - It will do no good to try to remember if "JBoss-runtime 5" is the 4.0 install with ejb3? Or the - 4.2 install's custom configuration you decided to create. - </para> - <para> - After pressing finish, you'll see that your new runtime has been added to the list - and can now be targeted by webtools type projects or servers, both of which we'll get to later. - </para> + <para>As shown above, all you need to do to create the runtime is to name it, browse to it's install directory, + select a Java Runtime Environment, and select which configuration you want. As you browse to a valid installation folder, the list of configurations will + update allowing you to select the configuration of your choice.</para> + <para>Once the runtime is created, the configuration is an unchanging property + of that runtime. This is because many of the jars necessary to provide for classpaths, such as the ejb3 jar locations or the servlet jar locations, + are located in deploy directories of each configurations (depending on which version of JBoss is being used). Because of this, to compile against + a different configuration's jars, you will need to create a new runtime from that configuration.</para> + <para>Also, because of the open-source nature of JBoss, it is likely that a user may want to + modify and repackage some of the configuration-specific jboss jars and create their own configuration using those modified jars. Rather than forcing the user to copy his + entire JBoss installation, this structure allows them to create only a new configuration instead.</para> + <para>As a result of having each runtime represent a specific configuration rather than the server installation as a whole, it is very likely you'll create several different runtimes + to test each of your configurations. It becomes important to ensure your runtimes, and later your servers, are given descriptive names that help you remember which is which. + It will do no good to try to remember if "JBoss-runtime 5" is the 4.0 install with ejb3? Or the 4.2 install's custom configuration you decided to create.</para> + <para>After pressing finish, you'll see that your new runtime has been added to the list and can now be targeted by webtools type projects or servers, both of which we'll get to later.</para> </section> + + <section><title>Deleting a Runtime</title> + <para></para> + </section> + </section> - - - <section> <title>Webtools Servers</title> - <section> - <title>What is a Server used for?</title> - <para> - Webtools servers are eclipse-representations of a backing server installation. - They are used to start or stop servers, deploy to servers, or debug code - that will run on the server. They keep track of what modules (jars, wars, etc) + <para>Webtools servers are eclipse-representations of a backing server installation. They are used to start or stop servers, deploy to servers, or debug code that will run on the server. They keep track of what modules (jars, wars, etc) you deploy to the server and also allow you to undeploy those modules. </para> - <para> - Servers can be started or stopped with different command-line arguments. - They are often backed by a runtime object representing that server's location. </para> - </section> - <section> + <para>Servers can be started or stopped with different command-line arguments. They are often backed by a runtime object representing that server's location.</para> + <section> <title>Creating a New Server</title> - <para> - There are many ways to get to the new server wizard. One way - is to use the old standard File -&gt; New -&gt; Other... wizard, - and type in Server. This should show the screen below, which - does not look that different from the initial screen when - creating a new runtime. </para> - <figure id="addServerWindow"> <title>Adding a JBoss Server</title> - <mediaobject> - <alt>Adding a JBoss Server</alt> - <imageobject> - <imagedata - fileref="..\..\..\..\reference\en\images\serverRuntimes\newServer.JPG"/> - </imageobject> - </mediaobject> - </figure> - <para> - Because the server object is what keeps track of things like command line arguments - when starting or stopping, and runtimes keep track of the location of the installation, + <para>There are many ways to get to the new server wizard. One way is to use the old standard <emphasis><property>File -&gt; New -&gt; Other... </property></emphasis>wizard, + and type in <emphasis><property>Server</property></emphasis>. This should show the screen below, which does not look that different from the initial screen when creating a new runtime. </para> + <figure> + <title>Adding a JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/serverRuntimes/newServer.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Because the server object is what keeps track of things like command line arguments when starting or stopping, and runtimes keep track of the location of the installation, each server instance must be backed by an appropriate runtime. </para> - <para> - Because there may be many runtimes of each type declared, the wizard allows you to select - which runtime you want your server to be backed by. The combo box below the view lets you - select which declared runtime to use. For example, if there were already multiple JBoss 4.0 - runtimes declared, the combo box would list all of the 4.0 runtimes available. </para> - <para> - If none of the runtimes declared are one you want to use, for example if - you declared a default and a minimal runtime before but now want your server - to be backed by the ALL configuration, then you can click on the - <emphasis>Installed Runtimes... </emphasis> Button to bring up the preference page + <para>Because there may be many runtimes of each type declared, the wizard allows you to select which runtime you want your server to be backed by. The combo box below the view lets you + select which declared runtime to use. For example, if there were already multiple JBoss 4.2 runtimes declared, the combo box would list all of the 4.2 runtimes available. </para> + <para>If none of the runtimes declared are one you want to use, for example if you declared a default and a minimal runtime before but now want your server + to be backed by the ALL configuration, then you can click on the <emphasis><property>Installed Runtimes... </property></emphasis> button to bring up the preference page shown at the beginning of this chapter. </para> - <para> - If the server you want to create doesn't have any installed runtime yet, the combo - box and button will disappear, and the next page in the wizard will force you to create + <figure> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/serverRuntimes/installedRuntimeEnv.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If the server you want to create doesn't have any installed runtime yet, the combo box and button will disappear, and the next page in the wizard will force you to create the associated runtime first. </para> - <para> - Either way, after targeting your server to a runtime, the final screen - in this wizard is largely confirmational, giving the user a chance to verify - that he's selected the appropriate runtime. It also allows the user - to name the server appropriately. </para> - </section> + <para>Either way, after targeting your server to a runtime, the final screen in this wizard is largely confirmational, giving the user a chance to verify + that he's selected the appropriate runtime. It also allows the user to name the server appropriately. </para> </section> - <section> - <title>Well then...</title> - <para>Now that we've created our runtimes and servers, - we'll explore how to use them in future chapters. </para> </section> + </chapter>