From jbosstools-commits at lists.jboss.org Fri Dec 19 14:21:14 2008 Content-Type: multipart/mixed; boundary="===============2178592318626118873==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r12773 - branches/jbosstools-3.0.0.CR1/as/docs/reference/en. Date: Fri, 19 Dec 2008 14:21:14 -0500 Message-ID: --===============2178592318626118873== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: smukhina Date: 2008-12-19 14:21:12 -0500 (Fri, 19 Dec 2008) New Revision: 12773 Added: branches/jbosstools-3.0.0.CR1/as/docs/reference/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-324 the file to build guide versions with highlighted diff markers = Added: branches/jbosstools-3.0.0.CR1/as/docs/reference/en/master_output.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 --- branches/jbosstools-3.0.0.CR1/as/docs/reference/en/master_output.xml = (rev 0) +++ branches/jbosstools-3.0.0.CR1/as/docs/reference/en/master_output.xml 20= 08-12-19 19:21:12 UTC (rev 12773) @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + = + + +]> + = + + JBoss Server Manager Reference Guide + = + AnatolyFedosik + OlgaChikvina= + RobStrykerrob.stryker(a)jboss.com + SvetlanaMukhinasmukhina(a)exadel.com = + = + April 2008 + + 2007 + 2008 + JBoss, a division of Red Hat Inc. + + + Version: 3.0.0.CR1 + + + + + PDF version + + + + + = + = + = + = + + Quick Start with JBoss Server + + This chapter covers the basics of working with the JBoss server. I= f you already have + installed JBoss server and runtime you can quickly learn how to config= ure, start, stop the + server, to know deployment and archiving processes. How to install run= times and servers read in + the Runtimes and Servers in the JBo= ss AS plugin chapter. + + To start working with JBoss AS, select a JBoss AS Perspective via + Window > Open Perspective= > Other > JBoss AS. + +
+ Starting JBoss server + + Starting JBoss server is quite simple. You can control the serve= r behaviour with the help + of a special toolbar in the JBoss Server= View where you could + start it in a regular or de= bug mode, stop it or + restart it, publish to the server. + +
+ JBoss Server Toolbar + + + + + +
+ + To launch the server click the green-with-white-arrow icon on th= e JBoss Server + View or right click server name in this view and select= + Start + . If this view is not open, select Window > Show View + > Other > Server > JBoss Server View. + +
+ Start JBoss Server + + + + + +
+ +
+ +
+ Stopping JBoss Server + + To stop the server, click the Stop icon in JBoss Server View or right + click the server name and press Stop. + +
+ Stop JBoss Server + + + + + +
+ + When the server is stopped you will see Stopped next to its name in + the State column. + Learn more about the JBoss Server View here. +
+ +
+ + Project Archiving + + JBoss Tools comes with our own archives tool. The Project Archiv= es plugin consists + primarily of a view to set up each packaging configuration ( + Window > Show View > Other > = JBoss Tools > Project archives + ). + Right clicking in the Project Archiv= es View you can create War, EJB + War or EAR archive. + +
+ Archive Creating + + + + + +
+ + Using the context menu on the item you can initiate a full build on + archive, edit, delete or + publish it. + +
+ Context Menu on the Item + + + + + +
+ + Learn more about the Project Archive= s View + here. + +
+
+ Deploying an Application to a Server + + There are two times to deploy your application: + + + While creating it + + + After it already exists + + + + 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 + Target Runtime + and + Target Server + sections. You can deploy the application through the app= ropriate selection in + these sections. + +
+ Runtime and Server Sections in the New Project Wizard + + + + + +
+ = +
+ Runtime and Server Sections in the Import Project Wizard</tit= le> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/quick_start/quick_start_4b.png"></i= magedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can deploy an existing application to a server by right-clic= king the target defined + server in the <property moreinfo=3D"none">JBoss Servers View</proper= ty> and then selecting <property moreinfo=3D"none">Add and + Remove Projects</property> from the context menu.</para> + + <figure float=3D"0"> + <title>Add and Remove Projects From the Context Menu. + + + + + +
+ + If this application is not assigned to a server, it will be in t= he left-hand available + projects list. Clicking on the Add ><= /property> button will add it to the right-hand + configured projects list and deploy the application to this server.<= /para> + +
+ Modifying The Projects that are Configured on the Server</tit= le> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/quick_start/quick_start_6.png"></im= agedata> + </imageobject> + </mediaobject> + </figure> + + <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 u= se of. Further we will talk about them in detail.</para> + </section> + = + = + <section> + <title>Other relevant resources on the topic + = + All JBoss Developer Studio/JBoss Tools documentation you can fin= d here. + The latest documentation builds are available here. + = +
+ = + + + = + + + + + 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's necessary to mention that the JBoss AS plugin ma= kes 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 classpat= h properly. + In order to get started creating, running, and debugging J2EE appl= ications, we should create + our runtime and server instances. + +
+ 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 JBoss installation, a= nd it can then be used for + two primary purposes: + + + it provides classpath additions to WTP projects that require= them. + + + for JBoss server at l= east, 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 > Installed Runtimes + from the categories available. +
+ Installed Runtimes + + + + + +
+ From this preference page you can see all declared runtimes an= d their types as well. + Figure above shows two declared runtimes that include a JBoss 4.2 = instance. Here, + it's possible to edit or remove existing runtimes as well as add a= new one. + + To create a JBoss runtime click + Add + button and choose a necessary type of runtime from the= appeared dialog. + +
+ Adding a Runtime + + + + + +
+ + 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 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 4.= 2 server adapter. + + + You'll also note a Deploy-Only Runtime type. This type provide= s 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 starting,= stopping, or + debugging their projects inside eclipse. + +
+ Adding a JBoss 4.2 Runtime + + + + + +
+ + The following table describes all the available options of the= wizard. + + 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 give descrip= tive + 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= . + + + + + + Configuration + + + The list of configurations (all, default, minimal) t= hat is updated as soon as + you browse to a valid runtime installation folder. After= the runtime is created + the configuration becomes an unchanging property of that= runtime. To compile + against a different configuration's jars, you will need = to create a new runtime + from that configuration. + + + + + +
+ + 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 create se= veral 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. + + Press + Finish + to see your new runtime in the list. +
+ +
+ +
+ 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. + = +
+ 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. + + From the list of already declared runtimes in the combo box be= low 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 + Installed Runtimes... + to bring up the familiar preference page like in + the previous section. Here, it becomes possible to edit a= lready existing runtime or + add a new one with necessary configuration. + +
+ Installed Server Runtime Environments + + + + + +
+ + If the server you want to create doesn't have any installed ru= ntime yet, the combo box + and button will disappear. + +
+ Installed Server Runtime Environments + + + + + +
+ + In this case the next page in the wizard which has the same fo= rm as in the previous section w= ill 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've = selected the + appropriate runtime. It also allows to name the server appropriate= ly. + +
+ 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 dwell = on all services + and tools that JBoss Server Manager provides. +
+ +
+ + + + = + + + + + JBoss Developer Studio + Eclipse + Deploy + Deployment + JBoss + + + JBoss AS Perspective + + This chapter tells how to manage installed JBoss Servers via JBoss AS + Perspective. + + The JBoss AS Perspective = is similar to the Java + Perspective, but it contains a few additional views. Two of the add= itional + views are standard views, specifically the Console View and the + Properties View. The ot= her two views that are added are the + Project Archives View a= nd the JBoss Server + View. + +
+ + The JBoss Server View + Let's have a look at the JBoss S= erver View and inspect + in detail all parts it consists of. + + The JBoss Server View= is based on the WTP view, Server View. The + top part of the JBoss Servers View= essentially embeds the original + Server View directly into it, making slight changes to the con= text menu. A second part + was added to provide additional information about the server s= elected in the top part. + +
+ The JBoss Server View + + + + + +
+ + + The view's toolbar provides quick access to starting a serve= r (in debug mode, run + mode, or profile mode), restarting a server, stopping a server= , or publishing to a + server. +
+ The JBoss Server View Toolbar + + + + + +
+ + In order to debug your applications or EJB's that are deploy= ed to the server, you must + start the server in debug mode. By starting the server in debu= g mode, eclipse will allow + you to set breakpoints on code in your workspace and step thro= ugh the code. + + + Start the server in profiling = mode + button allows to enable profiling actions for your= application. For more + details on how to start using TPTP profiling with JBoss Tools refer + to TPTP Support chapter.= + + + Publish to the server + button o= n the extreme right will republish any modules where it has + determined the workspace is out of sync with the server. It wi= ll attempt to do an + incremental publish if it turns out that the module in questio= n is capable of doing + one. + + Now, let's get to know with both of the JBoss Server + View parts. + +
+ Top Part of the JBoss Server View + In the top part of the JBoss= Server View all declared servers + are represented as well as their current states, that is, = whether they are started + or stopped. +
+ Server Publish Status + + + + + +
+ + The top part also shows the server's publish status. The= fallowing table + lists possible statuses. + + + Server Publish Status + + <= /colspec> + + + + + + Status + + Description + + + + + + + Republish + + + + The status which allows you to see if changes are + awaiting + + + + + Publishing... + + + + The status which shows if changes ar= e being updated + + + + + Synchronized + + + + The status which allows you to see if changes are + in-sync + + + + +
+ + By double-clic= king on any server, an editor window will appear allowing you to + edit parts of that server. On the figure you can see that = a username/password is + available in the UI when configuring the server. If you ge= t an SecurityException + when trying to launch the server, it is most likely becaus= e your server is protected + and hence you need to fill the username/password fields wi= th appropriate + values. + +
+ Preferences Page for the Chosen Server + + + + + +
+ + It should be pointed out that our server adapter by defa= ult tries to automatically + detect the ports it needs for integrating with a JBoss server. + Sometimes it can though be relevant to override this autom= atic detection if you are + using some custom configuration. For this purposes the + Server Ports + section in the Ser= ver editor is provided w= here the + port settings are configurable. Click the + Configure... + link t= o bring up the wizard for adjusting the settings for the + Ports. + +
+ <diffmk:wrapper diffmk:chan= ge=3D"added">Server Ports Preferences</diffmk:wrapper> + + + + + +
+ + Press + Edit XPath + button= for the chosen Port to configure its XPath's values. + +
+ <diffmk:wrapper diffmk:chan= ge=3D"added">XPath Pattern for a Server Port</diffmk:wrapper> + + + + + +
+ + The settings r= elated to + Publishing + , + Timeouts + or + Server Polling + can be= also adjusted in the Server editor. + + Server e= ditor makes it also po= ssible to + modify the server's launch configuration. It's just after = clicking + Open launch configuration<= /property> + link. In the open window there are the tabs fo= r setting command line + arguments and other things that are relevant to launching = the server. + +
+ Launch Configuration Properties + + + + + +
+ + Look up here to find parameters= which can be specified for JBoss + Server. + + As the JBoss Servers have few properties to modify in th= is editor, a shortcut to + the launch configuration has been provided in the context = menu when right-clicking + on a server. + +
+ Twiddle Server + + + + + +
+ + The following table describes all these additional prope= rties. + + Server Properties through the Context Menu + + <= /colspec> + + + + + + Name + + + + Description + + + + + + + + New Server + + + The option allows to define a new se= rver + + + + + + Delete + + + Standard option that allows to delet= e the chosen server + + + + + + Start + + + The action for stating a server in a= run mode + + + + + + Debug + + + The action for stating a server in a= debug mode + + + + + + Stop + + + The action for stopping a declared s= erver + + + + + + Publish + + + The action for synching the publish = information between the + server and workspace + + + + + + Clean + + + The option for complete redeploying = the resources + + + + + + Twiddle Server + + + The option provides a dialog for run= ning Twiddle commands + against the Twiddle Server + + + + + + Edit Launch Configuration + + + The option that provides an editor f= or editing launch + configuration properties of the proper= server + + + + + + Add and Remove Projects + + + The option allows to publish a new p= roject to the server (if + its type is supported) + + + + +
+ + Mentioned above Twiddle is a JMX library that comes with= JBoss, and you can use it + to access any variables that exposed via the JBoss JMX int= erfaces. +
+ +
+ Bottom Part of the JBoss Server View + + Here, we dwell on the bottom part of the JBoss Server + View. + First, we should say that the bottom part is meant to pr= ovide additional + functionality relevant to the server selected in the top p= art of the view. If a + standard server element is selected from above, some of th= e extensions may still + provide the additional information. Others may not. So, le= t's look at the + currently available extensions to the bottom part of the <= property moreinfo=3D"none">JBoss = Server + View. + +
+ View Extensions + + + + + +
+ + In order to access the view's preferences, you should ac= cess + Window > Preferences &g= t; JBoss Tools > JBoss + Servers > View + . This preference page allows you to select whi= ch view extensions you + want on or off, the order they appear in the view, as well= as any other + extension-specific preferences that may be available. + +
+ View Preferences + + + + + +
+ + The first view extension is + Modules + section. It shows which modules are currently = deployed to the server, + and allows you to remove them from the server, or force a = full republish upon them. + It only shows which modules have been deployed through Ecl= ipse, not any and all + modules that happen to be in the deploy directory. + +
+ Modules Action + + + + + +
+ + The + Event Log + will show relevant information to your server'= s startup, + shutdown, and publish processes. This allows you to keep a= n eye on what's + going on (such as automatic incremental deployment if you = have it enabled). The only + action available is to clear the + Event Log + . However, if the P= roperties View is opened, you can + receive further information on each + Event Log + item (when available). + +
+ Event Log Actions + + + + + +
+ +
+ Starting the Server + + + + + +
+ + The + XML Configuration + category allows you to quickly browse to descr= iptor files in your + server's deploy directory and check or change the values. = Its use requires the + Properties view= . Basically, + XML Configuration + includes XML XPaths where a xpath is a path us= ed to access some specific + part of an xml document. + +
+ XML Configuration and Properties View + + + + + +
+ + + Note: + You are assumed to be familiar with XPath. If not, w= e highly suggested that + you look through an appropriate manual or tutorial on = the topic. + + + The + XML Configuration + category itself contains only a list of catego= ries. + Ports + are provided by default and is filled with man= y of the most commonly + used ports in the JBoss Server= . In the Properties + view you can see an identifier and nested f= iles underneath in which + that xpath can be found as well as its current value. The = details of the xpath are + hidden as all you need to see is only which file you're re= ferring to and + what its current value is. + + By right-clicking on + XML Configuration, you can create a new + category. Besides, context menu for + XML Configuration + category makes possible to disable it. You can= disable any category in + the bottom part of the + JBoss Server View. Look for them in the + Inactive Categories + afterwards to re-enable. + +
+ Adding New Category + + + + + +
+ + By right-clicking on + Ports + or any other category in + XML Configuration + , you can create a new xpath. + +
+ Adding New XPath + + + + + +
+ + After that, the dialog shown below will appear. + +
+ Adding New XPath + + + + + +
+ + The goal here is to get an end result where the XPath ma= tches up with a necessary + property. With that in mind, let's look how it works. If t= he property you + want to reach is the value of the name attribute in the element + <mbean>, then your + XPath Patten + should end with mbean and = your + Attribute Name + should be name like on th= e next figure. + + +... + + = + + + + The EJBDeployer responsible for ejb jar deployment = + ... + + + +]]> + +
+ XPath Preview + + + + + +
+ + + Tip: + Notice, when you type the fields autocomplete to hel= p you locate exactly what + xpath you're looking for. + + + Then, on the other hand, if your desired field is the te= xt of an element + <description>, your + XPath Patten + should end with description and + Attribute Name + field should be left blank. When finished, cli= ck + Preview + to see how many matches you have for that part= icular XPath. + +
+ XPath Preview + + + + + +
+ + As part of the JBoss Server = View there is a + JMX Console + section which allows you to browse and use the= JMX exposed beans on the + server. +
+ JMX Console + + + + + +
+ +
+ Relevant Resources Links + Find more about XPath in the XPath + Documentation. +
+
+ +
+ +
+ Project Archives View + Every application, whether Plain Old Java, J2EE, or some oth= er language altogether, + needs to be packaged in some way. In Java-related projects, ma= ny people use ANT. JBoss + Tools comes with our own Archives tool with a bit easier and l= ess-verbose XML and a + handy user interface. The Project Archives plugin consists pri= marily of a view, that is + Project Archives View, to set up each packaging + configuration. + So far, let's look through all functionality that the Project + Archives View provides. + +
+ Overview + + The packaging configuration for each project is stored i= n the project's root + folder, and is in a file named + .packages + , which has a fairly simple XML structure. Modi= fying the file by hand is + neither required nor recommended, and using the UI is the = official way of modifying + your packaging structure. + +
+ Archives View + + + + + +
+ + A project's configuration contains archives. On the imag= e above there is + only one archive, but a project can contain many. Inside t= he archive folders + (testFolder), filesets, or other internal archives can be = located. Internal archives + and filesets may be directly inside of an archive, or in s= ome sub-folder of that + archive. + + In the upper right corner of the view you can see an ico= n which, when clicked, + will build the selected top-level archive. Additionally, y= ou can select + Project > Build Package= s + when a project is selected in the Packages View to + build all declared packages in that project's + .packages + file. This will execute a full build on all de= clared archives. +
+ +
+ Creating an Archive + When creating a new archive, you have some different opt= ions at your disposal. If + the project has no + .packages + file, your options will be presented to you al= l at once to choose from. + Otherwise you will right-click inside the view and select = + New Archive + to see your archive type options. +
+ Create an Archive + + + + + +
+ + + Note: + 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 wil= l show up. + + + JAR is the standa= rd 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. + The other types, for the most part, simply start off wit= h a default setting, + usually the jar with some specific children based on an ex= pected structure of the + project. For example, if the project is a Dynamic Web Proj= ect, and you create a + WAR archive, th= e archive will be created with a few + filesets relevant to the known structure of the project. + + Here is the first page of all New archive wizards. It is= the same for any archive + type and the only page in the = New Jar Wizard. +
+ New JAR Wizard + + + + + +
+ + The page is pretty simple. All it asks for is the name o= f your new archive, a + destination, which we'll get to in a moment, and whether t= he archive is exploded or + packaged up. + The destination of an archive can be anywhere on the fil= esystem, anywhere in the + workspace, inside some other archive, or inside a folder d= eclared inside an archive. + You can browse to workspace or filesystem destinations by = clicking on their + respective buttons. To select a destination inside some ot= her archive, you'll need + to press the + Workspace... + button. At the bottom of the list, you'll see = archives that + have been declared in the workspace. +
+ Creating a Folder + Creating a folder is much easier. You simply right-c= lick on an archive or + folder you want your new folder to be a child under. T= he only piece of required + information is naming the file. +
+
+ Creating a FileSet + To create a new fileset, you click on an available t= arget location such as an + archive, a nested archive, or a folder within an archi= ve, and select + New Fileset + . + The New Fileset Wizard requires a destination (where the + files will go), and a root directory (or where the fil= es are coming from). The + source can be anywhere in the workspace or from the fi= lesystem at large. + +
+ Adding a New FileSet + + + + + +
+ + Below that, the fileset requires only an includes pa= ttern and an excludes + pattern. As you type in either of these fields, the pr= eview viewer should update + itself with which files are matched. +
+
+
+ Archive Actions +
+ Context Menu on the Item + + + + + +
+ The context menu on the items in the view is extendable,= but there are several + that come standard. + + + Context Menu on the Item + + <= /colspec> + + + + + + + Name + + + + Description + + + + + + + + + Build Archive (Full) + + + + The action enabled only on top-level= archives, which initiates + a full build on that archive + + + + + + Edit Archive + + + + Standard action that brings up the w= izard associated with that + particular node type and allows the de= tails to be changed + + + + + + Delete Archive + + + + Deleting node is standard action wit= h deletion not needing an + explanation + + + + + + Publish To Server + + + + The action means the ability to publish to a declared + server + + + + + +
+
+ +
+ Publishing to Server + Finally, you'll need to publish your application to a se= rver. Here, we + show you how to do it with the help of + Archives View + . + +
+ Context Menu on the Item + + + + + +
+ The dialog above appears after selecting + Publish To Server + . To simply publish once, you just select the s= erver(s) that you want, + and finish. If you want the + Publish to Server + action on that particular Archive to publish a= lways to that set of + servers, then check the appropriate checkbox. And finally,= to enable automatic + publishing upon build events, check the last checkbox. + 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 destinati= on folder be the deploy + folder of the server. +
+
+ Relevant Resources Links + Refer to Ant manual + to find more on how to build your applications with help o= f Ant. + + At this point, you are guessed to be familiar with JBoss AS + Perspective and your next = step now is to explore how to work with + different kinds of projects. +
+ +
+ + + + + = + + Projects + The most popular of the projects we deal with are the J2EE ones, su= ch as Dynamic Web + Project, EJB Project, or EAR project. Web projects of JBoss Tools 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. + +
+ Faceted Projects Overview + The idea behind faceted projects is that each project can accept u= nits of + functionality, or facets, which can be added or removed by the user. Mo= st often, these + facets either add to the project's classpath, enable a builder, or watc= h 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. + + WTP projects have undergone some criticism as 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 E= JB project child, + or other types. + + However, the benefit of this is that the structure of your projec= ts 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 st= ill choose to + package your project using the A= rchives + plugin. +
+ + +
+ Adding Facets to a Project + + In this section we're going to consider the facets added by JBoss + Tools and show how you can configure them in a project: add= new ones or + modify already existing configuration of the facets. + + One way to configure the facets is doing it while organizing a new= project. To + demonstrate this let's create a new Dynamic= Web Project by + selecting + File > New > Other... + and then + Web > Dynamic Web Project. <= /emphasis> +
+ New Dynamic Web Project + + + + + +
+ Click + Next + and you will see Dynamic Web Project page like on the figur= e below. + + The first page of most WTP projects allows you to target a specif= ic 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 pre-selected default set o= f facets, called + a configuration, rather than manually select each facet you might want.= + Selecting the runtime, again, allows the project to install the p= roper classpaths to + the project so it knows what code to compile against. + +
+ New Dynamic Web Project + + + + + +
+ Click on the + Modify + button next to Configuration section in order to open + the wizard which allows you to modify a chosen configuration. The wizar= d looks as + follows. + +
+ Project Facets Wizard + + + + + +
+ + Here part of the listed facets are those which are provided by WTP= . Some of them are + added by JBoss Tools. They are:<= /para> + + + BIRT Charting Runtime Component + + + BIRT Reporting Runtime Component + + + JBoss ESB + + + JBoss Portlets + + + JBoss Web Services + + + Seam + + + + 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 co= nflict with each + other. In case of incompatibility you'll be prompted about this in the = combo + box underneath. +
+ Facet Constraints + + + + + +
+ When switching on the + Runtimes + tab on the right you'll see the currant Server Runtime. +
+ Runtimes on the Project Facets Wizard + + + + + +
+ On this tab you can also create a new Server Runtime and make it p= rimary by pressing + Make Primary + button after enabling it. + + Clicking on + OK + will save the chosen configuration of the facets and return= you to the Dynamic Web Project wizard. Further pages in the + wizard are specific to either the project type or the facets selected.<= /para> + + + If you need to configure the facets for the existing project, you = should bring up the + context menu for selected project and click + Properties + and then + Project Facets. Thi= s will bring up the familiar + Project Facets wizard, where y= ou can create + your own custom facets configuration. + + + +
+
+ Relevant Resources Links + + More on the WTP facets you can read in the eclipse help. +
+ + + = + + Deploying Modules + + In this chapter it will be described how to deploy modules onto the= server. + 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 p= rovided by JBoss + Tools. These methods are described further in this chapter. + +
+ Deploying on the Package Explorer + + On the package explorer it is possible to publish either a project= to a server or just + a signal file. Let's look at how to do this. +
+ Deploying with Run On Server Wizard + The first WTP method is to right-click on a project, such as a D= ynamic Web + project, EJB project, or EAR project and then select + Run As > Run on Server + . The resulting dialog allows you to select which supportin= g server the + project can be published to. +
+ Define a New Server + + + + + +
+ Click + Next + button to see add or remove projects page where you can ch= oose projects + to configure them on server. +
+ Add or Remove Projects + + + + + +
+ This page of the wizard also allows to undeploy modules from the = server. For that + choose proper module(s) from the right and click + < Remove + . The modules will be completely undeployed after restartin= g your server + or republishing. + Generally, for the JBoss AS Server Adapters, publishing using thi= s 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 + .war + , + .jar + , or + .ear + as appropriate, and then copies that file into the proper = deploy + directory. For quicker smarter deployment, you will need to create arc= hives using + the Project Archives view and customize + packaging yourself. +
+ +
+ + Deploying single files + + Sometimes it becomes necessary to deploy one or more files to a s= erver. For + that in order not to do a full republish in the context menu of files = a Deploy To Server + option is provided that allows a single file deployment. To deploy the= se non-WTP files/projects + right click on the file ( + -ds.xml, + .ear, + .jar etc.) and se= lect + Deploy To Server + and it will be automatically deployed. +
+ Deploy to Sever + + + + + +
+ The deployed files are listed side-by-side with other modules tha= t are deployed to + the server. + = +
+ Deployed files on the Server + + + + + +
+ +
+ +
+
+ Deploying with JBoss Server View + As it has been already mentioned JBoss= Server View contains two + parts: the top part that displays all defined servers and the bottom pa= rt which provides + categories with additional information. Thus, in this section we sugges= t two more ways + to deploy resources onto the server. +
+ Top part of JBoss Server View + In the top part of the JBoss Servers = View like in the Servers + View you should right click on a server and select the + Add and Remove Projects + menu item. +
+ Add and Remove Projects + + + + + +
+ + This will bring up a familiar dial= og 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 + Run on Server + wizard, with a best-guess full package. If, however, the s= elected + element is an archive from the = Project Archives + view, it will be published according to the rules of that modu= le + type. +
+ +
+ Bottom part of JBoss Server View + In the bottom part of + JBoss Server View + there is a category called + Modules + which should display all currently-published modules on th= e server. + Right-clicking on the desired module and selecting + Full Publish + will force a full rebuild of the entire module. +
+ Full Publish + + + + + +
+ + Here, + Incremental Publish + is meant to enable publishing of only those parts where ch= anges have + been made. +
+
+
+ Deploying with Project Archives View + In the Project Archives View you can right-click on any declared + archive and select the + Publish To Server + element. For more on this subject, see Publishing to Server in the Project Archives View sect= ion. +
+ Publish to Server + + + + + +
+ The only way to ensure an + Incremental Build + , such as changes to one + .jsp, + + .html, or + .class + file, is to enable the builder for that project. This is do= ne by either + changing the global preferences for the Arc= hives View, or by + enabling project-specific preferences and ensuring the builder is on. + The last chapter covers a variety of methods on how you can deploy= needed modules onto a + server. +
+ + + = + + TPTP Support + This chapter provides an overview on how to enable TPTP Profilin= g for JBoss + AS adapters in JBoss Tools<= /property>. + +
+ TPTP Profiling + + To get TPTP profiling work on JB= oss Application Server you should + first download TPT= P 4.5.0 Runtime and install it, i. e. just add the content of + plugins/features + folders from downloaded directory to the same fold= ers in your eclipse + installation directory. + + And now all profile actions should work for you. To start JBoss + AS in profiling mode use + Start the server in profiling = mode + button or + Profile As > Profile on Ser= ver + option in the context menu of the project. + +
+ Start the Server in Profiling mode + + + + + +
+ + To enable TPTP features in your workbench use Profiling and Logging + Perspective that you can find in the list of pr= oposed perspectives: + Window > Open Perspective &= gt; Other=E2=80=A6 + + + +
+ Profiling and Logging Perspective + + + + + +
+
+ +
+ Relevant Resources Links + All additional information on TPTP(Test and Performance Tool= s Platform) you can find + in eclipse documentation. + In summary, this reference should help you to start with JBoss AS and get to know w= ith functionality + for work with it. +
+ + + = + --===============2178592318626118873==--