From jbosstools-commits at lists.jboss.org Thu Jan 29 12:33:33 2009 Content-Type: multipart/mixed; boundary="===============5821282702708160822==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r13337 - branches/jbosstools-3.0.0.CR2/esb/docs/esb_ref_guide/en. Date: Thu, 29 Jan 2009 12:33:33 -0500 Message-ID: --===============5821282702708160822== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2009-01-29 12:33:33 -0500 (Thu, 29 Jan 2009) New Revision: 13337 Added: branches/jbosstools-3.0.0.CR2/esb/docs/esb_ref_guide/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-571- adding the master_output.xml; Added: branches/jbosstools-3.0.0.CR2/esb/docs/esb_ref_guide/en/master_outpu= t.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- branches/jbosstools-3.0.0.CR2/esb/docs/esb_ref_guide/en/master_output.x= ml (rev 0) +++ branches/jbosstools-3.0.0.CR2/esb/docs/esb_ref_guide/en/master_output.x= ml 2009-01-29 17:33:33 UTC (rev 13337) @@ -0,0 +1,819 @@ + + + + + + + + + + + + + + + + = + +]> + = + + ESB Tools Reference Guide + SvetlanaMukhina<= email>smukhina(a)exadel.com = + TatyanaRomanovich = + = + April 2008 + + 2007 + 2008 + JBoss, a division of Red Hat Inc. + + + Version: 1.1.0.CR1 + + = + + + + 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 dev= elop applications using ESB technology JBoss 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 p= rovide you with the information on JBoss ESB support (installation, configu= ration and deployment) and usage of ESB Editor 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 installati= on 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 yo= u can select a ESB project example from the example list. + Every ESB example has two projects, one is a ESB = project and another is a Java project used to test the ESB project. +
+ JBoss Tools ESB Project Examples + + + + + +
+ + Select JBoss ESB HelloWorl= d Example ESB and Client project, and then click = + Finish, th= en you will 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 chapter youwill see how to deploy a ESB proj= ect using the WTP deployment framework. + + 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 o= n the server. + You can check the deploying result in the Console view. = + = +
+ = +
+ 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 to be set vi= a the Properties dialog on each contained .jar: right-click on any .jar fil= e, select Properties. Choose Java Source Attachment and select location (folder, = JAR or zip) containing new source for the chosen .jar using one of the sugg= ested options (workspace, external folder or file) or enter the path manual= ly: + = +
+ <diffmk:wrapper di= ffmk:change=3D"added">Classpath Container: Java Source Attachment</diffmk:w= rapper> + + + + + +
+ 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 fi= le called package-list: + = +
+ <diffmk:wrapper di= ffmk:change=3D"added">Classpath Container: Javadoc Location</diffmk:wrapper= > + + + + + +
+ Click on Apply and then on Ok. + = +
+ + +
= + 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 > Preference= s > Server > Runtime Enironments, that will op= en the Server Runtime Environments Preferences page where you can add, remo= ve and edit a Server 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 next step you can specify a name of the serve= r runtime environement 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 + + + + + +
+ + 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 ha= s 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. +
+ + + +
+ + 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, this reference supplies you with all necessa= ry information on the + functionality that JBoss ESB Editor provides for work with= JBoss ESB. +
+
+ + = + + --===============5821282702708160822==--