From jbosstools-commits at lists.jboss.org Sat May 29 03:06:16 2010
Content-Type: multipart/mixed; boundary="===============0031790064374112786=="
MIME-Version: 1.0
From: jbosstools-commits at lists.jboss.org
To: jbosstools-commits at lists.jboss.org
Subject: [jbosstools-commits] JBoss Tools SVN: r22431 -
trunk/esb/docs/esb_ref_guide/en-US.
Date: Sat, 29 May 2010 03:06:15 -0400
Message-ID: <201005290706.o4T76F6Q007302@svn01.web.mwc.hst.phx2.redhat.com>
--===============0031790064374112786==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: abogachuk
Date: 2010-05-29 03:06:15 -0400 (Sat, 29 May 2010)
New Revision: 22431
Added:
trunk/esb/docs/esb_ref_guide/en-US/reference.xml
trunk/esb/docs/esb_ref_guide/en-US/summary.xml
trunk/esb/docs/esb_ref_guide/en-US/tasks.xml
Modified:
trunk/esb/docs/esb_ref_guide/en-US/introduction.xml
trunk/esb/docs/esb_ref_guide/en-US/master.xml
Log:
https://jira.jboss.org/browse/TOOLSDOC-77 - guide restructuring.
Modified: trunk/esb/docs/esb_ref_guide/en-US/introduction.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-US/introduction.xml 2010-05-29 06:37:02=
UTC (rev 22430)
+++ trunk/esb/docs/esb_ref_guide/en-US/introduction.xml 2010-05-29 07:06:15=
UTC (rev 22431)
@@ -18,15 +18,18 @@
=
=
- What is ESB?
+ What is ESB and JBoss ESB Tools?
=
- ESB (Enterprise Service Bus) - an abstraction layer on top o=
f implementation of an
- enterprise messaging system that provides the features Service=
Oriented
+ ESB (Enterprise Service Bus) is an abstraction layer on top =
of the implementation of an
+ enterprise messaging system that provides the features that Se=
rvice 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
+ If you want to develop applications using ESB technology JBoss ESB also meets your
+ needs. Read more about Jboss ESB at http://www.jboss.org/jbossesb.
+ =
+ =
+ JBoss ESB Tools provide an ESB editor a=
nd necessary wizard 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
+ In this guide we provide you with the information on JBoss ESB Tools (installation, configuration 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.
=
@@ -58,7 +61,7 @@
JBoss Tools Project Examples WizardSome kinds of projects with predefined st=
ructure are available for usage.
- Creating ESB =
Project using JBoss Tools Project Examples Wizard
+ Using ESB Pro=
ject Examples
=
@@ -66,7 +69,7 @@
JBoss Enterprise SOA PlatformThe SOA Platform integrates specific vers=
ions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platfo=
rm that are certified to work together in a single supported enterprise dis=
tribution.
- using and configuring =
SOA Platform
+ Using and configuring =
SOA Platform
=
@@ -82,37 +85,20 @@
=
- =
=
=
- =
- 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 Developer Studio documentation
- builds are available JBoss Tools nightly documentation page.
-
+ Requirements and Installation
+ =
+ This section will provide you with the information on how to=
install
+ JBoss ESB plugin into Eclipse.
+ =
+ ESB Tools come as one module of JBoss Tools project. Since E=
SB Tools have a
+ dependence on other JBoss Tools modules we recommend you to in=
stall a bundle
+ of all JBoss
+ Tools plug-ins. You can find all necessary instal=
lation instructions on JBoss Wiki in the InstallingJBossTools section.
+ =
Modified: trunk/esb/docs/esb_ref_guide/en-US/master.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-US/master.xml 2010-05-29 06:37:02 UTC (=
rev 22430)
+++ trunk/esb/docs/esb_ref_guide/en-US/master.xml 2010-05-29 07:06:15 UTC (=
rev 22431)
@@ -3,8 +3,9 @@
"http://www.docbook.org/xml/4.3/docbookx.dtd"
=
[
-
-
+
+
+
=
@@ -22,7 +23,7 @@
=
- ESB Tools Reference Guide
+ JBoss ESB Tools User Guide
=
@@ -59,7 +60,8 @@
=
=
&introduction;
- &esb_support;
- &esb_editor; =
+ &tasks;
+ &reference; =
+ &summary;
=
=
Added: trunk/esb/docs/esb_ref_guide/en-US/reference.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-US/reference.xml =
(rev 0)
+++ trunk/esb/docs/esb_ref_guide/en-US/reference.xml 2010-05-29 07:06:15 UT=
C (rev 22431)
@@ -0,0 +1,396 @@
+=EF=BB=BF
+
+
+
+
+ JBoss ESB
+ Editor
+ ESB
+
+
+
+ Reference
+ =
+ This chapter includes detailed reference information about JBoss ESB Tools.
+ =
+
+
+ JBoss ESB Editor
+ =
+ ESB editor has lots of useful features, they are described =
in details in this chapter.
+ =
+ ESB File Editor is a powerful and custo=
mizable tool which
+ allows developing an application using ESB technology.
+
+ ESB file editor has two tabs: Tree and Source.
+ =
+
+ Source View
+ =
+ You can easily switch from Tree to Source by selecting t=
he Source tab at the bottom of
+ the editor and work in Source view.
+ =
+
+ Source View
+
+
+
+
+
+
+ =
+ The Source view for the editor displays a text content o=
f the ESB file. It is always
+ synchronized with Tree view, so any c=
hanges made in one of the
+ views will immediately appear in the other.
+ =
+ No matter what view you select, you get full integration=
with Outline
+ view. For example, you can work in the Source v=
iew with the help of the
+ Outline view. The Outline view shows a tree structure of t=
he ESB file. Simply select any
+ element in the Outline view and it wi=
ll jump to the same place in
+ the Source editor, so you can navigate through the source =
code with Outline view.
+
+ Outline View
+
+
+
+
+
+
+ =
+ =
+ =
+
+ Tree View
+ =
+ You can switch to Tree. The Tree view for the editor dis=
plays all ESB artifacts in a
+ tree format. By selecting any node you can see and edit it=
s properties which will appear
+ in the right-hand area. For example, a Provider:
+
+ Tree View
+
+
+
+
+
+
+ =
+ Some properties are represented as links to the associat=
ed editors.
+ =
+
+ Property Link to the Associated Editor
+
+
+
+
+
+
+ Now when editing ESB actions which refer to other files =
(Drools, Groovy, Smooks, etc.),
+ the label for the field turns into a link to launch the ed=
itor associated with that type of file. =
+
+ Property Link to the Associated Editor
+
+
+
+
+
+
+ =
+ Adding, editing or deleting of some artifacts operations=
are available right in the
+ Tree view . Right-click any node and =
select one of the
+ available actions in the context menu. For example, you ca=
n easily add a new Provider:
+
+
+ Adding New Provider
+
+
+
+
+
+
+ Then you can add Channels and Properties for the Provide=
rs the same way or using the forms with Add, 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 o=
ther 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, Ed=
it and
+ Remove buttons.
+ =
+ Filter can be also edited this way
+ =
+
+ Editing Filter
+
+
+
+
+
+
+ =
+ =
+ In order to add a new custom Action to your ESB XML file=
you should select the
+ Actions node under the Services, then right-click and choo=
se
+ New > Custom Action. <=
/para>
+ =
+
+ Adding New Custom Action in the Tree View
+
+
+
+
+
+
+ =
+ Or instead make use of
+ Add...
+ button in the Form editor on =
the left.
+
+ Adding New Custom Action in the Form Editor
+
+
+
+
+
+
+ =
+
+ Note:
+ Some new components are available to support ESB 4.7=
,such as:
+ new actions (XsltAction, PersistAction, BpmProcessor, =
ScriptingAction),
+ new processors (EJBProcessor), new routers (HttpRouter=
, JMSRouter, EmailRouter).
+
+
+ Then you will see Add Action wizard=
. There is a need to specify Action name and Action Java class.
+
+ Add Action Wizard
+
+
+
+
+
+
+ To get a help with finding a proper class you can select=
Browse to open Select =
class dialog.
+
+ Select class dialog
+
+
+
+
+
+
+ Moreover it's possible to type a Process name<=
/property> or select it with Edit Process dialog whi=
ch is called out by clicking Browse.
+
+ Edit Process dialog
+
+
+
+
+
+
+ =
+ As you can see on the both figures above, the context me=
nu will also prompt you to
+ insert one of the Actions that are supplied out-of-the-box=
with JBoss
+ ESB. After choosing one an appeared New Pre-Packed Action wizard
+ will ask you to fill out a name field and other fields spe=
cific for each Action
+ property. For example, for
+ Content Based Router
+ Action the wizard looks as follows:
+ =
+
+ Add Pre-Packed Action Wizard
+
+
+
+
+
+
+ =
+ After confirming creating the Action you can see it in t=
he Tree 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 recognize some speci=
fic objects. On the figure you
+ can see org.jboss.soa.esb.actions.ContentBasedRo=
uter in the
+ Class
+ section.
+ =
+
+ =
+
+
+
+
+ ESB Editor 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 editor yo=
u 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 be=
low.
+ =
+
+
+
+ Support for XML Schema
+
+ JBoss ESB Framework fully s=
upports XML files based on
+ schemas as well as DTDs.
+ The schema checks the child elements of any kind of prov=
ider element; the ESB generates errors on startup if you attempt to define =
an incorrect combination (e.g.: a jms-bus inside an ftp-provider).
+ 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 As=
sist 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
+
+
+
+
+
+
+
+
+ =
+
+ OpenOn for ESB XML File
+ ESB file comes with the OpenOn feature that allows to make use=
of multiple file references in the file just with a click and the
+ Ctrl key hold down.
+ =
+ The OpenOn is implemented for different types of files/pages i=
nside the <action> tag: .xsd, .xml, etc.
+ =
+
+ OpenOn for smooks configuration file
+
+
+
+
+
+
+ =
+ It is also available for classes:
+ =
+
+ OpenOn for classes
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+ =
+ =
+
+
+
Added: trunk/esb/docs/esb_ref_guide/en-US/summary.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-US/summary.xml =
(rev 0)
+++ trunk/esb/docs/esb_ref_guide/en-US/summary.xml 2010-05-29 07:06:15 UTC =
(rev 22431)
@@ -0,0 +1,40 @@
+
+
+
+ Summary
+ =
+ On the whole, this reference supplies you with all necessary inform=
ation on the
+ functionality that JBoss ESB plugin provides for work with JBoss ESB.
+ =
+ We hope, this guide helped you to get started with the JBoss ESB To=
ols. For additional information you are welcome on JBoss forum.
+ =
+
+ Other Relevant Resources on the Topic
+ =
+ You can find a set of benefits and other extra information on:
+
+
+
+ JBoss ESB
+
+
+
+
+ JBoss Wiki
+
+
+
+
+ JBoss ESB
+ Documentation Library
+
+
+
+ =
+ The latest JBoss Tools/JBoss Developer Studio=
documentation
+ builds are available on the JBoss Tools nightly documentation page.
+ =
+
+
\ No newline at end of file
Added: trunk/esb/docs/esb_ref_guide/en-US/tasks.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-US/tasks.xml (r=
ev 0)
+++ trunk/esb/docs/esb_ref_guide/en-US/tasks.xml 2010-05-29 07:06:15 UTC (r=
ev 22431)
@@ -0,0 +1,549 @@
+
+
+
+
+
+ JBoss Developer Studio
+ Eclipse
+ ESB
+ Java
+ JBoss
+
+
+
+ Tasks
+
+ In this section we will focus on all concepts that JBoss Tools
+ integrate for working with JBoss ESB.
+
+
+ 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 project.
+
+ 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 > Project...
+ in the main menu bar or context menu f=
or selected project and
+ then
+ ESB > ESB Project
+ 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
+
+
+
+
+
+
+ By clicking Modify button you can op=
en Project Facets Wizard page,where you can select =
+ facets that should be enabled for this project.
+ On the Project Facets Wizard page =
you can also configure runtime for the application
+
+ Project Facets Wizard
+
+
+
+
+
+
+ Next step provides you an opportunity to configure your p=
roject for building a java application
+ =
+ Clicking
+ Next on this form
+ 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 Supplied 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 th=
at the project has the Target JBoss Runtime set and this runtime has a ESB =
runtime installed. =
+ =
+ 3. Choose ESB Config Vertion. From the version 3.1.0 JBos=
s ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1=
.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd. =
+ Note:
+ If you use ESB 4.7 you should select jbossesb-1.2=
.0.xsd. =
+
+ Install ESB facet step
+
+
+
+
+
+
+ Click
+ Finish
+ and a ESB project with the default jboss-esb.xml =
+ will be created.
+
+
+ The generated ESB project structure
+
+
+
+
+
+
+ =
+
+ =
+
+ Using ESB Project Examples
+ 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 > Others
+ , in the main menu bar or context menu=
for selected project and
+ then
+ JBoss Tools > Project Example=
s
+ in the New dialog:
+
+
+ Select a wizard - Project Examples
+
+
+
+
+
+
+
+ Clicking
+ Next
+ brings you to the wizard page where you can select a ESB p=
roject example from the example list.
+ =
+
+ Project Example Wizard</tit=
le>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref=
=3D"images/esb_project/05a_esb_project_example.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <note>
+ <title>Note:
+ Under the Projects
+ section you can find two categories relate=
d to ESB:
+ =
+
+ ESB=
+ ESB for SO=
A-P 5.0
+
+ =
+ =
+ It means that if you use a runtime pointed t=
o a SOA-P 5.0, you should download the examples from
+ the
+ ESB for SOA-P 5.0
+ category in order to avoid the=
incompatibility errors.
+
+
+ =
+ Every ESB example has two projects, one is a ESB pro=
ject and another is a Java project used to test the ESB project.
+ Here is a list of ready examples available in both c=
ategories (ESB and ESB for SOA-P 5.0):
+ =
+
+ =
+ JBoss ESB =
HelloWorld Example - demonstrates the minimal files necessary to=
make a basic ESB component execute as well as to prove that the ESB is pro=
perly configured.
+ JBoss ESB =
HelloWorld Action Example - demonstrates the use of multiple act=
ion invocations from a single configuration. You can use a single Action cl=
ass and make multiple method calls or use multiple Action classes. <=
/listitem>
+ JBoss ESB =
HelloWorld File Action Example - demonstrates using the File gat=
eway feature of the JBoss ESB. Files that are found in a particular directo=
ry with a particular extension are sent to a JMS queue with actions for pro=
cessing.
+ JBoss ESB =
Web Service consumer1 Example - demonstrates how to consume a 18=
1 Web Service in an ESB action.
+ JBoss ESB =
Web Service producer Example - demonstrates how to deploy a JSR1=
81 Webservice endpoint on JBossESB using the SOAPProcessor action.
+ JBoss ESB =
Smooks CSV -> XML Example - demonstrates how to transform a c=
omma separated value (CSV) file to an XML.
+ JBoss ESB =
Smooks XML -> POJO Example - demonstrates the use of Smooks p=
erforming a simple transformation by converting an XML file into Java POJOs=
.
+ JBoss ESB =
Smooks XML -> XML date-manipulation Example - demonstrates ho=
w to manually define and apply a Message Transformation within JBoss ESB. =
+ JBoss ESB =
Smooks XML -> XML Example - a very basic example of how to ma=
nually define and apply a Message Transformation within JBoss ESB. It appli=
es a very simple XSLT to a SampleOrder.xml message and prints the before an=
d after XML to the console.
+ =
+
+ =
+ =
+
+ We will take as our example JBoss ESB HelloW=
orld Example ESB and Client project:
+ =
+ =
+
+ JBoss Tools ESB Project Examples
+
+
+
+
+
+
+ =
+ =
+ Choose them using the Ctrl button and then click =
+ Finish. As a result 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 you will see how to deploy a ESB pro=
ject using the WTP deployment framework.
+
+ Before deploying the project, open the Servers View =
by selecting Window > Show View > Other > =
+ Server > Servers, =
+ create a JBoss Server in the Server view and start it, and=
then right click the created JBoss server, =
+ select Add and Remove Pro=
jects, =
+ 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.
+ =
+
+ Servers 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 c=
ausing a (re)deploy for a user designated server.
+ You can also use the "Finger touch" for a quick restart o=
f the project without restarting the server:
+
+ Finger Touch button
+
+
+
+
+
+ =
+ The "Finger" touches descriptors dependent on project (i.=
e. web.xml for WAR, application.xml for EAR) and now it is also available f=
or jboss-esb.xml in ESB projects.
+ You can also deploy your ESB project as an .esb arch=
ive. Right-click on the project, choose Export:
+ =
+
+ Export of ESB project
+
+
+
+
+
+ =
+ =
+ Choose ESB > ESB File and click Ne=
xt: =
+ =
+ Choosing ESB File
+
+
+
+
+
+ =
+ =
+ And 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=
.
+ =
+ ESB Export
+
+
+
+
+
+ =
+ =
+ Your project is deployed as an .esb archive.
+ An ESB archive can be created for ESB projects only. It i=
s also possible to deploy an .esb archive to a JBoss AS based server with J=
Boss ESB installed. =
+ =
+ =
+
+ =
+
+ 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 > Other...
+ in the main menu bar or context menu f=
or selected project and
+ then
+ ESB > ESB File
+ 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
+ as the name and accept the selected pr=
ojects folder and the default
+ version.
+ =
+ Note:
+ From the version 3.1.0 JBoss ESB Tools suppor=
ts three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1=
.0.xsd and jbossesb-1.2.0.xsd.
+ If you use ESB 4.7 you should select jbossesb=
-1.2.0.xsd.
+
+
+
+ Folder, Name and Version for ESB file</titl=
e>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref=3D"images/esb_s=
upport/02_create_esb.png"/>
+ </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>Browse...</property>
+ </emphasis> button to set needed folder or simply =
type it.</para>
+
+ <para>Clicking on <emphasis>
+ <property>Finish</property>
+ </emphasis> results in the file being generated. T=
he wizard creates one xml
+ file.</para>
+
+ </section>
+ <section id=3D"creating_esb_action">
+ <title>Creating a ESB Action
+ From this chapter you will find out how to create a=
ESB Action Java File.
+ At first you need to open a ESB=
or simple Java project. Then you should select File > New>Other in the main menu or fr=
om the context project menu. Then click ESB > ESB Acti=
on in the New dialog.
+
+ Select a wizard - ESB Action
+
+
+
+
+ =
+
+
+ After that click Next=
and you will be brought to the New ESB Acti=
on wizard. In this wizard the class name should be sp=
ecified, also you can set a package or add a interface as for any Java clas=
s.
+
+ New ESB Action wizard
+
+
+
+
+ =
+
+
+ As a result, the ESB Action Java File will be created in the selected package and it will have o=
rg.jboss.soa.esb.actions.AbstractActionPipelineProcessor as supe=
rclass.
+ Clicking on Finish will generate the ESB Action class. Also this=
class will become available in ESB Editor wizards.
+
+ =
+
+ 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 >Preferences > JBos=
s 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 location, n=
ame and version number. It's also possible to define configuration if you p=
oint the home location to a Jboss AS or SOA-p, in case you select a standal=
one ESB runtime location, the configuration combo will be empty and should =
be ignored. =
+ You can also customize the libraries of the runti=
me by checking the Customize JBoss ESB Runtime jars checkbox.
+ =
+
+ Configure new JBoss ESB Runtime
+
+
+
+
+
+
+
+ The new JBoss ESB Runtime will be configured. Click <=
property>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 Propertie=
s and a table listing all available JBoss ESB runtime=
s 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) containing 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 an=
d then on Ok.
+ To change Javadoc Location choose Javad=
oc Location and specify URL to the documentation gene=
rated by Javadoc. The Javadoc location will contain a file called package-list:
+ =
+
+ Classpath Container: Javadoc Location</tit=
le>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref=3D"images/esb_=
project/22_Javadoc.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on <emphasis><property>Apply</property></emph=
asis> and then on <emphasis><property>Ok</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 Environments, that will open the Server Run=
time Environments Preferences page where you can add, remove and edit a Ser=
ver Runtime Environment.
+ =
+
+ Configure new Server Runtime Environment</t=
itle>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref=3D"images/esb_p=
roject/13NewServerRuntimeEnv.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ =
+ <para>Select <emphasis><property>Add</property></emphasis>=
, choose <emphasis><property>JBoss 4.2 Runtime</property></emphasis> as a t=
ype of runtime environment, check the <emphasis><property>Create a new loca=
l server</property></emphasis> checkbox and click <emphasis><property>Next<=
/property></emphasis>:</para> =
+ <figure>
+ <title>Type of Server Runtime Environment
+
+
+
+
+
+
+ =
+ On the next step you can specify a name of the serve=
r 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"/>
+ </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"/>. As a result you will have two projects cre=
ated:</para>
+ =
+ <figure>
+ <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 Build Path > Add =
Libraries:
+ =
+
+ Add Libraries
+
+
+
+
+
+
+ =
+ Choose JBoss ESB Libraries 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.
+ =
+ =
+ =
+
+ =
+ =
+ =
+ =
+ =
+ =
+ =
+ =
+ =
+ =
+
\ No newline at end of file
--===============0031790064374112786==--