From jbosstools-commits at lists.jboss.org Fri May 8 08:39:35 2009 Content-Type: multipart/mixed; boundary="===============6868854711430807699==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r15138 - in trunk: documentation/guides/Exadel-migration/en and 5 other directories. Date: Fri, 08 May 2009 08:36:12 -0400 Message-ID: --===============6868854711430807699== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: smukhina Date: 2009-05-08 08:36:11 -0400 (Fri, 08 May 2009) New Revision: 15138 Modified: trunk/as/docs/reference/en/master_output.xml trunk/documentation/guides/Exadel-migration/en/master_output.xml trunk/documentation/guides/GettingStartedGuide/pom.xml trunk/drools/docs/reference/en/master_output.xml trunk/esb/docs/esb_ref_guide/en/master_output.xml trunk/hibernatetools/docs/reference/en/master_output.xml trunk/jbpm/docs/converter_ref/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-717 correcting syntax errors in rel= ease documentation = Modified: trunk/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 --- trunk/as/docs/reference/en/master_output.xml 2009-05-08 12:20:47 UTC (r= ev 15137) +++ trunk/as/docs/reference/en/master_output.xml 2009-05-08 12:36:11 UTC (r= ev 15138) @@ -22,2069 +22,2069 @@ = = = -]> - = - - JBoss Server Manager Reference Guide - = - AnatolyFedosik - OlgaChikvina= - RobStrykerrob.stryker(a)jboss.com - SvetlanaMukhinasmukhina(a)exadel.com = - = - April 2008 - - 2007 - 2009 - JBoss, a division of Red Hat - - - Version: 2.0.0.GA - - - - - PDF version - - - - - = - = - = - = - - Quick Start with JBoss Server - - This chapter covers the basics of working with the JBoss Server. If you - already have installed JBoss server and runtime you can quickly learn = how to configure, start, - stop the server, to know deployment and archiving processes. How to in= stall runtimes and servers - read in the Runtimes and Servers in= the JBoss 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 server - behaviour with the help of a special toolbar in the JBoss Server View - where you could - start - it in a regular or debug mode, - stop - it or - restart - it and - 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 the JBoss Server Vie= w or right click the server name - and press Stop. - -
- Stop JBoss Server - - - - - -
- - When the server is stopped you will see - Stopped - state next to its name in the square brackets. - Learn more about the JBoss Server Vi= ew - here. -
- -
- - Project Archiving - - JBoss Tools comes with ou= r own archives tool. The Project Archives - plugin consists primarily of a view to set up each packaging configu= ration ( - Window > Show View > Other >= ; JBoss Tools > Project archives). - - Right clicking in the Project archiv= es view you can create War, - EJB War, EAR or JAR 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 <emphasis><property moreinfo=3D"none">Add and - Remove Projects</property></emphasis> 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 classpath - 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 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 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 > 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 well 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 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= 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 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 the - Add... - link nearby to bring up the wizard for creating a new = runtime (see the previous section). 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 installed ru= ntime 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 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. - = - We hope, this guide helped you to get started with the JBoss Tools server= manager. Besides, for additional information you are welcome on JBoss forum. -
- -
- - - - = - - - - - JBoss Developer Studio - Eclipse - Deploy - Deployment - JBoss - - - - JBoss AS Perspective - - This chapter tells how to manage installed JBoss Server via - JBoss AS perspective. - - The JBoss AS perspective = is similar to the Java - perspective, but it contains a few additional views= . Two of the additional - 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 - - The JBoss Server View= is built on Common Navigator Framework - allowing extensions and is using label decorators what makes t= he UI enough compact - without loosing the vital information. - - Let's have a look at the JBoss S= erver View and inspect - in detail all parts it consists of. -
- The JBoss Server View - - - - - -
- -
- JBoss Server View Toolbar - In the right top corner of the JBoss Server View t= here is a - special toolbar which provides a quick access to starting = a server (in the debug mode, - run mode, or profile mode), restarting a server, stopping = a server and a possibility to publish to a - server. - -
- The JBoss Server View Toolbar - - - - - -
- - In order to debug your applications or EJB's that are de= ployed to the server, you - must start the server in debug mode. By starting the serve= r in debug mode, eclipse - will allow you to set breakpoints on code in your workspac= e and step through the - code. - - - Start the server in profil= ing 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 will republish any modules where it has= determined the workspace - is out of sync with the server. It will attempt to do an i= ncremental publish if it - turns out that the module in question is capable of doing = one. - = -
- -
- JBoss Server View Structure - The JBoss Server View displays all declared servers as well - as their current states (that is whether they are started = or stopped) and statuses - in the square brackets next to a server name. - -
- The JBoss Server View - - - - - -
- - The following table lists possible server statuses. - - - Server Publish Status - - <= /colspec> - - - - - - Status - - Description - - - - - - - Republish - - - - The status which allows you to see i= f changes are - awaiting - - - - - Publishing... - - - - The status which shows if changes ar= e being updated - - - - - Synchronized - - - - The status which allows you to see i= f changes are - in-sync - - - - -
- - You can control a server behavior as well as adjust some= server preferences with - the help of the context menu commands. - -
- Context Menu Commands - - - - - -
- - All available context menu commands are described in the= following table. - - Server Properties through the Context Menu - - <= /colspec> - - - - - - Name - - - - Description - - - - - - - - New Server - - - The option allows to define a new se= rver - - - - - - Open - - - The option opens the Server editor - - - - - - Show in - - - This option gives an easy access to = the next views: Console, - Debug view, Server Log or MBean Explor= er - - - - - - 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 synchronizing the publish information between - the server and workspace - - - - - - Explore - - - This action uses the native OS file = explorer to browse the - deploy destination. Note: The option i= s also available for - deployed resources/projects (see the f= igure below). - - - - - - Add and Remove Projects - - - The option allows to publish a new p= roject to the server (if - its type is supported) - - - - - - Monitoring - - - Possibility to add ports to be monit= ored on the current - server - - - - - - Properties - - - Opens the window to adjust the curre= nt server - preferences - - - - - -
- - Under the server element in the JBoss Server View, you can - see currently deployed to the server modules and some serv= er extensions which - provide the additional information on the server. - - The context menu for any module allows you to remove it = from the server, force a - full or incremental republish upon it. - -
- Modules Action - - - - - -
- -
- Filesets - - The - Filesets - category in the JBoss Server View is intended - for files filtering. - - To add a new file filter, right-click the - Filesets - category and select - Create File Filter.The New File - Filter wizard should appear. - -
- Creating a New File Filter - - - - - -
- - The wizard asks you to enter the filter name and add= includes and excludes - patterns. The preview box underneath gives a list of f= iles matched to the - defined patterns. - -
- New File Filter Wizard - - - - - -
- - After the filter is created, you can observe it by e= xpanding the - Filesets - category in the JBoss Server View. - - It's possible now to edit files directly from the - Filesets - category. Double clicking on a file from <= emphasis> - Filesets - opens up the editor automatically or you c= an use the - Edit File - context menu command. - -
- Direct Editing from the Filesets - - - - - -
- - To delete a file filter (or just a file) from the - Filesets, right-click a file filter (or the - unnecessary file) and select the - Delete File Filter - - (Delete File) command. - -
- Deleting the File from the Filesets - - - - - -
-
- -
- XML Configuration - The - XML Configuration - category allows you to quickly browse to d= escriptor files in your - server's deploy directory and check or change the valu= es. Basically, - XML Configuration - = includes XML XPaths where an xpath is a path used to access some - specific part of an xml document. - - - Note: - You are assumed to be familiar with XPath. If no= t, we highly suggested - that you look through an appropriate manual or tut= orial on the topic. - - - The - XML Configuration - category itself contains only a list of ca= tegories. - Ports - are provided by default and is filled with= many of the most commonly - used ports in the JBoss Se= rver. - -
- XML Configuration - - - - - -
- - - - - 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 XPat= h matches up with a - necessary property. With that in mind, let's look how = it works. If the - property you want to reach is the value of the name - attribute in the element <mbean>, then your - XPath Patten - should end with mbean = and your - Attribute Name - should be name like o= n the next figure. - - -... - - = - - - - The EJBDeployer responsible for ejb jar deployment = - ... - - - -]]> - -
- XPath Preview - - - - - -
- - - Tip: - Notice, when you type the fields autocomplete to= help you locate exactly - what xpath you're looking for. - - - Then, on the other hand, if your desired field is th= e text of an element - <description><= /code>, your - XPath Patten - should end with description and - Attribute Name - field should be left blank. When finished,= click - Preview - to see how many matches you have for that = particular XPath. - -
- XPath Preview - - - - - -
- -
-
- -
- Drag-n-Drop to JBoss Server View - - Starting from 2.0.0.CR2 version of JBoss AS Tools the - JBoss Server View supports drag-n-drop of deploy= able and - runnable projects/resources. - -
- Dragging to the JBoss Server View - - - - - -
- - With drag-n-drop the following actions can be performed:= - - - - dragging a project to a server will deploy it to= the server and run it by - showing the main page in a browser - - - - dragging an - .xhtml - file from - WebContent - will do the same and show the correspo= nding page in a - browser - - - - dragging a deployable resource (i.e. a datasourc= e ( - -ds.xml - ) file that has been made deployable) will simply deploy that - resource directly to the server - - - - In short, the feature does the same thing as if you used= the - Run On Server - option or - Add and Remove Projects - option in the context menu of the server. -
- -
- Server Log View - - You can monitor the current server behavior with the hel= p of the Server - Log. To open a server in the Server Log view you - should right-click on the server and follow to - Open in > Server Log. - - The - Server Log - shows relevant information to your server's st= artup, shutdown, - and publish processes. This allows you to keep an eye on w= hat's going on - (such as automatic incremental deployment if you have it e= nabled). - -
- Event Log Actions - - - - - -
- - The Server Log to= olbar contains several icons that perform - the following actions: - - - Server Log Toolbar Icons - - <= /colspec> - - - - - - Name - - - - Description - - - - - - - - Export Log - - - Possibility to export the log into a= text file - - - - - - Clear Log Viewer - - - The option clears the current server= log - - - - - - Delete Log - - - Click to delete the server log - - - - - - Open Log - - - Click to open the server log text fi= le - - - - - - Restore Log - - - Click to restore the server log - - - - - -
- -
- -
- Server Editor - By double-clicking on any server, an editor window will = appear allowing you to - edit parts of that server. - -
- Preferences Page for the Chosen Server - - - - - -
- - - Tip: - On the fig= ure you can see that a username/password is available in the UI when - configuring the server. If you get a SecurityException= when trying to launch the - server, it is most likely because your server is prote= cted and hence you need to - fill the username/password fields with appropriate val= ues. - - - 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 where the - port settings are configurable. Click the - Configure... - link to bring up the wizard for adjusting the = settings for the - ports. - -
- Server Ports Preferences - - - - - -
- - Press - Edit XPath - button for the chosen port to configure its XP= ath's values. - -
- XPath Pattern for a Server Port - - - - - -
- - The settings related to - Publishing - , - Timeouts - or - Server Polling - can be also adjusted in the Server editor. - - Server e= ditor makes it also possible 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 for setting command line - arguments, classpaths and other things that are relevant t= o launching the - server. - -
- Launch Configuration Properties - - - - - -
- - Look up here to find parameters= which can be specified for JBoss - Server. - - - <diffmk:wrapper diffmk:chan= ge=3D"added">Note:</diffmk:wrapper> - Please note, that the Launch Configurations for JBoss Servers a= re enough - strict in enforcing the configured values in the serve= r in order to avoid - inconsistencies between server's and their configured = runtime. - - For example, if you change the launch configuration program arg= uments to - "-c myConfig" but do not change the - targeted runtime configuration, then your program argu= ments will be ignored. The - server runtime "wins" so to speak. This ensures consis= tency - and if you change the location of the runtime, your la= unch configurations will - automatically pick that up. - - Values are not controlled by the server and its runtime setup w= ill be passed - on unaltered. - - - Until 3.0.0.GA release of JBoss = Tools, = the servers classpath was readonly, but that caused - problems for users wanting to add their own jars in the st= artup classpath. That is - relevant if you need to patch the server, add a custom cha= rset or other tweaks that - require early access to the classpath. - - Now all servers have a custom 'server runtime classpath - container', which is there by default and point to the def= ault jars in - JBoss. You can now adjust the classpath. Then just make su= re this container is there - if you want the classpath to be picked up. - -
- <diffmk:wrapper diffmk:chan= ge=3D"added">Server Classpaths</diffmk:wrapper> - - - - - -
- - If for some reason you have a launch configuration without this con= tainer, - Restore - Default Entries= should add it properly. Also, - Restore - Default Entries will also remove any - extra entries you added yourself. -
- -
- 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. - - Note: - Those who use ANT will appreciate how the Project Archiv= es Ant task is now - improved: it supports variables and gives more informative= error/logging messages - when something goes wrong. - - - But JBoss Tools come = with our own Archives tool with a bit easier - and less-verbose XML and a handy user interface. The Project A= rchives plugin consists - primarily of a view, that is Proje= ct 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. As you can = see on the image - above a project can contain more than one archive. Interna= l archives and filesets - can be directly inside of an archive, or in some sub-folde= r 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 you open the Project ar= chives view for the first time, - it asks you to select the project for what you want to cre= ate an archive. - -
- Archives View - - - - - -
- - When creating a new archive for selected project, you ha= ve some different options - at your disposal. You need 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 archi= ve 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 WAR Wizard - - - - - -
- - The page is pretty simple. First it asks to set the name= of your new archive and a - destination. - - The destination of an archive can be anywhere on the fil= e system, anywhere in the - workspace, inside some other archive, or inside a folder d= eclared inside an archive. - Select the necessary checkbox (either - workspace - or - file system - ) for marking the destination as related to eit= her workspace or file - system. You can browse to workspace or filesystem destinat= ions 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. - -
- Selecting the destination in the workspace - - - - - -
- - Also in the wizard for creating a new archive you can ch= oose whether an archive to - be compressed or exploded into a folder (without compressi= on). You need just select - proper chechbox in the - Archive type - section. - If a build or incremental update fails Project Archives = will show an error - dialog: -
- Selecting the destination in the workspace - - - - - -
- Click in - Details - to see detailed information about what caused = the error. - - In the Package Explorer you can observe the created - archive. -
- The Archive in the Package Explorer - - - - - -
- - If you use the exploded type of archiving, instead of a = single file archive the - result put into a folder is displayed in the Package - Explorer. -
- The Exploded Archive in the Package Explorer - - - - - -
- -
- 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. - - You can cr= eate a Fileset with flattening or without it. Look at the difference - on the figure below. - -
- <diffmk:wrapper diffmk:change=3D"changed">The F= ileSet with flattening and without it</diffmk:wrapper> - - - - - -
- -
-
- -
- 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 publ= ish to a declared - server - - - - - - Edit publish settings - - - - Gives possibility to edit an archive= publish settings - - - - - -
-
- -
- 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 server(s) that you want, and finish. If yo= u 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. -
- - -
- - - - - = - - 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 specific runtime, - representing a server's library location. It will also provide you the = ability to add - this project to an EAR project, and select a preselected default set of= facets, called - a configuration, rather than manually select each facet you might want.= - 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 current 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 single 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. -
- - - = - +]> + = + + JBoss Server Manager Reference Guide + = + AnatolyFedosik + OlgaChikvina= + RobStrykerrob.stryker(a)jboss.com + SvetlanaMukhinasmukhina(a)exadel.com = + = + April 2008 + + 2007 + 2009 + JBoss, a division of Red Hat + + + Version: 2.0.0.GA + + + + + PDF version + + + + + = + = + = + = + + Quick Start with JBoss Server + + This chapter covers the basics of working with the JBoss Server. If you + already have installed JBoss server and runtime you can quickly learn = how to configure, start, + stop the server, to know deployment and archiving processes. How to in= stall runtimes and servers + read in the Runtimes and Servers in= the JBoss 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 server + behaviour with the help of a special toolbar in the JBoss Server View + where you could + start + it in a regular or debug mode, + stop + it or + restart + it and + 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 the JBoss Server Vie= w or right click the server name + and press Stop. + +
+ Stop JBoss Server + + + + + +
+ + When the server is stopped you will see + Stopped + state next to its name in the square brackets. + Learn more about the JBoss Server Vi= ew + here. +
+ +
+ + Project Archiving + + JBoss Tools comes with ou= r own archives tool. The Project Archives + plugin consists primarily of a view to set up each packaging configu= ration ( + Window > Show View > Other >= ; JBoss Tools > Project archives). + + Right clicking in the Project archiv= es view you can create War, + EJB War, EAR or JAR 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 <emphasis><property moreinfo=3D"none">Add and + Remove Projects</property></emphasis> 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 classpath + 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 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 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 > 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 well 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 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= 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 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 the + Add... + link nearby to bring up the wizard for creating a new = runtime (see the previous section). 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 installed ru= ntime 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 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. + = + We hope, this guide helped you to get started with the JBoss Tools serv= er manager. Besides, for additional information you are welcome on JBoss forum. +
+ +
+ + + + = + + + + + JBoss Developer Studio + Eclipse + Deploy + Deployment + JBoss + + + + JBoss AS Perspective + + This chapter tells how to manage installed JBoss Server via + JBoss AS perspective. + + The JBoss AS perspective = is similar to the Java + perspective, but it contains a few additional views= . Two of the additional + 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 + + The JBoss Server View= is built on Common Navigator Framework + allowing extensions and is using label decorators what makes t= he UI enough compact + without loosing the vital information. + + Let's have a look at the JBoss S= erver View and inspect + in detail all parts it consists of. +
+ The JBoss Server View + + + + + +
+ +
+ JBoss Server View Toolbar + In the right top corner of the JBoss Server View t= here is a + special toolbar which provides a quick access to starting = a server (in the debug mode, + run mode, or profile mode), restarting a server, stopping = a server and a possibility to publish to a + server. + +
+ The JBoss Server View Toolbar + + + + + +
+ + In order to debug your applications or EJB's that are de= ployed to the server, you + must start the server in debug mode. By starting the serve= r in debug mode, eclipse + will allow you to set breakpoints on code in your workspac= e and step through the + code. + + + Start the server in profil= ing 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 will republish any modules where it has= determined the workspace + is out of sync with the server. It will attempt to do an i= ncremental publish if it + turns out that the module in question is capable of doing = one. + = +
+ +
+ JBoss Server View Structure + The JBoss Server View displays all declared servers as well + as their current states (that is whether they are started = or stopped) and statuses + in the square brackets next to a server name. + +
+ The JBoss Server View + + + + + +
+ + The following table lists possible server statuses. + + + Server Publish Status + + <= /colspec> + + + + + + Status + + Description + + + + + + + Republish + + + + The status which allows you to see i= f changes are + awaiting + + + + + Publishing... + + + + The status which shows if changes ar= e being updated + + + + + Synchronized + + + + The status which allows you to see i= f changes are + in-sync + + + + +
+ + You can control a server behavior as well as adjust some= server preferences with + the help of the context menu commands. + +
+ Context Menu Commands + + + + + +
+ + All available context menu commands are described in the= following table. + + Server Properties through the Context Menu + + <= /colspec> + + + + + + Name + + + + Description + + + + + + + + New Server + + + The option allows to define a new se= rver + + + + + + Open + + + The option opens the Server editor + + + + + + Show in + + + This option gives an easy access to = the next views: Console, + Debug view, Server Log or MBean Explor= er + + + + + + 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 synchronizing the publish information between + the server and workspace + + + + + + Explore + + + This action uses the native OS file = explorer to browse the + deploy destination. Note: The option i= s also available for + deployed resources/projects (see the f= igure below). + + + + + + Add and Remove Projects + + + The option allows to publish a new p= roject to the server (if + its type is supported) + + + + + + Monitoring + + + Possibility to add ports to be monit= ored on the current + server + + + + + + Properties + + + Opens the window to adjust the curre= nt server + preferences + + + + + +
+ + Under the server element in the JBoss Server View, you can + see currently deployed to the server modules and some serv= er extensions which + provide the additional information on the server. + + The context menu for any module allows you to remove it = from the server, force a + full or incremental republish upon it. + +
+ Modules Action + + + + + +
+ +
+ Filesets + + The + Filesets + category in the JBoss Server View is intended + for files filtering. + + To add a new file filter, right-click the + Filesets + category and select + Create File Filter.The New File + Filter wizard should appear. + +
+ Creating a New File Filter + + + + + +
+ + The wizard asks you to enter the filter name and add= includes and excludes + patterns. The preview box underneath gives a list of f= iles matched to the + defined patterns. + +
+ New File Filter Wizard + + + + + +
+ + After the filter is created, you can observe it by e= xpanding the + Filesets + category in the JBoss Server View. + + It's possible now to edit files directly from the + Filesets + category. Double clicking on a file from <= emphasis> + Filesets + opens up the editor automatically or you c= an use the + Edit File + context menu command. + +
+ Direct Editing from the Filesets + + + + + +
+ + To delete a file filter (or just a file) from the + Filesets, right-click a file filter (or the + unnecessary file) and select the + Delete File Filter + + (Delete File) command. + +
+ Deleting the File from the Filesets + + + + + +
+
+ +
+ XML Configuration + The + XML Configuration + category allows you to quickly browse to d= escriptor files in your + server's deploy directory and check or change the valu= es. Basically, + XML Configuration + = includes XML XPaths where an xpath is a path used to access some + specific part of an xml document. + + + Note: + You are assumed to be familiar with XPath. If no= t, we highly suggested + that you look through an appropriate manual or tut= orial on the topic. + + + The + XML Configuration + category itself contains only a list of ca= tegories. + Ports + are provided by default and is filled with= many of the most commonly + used ports in the JBoss Se= rver. + +
+ XML Configuration + + + + + +
+ + + + + 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 XPat= h matches up with a + necessary property. With that in mind, let's look how = it works. If the + property you want to reach is the value of the name + attribute in the element <mbean>, then your + XPath Patten + should end with mbean = and your + Attribute Name + should be name like o= n the next figure. + + +... + + = + + + + The EJBDeployer responsible for ejb jar deployment = + ... + + + +]]> + +
+ XPath Preview + + + + + +
+ + + Tip: + Notice, when you type the fields autocomplete to= help you locate exactly + what xpath you're looking for. + + + Then, on the other hand, if your desired field is th= e text of an element + <description><= /code>, your + XPath Patten + should end with description and + Attribute Name + field should be left blank. When finished,= click + Preview + to see how many matches you have for that = particular XPath. + +
+ XPath Preview + + + + + +
+ +
+
+ +
+ Drag-n-Drop to JBoss Server View + + Starting from 2.0.0.CR2 version of JBoss AS Tools the + JBoss Server View supports drag-n-drop of deploy= able and + runnable projects/resources. + +
+ Dragging to the JBoss Server View + + + + + +
+ + With drag-n-drop the following actions can be performed:= + + + + dragging a project to a server will deploy it to= the server and run it by + showing the main page in a browser + + + + dragging an + .xhtml + file from + WebContent + will do the same and show the correspo= nding page in a + browser + + + + dragging a deployable resource (i.e. a datasourc= e ( + -ds.xml + ) file that has been made deployable) will simply deploy that + resource directly to the server + + + + In short, the feature does the same thing as if you used= the + Run On Server + option or + Add and Remove Projects + option in the context menu of the server. +
+ +
+ Server Log View + + You can monitor the current server behavior with the hel= p of the Server + Log. To open a server in the Server Log view you + should right-click on the server and follow to + Open in > Server Log. + + The + Server Log + shows relevant information to your server's st= artup, shutdown, + and publish processes. This allows you to keep an eye on w= hat's going on + (such as automatic incremental deployment if you have it e= nabled). + +
+ Event Log Actions + + + + + +
+ + The Server Log to= olbar contains several icons that perform + the following actions: + + + Server Log Toolbar Icons + + <= /colspec> + + + + + + Name + + + + Description + + + + + + + + Export Log + + + Possibility to export the log into a= text file + + + + + + Clear Log Viewer + + + The option clears the current server= log + + + + + + Delete Log + + + Click to delete the server log + + + + + + Open Log + + + Click to open the server log text fi= le + + + + + + Restore Log + + + Click to restore the server log + + + + + +
+ +
+ +
+ Server Editor + By double-clicking on any server, an editor window will = appear allowing you to + edit parts of that server. + +
+ Preferences Page for the Chosen Server + + + + + +
+ + + Tip: + On the fig= ure you can see that a username/password is available in the UI when + configuring the server. If you get a SecurityException= when trying to launch the + server, it is most likely because your server is prote= cted and hence you need to + fill the username/password fields with appropriate val= ues. + + + 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 where the + port settings are configurable. Click the + Configure... + link to bring up the wizard for adjusting the = settings for the + ports. + +
+ Server Ports Preferences + + + + + +
+ + Press + Edit XPath + button for the chosen port to configure its XP= ath's values. + +
+ XPath Pattern for a Server Port + + + + + +
+ + The settings related to + Publishing + , + Timeouts + or + Server Polling + can be also adjusted in the Server editor. + + Server e= ditor makes it also possible 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 for setting command line + arguments, classpaths and other things that are relevant t= o launching the + server. + +
+ Launch Configuration Properties + + + + + +
+ + Look up here to find parameters= which can be specified for JBoss + Server. + + + <diffmk:wrapper diffmk:chan= ge=3D"added">Note:</diffmk:wrapper> + Please note, that the Launch Configurations for JBoss Servers a= re enough + strict in enforcing the configured values in the serve= r in order to avoid + inconsistencies between server's and their configured = runtime. + + For example, if you change the launch configuration program arg= uments to + "-c myConfig" but do not change the + targeted runtime configuration, then your program argu= ments will be ignored. The + server runtime "wins" so to speak. This ensures consis= tency + and if you change the location of the runtime, your la= unch configurations will + automatically pick that up. + + Values are not controlled by the server and its runtime setup w= ill be passed + on unaltered. + + + Until 3.0.0.GA release of JBoss = Tools, = the servers classpath was readonly, but that caused + problems for users wanting to add their own jars in the st= artup classpath. That is + relevant if you need to patch the server, add a custom cha= rset or other tweaks that + require early access to the classpath. + + Now all servers have a custom 'server runtime classpath + container', which is there by default and point to the def= ault jars in + JBoss. You can now adjust the classpath. Then just make su= re this container is there + if you want the classpath to be picked up. + +
+ <diffmk:wrapper diffmk:chan= ge=3D"added">Server Classpaths</diffmk:wrapper> + + + + + +
+ + If for some reason you have a launch configuration without this con= tainer, + Restore + Default Entries= should add it properly. Also, + Restore + Default Entries will also remove any + extra entries you added yourself. +
+ +
+ 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. + + Note: + Those who use ANT will appreciate how the Project Archiv= es Ant task is now + improved: it supports variables and gives more informative= error/logging messages + when something goes wrong. + + + But JBoss Tools come = with our own Archives tool with a bit easier + and less-verbose XML and a handy user interface. The Project A= rchives plugin consists + primarily of a view, that is Proje= ct 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. As you can = see on the image + above a project can contain more than one archive. Interna= l archives and filesets + can be directly inside of an archive, or in some sub-folde= r 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 you open the Project ar= chives view for the first time, + it asks you to select the project for what you want to cre= ate an archive. + +
+ Archives View + + + + + +
+ + When creating a new archive for selected project, you ha= ve some different options + at your disposal. You need 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 archi= ve 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 WAR Wizard + + + + + +
+ + The page is pretty simple. First it asks to set the name= of your new archive and a + destination. + + The destination of an archive can be anywhere on the fil= e system, anywhere in the + workspace, inside some other archive, or inside a folder d= eclared inside an archive. + Select the necessary checkbox (either + workspace + or + file system + ) for marking the destination as related to eit= her workspace or file + system. You can browse to workspace or filesystem destinat= ions 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. + +
+ Selecting the destination in the workspace + + + + + +
+ + Also in the wizard for creating a new archive you can ch= oose whether an archive to + be compressed or exploded into a folder (without compressi= on). You need just select + proper chechbox in the + Archive type + section. + If a build or incremental update fails Project Archives = will show an error + dialog: +
+ Selecting the destination in the workspace + + + + + +
+ Click in + Details + to see detailed information about what caused = the error. + + In the Package Explorer you can observe the created + archive. +
+ The Archive in the Package Explorer + + + + + +
+ + If you use the exploded type of archiving, instead of a = single file archive the + result put into a folder is displayed in the Package + Explorer. +
+ The Exploded Archive in the Package Explorer + + + + + +
+ +
+ 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. + + You can cr= eate a Fileset with flattening or without it. Look at the difference + on the figure below. + +
+ <diffmk:wrapper diffmk:change=3D"changed">The F= ileSet with flattening and without it</diffmk:wrapper> + + + + + +
+ +
+
+ +
+ 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 publ= ish to a declared + server + + + + + + Edit publish settings + + + + Gives possibility to edit an archive= publish settings + + + + + +
+
+ +
+ 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 server(s) that you want, and finish. If yo= u 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. +
+ + +
+ + + + + = + + 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 specific runtime, + representing a server's library location. It will also provide you the = ability to add + this project to an EAR project, and select a preselected default set of= facets, called + a configuration, rather than manually select each facet you might want.= + 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 current 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 single 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. +
+ + + = + Modified: trunk/documentation/guides/Exadel-migration/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 --- trunk/documentation/guides/Exadel-migration/en/master_output.xml 2009-0= 5-08 12:20:47 UTC (rev 15137) +++ trunk/documentation/guides/Exadel-migration/en/master_output.xml 2009-0= 5-08 12:36:11 UTC (rev 15138) @@ -20,408 +20,408 @@ = = = = -]> - - Exadel Studio Migration Guide - = - April 2008 - - 2007 - 2009 - JBoss, a division of Red Hat - - -Version: 2.0.1.GA - - - - - - PDF version - - - - - = - - = - - - = - - - JBoss Developer Studio - JBDS - Exadel Studio Pro - - - - Introduction - This document is intended= to help you to migrate an existing Exadel JSF or Struts projects - into JBoss Developer Studio= . Preferences can be e= xported from Eclipse 3.2.0 - (3.2.1 or 3.2.2) and imported in Eclipse 3.4.x by the standard Eclipse m= eans. -
- Other relevant resources on the topic - All JBoss Developer Stud= io/JBoss Tools release documentation you can find athttp://docs.jboss.org/tools in the corresponding releas= e directory. - The latest documentation= builds are available at = http://download.jboss.org/jbosstools/nightly-docs.= - -
- - - - - - - - - JBoss Developer Studio - JBDS - Exadel Studio Pro - - - = - Migrate workspace - You will not be able to run projects in JBoss Developer Studio - using Exadel Studio workspace. In= this case, project capabilities and settings specified in Exadel Studio wi= ll be lost. The simplest way to avoid this, is to copy your projects in JBoss Developer Studio workspace and ma= ke an import as it is described in the following chapters. - - - - - - - - JBoss Developer Studio - JBDS - Exadel Studio Pro - Migration - - - = - Migration of JSF and Struts Projects - In this chapter you can find concise description of migration of JS= F and Struts Projects. -
= - JSF - JBoss Developer Studio includes an Import JSF Project Wizard that radically simplifies the process of = bringing your existing JSF applications - into your JBoss Developer Studio workspace as JSF projects. You just ne= ed to follow these four steps: - - Select File > = Import... from the menu bar, and then select Other > JSF Project = from the Import dialog box that appears. - - = -
- Selecting the Import Menu Item - = - - - - -
- = -
- Selecting the Import JSF Project Wizard - = - - - - -
- = - - In the first screen of the wizard, select the Change... button next to= the web.xml Location field. Browse to the location of the web.xml file for the applicatio= n you = - want to import as a JSF project= . Once you select it, you'll be returned to the dialog box to see a project= name derived from the web.xml file you selected. = - You can edit this project name, if you wish. - - = -
- Selecting the Web.xml File in the Project Location Screen - = - - - - -
- = - - In the Project Fo= lders screen, you can configure the rest of your proj= ect. Afterwards click on the Finish button. - - On this step JBoss Developer Studio will try to determine your pro= ject - structure and set the values for: Web Root, Sour= ce Folder, Clas= ses Folder, Lib= Folder. If your project has a custom structure, some= values might not be = - set. If this is the case, you can manually set those values by clickin= g the Change...= button. - After dealing with these settings, you have to work through a fe= w more configuration settings. These settings deal primarily with how the p= roject will be deployed within JBoss Developer Studio. - First, if the project you are importing is not already a JSF proje= ct, select the Add Libraries check box to add all the JSF-related libraries to your projec= t. - Then, you may select the JavaServer Faces implementation (Environment) and Servlet Version. - The Context Path<= /emphasis> is the name under which the application will be deployed. - The Runtime value tells Eclipse where to find Web libraries in order to build the= project. It is not possible to finish the importing of a project without s= electing a Runtime. If you don't have any choices displayed for this, selec= t New... to add= a new Runtime. - Finally, Target Server sets the server to deploy the application under. The Targe= t Server corresponds to the Runtime value selected above. If you don't want= to deploy the application, uncheck this value. - = - = -
- The Project Folders Screen - = - - - - -
- = - - Once the project is imported, it will appear in the Pac= kage Explorer view. - - = -
- Imported Project in the Package Explorer View - = - - - - -
- = -
-
- Struts - - Select File > = Import... from the menu bar, and then select Other > Struts Project from the Import dialog box that appears. - - = -
- Selecting the Import Menu Item - = - - - - -
- = -
- Selecting the Import Struts Project Wizard - = - - - - -
- = - - In the Project Location screen of the wizard, select th= e Change... but= ton next to the web.xml Location field. Browse the location of the web.xml file for the ap= plication you = - want to import as a Struts project. Once you select it, you'll be returned to the dialog box to see a proj= ect name derived from the web.xml file you selected. = - You can edit this project name, if you wish. - - = -
- The Project Location Screen - = - - - - -
- = - - In the next screen, JBoss Developer Studio will try to = determine your project structure. The upper pane shows the modules in this = project. = - The lower pane allows you to edit the details of the select module. If= the project structure is non-standard, some values might be left blank. - You can edit any values by hand or by using the Change... button. - - = -
- The Project Modules Screen - = - - - - -
- = - - In the Project Fo= lders screen, you can configure the rest of your proj= ect. Afterwards click on the Finish button. - - - On this step JBoss Developer Studio will try to determine your pro= ject structure and set the values for: Classes Folder, Lib Folder, and Ant Build File. If your project has a custom stru= cture, some values might not be set. If this is the case, you can manually = set those values by clicking Change. - After dealing with these settings, you have to work through a fe= w more configuration settings. These settings deal primarily with how the p= roject will be deployed within JBoss Developer Studio. - First, if the project you are importing is not already a Struts pr= oject, select the Add Libraries check box to add all the Struts-related libraries to your = project. - Then, you may select the Struts Environment and Servlet Version. - The Context Path<= /emphasis> is the name under which the application will be deployed. - The Runtime value tells Eclipse where to find Web libraries in order to build the= project. It is not possible to finish the importing of a project without s= electing a Runtime. If you don't have any choices displayed for this, selec= t New... to add= a new Runtime. - Finally, Target Server sets the server to deploy the application under. The Targe= t Server corresponds to the Runtime value selected above. If you don't want= to deploy the application, uncheck this value. - - = -
- The Project Folders Screen - = - - - - -
- = - - Once the project is imported, it will appear in the Pac= kage Explorer view. - - = -
- Imported Project in the Package Explorer View - = - - - - -
- -
- - - - - - - - - JBoss Developer Studio - - JBDS - - Exadel Studio Pro - - - - Migrate JSF and Struts projects from *.war file - After you familiarized oneself with last chapter you can read this= chapter. It looks as if you read in last chapter. -
- JSF - - - - Select File > Impor= t... from the menu bar, and then select - Other > JSF Project From = *.war from the Import dialog box that - appears. - - - -
- Selecting the Import Menu Item - - - - - - -
- -
- Selecting the JSF Project From *.war Import Wizard - - - - - - -
- - - - In the wizard screen, select the Change... button next to - the *.war Location field. Browse to the location of the *.war file for - the application you want to import as a JSF project. Once you sele= ct - it, you'll be returned to the dialog box to see a project name - derived from the *.war file you selected. You can edit this name, = if - you wish. - - Uncheck the Use Defaul= t Path check box if you want to import - your project outside of the Eclipse workspace. In this case, you w= ould - use Change... button next to the Location= field to choose a - location. - - Context Path is the name under which the application will be - deployed. - - The Runtime= value tells Eclipse where to find Web libraries in - order to build the project. It is not possible to finish project - import without selecting Runtime. If you don't have any options - here, select New... to add a new Runtime. - - Finally, Target Server= sets the server to deploy the application - under. The Target Server corresponds to the Runtime value selected - above. If you don't want to deploy the application, uncheck this - value. - - - -
- The JSF Project From *.war Import Wizard - - - - - - -
- - - - Click on the Finish button. - - -
- -
- Struts - - - - Select File > Impor= t... from the menu bar, and then select - Other > Struts Project Fr= om *.war from the Import dialog box that - appears. - - - -
- Selecting the Import Menu Item - - - - - - -
- -
- Selecting the Struts Project From *.war Import Wizard - - - - - -
- - - - Follow the same steps as with the JSF Project From *.war import - wizard. - - - -
- The Struts Project From *.war Import Wizard - - - - - - -
- - - - Click on the Finish button. - - - The migration process is completed - = - = If there's anything we didn't cover or you can't figure - out, please feel free to visit our JBoss Developer Stud= io Users Forum or JBoss Tools Users Forum to ask questions. There we are also look= ing for - your suggestions and comments. -
- = - = - - = - +]> + + Exadel Studio Migration Guide + = + April 2008 + + 2007 + 2009 + JBoss, a division of Red Hat + + +Version: 2.0.1.GA + + + + + + PDF version + + + + + = + + = + + + = + + + JBoss Developer Studio + JBDS + Exadel Studio Pro + + + + Introduction + This document is intended= to help you to migrate an existing Exadel JSF or Struts projects + into JBoss Developer Studio= . Preferences can be e= xported from Eclipse 3.2.0 + (3.2.1 or 3.2.2) and imported in Eclipse 3.4.x by the standard Eclipse m= eans. +
+ Other relevant resources on the topic + All JBoss Developer Stud= io/JBoss Tools release documentation you can find athttp://docs.jboss.org/tools in the corresponding releas= e directory. + The latest documentation= builds are available at = http://download.jboss.org/jbosstools/nightly-docs.= + +
+ + + + + + + + + JBoss Developer Studio + JBDS + Exadel Studio Pro + + + = + Migrate workspace + You will not be able to run projects in JBoss Developer Studio + using Exadel Studio workspace. In= this case, project capabilities and settings specified in Exadel Studio wi= ll be lost. The simplest way to avoid this, is to copy your projects in JBoss Developer Studio workspace and ma= ke an import as it is described in the following chapters. + + + + + + + + JBoss Developer Studio + JBDS + Exadel Studio Pro + Migration + + + = + Migration of JSF and Struts Projects + In this chapter you can find concise description of migration of JS= F and Struts Projects. +
= + JSF + JBoss Developer Studio includes an Import JSF Project Wizard that radically simplifies the process of = bringing your existing JSF applications + into your JBoss Developer Studio workspace as JSF projects. You just ne= ed to follow these four steps: + + Select File > = Import... from the menu bar, and then select Other > JSF Project = from the Import dialog box that appears. + + = +
+ Selecting the Import Menu Item + = + + + + +
+ = +
+ Selecting the Import JSF Project Wizard + = + + + + +
+ = + + In the first screen of the wizard, select the Change... button next to= the web.xml Location field. Browse to the location of the web.xml file for the applicatio= n you = + want to import as a JSF project= . Once you select it, you'll be returned to the dialog box to see a project= name derived from the web.xml file you selected. = + You can edit this project name, if you wish. + + = +
+ Selecting the Web.xml File in the Project Location Screen + = + + + + +
+ = + + In the Project Fo= lders screen, you can configure the rest of your proj= ect. Afterwards click on the Finish button. + + On this step JBoss Developer Studio will try to determine your pro= ject + structure and set the values for: Web Root, Sour= ce Folder, Clas= ses Folder, Lib= Folder. If your project has a custom structure, some= values might not be = + set. If this is the case, you can manually set those values by clickin= g the Change...= button. + After dealing with these settings, you have to work through a fe= w more configuration settings. These settings deal primarily with how the p= roject will be deployed within JBoss Developer Studio. + First, if the project you are importing is not already a JSF proje= ct, select the Add Libraries check box to add all the JSF-related libraries to your projec= t. + Then, you may select the JavaServer Faces implementation (Environment) and Servlet Version. + The Context Path<= /emphasis> is the name under which the application will be deployed. + The Runtime value tells Eclipse where to find Web libraries in order to build the= project. It is not possible to finish the importing of a project without s= electing a Runtime. If you don't have any choices displayed for this, selec= t New... to add= a new Runtime. + Finally, Target Server sets the server to deploy the application under. The Targe= t Server corresponds to the Runtime value selected above. If you don't want= to deploy the application, uncheck this value. + = + = +
+ The Project Folders Screen + = + + + + +
+ = + + Once the project is imported, it will appear in the Pac= kage Explorer view. + + = +
+ Imported Project in the Package Explorer View + = + + + + +
+ = +
+
+ Struts + + Select File > = Import... from the menu bar, and then select Other > Struts Project from the Import dialog box that appears. + + = +
+ Selecting the Import Menu Item + = + + + + +
+ = +
+ Selecting the Import Struts Project Wizard + = + + + + +
+ = + + In the Project Location screen of the wizard, select th= e Change... but= ton next to the web.xml Location field. Browse the location of the web.xml file for the ap= plication you = + want to import as a Struts project. Once you select it, you'll be returned to the dialog box to see a proj= ect name derived from the web.xml file you selected. = + You can edit this project name, if you wish. + + = +
+ The Project Location Screen + = + + + + +
+ = + + In the next screen, JBoss Developer Studio will try to = determine your project structure. The upper pane shows the modules in this = project. = + The lower pane allows you to edit the details of the select module. If= the project structure is non-standard, some values might be left blank. + You can edit any values by hand or by using the Change... button. + + = +
+ The Project Modules Screen + = + + + + +
+ = + + In the Project Fo= lders screen, you can configure the rest of your proj= ect. Afterwards click on the Finish button. + + + On this step JBoss Developer Studio will try to determine your pro= ject structure and set the values for: Classes Folder, Lib Folder, and Ant Build File. If your project has a custom stru= cture, some values might not be set. If this is the case, you can manually = set those values by clicking Change. + After dealing with these settings, you have to work through a fe= w more configuration settings. These settings deal primarily with how the p= roject will be deployed within JBoss Developer Studio. + First, if the project you are importing is not already a Struts pr= oject, select the Add Libraries check box to add all the Struts-related libraries to your = project. + Then, you may select the Struts Environment and Servlet Version. + The Context Path<= /emphasis> is the name under which the application will be deployed. + The Runtime value tells Eclipse where to find Web libraries in order to build the= project. It is not possible to finish the importing of a project without s= electing a Runtime. If you don't have any choices displayed for this, selec= t New... to add= a new Runtime. + Finally, Target Server sets the server to deploy the application under. The Targe= t Server corresponds to the Runtime value selected above. If you don't want= to deploy the application, uncheck this value. + + = +
+ The Project Folders Screen + = + + + + +
+ = + + Once the project is imported, it will appear in the Pac= kage Explorer view. + + = +
+ Imported Project in the Package Explorer View + = + + + + +
+ +
+ + + + + + + + + JBoss Developer Studio + + JBDS + + Exadel Studio Pro + + + + Migrate JSF and Struts projects from *.war file + After you familiarized oneself with last chapter you can read this= chapter. It looks as if you read in last chapter. +
+ JSF + + + + Select File > Impor= t... from the menu bar, and then select + Other > JSF Project From = *.war from the Import dialog box that + appears. + + + +
+ Selecting the Import Menu Item + + + + + + +
+ +
+ Selecting the JSF Project From *.war Import Wizard + + + + + + +
+ + + + In the wizard screen, select the Change... button next to + the *.war Location field. Browse to the location of the *.war file for + the application you want to import as a JSF project. Once you sele= ct + it, you'll be returned to the dialog box to see a project name + derived from the *.war file you selected. You can edit this name, = if + you wish. + + Uncheck the Use Defaul= t Path check box if you want to import + your project outside of the Eclipse workspace. In this case, you w= ould + use Change... button next to the Location= field to choose a + location. + + Context Path is the name under which the application will be + deployed. + + The Runtime= value tells Eclipse where to find Web libraries in + order to build the project. It is not possible to finish project + import without selecting Runtime. If you don't have any options + here, select New... to add a new Runtime. + + Finally, Target Server= sets the server to deploy the application + under. The Target Server corresponds to the Runtime value selected + above. If you don't want to deploy the application, uncheck this + value. + + + +
+ The JSF Project From *.war Import Wizard + + + + + + +
+ + + + Click on the Finish button. + + +
+ +
+ Struts + + + + Select File > Impor= t... from the menu bar, and then select + Other > Struts Project Fr= om *.war from the Import dialog box that + appears. + + + +
+ Selecting the Import Menu Item + + + + + + +
+ +
+ Selecting the Struts Project From *.war Import Wizard + + + + + +
+ + + + Follow the same steps as with the JSF Project From *.war import + wizard. + + + +
+ The Struts Project From *.war Import Wizard + + + + + + +
+ + + + Click on the Finish button. + + + The migration process is completed + = + = If there's anything we didn't cover or you can't figure + out, please feel free to visit our JBoss Develop= er Studio Users Forum or JBoss Tools Users Forum to ask questions. There w= e are also looking for + your suggestions and comments. +
+ = + = + + = + Modified: trunk/documentation/guides/GettingStartedGuide/pom.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/documentation/guides/GettingStartedGuide/pom.xml 2009-05-08 12:20= :47 UTC (rev 15137) +++ trunk/documentation/guides/GettingStartedGuide/pom.xml 2009-05-08 12:36= :11 UTC (rev 15138) @@ -94,11 +94,11 @@ = - + html ${xsl-chunked} Modified: trunk/drools/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 --- trunk/drools/docs/reference/en/master_output.xml 2009-05-08 12:20:47 UT= C (rev 15137) +++ trunk/drools/docs/reference/en/master_output.xml 2009-05-08 12:36:11 UT= C (rev 15138) @@ -21,752 +21,752 @@ = = -]> - = - - Drools Tools Reference Guide - - OlgaChikvina= = - = - April 2008 - - 2007 - 2009 - JBoss, a division of Red Hat - - - Version: 5.0.0.CR1 - - - - - PDF version - - - - - = - = - = - = - - Introduction - -
- What is Drools? - - Drools is a business = rule management system (BRMS) with a forward - chaining inference based rules engine, more correctly known as= a production rule system, - using an enhanced implementation of the Rete algorithm. - - In this guide we = are going to get you familiar with Drools Eclipse plugin which - provides development tools for creating, executing and debuggi= ng Drools processes and - rules from within Eclipse. - - - Note: - It is assumed that you has some familiarity with rule en= gines and Drools in - particular. If no, we suggest that you look carefully thro= ugh the Drools Documentation. - - - Drools Tools come bun= dled with JBoss Tools - set of Eclipse plugins. How to install JBoss Tools you c= an find in - the Getting Started Guide. -
- -
- Drools Tools Key Features - - The following table lists all valuable features of the Drools - Tools. - - Key Functionality of Drools Tools - - - - - - - - - Feature - Benefit - Chapter - - - - - - - - Wizard for creating a new Drools Project= - - - The wizard allows to create a sample pro= ject to easy get started - with Drools - - - Creati= ng a Sample Drools - Project - - - - - - Wizards for creation new Drools resource= s - - - A set of wizards are provided with the D= rools Eclipse tools to - quickly create a new Rule resource, a new = Domain Specific language, - Decision Table and Business rule - - - Creating a New= Rule - - - - - - - The Rule editor - - - An editor that is aware of DRL syntax an= d provides content - assistance and synchronizing with the Outl= ine view - - - The Rule= Editor - - - - - - The Domain Specific Language editor - - - The editor allows to create and manage m= appings from users - language to the rule language - - - - - - - - - The Guided editor - - - This guided editor for rules allows you = to build rules in a GUI - driven fashion based on your object model<= /para> - - - - - - - - - The Rule Flow graphical editor - - - The editor is meant for editing visual g= raphs which represent a - process (a rule flow) - - - - - - - - -
-
- -
- Other relevant resources on the topic - - - - Drools on JBoss.org - - - - - JBoss Tools= Home Page - - - - - - The latest - JBossTools/JBDS documentation builds - - - - - All JBoss Tools/JBDS documentation you can find on the - = documentation release - page. - - - -
- - - = - - - - JBoss Tools - Drools Tools - - - - Creating a New Drools Project - - In this chapter we are going to show you how to setup an executa= ble sample Drools project - to start using rules immediately. - - - -
- Creating a Sample Drools Project - - First, we suggest that you use D= rools perspective which is aimed - at work with Drools specific resources. - - To create a new Drools project follow to - File > New > Drools Proj= ect. This will open - New Drools Project wizard like on the figure below. - - On the first page type the project name and click - Next. - -
- Creating a New Drools Project - - - - - -
- - Next you have a choice to add some default artifacts to it l= ike sample rules, decision - tables or ruleflows and Java classes for them. Let's select fi= rst two check - boxes and press - Next. - -
- Selecting Drools Project Elements - - - - - -
- - Next page asks you to specify a Drools runtime. If you have = not yet set it up, you - should do this now by clicking the - Configure Workspace Settings - link. - -
- Configuring Drools Runtime - - - - - -
- - You should see the Preferences window= where you can configure the - workspace settings for Drools runtimes. To create a new runtim= e, press the - Add - button. The appeared dialog prompts you to enter a - name for a new runtime and a path to the Drools runtime on you= r file system. - - - Note: - A Drools runtime is a collection of jars on your file sy= stem that represent one - specific release of the Drools project jars. While creatin= g a new runtime, you must - either point to the release of your choice, or you can sim= ply create a new runtime - on your file system from the jars included in the Drools E= clipse plugin. - - -
- Adding a New Drools Runtime - - - - - -
- = - Let's simply create a new Drools 5 runtime from the jars emb= edded in the - Drools Eclipse plugin. Thus, you should press - Create a new Drools 5 runtime<= /property> - button and select the folder where you want this r= untime to be created and - hit - OK. - - You will see the newly created runtime show up in your list = of Drools runtimes. Check - it and press - OK. - -
- Selecting a Drools Runtime - - - - - -
- - Now press - Finish - to complete the project creation. - -
- Completing the Drools Project Creation - - - - - -
- - This will setup a basic structure, classpath and sample rule= s and test case to get you - started. -
- - -
- Drools Project Structure Overview - - Now let's look at the structure of the organized project. In= the - Package Explorer yo= u should see the following: - -
- Drools Project in the Package Explorer - - - - - -
- - The newly created project contains an example rule file - Sample.drl - in the - src/main/rules - directory and an example java file - DroolsTest.java - that can be used to execute the rules in a Drools = engine in the folder - src/main/java - , in the - com.sample - package. All the others jar's that are necessary d= uring execution - are also added to the classpath in a custom classpath containe= r called Drools - Library. - - - Tip: - Rules do not have to be kept in Java projects at all, th= is is just a convenience - for people who are already using eclipse as their Java IDE= . - - -
- -
- Creating a New Rule - - Now we are going to add a new Rule resource to the project.<= /para> - - You can either create an empty text - .drl - file or make use of the special New Rule Resource - wizard to do it. - - To open the wizard follow to - File > New > Rule Resour= ce - or use the menu with the JBoss Drools icon on the = toolbar. - -
- Opening the New Rule Resource Wizard - - - - - -
- - On the wizard page first select - /rules - as a top level directory to store your rules and t= ype the rule name. Next - it's mandatory to specify the rule package name. It defines a = namespace that - groups rules together. - -
- New Rule Resource Wizard - - - - - -
- - As a result the wizard generates a rule skeleton to get you = started. - -
- New Rule - - - - - -
- -
- - - - = - - - - JBoss Tools - Drools Tools - - - - Debugging rules - = - This chapter describes how to debug rules during the execution of y= our Drools application. - -
- Creating Breakpoints - = - At first, we'll focus on how to add - breakpoints in the consequences of your rules. - = - Whenever such a breakpoint is uncounted - during the execution of the rules, the execution is halted. It's possib= le then inspect the - variables known at that point and use any of the default debugging acti= ons to decide what - should happen next (step over, continue, etc). To inspect - the content of the working memory and agenda the Debug views can be use= d. - - You can add/remove rule breakpoints in - .drl - files in two ways, similar to adding breakpoints to Java fi= les: - - - - Double-click the ruler in the Rule e= ditor at the line - where you want to add a breakpoint. - - Tip: - Note that rule breakpoints can only be created in the consequen= ce of a - rule. Double-clicking on a line where no breakpoint is allowed will = do - nothing. - - A breakpoint can be removed by double-clicking the ruler once mo= re. - - - - Right-click the ruler. Select - Toggle Breakpoint - action in the appeared popup menu. Clicking the action wi= ll add a - breakpoint at the selected line or remove it if there is one already.= - - - -
- Adding Breakpoints - - - - - -
- - The Debug perspective conta= ins a Breakpoints - view which can be used to see all defined breakpoints, get = their - properties, enable/disable or remove them, etc. You can switch to it by= navigating to - Window > Perspective > Others > D= ebug. -
- -
- Debugging - - Drools breakpoints are only enabled if you debug your application = as a Drools - Application. To do this you should perform one of the actions: - - - - Select the main class of your application. Right click it and se= lect - Debug As > Drools Application. - - -
- Debugging Drools Application - - - - - -
- - - - Alternatively, you can also go to - Debug As > Debug Configuration - to open a new dialog for creating, managing and running d= ebug - configurations. - - Select the - Drools Application - item in the left tree and click the - New launch configuration - button (leftmost icon in the toolbar above the tree). Thi= s will - create a new configuration and already fill in some of the properties= (like the - Project and Main class) based on main class you selected in the begin= ning. All - properties shown here are the same as any standard Java program. - - - -
- New Debug Configuration - - - - - -
- - - Tip: - Remember to change the name of your debug configuration to someth= ing meaningful. - - = - Next - click the - Debug - button on the bottom to start debugging your application. <= /para> - - After enabling the debugging, the application starts executing and= will halt if - any breakpoint is encountered. This can be a Drools rule breakpoint, or= any other - standard Java breakpoint. Whenever a Drools rule breakpoint is encounte= red, the - corresponding - .drl file is opened = and the active line is highlighted. The Variables view - also contains all rule parameters and their value. You can then use the= default Java - debug actions to decide what to do next (resume, terminate, step over, = etc.). The debug - views can also be used to determine the contents of the working memory = and agenda at - that time as well (you don't have to select a working memory now, the c= urrent executing - working memory is automatically shown). - = - = -
- - - = - - - - JBoss Tools - Drools Tools - - - - Editors - -
- The Rule Editor - - The Rule editor works= on files that have a - .drl - (or - .rule - in the case of spreading rules across multiple rul= e files) extension. - -
- New Rule - - - - - -
- - The editor follows the pattern of a normal text editor in ec= lipse, with all the normal - features of a text editor: - - - - - Content = Assist - - - - - - Code Foldi= ng - - - - - - - - Synch= ronization with Outline - View - - - - -
- Content Assist - - While working in the Rule ed= itor you can get a content - assistance the usual way by pressing - Ctrl + Space. - - Content Assist shows all possible keywords for the curre= nt cursor position. - -
- Content Assist Demonstration - - - - - -
- - Content Assist inside of the - Message - suggests all available fields. - -
- Content Assist Demonstration - - - - - -
- -
- -
- Code Folding - - Code folding is also available in the Rule editor. To - hide/show sections of the file use the icons with minus/pl= us on the left vertical - line of the editor. - -
- Code Folding - - - - - -
- -
- - - -
- Synchronization with Outline View - - The Rule editor w= orks in synchronization with the - Outline view wh= ich shows the structure of the rules, - imports in the file and also globals and functions if the = file has them. - -
- Synchronization with Outline View - - - - - -
- - The view is updated on save. It provides a quick way of = navigating around rules by - names in a file which may have hundreds of rules. The item= s are sorted - alphabetically by default. -
- -
- The Rete Tree View - - The Rete Tree view shows you the current Rete Network for - your - .drl - file. Just click on the - Rete Tree tab - at the bottom of the Rule editor. - -
- Rete Tree - - - - - -
- - Afterwards you can generate the current Rete Network vis= ualization. You can push - and pull the nodes to arrange your optimal network overvie= w. - If you got hundreds of nodes, select some of them with a= frame. Then you can pull - groups of them. - -
- Selecting the nodes in the Rete Tree with Frame</ti= tle> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/editors/editors7.png"= ></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>You can zoom in and out the Rete tree in case not all no= des are shown in the - current view. For this use the combo box or "+" and "-" ic= ons on the toolbar.</para> - - <figure float=3D"0"> - <title>Rete Tree Zooming - - - - - -
- - - Note: - - The Rete Tree view works only in Drools Rule Projects, - where the Drools Builder is set in the project propert= ies. - - We hope, this guide helped you to get started with the JBoss BPMN C= onvert module. Besides, for additional information you are welcome on JBoss forum. -
- = -
- = - - - = - = - +]> + = + + Drools Tools Reference Guide + + OlgaChikvina= = + = + April 2008 + + 2007 + 2009 + JBoss, a division of Red Hat + + + Version: 5.0.0.CR1 + + + + + PDF version + + + + + = + = + = + = + + Introduction + +
+ What is Drools? + + Drools is a business = rule management system (BRMS) with a forward + chaining inference based rules engine, more correctly known as= a production rule system, + using an enhanced implementation of the Rete algorithm. + + In this guide we = are going to get you familiar with Drools Eclipse plugin which + provides development tools for creating, executing and debuggi= ng Drools processes and + rules from within Eclipse. + + + Note: + It is assumed that you has some familiarity with rule en= gines and Drools in + particular. If no, we suggest that you look carefully thro= ugh the Drools Documentation. + + + Drools Tools come bun= dled with JBoss Tools + set of Eclipse plugins. How to install JBoss Tools you c= an find in + the Getting Started Guide. +
+ +
+ Drools Tools Key Features + + The following table lists all valuable features of the Drools + Tools. + + Key Functionality of Drools Tools + + + + + + + + + Feature + Benefit + Chapter + + + + + + + + Wizard for creating a new Drools Project= + + + The wizard allows to create a sample pro= ject to easy get started + with Drools + + + Creati= ng a Sample Drools + Project + + + + + + Wizards for creation new Drools resource= s + + + A set of wizards are provided with the D= rools Eclipse tools to + quickly create a new Rule resource, a new = Domain Specific language, + Decision Table and Business rule + + + Creating a New= Rule + + + + + + + The Rule editor + + + An editor that is aware of DRL syntax an= d provides content + assistance and synchronizing with the Outl= ine view + + + The Rule= Editor + + + + + + The Domain Specific Language editor + + + The editor allows to create and manage m= appings from users + language to the rule language + + + + + + + + + The Guided editor + + + This guided editor for rules allows you = to build rules in a GUI + driven fashion based on your object model<= /para> + + + + + + + + + The Rule Flow graphical editor + + + The editor is meant for editing visual g= raphs which represent a + process (a rule flow) + + + + + + + + +
+
+ +
+ Other relevant resources on the topic + + + + Drools on JBoss.org + + + + + JBoss Tools= Home Page + + + + + + The latest + JBossTools/JBDS documentation builds + + + + + All JBoss Tools/JBDS documentation you can find on the + = documentation release + page. + + + +
+ + + = + + + + JBoss Tools + Drools Tools + + + + Creating a New Drools Project + + In this chapter we are going to show you how to setup an executa= ble sample Drools project + to start using rules immediately. + + + +
+ Creating a Sample Drools Project + + First, we suggest that you use D= rools perspective which is aimed + at work with Drools specific resources. + + To create a new Drools project follow to + File > New > Drools Proj= ect. This will open + New Drools Project wizard like on the figure below. + + On the first page type the project name and click + Next. + +
+ Creating a New Drools Project + + + + + +
+ + Next you have a choice to add some default artifacts to it l= ike sample rules, decision + tables or ruleflows and Java classes for them. Let's select fi= rst two check + boxes and press + Next. + +
+ Selecting Drools Project Elements + + + + + +
+ + Next page asks you to specify a Drools runtime. If you have = not yet set it up, you + should do this now by clicking the + Configure Workspace Settings + link. + +
+ Configuring Drools Runtime + + + + + +
+ + You should see the Preferences window= where you can configure the + workspace settings for Drools runtimes. To create a new runtim= e, press the + Add + button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on you= r file system. + + + Note: + A Drools runtime is a collection of jars on your file sy= stem that represent one + specific release of the Drools project jars. While creatin= g a new runtime, you must + either point to the release of your choice, or you can sim= ply create a new runtime + on your file system from the jars included in the Drools E= clipse plugin. + + +
+ Adding a New Drools Runtime + + + + + +
+ = + Let's simply create a new Drools 5 runtime from the jars emb= edded in the + Drools Eclipse plugin. Thus, you should press + Create a new Drools 5 runtime<= /property> + button and select the folder where you want this r= untime to be created and + hit + OK. + + You will see the newly created runtime show up in your list = of Drools runtimes. Check + it and press + OK. + +
+ Selecting a Drools Runtime + + + + + +
+ + Now press + Finish + to complete the project creation. + +
+ Completing the Drools Project Creation + + + + + +
+ + This will setup a basic structure, classpath and sample rule= s and test case to get you + started. +
+ + +
+ Drools Project Structure Overview + + Now let's look at the structure of the organized project. In= the + Package Explorer yo= u should see the following: + +
+ Drools Project in the Package Explorer + + + + + +
+ + The newly created project contains an example rule file + Sample.drl + in the + src/main/rules + directory and an example java file + DroolsTest.java + that can be used to execute the rules in a Drools = engine in the folder + src/main/java + , in the + com.sample + package. All the others jar's that are necessary d= uring execution + are also added to the classpath in a custom classpath containe= r called Drools + Library. + + + Tip: + Rules do not have to be kept in Java projects at all, th= is is just a convenience + for people who are already using eclipse as their Java IDE= . + + +
+ +
+ Creating a New Rule + + Now we are going to add a new Rule resource to the project.<= /para> + + You can either create an empty text + .drl + file or make use of the special New Rule Resource + wizard to do it. + + To open the wizard follow to + File > New > Rule Resour= ce + or use the menu with the JBoss Drools icon on the = toolbar. + +
+ Opening the New Rule Resource Wizard + + + + + +
+ + On the wizard page first select + /rules + as a top level directory to store your rules and t= ype the rule name. Next + it's mandatory to specify the rule package name. It defines a = namespace that + groups rules together. + +
+ New Rule Resource Wizard + + + + + +
+ + As a result the wizard generates a rule skeleton to get you = started. + +
+ New Rule + + + + + +
+ +
+ + + + = + + + + JBoss Tools + Drools Tools + + + + Debugging rules + = + This chapter describes how to debug rules during the execution of y= our Drools application. + +
+ Creating Breakpoints + = + At first, we'll focus on how to add + breakpoints in the consequences of your rules. + = + Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It's possib= le then inspect the + variables known at that point and use any of the default debugging acti= ons to decide what + should happen next (step over, continue, etc). To inspect + the content of the working memory and agenda the Debug views can be use= d. + + You can add/remove rule breakpoints in + .drl + files in two ways, similar to adding breakpoints to Java fi= les: + + + + Double-click the ruler in the Rule e= ditor at the line + where you want to add a breakpoint. + + Tip: + Note that rule breakpoints can only be created in the consequen= ce of a + rule. Double-clicking on a line where no breakpoint is allowed will = do + nothing. + + A breakpoint can be removed by double-clicking the ruler once mo= re. + + + + Right-click the ruler. Select + Toggle Breakpoint + action in the appeared popup menu. Clicking the action wi= ll add a + breakpoint at the selected line or remove it if there is one already.= + + + +
+ Adding Breakpoints + + + + + +
+ + The Debug perspective conta= ins a Breakpoints + view which can be used to see all defined breakpoints, get = their + properties, enable/disable or remove them, etc. You can switch to it by= navigating to + Window > Perspective > Others > D= ebug. +
+ +
+ Debugging + + Drools breakpoints are only enabled if you debug your application = as a Drools + Application. To do this you should perform one of the actions: + + + + Select the main class of your application. Right click it and se= lect + Debug As > Drools Application. + + +
+ Debugging Drools Application + + + + + +
+ + + + Alternatively, you can also go to + Debug As > Debug Configuration + to open a new dialog for creating, managing and running d= ebug + configurations. + + Select the + Drools Application + item in the left tree and click the + New launch configuration + button (leftmost icon in the toolbar above the tree). Thi= s will + create a new configuration and already fill in some of the properties= (like the + Project and Main class) based on main class you selected in the begin= ning. All + properties shown here are the same as any standard Java program. + + + +
+ New Debug Configuration + + + + + +
+ + + Tip: + Remember to change the name of your debug configuration to someth= ing meaningful. + + = + Next + click the + Debug + button on the bottom to start debugging your application. <= /para> + + After enabling the debugging, the application starts executing and= will halt if + any breakpoint is encountered. This can be a Drools rule breakpoint, or= any other + standard Java breakpoint. Whenever a Drools rule breakpoint is encounte= red, the + corresponding + .drl file is opened = and the active line is highlighted. The Variables view + also contains all rule parameters and their value. You can then use the= default Java + debug actions to decide what to do next (resume, terminate, step over, = etc.). The debug + views can also be used to determine the contents of the working memory = and agenda at + that time as well (you don't have to select a working memory now, the c= urrent executing + working memory is automatically shown). + = + = +
+ + + = + + + + JBoss Tools + Drools Tools + + + + Editors + +
+ The Rule Editor + + The Rule editor works= on files that have a + .drl + (or + .rule + in the case of spreading rules across multiple rul= e files) extension. + +
+ New Rule + + + + + +
+ + The editor follows the pattern of a normal text editor in ec= lipse, with all the normal + features of a text editor: + + + + + Content = Assist + + + + + + Code Foldi= ng + + + + + + + + Synch= ronization with Outline + View + + + + +
+ Content Assist + + While working in the Rule ed= itor you can get a content + assistance the usual way by pressing + Ctrl + Space. + + Content Assist shows all possible keywords for the curre= nt cursor position. + +
+ Content Assist Demonstration + + + + + +
+ + Content Assist inside of the + Message + suggests all available fields. + +
+ Content Assist Demonstration + + + + + +
+ +
+ +
+ Code Folding + + Code folding is also available in the Rule editor. To + hide/show sections of the file use the icons with minus/pl= us on the left vertical + line of the editor. + +
+ Code Folding + + + + + +
+ +
+ + + +
+ Synchronization with Outline View + + The Rule editor w= orks in synchronization with the + Outline view wh= ich shows the structure of the rules, + imports in the file and also globals and functions if the = file has them. + +
+ Synchronization with Outline View + + + + + +
+ + The view is updated on save. It provides a quick way of = navigating around rules by + names in a file which may have hundreds of rules. The item= s are sorted + alphabetically by default. +
+ +
+ The Rete Tree View + + The Rete Tree view shows you the current Rete Network for + your + .drl + file. Just click on the + Rete Tree tab + at the bottom of the Rule editor. + +
+ Rete Tree + + + + + +
+ + Afterwards you can generate the current Rete Network vis= ualization. You can push + and pull the nodes to arrange your optimal network overvie= w. + If you got hundreds of nodes, select some of them with a= frame. Then you can pull + groups of them. + +
+ Selecting the nodes in the Rete Tree with Frame</ti= tle> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/editors/editors7.png"= ></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all no= des are shown in the + current view. For this use the combo box or "+" and "-" ic= ons on the toolbar.</para> + + <figure float=3D"0"> + <title>Rete Tree Zooming + + + + + +
+ + + Note: + + The Rete Tree view works only in Drools Rule Projects, + where the Drools Builder is set in the project propert= ies. + + We hope, this guide helped you to get started with the JBoss BPMN C= onvert module. Besides, for additional information you are welcome on JBoss forum. +
+ = +
+ = + + + = + = + Modified: trunk/esb/docs/esb_ref_guide/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 --- trunk/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-08 12:20:47 U= TC (rev 15137) +++ trunk/esb/docs/esb_ref_guide/en/master_output.xml 2009-05-08 12:36:11 U= TC (rev 15138) @@ -18,877 +18,877 @@ = = -]> - = - - ESB Tools Reference Guide - SvetlanaMukhina<= email>smukhina(a)exadel.com = - TatyanaRomanovich = - = - April 2008 - - 2007 - 2009 - JBoss, a division of Red Hat - - - Version: 1.1.1.GA - - = - - - - PDF version - - - - - = - = - = - - - - - - JBoss Developer Studio - Eclipse - Java - JBoss - JBoss Tools - JBDS - ESB - - - - Introduction - -
- - What is ESB? - - ESB (Enterprise Service Bus) - an abstraction layer on top o= f implementation of an - enterprise messaging system that provides the features Service= Oriented - Architectures may be implemented with. - If you want to develop applications using ESB technology JBo= ss ESB also meets your - needs. The JBoss Tools provide an ESB editor and all necessary= wizards for creating an ESB - file. - In this guide we provide you with the information on JBoss E= SB support (installation, configuration and deployment) and usage of ESB Ed= itor which allows you to - develop an ESB file much faster and with far fewer errors so s= paring your time. - -
- -
- Other relevant resources on the topic - - You can find a set of benefits and other extra information o= n: - - - - JBoss ESB= - - - - - JBo= ss Wiki - - - - - JBoss ESB - Documentation Library - - - - - The latest JBoss Tools/JBoss Dev= eloper Studio documentation - builds are available here. - -
- - - = - - - - - JBoss Developer Studio - Eclipse - ESB - Java - JBoss - - - - ESB Support - - In this section we will focus on all concepts that JBoss Tools - integrate for working with JBoss ESB. - -
- ESB Tools Installation - - This chapter will provide you with the information o= n how to install - JBoss ESB plugin into Eclipse. - - ESB Tools come as one module of JBoss Tools project.= Since ESB Tools have a - dependence on other JBoss Tools modules we recomme= nd you to install a bundle - of all JBoss - Tools plug-ins. You can find all = necessary installation instructions on JBoss Wiki in the InstallingJBossTools s= ection. -
- -
- Creating a ESB Project - In this chapter we suggest a step-by-step walk-throu= gh of creating a new - ESB project. Let's try to create a new JBoss ESB p= roject. - - We will show you how to use the ESB Project Creation= wizard for creating a new ESB project and setting basic ESB classpath. - - Select - File >New &= gt; Project... - in the main menu bar or context menu f= or selected project and - then - ESB > ESB P= roject - in the dialog opened: - -
- Select a Wizard dialog - - - - - -
- - Clicking - Next - brings you to the JBoss ESB Project wi= zard page where a project name, ESB version and target JBoss Runtime are to= be specified. Specify, for example, - helloworld - as a Project name and accept the defau= lt ESB version. -
- JBoss ESB Project wizard - - - - - -
- - Clicking - Next - brings you to the ESB facet installation page where you can = - specify Java Source Directory and ESB Content Dire= ctory. ESB Content Directory is a folder that contains the most of - artifacts that an ESB archive needs. You also can= configure ESB libraries to the project by selecting a ESB runtime using on= e of the options: - - 1. Use - Server Supplie= d ESB Runtime - = - = - - 2. Select a ESB runtime from the JBoss ESB= runtime list predefined in the preferences = - - If you choose the first option, make sure t= hat the project has the Target JBoss Runtime set and this runtime has a ESB= runtime installed. - -
- Install ESB facet step - - - - - -
- Click - Finish - and a ESB project with the default jboss-esb.xml = - will be created. - -
- The generated ESB project structure - - - - - -
- = -
- = -
- Creating ESB Project using JBoss Tools Project Exam= ples Wizard - JBoss Tools provides a Project Example wizard that i= s an easy way for users to create some kinds of projects to be used as exam= ples with some predefined structure. Let's start = - creating a ESB project using this wizard. - = - Before creating a ESB project example create JBoss R= untime with name - JBoss 4.2 Runtime, it will be used b= y your ESB project example. - - Select - File >New &= gt; Others - , in the main menu bar or context menu= for selected project and - then - JBoss Tools &g= t; Project Examples - in the New dialog: - -
- Select a wizard - Project Examples - - - - - -
- - Clicking - Next - brings you to the wizard page where you can select a ESB project exampl= e from the example list. - Every ESB example has two projects, one is a ESB p= roject and another is a Java project used to test the ESB project. - Here is a list of ready examples available: - = - - = - JBoss ESB HelloWorld Example - demonstrates the minimal= files necessary to make a basic ESB component execute as well as to prove = that the ESB os properly configured. - JBoss ESB HelloWorld Action Example - demonstrates the = use of multiple action invocations from a single configuration. You can use= a single Action class and make multiple method calls or use multiple Actio= n classes. - JBoss ESB HelloWorld File Action Example - demonstrates= using the File gateway feature of the JBoss ESB. Files that are found in a= particular directory with a particular extension are sent to a JMS queue w= ith actions for processing. - JBoss ESB Web Service consumer1 Example - demonstrates = how to consume a 181 Web Service in an ESB action.<= /listitem> - JBoss ESB Web Service producer Example - demonstrates h= ow to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcess= or action. - JBoss ESB Smooks CSV -> XML Example - demonstrates h= ow to transform a comma separated value (CSV) file to an XML. - JBoss ESB Smooks XML -> POJO Example - demonstrates = the use of Smooks performing a simple transformation by converting an XML f= ile into Java POJOs. - JBoss ESB Smooks XML -> XML date-manipulation= Example - demonstrates how to manually define and apply a Message Transformation = within JBoss ESB. = - JBoss ESB Smooks XML -> XML Example - a very basic e= xample of how to manually define and apply a Message Transformation within = JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and p= rints the before and after XML to the console. - = - - = - = - - = We will take as our example JBoss ESB HelloWorld Example ESB and Client proje= ct: - = - = -
- JBoss Tools ESB Project Examples - - - - - -
- = - = - Choose them usi= ng the Ctrl button and then click = - Finish. As a result you wi= ll get two projects created: -
- JBoss ESB Project Examples: helloworld and = helloworld_testclient - - - - - -
- = - Deploy the HelloWorld ESB project and run a test cl= ass in the client Java project to see the test result in the Console view.<= /para> -
- -
- Deploying a ESB Project - In this ch= apter you will see how to deploy a ESB project using the WTP deployment fra= mework. - - Before deploying the project, open the JBoss Server = View by selecting Window > Show Vi= ew > Other > = - Server > JBoss Server View, = - create a JBoss Server in the Server view and start it, and= then right click the created JBoss server, = - select = Add and Remove Projects, = - and add the ESB projects you want to deploy from the left = side to the right side in the opened dialog. - -
- Add and Remove Projects - - - - - -
- = - Click Finish to add the project to the server. = - You also can drag the ESB project from the Project View to= the server. - = -
- JBoss Server View - - - - - -
- = - Thus, you have just added the ESB project to the JBoss se= rver module list. Right click the JBoss Server and select Publish to publish the project on the server. - You can check the deploying result in the Console view. = - The Run and Debug options work on ESB projects causing a (re)deploy for = a user designated server. - You can also use the "Finger touch" for a quick restart of the proje= ct without restarting the server: -
- <diffmk:wrapper diffmk:c= hange=3D"added">Finger Touch button</diffmk:wrapper> - - - - - -
= - The "Finger" touches descriptors dependent on project (i.e. web.xml = for WAR, application.xml for EAR) and now it is also available for jboss-es= b.xml in ESB projects. - You can also deploy your ESB project as an .esb archive. Right-= click on the project, choose Export: - = -
- <diffmk:wrapper diffmk:change=3D= "added">Export of ESB project</diffmk:wrapper> - - - - - -
= - = - Ch= oose ES= B > ESB File and click Next: = - = -
<diffmk:wrapper diffmk:change=3D"added">Choosing ESB File</diff= mk:wrapper> - - - - - -
= - = - An= d finally export the ESB project to the file system: choose the destination= , choose the target runtime if need a specific one and make the appropriate= settings for the archive. Then click Finish. - = -
<diffmk:wrapper diffmk:change=3D"added">ESB Export</diffmk:wrap= per> - - - - - -
= - = - Your project is deployed as an .esb archive. - An ESB archive can be created for ESB projects only. It is also poss= ible to deploy an .esb archive to a JBoss AS based server with JBoss ESB in= stalled. = - = - = -
- = -
- Creating a ESB File - In this chapter we suggest a step-by-step walk-throu= gh of creating your own - simple file. Let's try to organize a new ESB file.= - - We will show you how to use the Creation wizard for = creating a new ESB file. - - At first you should open any project. Select - File >New &= gt; Other... - in the main menu bar or context menu f= or selected project and - then - ESB > ESB F= ile - in the New dialog: - -
- Select a wizard - ESB File - - - - - -
- - Clicking - Next - brings you to the wizard page where a = folder, a name and a version for the file should be specified. Choose, for = example, - jboss-esb.xml<= /property> - as the name and accept the selected pr= ojects folder and the default - version. -
- Folder, Name and Version for ESB file</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/esb_s= upport/02_create_esb.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Thus, your file will be created in the selected proj= ects folder by default. If - you want to change the folder for your future file= click <emphasis> - <property moreinfo=3D"none">Browse...</pro= perty> - </emphasis> button to set needed folder or simply = type it.</para> - - <para>Clicking on <emphasis> - <property moreinfo=3D"none">Finish</proper= ty> - </emphasis> results in the file being generated. T= he wizard creates one xml - file.</para> - - </section> - = - <section role=3D"updated"> - <title>Configuring ESB Runtime in Preferences - In this chapter you will know how to predefine a JBo= ss ESB runtime on the Preferences page. - - You may already know, there are two ways to set JBos= s ESB runtime when creating a ESB project, - one is to use the project target JBoss runtime, and anothe= r is to select a JBoss ESB runtime predefined in JBoss Tools preferences. - Let's configure it. - - Select - Window >Pre= ferences > JBoss Tools > JBoss ESB Runtime - , to open the JBoss ESB Runtime Prefere= nces page where you can add, remove and Edit a JBoss ESB runtime. - -
- JBoss ESB Runtimes - - - - - -
- - Select Add to open a dialog where you can specify the JBoss ESB runtime locati= on, name and version number. = - You also can customize the libraries of the runti= me by checking the Customize JBoss ES= B Runtime jars checkbox. - = -
- Configure new JBoss ESB Runtime - - - - - -
- - The new JBoss ESB Runtime will be configured. Click <= property moreinfo=3D"none">OK to finish and save the= preferences. - You can use the configuration when creating a JBoss ESB project. - When a ESB runtime is configured for your ESB proje= ct you are able to change it to any other using the classpath container pag= e for ESB runtime. To do that, turn to the Package Explorer view and right-= click the "JBoss ESB Runtime" library. Select Properties and a table listing all availabl= e JBoss ESB runtimes will appear: - = -
- Classpath Container Page to change ESB run= time - - - - - -
- = - = - = - Choose one of them to set to the ESB project and cl= ick Ok. - ESB container allows Source and JavaDoc locations t= o be set via the Properties dialog on each contained .jar: right-click on a= ny .jar file, select Properties. Choose Java Source = Attachment and select location (folder, JAR or zip) c= ontaining new source for the chosen .jar using one of the suggested options= (workspace, external folder or file) or enter the path manually: - = -
- Classpath Container: Java Source Attachmen= t - - - - - -
- Click on Apply and then on Ok. - To change Javadoc Location choose Javadoc Location and specify URL to the = documentation generated by Javadoc. The Javadoc location will contain a fil= e called package-list: - = -
- Classpath Container: Javadoc Location</tit= le> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/esb_= project/22_Javadoc.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis><property moreinfo=3D"none">Appl= y</property></emphasis> and then on <emphasis><property moreinfo=3D"none">O= k</property></emphasis>.</para> - = - </section> - - - <section id=3D"using_SOA"> = - <title>Using and Configuring SOA Platform - = - In this chapter you will know what is JBoss Enterpri= se SOA Platform and how you can configure it to use for your ESB projects.= - = - JBoss Enterprise SOA Platform delivers a flexible, s= tandards-based platform to integrate applications, SOA services, business e= vents and automate business processes. The SOA Platform integrates specific= versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application P= latform that are certified to work together in a single supported enterpris= e distribution. - Having configured JBoss Enterprise SOA Platform for = your ESB project you don't need to install and configure ESB server and run= time as they are already included. - - Check here to find more details on the platform: JBoss Enterprise SO= A Platform and JBoss Enterprise SOA Platform Component Details.<= /para> - You can find out what is SOA here: Basics of SOA a= nd SO= A and EOA. - = - To configure the JBoss Enterprise SOA platform selec= t - Window > Preferences > Server > Runtime Envir= onments, that will open the Server R= untime Environments Preferences page where you can add, remove and edit a S= erver Runtime Environment. - = -
- Configure new Server Runtime Environment</t= itle> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/esb_p= roject/13NewServerRuntimeEnv.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - = - <para>Select <emphasis><property moreinfo=3D"none">Add</pr= operty></emphasis>, choose <emphasis><property moreinfo=3D"none">JBoss 4.2 = Runtime</property></emphasis> as a type of runtime environment, check the <= emphasis><property moreinfo=3D"none">Create a new local server</property></= emphasis> checkbox and click <emphasis><property moreinfo=3D"none">Next</pr= operty></emphasis>:</para> = - <figure float=3D"0"> - <title>Type of Server Runtime Environment - - - - - -
- = - On the nex= t step you can specify a name of the server runtime environment and browse = to its location. Click Finish to add the server runtime environment. - = - = -
- New Server Runtime Environment Details</tit= le> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/esb_p= roject/15AddNew.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Now you have your SOA platform configured. To check = the configuration create a ESB Project using instructions described <xref l= inkend=3D"ESB_project_wizard"></xref>. As a result you will have two projec= ts created:</para> - = - <figure float=3D"0"> - <title>Helloworld Projects Created - - - - - -
- Then you will need to add JBoss ESB libraries to you= r projects to configure the SOA server runtime exactly for your projects. R= ight-click on your project, select Bu= ild Path > Add Libraries: - = -
- Add Libraries - - - - - -
- = - Choose JBoss ESB Libra= ries and click = Next: - = -
- ESB Libraries - - - - - -
- = - Select the necessary runtime to add to the project c= lasspath: - = - = -
- Select a ESB runtime - - - - - -
- Click Finish. - Now you can deploy your Helloworld project to the s= erver and run a test class in the client Java project to see the test resul= t in the Console view. - = - = - = -
- = - = - = - = - = - = - = - = - = - = - - - = - - - - - JBoss ESB - Editor - ESB - - - - ESB Editor - - ESB editor has lots of useful features, they are described in d= etails in this chapter. In - addition you'll get to know with how E= SB Editor uses combined - visual and source editing of esb files. - -
- - ESB File Editor - ESB File Editor is a = powerful and customizable tool. ESB File - Editor allows developing an application using ESB technology.<= /para> - - ESB file editor has two tabs: Tree and Source. - - You can switch to Tree. The Tree view for the editor display= s all ESB artifacts in a - tree format. By selecting any node you can see and edit its pr= operties which will appear - in the right-hand area. For example, a Provider: -
- Tree View - - - - - -
- - You can easily switch from Tree to Source by selecting the S= ource tab at the bottom of - the editor and work in Source view= . - -
- Source View - - - - - -
- - The Source view for the editor displays a text content of th= e ESB file. It is always - synchronized with Tree view, so any changes made in one of the - views will immediately appear in the other. - - No matter what view you select, you get full integration wit= h Outline - view. For example, you can work in the Source view = with the help of the - Outline view. The Outline view shows a tree structure of the E= SB file. Simply select any - element in the Outline view and it will jump to the same place in - the Source editor, so you can navigate through the source code= with Outline view. -
- Outline View - - - - - -
- - Adding, editing or deleting of some artifacts operations are= available right in the - Tree view . Right-c= lick any node and select one of the - available actions in the context menu. For example, you can ea= sily add a new Provider: - -
- Adding New Provider - - - - - -
- Then you can add Channels and Properties for the Providers the same way= or using the forms with Add, <= property diffmk:change=3D"added" moreinfo=3D"none">Edit and - Remove buttons to the right. - - You can easily add a new Service too: -
- Adding New Service - - - - - -
- - The same way you can create a listener for service and other= elements of ESB: -
- Adding New Listener for Service - - - - - -
- The same actions can be done in the right part of Tree view tab - (Form editor) using Add= , Edit and - Remove buttons. - - - In order to add a new generic Action to your ESB XML file yo= u should select the - Actions node under the Services, then right-click and choose <= emphasis> - New > Generic Action. - -
- Adding New Action in the Tree View - - - - - -
- - Or instead make use of - Add... - button in the Form edi= tor on the left. -
- Adding New Action in the Form Editor - - - - - -
- - As you can see on the bath figures above, the context menu w= ill also prompt you to - insert one of the Actions that are supplied out-of-the-box wit= h JBoss - ESB. After choosing one an appeared New Action wizard - will ask you to fill out a name field and other fields specifi= c for each Action - property. For example, for - Content Based Router - Action the wizard looks as follows: - -
- New Action Wizard - - - - - -
- - After confirming creating the Action you can see it in the T= ree under the - Actions - node and preview as well as edit its settings in t= he Form - editor on the left. - -
- Form Editor for Content Based Router - - - - - -
- - ESB editor can recogn= ize some specific objects. On the figure you - can see org.jboss.soa.esb.actions.ContentBasedRouter= in the - Class - section. - -
- -
- - ESB Editors Features - JBoss ESB tooling has powerful editor features that help you= easily make use of - content and code assist. - This last chapter covers capabilities on how you can use ESB= editor. - -
- - ESB syntax validation - When working in JBoss ESB ed= itor you are constantly provided - with feedback and contextual error checking as you type. I= n the Source viewer, if at - any point a tag is incorrect or incomplete, an error will = be indicated next to the - line and also in the Problems = view below. -
- -
- Support for XML Schema - - JBoss ESB Framework fully s= upports XML files based on - schemas as well as DTDs. - Note: - The schema used behind ESB editor now uses the lates= t version available (from SOA-P 4.3). This removes the errors/warnings some= users have reported seeing when using SOA-P specific esb.xml files.= - = -
- - - -
- - Content Assist for ESB XML file - - When you work with any ESB XML file Content Assist is - available to help you. It provides pop-up tip to help you = complete your code - statements. It allows you to write your code faster and wi= th more accuracy. Content - assist is always available in the Source mode. Simply type= - Ctrl-Space - to see what is available. - - Content Assist for ESB XML file: -
- Content Assist for ESB XML file - - - - - -
- - Content Assist for attributes: -
- Content Assist for attributes: - - - - - -
- -
- -
- - Synchronized Source and Visual Editing - - ESB file can be edited in either source or extra visual = modes at the same time. - - JBoss Tools provide you two different editors to speed y= our development: a - graphical view (Tree) and source (Source). - At the same time, you always have full control over esb so= urce file. Any changes you - make in the source view will immediately appear in the tre= e view. Both views are - synchronized, you can edit the file in any view. - -
- Two Views are Synchronized - - - - - -
- = - In summary, th= is reference supplies you with all necessary information on the - functionality that JBoss ESB Editor provides for work with JBo= ss ESB. - = - We hope, this guide helped you to get started with the JBoss ESB To= ols. Besides, for additional information you are welcome on JB= oss forum.= - = -
-
- - = - - +]> + = + + ESB Tools Reference Guide + SvetlanaMukhina<= email>smukhina(a)exadel.com = + TatyanaRomanovich = + = + April 2008 + + 2007 + 2009 + JBoss, a division of Red Hat + + + Version: 1.1.1.GA + + = + + + + PDF version + + + + + = + = + = + + + + + + JBoss Developer Studio + Eclipse + Java + JBoss + JBoss Tools + JBDS + ESB + + + + Introduction + +
+ + What is ESB? + + ESB (Enterprise Service Bus) - an abstraction layer on top o= f implementation of an + enterprise messaging system that provides the features Service= Oriented + Architectures may be implemented with. + If you want to develop applications using ESB technology JBo= ss ESB also meets your + needs. The JBoss Tools provide an ESB editor and all necessary= wizards for creating an ESB + file. + In this guide we provide you with the information on JBoss E= SB support (installation, configuration and deployment) and usage of ESB Ed= itor which allows you to + develop an ESB file much faster and with far fewer errors so s= paring your time. + +
+ +
+ Other relevant resources on the topic + + You can find a set of benefits and other extra information o= n: + + + + JBoss ESB= + + + + + JBo= ss Wiki + + + + + JBoss ESB + Documentation Library + + + + + The latest JBoss Tools/JBoss Dev= eloper Studio documentation + builds are available here. + +
+ + + = + + + + + JBoss Developer Studio + Eclipse + ESB + Java + JBoss + + + + ESB Support + + In this section we will focus on all concepts that JBoss Tools + integrate for working with JBoss ESB. + +
+ ESB Tools Installation + + This chapter will provide you with the information o= n how to install + JBoss ESB plugin into Eclipse. + + ESB Tools come as one module of JBoss Tools project.= Since ESB Tools have a + dependence on other JBoss Tools modules we recomme= nd you to install a bundle + of all JBoss + Tools plug-ins. You can find all = necessary installation instructions on JBoss Wiki in the InstallingJBossTools s= ection. +
+ +
+ Creating a ESB Project + In this chapter we suggest a step-by-step walk-throu= gh of creating a new + ESB project. Let's try to create a new JBoss ESB p= roject. + + We will show you how to use the ESB Project Creation= wizard for creating a new ESB project and setting basic ESB classpath. + + Select + File >New &= gt; Project... + in the main menu bar or context menu f= or selected project and + then + ESB > ESB P= roject + in the dialog opened: + +
+ Select a Wizard dialog + + + + + +
+ + Clicking + Next + brings you to the JBoss ESB Project wi= zard page where a project name, ESB version and target JBoss Runtime are to= be specified. Specify, for example, + helloworld + as a Project name and accept the defau= lt ESB version. +
+ JBoss ESB Project wizard + + + + + +
+ + Clicking + Next + brings you to the ESB facet installation page where you can = + specify Java Source Directory and ESB Content Dire= ctory. ESB Content Directory is a folder that contains the most of + artifacts that an ESB archive needs. You also can= configure ESB libraries to the project by selecting a ESB runtime using on= e of the options: + + 1. Use + Server Supplie= d ESB Runtime + = + = + + 2. Select a ESB runtime from the JBoss ESB= runtime list predefined in the preferences = + + If you choose the first option, make sure t= hat the project has the Target JBoss Runtime set and this runtime has a ESB= runtime installed. + +
+ Install ESB facet step + + + + + +
+ Click + Finish + and a ESB project with the default jboss-esb.xml = + will be created. + +
+ The generated ESB project structure + + + + + +
+ = +
+ = +
+ Creating ESB Project using JBoss Tools Project Exam= ples Wizard + JBoss Tools provides a Project Example wizard that i= s an easy way for users to create some kinds of projects to be used as exam= ples with some predefined structure. Let's start = + creating a ESB project using this wizard. + = + Before creating a ESB project example create JBoss R= untime with name + JBoss 4.2 Runtime, it will be used b= y your ESB project example. + + Select + File >New &= gt; Others + , in the main menu bar or context menu= for selected project and + then + JBoss Tools &g= t; Project Examples + in the New dialog: + +
+ Select a wizard - Project Examples + + + + + +
+ + Clicking + Next + brings you to the wizard page where you can select a ESB project exampl= e from the example list. + Every ESB example has two projects, one is a ESB p= roject and another is a Java project used to test the ESB project. + Here is a list of ready examples available: + = + + = + JBoss ESB HelloWorld Example - demonstrates the minimal= files necessary to make a basic ESB component execute as well as to prove = that the ESB os properly configured. + JBoss ESB HelloWorld Action Example - demonstrates the = use of multiple action invocations from a single configuration. You can use= a single Action class and make multiple method calls or use multiple Actio= n classes. + JBoss ESB HelloWorld File Action Example - demonstrates= using the File gateway feature of the JBoss ESB. Files that are found in a= particular directory with a particular extension are sent to a JMS queue w= ith actions for processing. + JBoss ESB Web Service consumer1 Example - demonstrates = how to consume a 181 Web Service in an ESB action.<= /listitem> + JBoss ESB Web Service producer Example - demonstrates h= ow to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcess= or action. + JBoss ESB Smooks CSV -> XML Example - demonstrates h= ow to transform a comma separated value (CSV) file to an XML. + JBoss ESB Smooks XML -> POJO Example - demonstrates = the use of Smooks performing a simple transformation by converting an XML f= ile into Java POJOs. + JBoss ESB Smooks XML -> XML date-manipulation= Example - demonstrates how to manually define and apply a Message Transformation = within JBoss ESB. = + JBoss ESB Smooks XML -> XML Example - a very basic e= xample of how to manually define and apply a Message Transformation within = JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and p= rints the before and after XML to the console. + = + + = + = + + = We will take as our example JBoss ESB HelloWorld Example ESB and Client proje= ct: + = + = +
+ JBoss Tools ESB Project Examples + + + + + +
+ = + = + Choose them usi= ng the Ctrl button and then click = + Finish. As a result you wi= ll get two projects created: +
+ JBoss ESB Project Examples: helloworld and = helloworld_testclient + + + + + +
+ = + Deploy the HelloWorld ESB project and run a test cl= ass in the client Java project to see the test result in the Console view.<= /para> +
+ +
+ Deploying a ESB Project + In this ch= apter you will see how to deploy a ESB project using the WTP deployment fra= mework. + + Before deploying the project, open the JBoss Server = View by selecting Window > Show Vi= ew > Other > = + Server > JBoss Server View, = + create a JBoss Server in the Server view and start it, and= then right click the created JBoss server, = + select = Add and Remove Projects, = + and add the ESB projects you want to deploy from the left = side to the right side in the opened dialog. + +
+ Add and Remove Projects + + + + + +
+ = + Click Finish to add the project to the server. = + You also can drag the ESB project from the Project View to= the server. + = +
+ JBoss Server View + + + + + +
+ = + Thus, you have just added the ESB project to the JBoss se= rver module list. Right click the JBoss Server and select Publish to publish the project on the server. + You can check the deploying result in the Console view. = + The Run and Debug options work on ESB projects causing a (re)deploy for = a user designated server. + You can also use the "Finger touch" for a quick restart of the proje= ct without restarting the server: +
+ <diffmk:wrapper diffmk:c= hange=3D"added">Finger Touch button</diffmk:wrapper> + + + + + +
= + The "Finger" touches descriptors dependent on project (i.e. web.xml = for WAR, application.xml for EAR) and now it is also available for jboss-es= b.xml in ESB projects. + You can also deploy your ESB project as an .esb archive. Right-= click on the project, choose Export: + = +
+ <diffmk:wrapper diffmk:change=3D= "added">Export of ESB project</diffmk:wrapper> + + + + + +
= + = + Ch= oose ES= B > ESB File and click Next: = + = +
<diffmk:wrapper diffmk:change=3D"added">Choosing ESB File</diff= mk:wrapper> + + + + + +
= + = + An= d finally export the ESB project to the file system: choose the destination= , choose the target runtime if need a specific one and make the appropriate= settings for the archive. Then click Finish. + = +
<diffmk:wrapper diffmk:change=3D"added">ESB Export</diffmk:wrap= per> + + + + + +
= + = + Your project is deployed as an .esb archive. + An ESB archive can be created for ESB projects only. It is also poss= ible to deploy an .esb archive to a JBoss AS based server with JBoss ESB in= stalled. = + = + = +
+ = +
+ Creating a ESB File + In this chapter we suggest a step-by-step walk-throu= gh of creating your own + simple file. Let's try to organize a new ESB file.= + + We will show you how to use the Creation wizard for = creating a new ESB file. + + At first you should open any project. Select + File >New &= gt; Other... + in the main menu bar or context menu f= or selected project and + then + ESB > ESB F= ile + in the New dialog: + +
+ Select a wizard - ESB File + + + + + +
+ + Clicking + Next + brings you to the wizard page where a = folder, a name and a version for the file should be specified. Choose, for = example, + jboss-esb.xml<= /property> + as the name and accept the selected pr= ojects folder and the default + version. +
+ Folder, Name and Version for ESB file</titl= e> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/esb_s= upport/02_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, your file will be created in the selected proj= ects folder by default. If + you want to change the folder for your future file= click <emphasis> + <property moreinfo=3D"none">Browse...</pro= perty> + </emphasis> button to set needed folder or simply = type it.</para> + + <para>Clicking on <emphasis> + <property moreinfo=3D"none">Finish</proper= ty> + </emphasis> results in the file being generated. T= he wizard creates one xml + file.</para> + + </section> + = + <section role=3D"updated"> + <title>Configuring ESB Runtime in Preferences + In this chapter you will know how to predefine a JBo= ss ESB runtime on the Preferences page. + + You may already know, there are two ways to set JBos= s ESB runtime when creating a ESB project, + one is to use the project target JBoss runtime, and anothe= r is to select a JBoss ESB runtime predefined in JBoss Tools preferences. + Let's configure it. + + Select + Window >Pre= ferences > JBoss Tools > JBoss ESB Runtime + , to open the JBoss ESB Runtime Prefere= nces page where you can add, remove and Edit a JBoss ESB runtime. + +
+ JBoss ESB Runtimes + + + + + +
+ + Select Add to open a dialog where you can specify the JBoss ESB runtime locati= on, name and version number. = + You also can customize the libraries of the runti= me by checking the Customize JBoss ES= B Runtime jars checkbox. + = +
+ Configure new JBoss ESB Runtime + + + + + +
+ + The new JBoss ESB Runtime will be configured. Click <= property moreinfo=3D"none">OK to finish and save the= preferences. + You can use the configuration when creating a JBoss ESB project. + When a ESB runtime is configured for your ESB proje= ct you are able to change it to any other using the classpath container pag= e for ESB runtime. To do that, turn to the Package Explorer view and right-= click the "JBoss ESB Runtime" library. Select Properties and a table listing all availabl= e JBoss ESB runtimes will appear: + = +
+ Classpath Container Page to change ESB run= time + + + + + +
+ = + = + = + Choose one of them to set to the ESB project and cl= ick Ok. + ESB container allows Source and JavaDoc locations t= o be set via the Properties dialog on each contained .jar: right-click on a= ny .jar file, select Properties. Choose Java Source = Attachment and select location (folder, JAR or zip) c= ontaining new source for the chosen .jar using one of the suggested options= (workspace, external folder or file) or enter the path manually: + = +
+ Classpath Container: Java Source Attachmen= t + + + + + +
+ Click on Apply and then on Ok. + To change Javadoc Location choose Javadoc Location and specify URL to the = documentation generated by Javadoc. The Javadoc location will contain a fil= e called package-list: + = +
+ Classpath Container: Javadoc Location</tit= le> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/esb_= project/22_Javadoc.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo=3D"none">Appl= y</property></emphasis> and then on <emphasis><property moreinfo=3D"none">O= k</property></emphasis>.</para> + = + </section> + + + <section id=3D"using_SOA"> = + <title>Using and Configuring SOA Platform + = + In this chapter you will know what is JBoss Enterpri= se SOA Platform and how you can configure it to use for your ESB projects.= + = + JBoss Enterprise SOA Platform delivers a flexible, s= tandards-based platform to integrate applications, SOA services, business e= vents and automate business processes. The SOA Platform integrates specific= versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application P= latform that are certified to work together in a single supported enterpris= e distribution. + Having configured JBoss Enterprise SOA Platform for = your ESB project you don't need to install and configure ESB server and run= time as they are already included. + + Check here to find more details on the platform: JBoss Enterprise SO= A Platform and JBoss Enterprise SOA Platform Component Details.<= /para> + You can find out what is SOA here: Basics of SOA a= nd SO= A and EOA. + = + To configure the JBoss Enterprise SOA platform selec= t + Window > Preferences > Server > Runtime Envir= onments, that will open the Server R= untime Environments Preferences page where you can add, remove and edit a S= erver Runtime Environment. + = +
+ Configure new Server Runtime Environment</t= itle> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/esb_p= roject/13NewServerRuntimeEnv.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + = + <para>Select <emphasis><property moreinfo=3D"none">Add</pr= operty></emphasis>, choose <emphasis><property moreinfo=3D"none">JBoss 4.2 = Runtime</property></emphasis> as a type of runtime environment, check the <= emphasis><property moreinfo=3D"none">Create a new local server</property></= emphasis> checkbox and click <emphasis><property moreinfo=3D"none">Next</pr= operty></emphasis>:</para> = + <figure float=3D"0"> + <title>Type of Server Runtime Environment + + + + + +
+ = + On the nex= t step you can specify a name of the server runtime environment and browse = to its location. Click Finish to add the server runtime environment. + = + = +
+ New Server Runtime Environment Details</tit= le> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/esb_p= roject/15AddNew.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now you have your SOA platform configured. To check = the configuration create a ESB Project using instructions described <xref l= inkend=3D"ESB_project_wizard"></xref>. As a result you will have two projec= ts created:</para> + = + <figure float=3D"0"> + <title>Helloworld Projects Created + + + + + +
+ Then you will need to add JBoss ESB libraries to you= r projects to configure the SOA server runtime exactly for your projects. R= ight-click on your project, select Bu= ild Path > Add Libraries: + = +
+ Add Libraries + + + + + +
+ = + Choose JBoss ESB Libra= ries and click = Next: + = +
+ ESB Libraries + + + + + +
+ = + Select the necessary runtime to add to the project c= lasspath: + = + = +
+ Select a ESB runtime + + + + + +
+ Click Finish. + Now you can deploy your Helloworld project to the s= erver and run a test class in the client Java project to see the test resul= t in the Console view. + = + = + = +
+ = + = + = + = + = + = + = + = + = + = + + + = + + + + + JBoss ESB + Editor + ESB + + + + ESB Editor + + ESB editor has lots of useful features, they are described in d= etails in this chapter. In + addition you'll get to know with how E= SB Editor uses combined + visual and source editing of esb files. + +
+ + ESB File Editor + ESB File Editor is a = powerful and customizable tool. ESB File + Editor allows developing an application using ESB technology.<= /para> + + ESB file editor has two tabs: Tree and Source. + + You can switch to Tree. The Tree view for the editor display= s all ESB artifacts in a + tree format. By selecting any node you can see and edit its pr= operties which will appear + in the right-hand area. For example, a Provider: +
+ Tree View + + + + + +
+ + You can easily switch from Tree to Source by selecting the S= ource tab at the bottom of + the editor and work in Source view= . + +
+ Source View + + + + + +
+ + The Source view for the editor displays a text content of th= e ESB file. It is always + synchronized with Tree view, so any changes made in one of the + views will immediately appear in the other. + + No matter what view you select, you get full integration wit= h Outline + view. For example, you can work in the Source view = with the help of the + Outline view. The Outline view shows a tree structure of the E= SB file. Simply select any + element in the Outline view and it will jump to the same place in + the Source editor, so you can navigate through the source code= with Outline view. +
+ Outline View + + + + + +
+ + Adding, editing or deleting of some artifacts operations are= available right in the + Tree view . Right-c= lick any node and select one of the + available actions in the context menu. For example, you can ea= sily add a new Provider: + +
+ Adding New Provider + + + + + +
+ Then you can add Channels and Properties for the Providers the same way= or using the forms with Add, <= property diffmk:change=3D"added" moreinfo=3D"none">Edit and + Remove buttons to the right. + + You can easily add a new Service too: +
+ Adding New Service + + + + + +
+ + The same way you can create a listener for service and other= elements of ESB: +
+ Adding New Listener for Service + + + + + +
+ The same actions can be done in the right part of Tree view tab + (Form editor) using Add= , Edit and + Remove buttons. + + + In order to add a new generic Action to your ESB XML file yo= u should select the + Actions node under the Services, then right-click and choose <= emphasis> + New > Generic Action. + +
+ Adding New Action in the Tree View + + + + + +
+ + Or instead make use of + Add... + button in the Form edi= tor on the left. +
+ Adding New Action in the Form Editor + + + + + +
+ + As you can see on the bath figures above, the context menu w= ill also prompt you to + insert one of the Actions that are supplied out-of-the-box wit= h JBoss + ESB. After choosing one an appeared New Action wizard + will ask you to fill out a name field and other fields specifi= c for each Action + property. For example, for + Content Based Router + Action the wizard looks as follows: + +
+ New Action Wizard + + + + + +
+ + After confirming creating the Action you can see it in the T= ree under the + Actions + node and preview as well as edit its settings in t= he Form + editor on the left. + +
+ Form Editor for Content Based Router + + + + + +
+ + ESB editor can recogn= ize some specific objects. On the figure you + can see org.jboss.soa.esb.actions.ContentBasedRouter= in the + Class + section. + +
+ +
+ + ESB Editors Features + JBoss ESB tooling has powerful editor features that help you= easily make use of + content and code assist. + This last chapter covers capabilities on how you can use ESB= editor. + +
+ + ESB syntax validation + When working in JBoss ESB ed= itor you are constantly provided + with feedback and contextual error checking as you type. I= n the Source viewer, if at + any point a tag is incorrect or incomplete, an error will = be indicated next to the + line and also in the Problems = view below. +
+ +
+ Support for XML Schema + + JBoss ESB Framework fully s= upports XML files based on + schemas as well as DTDs. + Note: + The schema used behind ESB editor now uses the lates= t version available (from SOA-P 4.3). This removes the errors/warnings some= users have reported seeing when using SOA-P specific esb.xml files.= + = +
+ + + +
+ + Content Assist for ESB XML file + + When you work with any ESB XML file Content Assist is + available to help you. It provides pop-up tip to help you = complete your code + statements. It allows you to write your code faster and wi= th more accuracy. Content + assist is always available in the Source mode. Simply type= + Ctrl-Space + to see what is available. + + Content Assist for ESB XML file: +
+ Content Assist for ESB XML file + + + + + +
+ + Content Assist for attributes: +
+ Content Assist for attributes: + + + + + +
+ +
+ +
+ + Synchronized Source and Visual Editing + + ESB file can be edited in either source or extra visual = modes at the same time. + + JBoss Tools provide you two different editors to speed y= our development: a + graphical view (Tree) and source (Source). + At the same time, you always have full control over esb so= urce file. Any changes you + make in the source view will immediately appear in the tre= e view. Both views are + synchronized, you can edit the file in any view. + +
+ Two Views are Synchronized + + + + + +
+ = + In summary, th= is reference supplies you with all necessary information on the + functionality that JBoss ESB Editor provides for work with JBo= ss ESB. + = + We hope, this guide helped you to get started with the JBoss ES= B Tools. Besides, for additional information you are welcome on JBoss forum. + = +
+
+ + = + + Modified: trunk/hibernatetools/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 --- trunk/hibernatetools/docs/reference/en/master_output.xml 2009-05-08 12:= 20:47 UTC (rev 15137) +++ trunk/hibernatetools/docs/reference/en/master_output.xml 2009-05-08 12:= 36:11 UTC (rev 15138) @@ -5244,7 +5244,7 @@ The rest chapters have shown the aspects of using the Hibernate Tools via Ant tasks. = - Please, visit JBoss + Please, visit JBoss Tools Users Forum to leave questions or/and suggestion= s on the topic. Your feedback is always appreciated. Modified: trunk/jbpm/docs/converter_ref/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 --- trunk/jbpm/docs/converter_ref/en/master_output.xml 2009-05-08 12:20:47 = UTC (rev 15137) +++ trunk/jbpm/docs/converter_ref/en/master_output.xml 2009-05-08 12:36:11 = UTC (rev 15138) @@ -159,7 +159,7 @@ = - We hope, this guide helped you to get started with the JBoss BPMN C= onvert module. Besides, for additional information you are welcome on JBoss forum. + We hope, this guide helped you to get started with the JBoss BPMN C= onvert module. Besides, for additional information you are welcome on JBoss forum. = --===============6868854711430807699==--