From jbosstools-commits at lists.jboss.org Sun Jan 30 20:54:21 2011 Content-Type: multipart/mixed; boundary="===============8141282437216333059==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r28739 - trunk/as/docs/reference/en-US. Date: Sun, 30 Jan 2011 20:54:21 -0500 Message-ID: <201101310154.p0V1sL90020234@svn01.web.mwc.hst.phx2.redhat.com> --===============8141282437216333059== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- 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 @@ - - - - JBoss Developer Studio - Eclipse - Deploy - Deployment - JBoss - - - Runtimes and Servers in the JBoss AS plugin - - In this chapter we will discuss how to install runtimes and server= s. - - First of all it is necessary to mention that the JBoss AS plugin m= akes use of WTP. - This includes starting and stopping servers in run or debug mode. It a= lso 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. - In order to get started creating, running, and debugging J2EE appl= ications, we should create - our runtime and server insta= nces. - -
- Runtimes - In JBoss Tools, the main purpose of Server = Runtimes is to point to a - server installation somewhere on disk. In our case, this will be a J= Boss installation, and it - can then be used for two primary purposes: - - - it provides classpath additions to WTP projects that require= them. - - - for JBoss server 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. - - -
- Installing a new runtime - You can install runtimes into eclipse from the - Window > Preferences - menu, and then select - Server > Runtime Environments - from the categories available on the left. -
- Installed Runtimes - - - - - -
- From this preference page you can see all declared runtimes an= d their types as well. - Here, it's possible to edit or remove existing runtimes as we= ll as add a new - one. - - To create a JBoss runtime click - Add - button and choose a necessary type of runtime from the= - JBoss Community - category. - -
- Adding a Runtime - - - - - -
- - - Note: - - Now there is a separation between .org servers (the - JBoss Community - category) and product server that comes with JBoss E= AP in JBDS ( the - JBoss Enterprise Middleware - category). - - - As you can see, JBoss Tools provide its o= wn 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 p= icked up by the server. It - means that scanning for auto-deployment is suspended while files a= re being copied to the - deployment location and resumed when the copy is completed. - - - Note: - Currently we recommend you to use a fully supported JBoss 5.= 0 server adapter. - - - You'll also note a Deploy-Only Runtime type. This type pr= ovides no classpath - for WTP projects. It is used solely by its server type for the pur= pose of setting up a - deploy directory for users who don't wish to make use of star= ting, stopping, or - debugging their projects inside eclipse. - -
- Adding a JBoss 5.0 Runtime - - - - - -
- - The following table describes all the available options of the= currant wizard - page. - - Server Runtime Wizard Parameters - - - - - - - - Name - - - - Description - - - - - - - - Name - - - The name of a new Runtime for a chosen server. We su= ggest that you - don't leave a default value. It's better to gi= ve descriptive - names that will help to distinguish one runtime from ano= ther. - - - - - - Home directory - - - The path to a directory where the runtime is install= ed. - - - - - - JRE - - - 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 c= onfiguration. Thus, rather - than forcing you to copy his entire JBoss installation, = the structure of the - wizard allows to create only a new configuration instead= . - - - = - - - Directory - - - The path to a directory where the configurations are= installed. - - - - - Configuration - - - The list of configurations (all, default, minimal) t= hat is updated as soon as - you browse to a valid runtime installation folder. - - - - - -
- - As a result of having each runtime represent a specific config= uration rather than the - server installation as a whole, it is very likely you'll crea= te 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. - - Press - Finish - to see your new runtime in the list. - - Note: - 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, - Overview>Runtime Environment - ,make sure that necessary configuration is chosen,click Finish and then Sav= e button. - -
-
- Detecting an existing runtime - - JBoss Tools features the ability to search, detect and add existing= JBoss server runtimes installed on your system. If you don't have an exist= ing runtime will guide you through the c= reation process. To begin searching for your existing JBoss runtime navigat= e to - Window - Preferences - JBoss Tools - JBoss Runtimes - . = + + + + JBoss Developer Studio + Eclipse + Deploy + Deployment + JBoss + + + Runtimes and Servers in the JBoss AS plugin + = + In this chapter we will discuss how to install runtimes and servers= . + = + + First of all it is necessary to mention that the JBoss AS plugin makes u= se 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 spe= cific server are added to the project's classpath properly. + + + In order to get started creating, running, and debugging J2EE applicatio= ns, we should create our runtime and server<= /property> instances. + + = +
+ Runtimes + + In JBoss Tools, the main purpose of Server Runtime= s 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: + + + + Providing classpath additions to WTP projects that require them.= + + + + For JBoss server at least, it provides the neces= sary information to allow the server to be started and stopped, and provide= s information on which JARs to run and which configuration to use. + + + +
+ Installing a new runtime + + You can install runtimes into Eclipse by selecting Window + Preferences + menu, and then selecting Server= + Runtime Environments + from the categories available on the left. + +
+ Installed Runtimes + + + + + +
+ + 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. + + = + + To create a JBoss runtime click the Add button = and choose the appropriate type of runtime from the JBoss Communi= ty category. + + = +
+ Adding a Runtime + + + + + +
+ = + + Note: + = + + Now there is a separation between .org servers (the JBoss C= ommunity category) and product server that comes with JBoss EAP = in JBDS ( the JBoss Enterprise Middleware category). + + + = + + As you can see, JBoss Tools 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 deploymen= ts to be picked up by the server. It means that scanning for auto-deploymen= t is suspended while files are being copied to the deployment location and = resumed when the copy is completed. + + = + + Note: + Currently we recommend you to use a fully supported JBoss 5.0 se= rver adapter. + + = + + You will also note a Deploy-Only Runtime type. This type does not prov= ide 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 m= ake use of starting, stopping, or debugging their projects inside Eclipse. + + = +
+ Adding a JBoss 5.0 Runtime + + + + + +
+ = + The following table describes all the available options of the cu= rrant wizard page. + + Server Runtime Wizard Parameters + + + + = + + + + Name + + = + + Description + + + + = + + + + Name + + + + The name of a new Runtime for a chosen server. We suggest that yo= u do not leave the default value for this field. It is better to give descr= iptive names that will help to distinguish one runtime from another. + + + + = + + + Home directory + + + The path to a directory where the runtime is installed. + + + = + + + JRE + + + + The proper Java Runtime Environment. Because of the open-source n= ature of JBoss, a user is likely to want to modify and repackage some of th= e configuration-specific JBoss JARs and create their own configuration. So = rather than forcing you to copy your entire JBoss installation, the structu= re of the wizard allows to create a new configuration instead. + + + + = + + + Directory + + + The path to a directory where the configurations are install= ed. + + + + + Configuration + + + The list of configurations (all, default, minimal), which is= updated as soon as you browse to a valid runtime installation folder. + + + = + + +
+ = + + 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 i= t becomes important to ensure your runtimes, and later your servers, are gi= ven descriptive names that help you to remember which is which. + + = + Click the Finish button to see your new ru= ntime in the list. + + Note: + + 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 ch= anges to them also, you should double right click the server, select Overview + Runtime Environment + , make sure that necessary configuration is chosen, clic= k the Finish button and then Save button. + + +
+
+ Detecting an existing runtime + + JBoss Tools features the ability to search, detect and add existing= JBoss server runtimes installed on your system. If you don't have an exist= ing runtime will guide you through the c= reation process. To begin searching for your existing JBoss runtime select = Window + Preferences + JBoss Tools + JBoss Runtimes + . = -
- Preference page for JBoss Runtimes - - - - - -
- +
+ Preference page for JBoss Runtimes + + + + + +
+ The JBoss Runtimes preference page allows you to perform three diff= erent actions: Search for a JBoss runtime installati= on, Export a JBoss runtime configuration and Import the configuration of a JBoss runtime. - - The Search button opens a file system browse= r window. Select a directory where you wish JBoss Tools to begin recursivel= y searching for JBoss runtimes and upon completion it will return all those= found. From the returned list, choose the runtimes you wish to make availa= ble to your JBoss Tools instance by clicking the box beside each runtime an= d clicking the OK button. + + The Search button opens a file system browse= r window. Select the directory where you wish JBoss Tools to begin recursiv= ely searching for JBoss runtimes and upon completion it will return all tho= se found. From the returned list, choose the runtimes you wish to make avai= lable to your JBoss Tools instance by clicking the box beside each runtime = and clicking the OK button. -
- JBoss Runtime search results - - - - - -
-
-
- Exporting and Importing runtime preferences - - The JBoss Runtimes Preferences interface seen in = also allows you to export and import your runtime preferences. You can navi= gate to the page through WindowPreferencesJBoss ToolsJBoss Runtimes. +
+ JBoss Runtime search results + + + + + +
+
+
+ Exporting and Importing runtime preferences + + The JBoss Runtimes + Preferences interface seen in also allows you to export and import your ru= ntime preferences. You can navigate to the page by selecting Window + Preferences + JBoss Tools + JBoss Runtimes + . - - The Export button opens the Export Pref= erences dialog. The Export all box will aut= omatically be selected, however you can choose to only export specific pref= erence settings (such as only those related to your JBoss runtime) by selec= ting individual entries from the displayed list. + + The Export button opens the Export Pr= eferences dialog. The Export all box will a= utomatically be selected, however you can choose to only export specific pr= eference settings (such as only those related to your JBoss runtime) by sel= ecting individual entries from the displayed list. -
- Export Preferences dialog - - - - - -
- - To export the preference settings you must specify a preference file th= at the information will be written to. This file, once exported, can be use= d to reapply your settings by clicking on the Import b= utton. = +
+ Export Preferences dialog + + + + + +
+ + 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 Import button. = - - The Import button opens the Import Pre= ferences dialog. The Import all box will au= tomatically be selected, however you can choose to only import specific pre= ference settings (such as only those related to your JBoss runtime) by sele= cting individual entries from the list that displays after using the Browse button to select your exported preference file (for= example: preference_file.epf). + + The Import button opens the Import Pr= eferences dialog. The Import all box will a= utomatically be selected, however you can choose to only import specific pr= eference settings (such as only those related to your JBoss runtime) by sel= ecting individual entries from the list that displays after using the Browse button to select your exported preference file (fo= r example: preference_file.epf). -
- Import Preferences dialog - - - - - -
-
-
- Duplicating a runtime configuration - 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 previous section except pressing - Finish - in the New Server Runtime Environment menu . +
+ Import Preferences dialog + + + + + +
+
+
+ Duplicating a runtime configuration + + While installing a new runtime you can copy the configuration from the= existing one. To do this you should perform all the steps in , with the exception of clicking the Finish= button in the New Server Runtime Environment menu. - Make sure that you browse to a valid runtime folder and can se= e the list of configurations (all, default, minimal) in the Configuration s= ection . - Then choose necessary Configuration from the list and click - Copy.The next dialog should appe= ar. + + Make sure that you browse to a valid runtime folder and can see the li= st of configurations (all, default, minimal) in the Configuration section. = Then choose appropriate Configuration from the list and click the Copy button.The next dialog should appear. -
- Copy the existing configuration - - - - - -
- Change the name Click on - Browse and select your configurati= on location or leave as it's if you want it to be located together with ot= her runtime configurations. +
+ Copy the existing configuration + + + + + +
+ + Change the name, click the Browse button, and s= elect your configuration location or leave as it is if you want it to be lo= cated together with other runtime configurations. -
- Copy the existing configuration - - - - - -
= - = - Click - Ok and you should see the next wiz= ard with the just added copied configuration. - = +
+ Copy the existing configuration + + + + + +
+ = + Click the OK button and you should see the= next wizard with the newly copied configuration. +
+ Runtime with copied configuration + + + + + +
+ Click the Finish button and you will see = your new runtime in the list. -
- Runtime with copied configuration - - - - - -
= - Press - Finish - and you will see your new runtime in the list. + + You can also change the configuration of existing runtime to a copied = one in the same way by selecting WindowPreferencesServer= Runtime Environments and clicking t= he Edit button. - You can also change a configuration of existing runtime to a cop= ied one in the same way from the - Window > Preferences - menu - Server > Runtime Environments - and clicking - Edit. - -
-
-
- Servers - WTP servers are eclipse-representations of a backing server inst= allation. They are used to - start or stop servers, deploy to servers, or debug code that will ru= n 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 Deploying = with Run On Server - Wizard section). - Servers can be started or stopped with different command-line - arguments. They are often backed by a runtime object repres= enting that server's - location. +
+
+
+ Servers + + WTP servers are Eclipse-representations of a back end server installati= on. They are used to start or stop servers, deploy to servers, or debug cod= e 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 ). = + + + Servers can be started or stopped with different command-line arguments. They are often backed by a runtime = object representing that server's location. + + = +
+ Creating a New Server + = + + There are many ways to get to the new server wizard. One way is to sel= ect FileNewOther...Server. This should show the wizard like below. + +
+ Adding a JBoss Server + + + + + +
+ + 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 i= nstallation. Thus, each server instance must be backed by an appropriate ru= ntime. + + = + + The New server wizard allows you to name the serv= er via the Server name field, or you can use a generat= ed default name .If it is necessary to restore the default name, click the = Reset default button ( <= imageobject>). + + + You can select the appropriate runtime you from the Server r= untime environment combobox. If there is no runtime that matches= your needs just press the Add... link nearby to bring= up the wizard for creating a new runtime (see ). To configure an existing runtimes you should go to server pref= erences by pressing the Configure runtime environments... link. + + = + If the server you want to create does not have any installed runt= ime yet, the combo box and the links are absent. + = +
+ Installed Server Runtime Environments + + + + + +
+ = + + In this case the next page of the wizard which has the same form as in= the previous section, and will= ask you to create the associated runtime. + + + 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 ch= ance to verify that you have selected the appropriate runtime. + + = +
+ Installed Server Runtime Environments + + + + + +
+ = + Click the Finish button to complete the pr= ocess of the server creation. + Now that we have created our runtimes and servers, we can explore= the services and tools provided by the JBoss Server Manager. + = + + We hope this guide helped you to get started with the JBoss Tools serv= er manager. For additional information you are welcome on JB= oss forum. + +
+
= -
- Creating a New Server = - There are many ways to get to the new server wizard. One way i= s to use the old standard - File > New > Other... - and then - Server - . This should show the wizard like below. -
- Adding a JBoss Server - - - - - -
- A server object is that keeps track of things like command lin= e arguments when starting - or stopping, and runtimes keep track of the location of the instal= lation. Thus, each server - instance must be backed by an appropriate runtime. - - New server wizard = allows to name the server appropriately in the Server = name field or you can use a generated default name.I= f it's nessecary to restore the default name,after you defined yours, click= the Reset default button( - - ). - 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 - Add... - link nearby to bring up the wizard for creating a new = runtime (see the Installing a New Runtime section<= /link>). To configure the already installed - runtimes you should go to server preferences that you can easily d= o by pressing the - Configure runtime environments... link. - - If the server you want to create doesn't have any install= ed runtime yet, the combo box - and the links are absent. - -
- Installed Server Runtime Environments - - - - - -
- - In this case the next page in the wizard which has the same fo= rm as in the previous section will = ask you to create the - associated runtime. - Either way, after targeting your server to a runtime, the fina= l screen in this wizard is - largely confirmational, giving you a chance to verify that you&apo= s;ve selected the - appropriate runtime. - -
- Installed Server Runtime Environments - - - - - -
- - Press - Finish - to complete the process of the server creation. - Now that we've created our runtimes and servers, we can d= well on all services - and tools that JBoss Server Manager provides. - = - We hope, this guide helped you to get started with the JBoss T= ools server manager. Besides, for additional information you are welcome on= JBoss forum. -
-
- = - --===============8141282437216333059==--