From jbosstools-commits at lists.jboss.org Wed Mar 11 12:04:53 2009
Content-Type: multipart/mixed; boundary="===============4170970672792194128=="
MIME-Version: 1.0
From: jbosstools-commits at lists.jboss.org
To: jbosstools-commits at lists.jboss.org
Subject: [jbosstools-commits] JBoss Tools SVN: r14171 - in trunk:
documentation/guides/Exadel-migration/en and 11 other directories.
Date: Wed, 11 Mar 2009 12:04:53 -0400
Message-ID:
--===============4170970672792194128==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: smukhina
Date: 2009-03-11 12:04:53 -0400 (Wed, 11 Mar 2009)
New Revision: 14171
Modified:
trunk/as/docs/reference/en/master_output.xml
trunk/documentation/guides/Exadel-migration/en/master_output.xml
trunk/documentation/guides/GettingStartedGuide/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/reference/en/master_output.xml
trunk/jsf/docs/jsf_tools_ref_guide/en/master_output.xml
trunk/jsf/docs/jsf_tools_tutorial/en/master_output.xml
trunk/jsf/docs/userguide/en/master_output.xml
trunk/seam/docs/reference/en/master_output.xml
trunk/struts/docs/struts_tools_ref_guide/en/master_output.xml
trunk/struts/docs/struts_tools_tutorial/en/master_output.xml
trunk/ws/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 updated master_output files f=
or all release guides are added =
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-03-11 14:34:56 UTC (r=
ev 14170)
+++ trunk/as/docs/reference/en/master_output.xml 2009-03-11 16:04:53 UTC (r=
ev 14171)
@@ -22,2039 +22,2035 @@
=
=
=
-]>
- =
-
- 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,
- publish
- to the server,
- clean
- 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
-
-
-
-
-
-
-
- You can deploy an existing application to a server by right-clic=
king the target defined
- server in the JBoss Servers View and then selecting Add and
- Remove Projects from the context menu.
-
-
- 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
-
-
-
-
-
-
-
- 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.
-
-
-
-
- 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.
-
-
-
-
-
-
- =
-
-
-
-
- JBoss Developer Studio
- Eclipse
- Deploy
- Deployment
- JBoss
-
-
-
- JBoss AS Perspective
-
- This chapter tells how to manage installed JBoss Server via
- JBoss AS perspective.=
para>
-
- 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 there is a
- special toolbar which provides a quick access to starting =
a server (in debug mode,
- run mode, or profile mode), restarting a server, stopping =
a server, publishing to a
- server and a possibility to clean 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.
-
-
- Press
- Clean
- if you need to clean projects published on the=
server, i.e. remove
- invalid resources from the server.
-
-
-
- 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=
para>
-
-
-
-
-
- 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 synching the publish =
information between the
- server and workspace
-
-
-
-
-
- Clean
-
-
- The option for complete redeploying =
the resources
-
-
-
-
-
- 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,=
emphasis> 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 a xpath is a pat=
h 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>, 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 deployable 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 reso=
urce 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 figure you can see that a username/password i=
s available in the UI when
- configuring the server. If you get an SecurityExceptio=
n when trying to launch
- the server, it is most likely because your server is p=
rotected and hence you
- need to fill the username/password fields with appropr=
iate values.
-
-
- 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 fo=
r setting command line
- arguments and other things that are relevant to launching =
the server.
-
-
- Launch Configuration Properties
-
-
-
-
-
-
-
- Look up here to find parameters=
which can be specified for JBoss
- Server.
-
-
-
- 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.=
para>
-
- 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=
property> 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 create a Fileset with flattenning or without=
it. Look at the
- difference on the figure below.
-
-
- The FileSet with flattenning and without it
-
-
-
-
-
-
-
-
-
-
-
- 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.
-
-
- Relevant Resources Links
- Refer to Ant manual
- to find more on how to build your applications with help o=
f Ant.
-
- We also recommend you to watch the movie wh=
ich demonstrates a powerful archiving functionality in
- JBoss Tools.
-
- At this point, you are guessed to be familiar with JBoss AS
- perspective and your next step now is to ex=
plore how to work with
- different kinds of projects.
-
-
-
-
-
-
-
- =
-
- Projects
- The most popular of the projects we deal with are the J2EE ones, su=
ch as Dynamic Web
- Project, EJB Project, or EAR project. Web projects of JBoss Tools are
- Struts, JSF and Seam projects. All of them are called faceted projects. =
Thus, in this
- chapter we are going to tell you about facets the main benefit of which =
to provide proper
- structuring and packaging for any type of project.
-
-
- Faceted Projects Overview
- The idea behind faceted projects is that each project can accept u=
nits of
- functionality, or facets, which can be added or removed by the user. Mo=
st often, these
- facets either add to the project's classpath, enable a builder, or watc=
h the project in
- some other fashion. Generally, every project concerned has at least one=
facet when
- it's created. As an example, a Web project has a WebDoclet facet, or an=
EJB
- Project has an EJB Module facet as prerequisites.
-
- WTP projects have undergone some criticism as being
- over-engineered or too restrictive in their design=
. WTP projects
- are set up in a tree-relationship to each other, where one project can =
be a child of
- another. For example, an EAR project may have a Web Project child, an E=
JB project child,
- or other types.
-
- However, the benefit of this is that the structure of your projec=
ts is then known,
- and packaging it up *should* be trivial. Apparently, if your project is=
non-standard, or
- you feel too confined by such rigid structural requirements, you can st=
ill choose to
- package your project using the A=
rchives
- plugin.
-
-
-
-
- Adding Facets to a Project
-
- In this section we're going to consider the facets added by JBoss
- Tools and show how you can configure them in a project: add=
new ones or
- modify already existing configuration of the facets.
-
- One way to configure the facets is doing it while organizing a new=
project. To
- demonstrate this let's create a new Dynamic=
Web Project by
- selecting
- File > New > Other...
- and then
- Web > Dynamic Web Project. <=
/emphasis>
-
- New Dynamic Web Project
-
-
-
-
-
-
- Click
- Next
- and you will see Dynamic Web Project page like on the figur=
e below.
-
- The first page of most WTP projects allows you to target a specif=
ic runtime,
- representing a server's library location. It will also provide you the =
ability to add
- this project to an EAR project, and select a pre-selected default set o=
f facets, called
- a configuration, rather than manually select each facet you might want.=
- Selecting the runtime, again, allows the project to install the p=
roper classpaths to
- the project so it knows what code to compile against.
-
-
- New Dynamic Web Project
-
-
-
-
-
-
- Click on the
- Modify
- button next to Configuration section in order to open
- the wizard which allows you to modify a chosen configuration. The wizar=
d looks as
- follows.
-
-
- Project Facets Wizard
-
-
-
-
-
-
-
- Here part of the listed facets are those which are provided by WTP=
. Some of them are
- added by JBoss Tools. They are:<=
/para>
-
-
- BIRT Charting Runtime Component
-
-
- BIRT Reporting Runtime Component
-
-
- JBoss ESB
-
-
- JBoss Portlets
-
-
- JBoss Web Services
-
-
- Seam
-
-
-
- On this wizard page you can enable or disable any facet as well as=
change it version.
- What you should note here is that some facets or facets versions may co=
nflict with each
- other. In case of incompatibility you'll be prompted about this in the =
combo
- box underneath.
-
- Facet Constraints
-
-
-
-
-
-
- When switching on the
- Runtimes
- tab on the right you'll see the 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 signal file. Let's look at how to do this.
-
- Deploying with Run On Server Wizard
- The first WTP method is to right-click on a project, such as a D=
ynamic Web
- project, EJB project, or EAR project and then select
- Run As > Run on Server
- . The resulting dialog allows you to select which supportin=
g server the
- project can be published to.
-
- Define a New Server
-
-
-
-
-
-
- Click
- Next
- button to see add or remove projects page where you can ch=
oose projects
- to configure them on server.
-
- Add or Remove Projects
-
-
-
-
-
-
- This page of the wizard also allows to undeploy modules from the =
server. For that
- choose proper module(s) from the right and click
- < Remove
- . The modules will be completely undeployed after restartin=
g your server
- or republishing.
- Generally, for the JBoss AS Server Adapters, publishing using thi=
s method will
- force a default, best-guess, packaging configuration for your project.=
This
- best-guess does not publish incrementally, but instead repackages your=
entire
- project into a
- .war
- ,
- .jar
- , or
- .ear
- as appropriate, and then copies that file into the proper =
deploy
- directory. For quicker smarter deployment, you will need to create arc=
hives using
- the Project Archives view and customize
- packaging yourself.
-
-
-
-
- Deploying single files
-
- Sometimes it becomes necessary to deploy one or more files to a s=
erver. For
- that in order not to do a full republish in the context menu of files =
a Deploy To Server
- option is provided that allows a single file deployment. To deploy the=
se non-WTP files/projects
- right click on the file (
- -ds.xml,
- .ear,
- .jar etc.) and se=
lect
- Deploy To Server
- and it will be automatically deployed.
-
- Deploy to Sever
-
-
-
-
-
-
- The deployed files are listed side-by-side with other modules tha=
t are deployed to
- the server.
- =
-
- Deployed files on the Server
-
-
-
-
-
-
-
-
-
-
-
- Deploying with JBoss Server View
- As it has been already mentioned JBoss=
Server View contains two
- parts: the top part that displays all defined servers and the bottom pa=
rt which provides
- categories with additional information. Thus, in this section we sugges=
t two more ways
- to deploy resources onto the server.
-
- Top part of JBoss Server View
- In the top part of the JBoss Servers =
View like in the Servers
- View you should right click on a server and select the
- Add and Remove Projects
- menu item.
-
- Add and Remove Projects
-
-
-
-
-
-
-
- This will bring up a familiar dial=
og allowing
- you to either publish projects or modules to a server, or remove them =
from the
- server. If the selected module is a project like a Dynamic Web project=
, EJB project,
- or EAR project, it will be published as through
- Run on Server
- wizard, with a best-guess full package. If, however, the s=
elected
- element is an archive from the =
Project Archives
- view, it will be published according to the rules of that modu=
le
- type.
-
-
-
- Bottom part of JBoss Server View
- In the bottom part of
- JBoss Server View
- there is a category called
- Modules
- which should display all currently-published modules on th=
e server.
- Right-clicking on the desired module and selecting
- Full Publish
- will force a full rebuild of the entire module.
-
- Full Publish
-
-
-
-
-
-
-
- Here,
- Incremental Publish
- is meant to enable publishing of only those parts where ch=
anges have
- been made.
-
-
-
- Deploying with Project Archives View
- In the Project Archives View you can right-click on any declared
- archive and select the
- Publish To Server
- element. For more on this subject, see Publishing to Server in the Project Archives View sect=
ion.
-
- Publish to Server
-
-
-
-
-
-
- The only way to ensure an
- Incremental Build
- , such as changes to one
- .jsp,
-
- .html, or
- .class
- file, is to enable the builder for that project. This is do=
ne by either
- changing the global preferences for the Arc=
hives View, or by
- enabling project-specific preferences and ensuring the builder is on.=
para>
- 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,
+ publish
+ to the server,
+ clean
+ 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
+
+
+
+
+
+
+
+ You can deploy an existing application to a server by right-clic=
king the target defined
+ server in the JBoss Servers View and then selecting Add and
+ Remove Projects from the context menu.
+
+
+ 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
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+ 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 necess=
ary to mention that the JBoss AS plugin makes 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 Ru=
ntime
+ You can install runtimes into eclipse from the
+ Window > Preferences
+ menu, and then select
+ Server > Runtime Environments
+ from the cat=
egories available on the left.
+
+ Installed Runtimes
+
+
+
+
+
+
+ From this preference=
page you can see all declared runtimes and 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 cho=
ose 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) an=
d product server that comes with JBoss EAP in JBDS ( the <=
emphasis diffmk:change=3D"added">
+ JBoss Enterprise Middleware<=
/property>
+ category).=
diffmk:wrapper>
+
+
+ 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 havin=
g each runtime represent a specific configuration 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 a=
re often backed by a runtime object representing that server's
+ location.
+
+
+ Creating a New Server
+
+ There are many ways to get to the new server wizard. One way 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 alr=
eady declared runtimes in the combo box below the view it's
+ possible to select which runtime you want your server to be backed=
by. If there is no
+ runtime that matches your needs just press the
+ Add...
+ link nearby to=
bring up the wizard for creating a new runtime (see the <=
link diffmk:change=3D"added" linkend=3D"add_runtime_figure">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 wa=
nt to create doesn't have any installed runtime yet, the combo box
+ and the links are absent.
+
+
+ Installed Server Runtime Environments
+
+
+
+
+
+
+
+ In this case the next page in the wizard which has the same fo=
rm as in the previous section w=
ill ask you to create the
+ associated runtime.
+ Either way, after targeting your server to a runtime, the fina=
l screen in this wizard is
+ largely confirmational, giving you a chance to verify that you've =
selected the
+ appropriate runtime. It also allows to name the server appropriate=
ly.
+
+
+ Installed Server Runtime Environments
+
+
+
+
+
+
+
+ Press
+ Finish
+ to complete the process of the server creation.
+ Now that we've created our runtimes and servers, we can dwell =
on all services
+ and tools that JBoss Server Manager provides.
+
+
+
+
+
+
+ =
+
+
+
+
+ JBoss Developer Studio
+ Eclipse
+ Deploy
+ Deployment
+ JBoss
+
+
+
+ JBoss AS Perspective
+
+ This chapter tells how to manage installed JBoss Server via
+ JBoss AS perspective.=
para>
+
+ 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 there is a
+ special toolbar which provides a quick access to starting =
a server (in debug mode,
+ run mode, or profile mode), restarting a server, stopping =
a server, publishing to a
+ server and a possibility to clean 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.
+
+
+ Press
+ Clean
+ if you need to clean projects published on the=
server, i.e. remove
+ invalid resources from the server.
+
+
+
+ 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 M=
enu 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=
para>
+
+
+
+
+
+ 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 synching the publish =
information between the
+ server and workspace
+
+
+
+
+
+ Clean
+
+
+ The option for complete redeploying =
the resources
+
+
+
+
+
+ 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 Remo=
ve 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 monitored on the current
+ server
+
+
+
+
+
+ Properties
+
+
+ Opens the window to adjust the current 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
+ ca=
tegory in the JBoss Server View is intended
+ for files filtering.
+
+ To add a new file filter, right-click the
+ Filesets
+ ca=
tegory 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 a=
nd 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 expanding th=
e
+ Filesets
+ ca=
tegory in the JBoss Server View.
+
+ It's possible now to edit files directly from the
+ Filesets
+ =
category. Double clicking on a file from
+ Filesets
+ op=
ens up the editor automatically or you can use the
+ Edit File
+ =
context menu command.
+
+
+ Direc=
t 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
+ ca=
tegory allows you to quickly browse to descriptor files in your
+ server's deploy directory and check or change the valu=
es. Basically,
+ XML Configuration
+ in=
cludes XML XPaths where a xpath is a path used to access some
+ specific part of an xml document.
+
+
+ Note:
+ You are assumed to be familiar with XPath. If not, we highl=
y 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 Server.
+
+
+ XML Configuration
+
+
+
+
+
+
+
+
+ =
+
+ By right-clicking on
+ XML Configuration, you can creat=
e a new
+ category. Besides, context menu for <=
emphasis>
+ 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 h=
ere is to get an end result where the XPath 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 &l=
t;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 t=
he other hand, if your desired field is the text of an element
+ <description>, 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 deployable 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=
property>
+ will do the same and show the corresponding page in a
+ browser
+
+
+
+ dragging a deployable resource (i.e. a datasource (
+ -ds.xml) file that has
+ been made deployable) will simply deploy that reso=
urce 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 monito=
r the current server behavior with the help 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
+ show=
s relevant information to your server's startup, 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 toolbar 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 figure you can see that a username/password i=
s available in the UI when
+ configuring the server. If you get an SecurityExceptio=
n when trying to launch
+ the server, it is most likely because your server is p=
rotected and hence you
+ need to fill the username/password fields with appropr=
iate values.
+
+
+ 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 fo=
r setting command line
+ arguments and other things that are relevant to launching =
the server.
+
+
+ Launch Configuration Properties
+
+
+
+
+
+
+
+ Look up here to find parameters=
which can be specified for JBoss
+ Server.
+
+
+
+ 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.=
para>
+
+ 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=
property> 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 create a Fileset with flattenning or without=
it. Look at the
+ difference on the figure below.
+
+
+ The FileSet with flattenning and without it
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+ Relevant Resources Links
+ Refer to Ant manual
+ to find more on how to build your applications with help o=
f Ant.
+
+ We also recommend you to watch the movie wh=
ich demonstrates a powerful archiving functionality in
+ JBoss Tools.
+
+ At this point, you are guessed to be familiar with JBoss AS
+ perspective and your next step now is to ex=
plore how to work with
+ different kinds of projects.
+
+
+
+
+
+
+
+ =
+
+ Projects
+ The most popular of the projects we deal with are the J2EE ones, su=
ch as Dynamic Web
+ Project, EJB Project, or EAR project. Web projects of JBoss Tools are
+ Struts, JSF and Seam projects. All of them are called faceted projects. =
Thus, in this
+ chapter we are going to tell you about facets the main benefit of which =
to provide proper
+ structuring and packaging for any type of project.
+
+
+ Faceted Projects Overview
+ The idea behind faceted projects is that each project can accept u=
nits of
+ functionality, or facets, which can be added or removed by the user. Mo=
st often, these
+ facets either add to the project's classpath, enable a builder, or watc=
h the project in
+ some other fashion. Generally, every project concerned has at least one=
facet when
+ it's created. As an example, a Web project has a WebDoclet facet, or an=
EJB
+ Project has an EJB Module facet as prerequisites.
+
+ WTP projects have undergone some criticism as being
+ over-engineered or too restrictive in their design=
. WTP projects
+ are set up in a tree-relationship to each other, where one project can =
be a child of
+ another. For example, an EAR project may have a Web Project child, an E=
JB project child,
+ or other types.
+
+ However, the benefit of this is that the structure of your projec=
ts is then known,
+ and packaging it up *should* be trivial. Apparently, if your project is=
non-standard, or
+ you feel too confined by such rigid structural requirements, you can st=
ill choose to
+ package your project using the A=
rchives
+ plugin.
+
+
+
+
+ Adding Facets to a Project
+
+ In this section we're going to consider the facets added by JBoss
+ Tools and show how you can configure them in a project: add=
new ones or
+ modify already existing configuration of the facets.
+
+ One way to configure the facets is doing it while organizing a new=
project. To
+ demonstrate this let's create a new Dynamic=
Web Project by
+ selecting
+ File > New > Other...
+ and then
+ Web > Dynamic Web Project. <=
/emphasis>
+
+ New Dynamic Web Project
+
+
+
+
+
+
+ Click
+ Next
+ and you will see Dynamic Web Project page like on the figur=
e below.
+
+ The first page of most WTP projects allows you to target a specif=
ic runtime,
+ representing a server's library location. It will also provide you the =
ability to add
+ this project to an EAR project, and select a pre-selected default set o=
f facets, called
+ a configuration, rather than manually select each facet you might want.=
+ Selecting the runtime, again, allows the project to install the p=
roper classpaths to
+ the project so it knows what code to compile against.
+
+
+ New Dynamic Web Project
+
+
+
+
+
+
+ Click on the
+ Modify
+ button next to Configuration section in order to open
+ the wizard which allows you to modify a chosen configuration. The wizar=
d looks as
+ follows.
+
+
+ Project Facets Wizard
+
+
+
+
+
+
+
+ Here part of the listed facets are those which are provided by WTP=
. Some of them are
+ added by JBoss Tools. They are:<=
/para>
+
+
+ BIRT Charting Runtime Component
+
+
+ BIRT Reporting Runtime Component
+
+
+ JBoss ESB
+
+
+ JBoss Portlets
+
+
+ JBoss Web Services
+
+
+ Seam
+
+
+
+ On this wizard page you can enable or disable any facet as well as=
change it version.
+ What you should note here is that some facets or facets versions may co=
nflict with each
+ other. In case of incompatibility you'll be prompted about this in the =
combo
+ box underneath.
+
+ Facet Constraints
+
+
+
+
+
+
+ When switching on the
+ Runtimes
+ tab on the right =
you'll see the 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 signal file. Let's look at how to do this.
+
+ Deploying with Run On Server Wizard
+ The first WTP method is to right-click on a project, such as a D=
ynamic Web
+ project, EJB project, or EAR project and then select
+ Run As > Run on Server
+ . The resulting dialog allows you to select which supportin=
g server the
+ project can be published to.
+
+ Define a New Server
+
+
+
+
+
+
+ Click
+ Next
+ button to see add or remove projects page where you can ch=
oose projects
+ to configure them on server.
+
+ Add or Remove Projects
+
+
+
+
+
+
+ This page of the wizard also allows to undeploy modules from the =
server. For that
+ choose proper module(s) from the right and click
+ < Remove
+ . The modules will be completely undeployed after restartin=
g your server
+ or republishing.
+ Generally, for the JBoss AS Server Adapters, publishing using thi=
s method will
+ force a default, best-guess, packaging configuration for your project.=
This
+ best-guess does not publish incrementally, but instead repackages your=
entire
+ project into a
+ .war
+ ,
+ .jar
+ , or
+ .ear
+ as appropriate, and then copies that file into the proper =
deploy
+ directory. For quicker smarter deployment, you will need to create arc=
hives using
+ the Project Archives view and customize
+ packaging yourself.
+
+
+
+
+ Deploying single files
+
+ Sometimes it becomes necessary to deploy one or more files to a s=
erver. For
+ that in order not to do a full republish in the context menu of files =
a Deploy To Server
+ option is provided that allows a single file deployment. To deploy the=
se non-WTP files/projects
+ right click on the file (
+ -ds.xml,
+ .ear,
+ .jar etc.) and se=
lect
+ Deploy To Server
+ and it will be automatically deployed.
+
+ Deploy to Sever
+
+
+
+
+
+
+ The deployed files are listed side-by-side with other modules tha=
t are deployed to
+ the server.
+ =
+
+ Deployed files on the Server
+
+
+
+
+
+
+
+
+
+
+
+ Deploying with JBoss Server View
+ As it has been already mentioned JBoss=
Server View contains two
+ parts: the top part that displays all defined servers and the bottom pa=
rt which provides
+ categories with additional information. Thus, in this section we sugges=
t two more ways
+ to deploy resources onto the server.
+
+ Top part of JBoss Server View
+ In the top part of the JBoss Servers =
View like in the Servers
+ View you should right click on a server and select the
+ Add and Remove Projects
+ menu item.
+
+ Add and Remove Projects
+
+
+
+
+
+
+
+ This will bring up a familiar dial=
og allowing
+ you to either publish projects or modules to a server, or remove them =
from the
+ server. If the selected module is a project like a Dynamic Web project=
, EJB project,
+ or EAR project, it will be published as through
+ Run on Server
+ wizard, with a best-guess full package. If, however, the s=
elected
+ element is an archive from the =
Project Archives
+ view, it will be published according to the rules of that modu=
le
+ type.
+
+
+
+ Bottom part of JBoss Server View
+ In the bottom part of
+ JBoss Server View
+ there is a category called
+ Modules
+ which should display all currently-published modules on th=
e server.
+ Right-clicking on the desired module and selecting
+ Full Publish
+ will force a full rebuild of the entire module.
+
+ Full Publish
+
+
+
+
+
+
+
+ Here,
+ Incremental Publish
+ is meant to enable publishing of only those parts where ch=
anges have
+ been made.
+
+
+
+ Deploying with Project Archives View
+ In the Project Archives View you can right-click on any declared
+ archive and select the
+ Publish To Server
+ element. For more on this subject, see Publishing to Server in the Project Archives View sect=
ion.
+
+ Publish to Server
+
+
+
+
+
+
+ The only way to ensure an
+ Incremental Build
+ , such as changes to one
+ .jsp,
+
+ .html, or
+ .class
+ file, is to enable the builder for that project. This is do=
ne by either
+ changing the global preferences for the Arc=
hives View, or by
+ enabling project-specific preferences and ensuring the builder is on.=
para>
+ 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=
3-11 14:34:56 UTC (rev 14170)
+++ trunk/documentation/guides/Exadel-migration/en/master_output.xml 2009-0=
3-11 16:04:53 UTC (rev 14171)
@@ -27,12 +27,12 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a div=
ision of Red Hat
-
+
Version: 2.0.0.GA
-
+
=
Modified: trunk/documentation/guides/GettingStartedGuide/en/master_output.x=
ml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=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/en/master_output.xml 200=
9-03-11 14:34:56 UTC (rev 14170)
+++ trunk/documentation/guides/GettingStartedGuide/en/master_output.xml 200=
9-03-11 16:04:53 UTC (rev 14171)
@@ -26,17 +26,16 @@
=
=
=
-]>
-
+]>Getting Started with JBoss Developer StudioApril 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009=
year>
+ JBoss, a division of =
Red Hat
- Version: 2.0.0.GA
+ Version: 2.0.0.GA=
@@ -509,8 +508,8 @@
Get Eclipse and Web Tools
- The current version of JBoss Tools (3.0.0.GA) targets at Eclipse =
3.4.2/Ganymede SR2 and WTP
- 3.0.3+
+ The current version of =
JBoss Tools (3.0.0.GA) targets at Eclipse 3.4.2/Ganymede SR2 and WTP
+ 3.0.3+
=
Tip:
@@ -725,9 +724,9 @@
AS from JBoss Developer=
Studio.JBoss Developer Studio sh=
ips with JBoss EAP
v.4.2 bundled. When you followed the default instal=
lation of JBoss
- Developer Studio, you should already have a JBoss E=
AP 4.3 Server installed and
+ Developer Studio, you should already have a JBoss EAP 4.3 Server installed and
defined. To run JBoss AS you need JDK 1.5, JDK 6 is not formally s=
upported yet, although
- you may be able to start the server with it.
+ you may be able to start the server with it.
=
@@ -741,9 +740,9 @@
Starting JBoss ServerStarting JBoss Server is quite simple. JBoss
- Developer Studio allows you to control its =
behaviour with the help of
+ Developer Studio allows you to control its behaviour with the help of
a special toolbar, where you could start it in a regular o=
r debug mode, stop it or
- restart it.
+ restart it.
=
@@ -779,8 +778,8 @@
When the server is started you should see Started
- in the square brackets right next its name in =
JBoss Server
- View.
+ in t=
he square brackets right next its name in JBoss Server
+ View.
=
Server is Started
@@ -807,9 +806,9 @@
Stopping JBoss ServerTo stop the server, click the Stop
- icon in JBoss Serv=
er View or right click the server
+ icon in JBoss Server View or right click the server
name and press
- Stop.
+ Stop.
=
Stopping Server
@@ -821,7 +820,7 @@
When the server is stopped you will see Stopped
- in the square brackets next to its name.
+ in t=
he square brackets next to its name.
@@ -852,14 +851,14 @@
JBoss EAP 4.2 we do=
not ultimately tie you to any particular
server for deployment. There are some servers that Studio supp=
orts directly (via the
bundled Eclipse WTP plug-ins). In this section we discuss how =
to manage self-installed
- JBoss AS. Suppose you want to deploy the application to JBoss 4.2.3
- server. First of all you need to install it.
+ JBoss AS. Suppose you want to deploy the application to JBoss 4.2.3
+ server. First of all you need =
to install it.
JBoss AS Installation
- Download the binary package of JBoss 4.2.3 and save
+ Download the binary package of JBoss 4.2.3 and save
it on your computer: http://labs.jboss.com/jbossas/downloads=
para>
@@ -877,24 +876,24 @@
range.
- After you have the binary archive you want to in=
stall, use the JDK jar
+ After =
you have the binary archive you want to install, use the JDK jar
tool (or any other ZIP extraction tool) to extract=
the jboss-4.2.3.GA.zip
archive contents into a location of your choice. T=
he jboss-4.2.3.GA.tgz
archive is a gzipped tar file that requires a gnut=
ar compatible tar which
can handle the long pathnames in the archive. The =
extraction process will
- create a jboss-4.2.3.GA directory.
+ create a jboss-4.2.3.GA directory.
=
- Adding and Configuring JBoss Server
+ Adding and Co=
nfiguring JBoss ServerNow we should add just installed server into server mana=
ger in JBoss
Developer Studio.
- Open the JBoss Serve=
r View by selecting
+ Open the=
JBoss Server View by selecting Window > Show V=
iew > Other > Server
> JBoss Server View
@@ -906,7 +905,7 @@
Select
- JBoss Community &g=
t; JBoss 4.2 Server
+ JBoss Community > JBoss 4.2 Server
@@ -919,21 +918,21 @@
=
-
- Note:
+
+ Note:
=
- Now in the New Server wi=
zard there is a separation
- between the .org servers (the
- JBoss Community
- category) and product server that comes bu=
ndled with JBoss EAP (the
-
- JBoss Enterprise Middl=
eware category).
+ Now in the=
New Server wizard there is a separation
+ between the .org servers (the
+ JBoss Community<=
/property>
+ ca=
tegory) and product server that comes bundled with JBoss EAP (the
+
+ JBoss Enterprise Middleware c=
ategory).
=
- To create a new runtime, which Jboss AS 4.2 matc=
hes to, click
- Next
+ To cre=
ate a new runtime, which Jboss AS 4.2 matches to, click
+ Next
@@ -961,8 +960,8 @@
=
- In the next dialog verify the specified informat=
ion and if something is
- unfair go back and correct it
+ In the n=
ext dialog verify the specified information and if something is
+ unfair go back and correct it
@@ -3637,7 +3636,7 @@
=
=
=
-
+
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-03-11 14:34:56 U=
TC (rev 14170)
+++ trunk/esb/docs/esb_ref_guide/en/master_output.xml 2009-03-11 16:04:53 U=
TC (rev 14171)
@@ -18,874 +18,874 @@
=
=
-]>
- =
-
- ESB Tools Reference Guide
- SvetlanaMukhina<=
email>smukhina(a)exadel.com =
- TatyanaRomanovich =
- =
- April 2008
-
- 2007
- 2009
- JBoss, a division of Red Hat
-
-
- Version: 1.1.0.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 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 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 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.=
listitem>
- 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 simpe 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.=
para> =
- 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 HelloWorld Example ESB and Client projec=
t:
- =
- =
-
- 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 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=
property> 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. =
- The Run<=
/emphasis> and Debug options work on ESB projects causing a (re)deploy for a user designat=
ed 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 Next: =
- =
- 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 &=
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
-
-
-
-
-
-
-
- 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
- Browse...
- button to set needed folder or simply =
type it.
-
- Clicking on
- Finish
- results in the file being generated. T=
he wizard creates one xml
- file.
-
-
- =
-
- 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
-
-
-
-
-
-
- Click on Appl=
y and then on O=
k.
- =
-
-
-
- =
- 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
-
-
-
-
-
-
- =
- Select Add, choose JBoss 4.2 =
Runtime as a type of runtime environment, check the <=
emphasis>Create a new local server=
emphasis> checkbox and click Next: =
-
- 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
-
-
-
-
-
-
- Now you have your SOA platform configured. To check =
the configuration create a ESB Project using instructions described . As a result you will have two projec=
ts created:
- =
-
- 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 t=
he same way or using the forms with Add, Edit and
- Remove buttons to the r=
ight.
-
- 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, this reference supplies you with all necessa=
ry information on the
- functionality that JBoss ESB Editor provides for work with=
JBoss ESB.
-
-
-
- =
-
-
+]>
+ =
+
+ ESB Tools Reference Guide
+ SvetlanaMukhina<=
email>smukhina(a)exadel.com =
+ TatyanaRomanovich =
+ =
+ April 2008
+
+ 2007
+ 2009
+ JBoss, a div=
ision of Red Hat
+
+
+ Version: 1.1.0.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 simpe transformation by converting an XML fi=
le 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 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=
property> 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:
+
+ 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 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:
+ =
+
+ Export of ESB project
+
+
+
+
+
+ =
+ =
+ Ch=
oose ES=
B > ESB File and click Next: =
+ =
+ Choosing ESB File
+
+
+
+
+
+ =
+ =
+ 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.
+ =
+ ESB Export
+
+
+
+
+
+ =
+ =
+ 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
+
+
+
+
+
+
+
+ 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
+ Browse...
+ button to set needed folder or simply =
type it.
+
+ Clicking on
+ Finish
+ results in the file being generated. T=
he wizard creates one xml
+ file.
+
+
+ =
+
+ 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
+
+
+
+
+
+
+ Click on Appl=
y and then on O=
k.
+ =
+
+
+
+ =
+ 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
+
+
+
+
+
+
+ =
+ Select Add, choose JBoss 4.2 =
Runtime as a type of runtime environment, check the <=
emphasis>Create a new local server=
emphasis> checkbox and click Next: =
+
+ 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
+
+
+
+
+
+
+ Now you have your SOA platform configured. To check =
the configuration create a ESB Project using instructions described . As a result you will have two projec=
ts created:
+ =
+
+ 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 <=
diffmk:wrapper diffmk:change=3D"changed">supports XML files based on
+ schemas as well as DTDs.
+ <=
diffmk:wrapper diffmk:change=3D"added">Note:
+ The schema used behind ESB editor now uses the latest version a=
vailable (from SOA-P 4.3). This removes the errors/warnings some users have=
reported seeing when using SOA-P specific esb.xml files.<=
/para>
+ =
+
+
+
+
+
+
+ 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.
+
+
+
+ =
+
+
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-03-11 14:=
34:56 UTC (rev 14170)
+++ trunk/hibernatetools/docs/reference/en/master_output.xml 2009-03-11 16:=
04:53 UTC (rev 14171)
@@ -34,13 +34,13 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a division =
of Red Hat
=
-
+
Version: 3.2.4.GA
-
+
=
=
@@ -405,7 +405,7 @@
=
=
-
+Eclipse Plugins
=
This chapter will introduce you to the functionality that Hibernate
@@ -1024,7 +1024,7 @@
=
-
+ Reverse Engineering and Code Generation
=
A "click-and-generate" reverse engineering and code generation f=
acility
@@ -1239,20 +1239,20 @@
=
-
-
- Detect one-to-one associations
+
+
+ Detect one-to-one associations
=
-
-
+
+
Reverse engineering detects one-to-one associations via =
primary key and both hbm.xml and annotation generation generates the proper=
code for it.
-
-
+
+
The detection is enabled by default (except for Seam 1.2=
and Seam 2.0) reverse engineering.
For Hibernate Tools generation there is a checkbox to di=
sable if not wanted.
=
-
+
=
@@ -2326,8 +2326,8 @@
Note:
=
- Please note, if you choose Hibernate as a platform and leave t=
he Target Runtime =
- with <none>, the wizard does not require you to have a Hibernate Console Configuration. A Hiberna=
te Console Configuration is created when the wizard finishes its work.
+ Please note, if you =
choose Hibernate as a platform and leave the Target Runtime =
+ with <none>, the wizard does not require you to have a Hibernate Console Configuration<=
/link>. A Hibernate Console Confi=
guration is created when the wizard finishes its work.
Modified: trunk/jbpm/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/jbpm/docs/reference/en/master_output.xml 2009-03-11 14:34:56 UTC =
(rev 14170)
+++ trunk/jbpm/docs/reference/en/master_output.xml 2009-03-11 16:04:53 UTC =
(rev 14171)
@@ -55,10 +55,10 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a div=
ision of Red Hat
- Version: 3.1.5.GA
+ Version: 3=
.1.5.GA
=
@@ -487,10 +487,10 @@
The views
=
Here, it will be explained how to work with views and editors pr=
ovided by JBDS.
- The views are used for representation and navigation the resourc=
es you are working on at
+ The views are used for=
representation and navigation the resources you are working on at
the moment. One of the advantages of all the views is that all mod=
ifications made in the
current active file are immediately displayed in them. Let=E2=80=
=99s get acquainted more closely
- with those that the jPDL perspective=
property> provides.
+ with those that the j=
PDL perspective provides.
=
The jPDL Perspective Views and Editors
@@ -525,8 +525,8 @@
The Overview
- The main advantage of this view is that it gives visual repr=
esentation of the whole
- current developing process. Besides, the
+ The main advantage=
of this view is that it gives visual representation of the whole
+ current developing process. Besides, the Overview comes as a scrollable thumbnail which enables a be=
tter navigation of the
process structure if it's too large.
Modified: trunk/jsf/docs/jsf_tools_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/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2009-03-11 14:3=
4:56 UTC (rev 14170)
+++ trunk/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2009-03-11 16:0=
4:53 UTC (rev 14171)
@@ -36,12 +36,12 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a div=
ision of Red Hat
-
+
Version: 3.0.0.GA
-
+
=
@@ -902,7 +902,7 @@
=
-
+
@@ -1020,7 +1020,7 @@
-
+
=
Tree View
=
Modified: trunk/jsf/docs/jsf_tools_tutorial/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/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2009-03-11 14:34=
:56 UTC (rev 14170)
+++ trunk/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2009-03-11 16:04=
:53 UTC (rev 14171)
@@ -35,13 +35,13 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a div=
ision of Red Hat
=
-
+
Version: 3.0.0.GA
-
+
=
=
Modified: trunk/jsf/docs/userguide/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/jsf/docs/userguide/en/master_output.xml 2009-03-11 14:34:56 UTC (=
rev 14170)
+++ trunk/jsf/docs/userguide/en/master_output.xml 2009-03-11 16:04:53 UTC (=
rev 14171)
@@ -31,12 +31,12 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a div=
ision of Red Hat
-
+
Version: 2.0.0.GA
-
+
@@ -185,7 +185,7 @@
components in any web application. Support for RichFaces and Ajax4j=
sf libraries in JBoss
Tools Palette. Rendering RichFaces components in Visual Page Editor=
.
- RichFaces support
+ RichFaces support
@@ -230,7 +230,7 @@
=
=
-
+
@@ -424,9 +424,9 @@
=
- Notice, that code completion for EL variables has icons =
illustrating what they are
+ Notice, that c=
ode completion for EL variables has icons illustrating what they are
from. Currently it's performed for resource bundles, JSF a=
nd Seam
- components.
+ components.
=
JSF Content Assist
@@ -446,8 +446,8 @@
=
- Also, as you can see, the ranking and sorting are availa=
ble in EL code
- completions.
+ Also, as you c=
an see, the ranking and sorting are available in EL code
+ completions.
=
=
@@ -568,13 +568,13 @@
=
- Code Assist can also provide you with access to =
the beans located in jar archives.
+ Code Assist can also provide you with access to the beans l=
ocated in jar archives.
=
-
- Code Assist: accessing beans in jar archives
-
-
-
+
+ Code Assist: accessing beans in jar archives
+
+
+
@@ -798,7 +798,7 @@
-
+ =
=
=
@@ -954,14 +954,14 @@
Visual Page Editor
=
JBoss Developer Studio comes with a powerful and customizable
- Visual Page Editor =
(VPE). You can use the Visual Page Editor to
- develop an application using any technology: JSF, Struts, JSP,=
HTML and others. Double-click on the necessary file in the Package Explore=
r view to open it in the Visual Editor or just drag-and-drop it into perspe=
ctive (the drag-and-drop feature can be also applied to JSP, XHTML or HTML =
files created locally).
+ Visual Page Editor<=
diffmk:wrapper diffmk:change=3D"changed"> (VPE). You can use the Visual Pag=
e Editor to
+ develop an application using any technology: JSF, Struts, JSP,=
HTML and others. Double-click on the necessary file in the Package Explore=
r view to open it in the Visual Editor or just drag-and-drop it into perspe=
ctive (the drag-and-drop feature can be also applied to JSP, XHTML or HTML =
files created locally).
=
Current VPE version has three tabs: Visual/Source,
Source and Preview. To switch between the
views you can use tabs at the bottom of the VPE or the shortcu=
ts Ctrl + PageUp/Ctrl + PageDown<=
/property>
- .
+ .
=
Visual Page Editor
@@ -1026,30 +1026,30 @@
- You can insert a tag/component from the palette into ei=
ther the Source or the
- Visual part by calling a context menu and selecting Insert
- around, Insert =
before, Insert
- after or Replac=
e With, pointing to
- From Palette, p=
icking the type of the tag and finally
- choosing the tag you want to insert.
+ You can insert a tag/component from the palette into either the So=
urce or the
+ Visual part by calling a context menu and selecting Insert
+ around, Insert before, Insert
+ after or Replace With, pointing to
+ From Palette, picking the t=
ype of the tag and finally
+ choosing the tag you want to insert.
=
- The image below illustrates how you can insert a tag int=
o the Source part.
-
- Inserting a tag into the Source part
-
-
-
+ The image below illustrates how you can insert a tag into the Sourc=
e part.
+
+ Inserting a tag into the Source part
+
+
+
=
- And this is how a tag is inserted using a context menu i=
n the Visual part.
+ And this is how a tag is inserted using a context menu in the Visua=
l part.
=
-
- Inserting a tag into the Visual part
-
-
-
+
+ Inserting a tag into the Visual part
+
+
+
@@ -1113,51 +1113,51 @@
=
-
- Using Code Folding
-
- Visual Page Editor lets you collapse (hide) and expand
- (show) sections of your code to make it easier to navi=
gate and read.
- Code folding can be enabled by right-clicking on the=
left margin on the Source
- part of Visual Page Editor, selecting Folding and checking
- the Enable Folding checkbox or using the
- Ctrl+Numpad_Divide
- shortcut.
- When the code folding is enabled a minus sing (
-
-
+
+ Using Code Folding
+
+ Visual Page Editor=
property> lets you collapse (hide) =
and expand
+ (show) sections of your code to make it easier to navi=
gate and read.
+ Code folding can be enabled by right-clicking on the left margi=
n on the Source
+ part of Visual Page Editor, selecting Folding and checking
+ the Enable Folding=
diffmk:wrapper> checkbox=
or using the
+ Ctrl+Numpad_Divide
+ sh=
ortcut.
+ When the code folding is enabled a minus sing (
+
+
- ) will appear on the left margin =
of the editor next to each
- opening block tag.
+ ) will appear on the left margin of the editor next to each
+ opening block tag.
=
-
- Enabled Code Folding
-
-
-
+
+ Enabled Code Folding
+
+
+
=
- Click the minus sign to collapse a block tag.
+ Click the minus sign to collapse a block tag.<=
/para>
=
- When the minus sing is clicked on the appropriate ta=
g collapses and a plus
- sing (
-
-
+ When the minus sing is clicked on the appropriate tag collapses=
and a plus
+ sing (
+
+
- ) is displayed on the left margin=
as well as a gray
- rectangle two dots (
-
-
+ ) is displayed on the left margin as well as a gray
+ rectangle two dots (
+
+
- ) appears after opening and closi=
ng tags.
+ ) appears after opening and closing tags.
=
-
- Collapsed Code
-
-
-
+
+ Collapsed Code
+
+
+
@@ -1175,9 +1175,9 @@
Support for Taglib versions
=
VPE templates now support various versions of tag li=
braries. It means that the
- VPE takes c=
ontrol over those components which have
+ VPE takes control over those components whic=
h have
different parameters or preview according to the frame=
work version (like seam
- 1.2 and seam 2.0, or JSF 1.1 and JSF 1.2).
+ 1.2 and seam 2.0, or JSF 1.1 and JSF 1.2).
=
For example, <s:decorate>
@@ -1247,8 +1247,8 @@
The pages you are working with in VPE can use external
stylesheets. VPE allows you to create new style classes in
existing stylesheets and/or edit them as well. For the=
se purposes CSS
- Style Class Dialog is provided (hot key=
s -
- CTRL+SHIT+C).
+ Style Class Dialog is provided (hot keys -
+ CTRL+SHIT+C<=
/property>).Select the element for which you need to create or e=
dit style class and press
button next to styleClass
@@ -1273,8 +1273,8 @@
- First, you should specify the CSS file where you are=
going to put your style
- class. Do this by pressing the button next to the
+ First, you=
should specify the CSS file where you are going to put your style
+ class. Do this by pressing the button next to the CSS file field.
@@ -1295,9 +1295,9 @@
Boxes,
- Property Sheet. The list of already exisiting classes with names begining w=
ith the symbols printed will be displayed on standard "Ctrl+Space" key comb=
ination. To add existing styling to
+ Property Sheet. The list of already=
exisiting classes with names begining with the symbols printed will be dis=
played on standard "Ctrl+Space" key combination. To add existing styling to
the chosen element just point to the
- necessary one. Each time you select any class it is di=
splayed in the Preview tab. Click on the Apply button will apply the changes without closi=
ng the window.
+ necessary one. Each time you select any class it is di=
splayed in the Preview tab. Click on the Apply button will apply the changes w=
ithout closing the window.
=
Style Class Selection
@@ -1308,13 +1308,13 @@
=
- The
- Edited properties
- tab gives a preview of the properties whic=
h are set for the existing
- style class. You can easily modify them with the help =
of this wizard.
+ The
+ Edited properties
+ =
tab gives a preview of the properties which are set for the existing
+ style class. You can easily modify them with the help =
of this wizard.
=
- Edited Properties
+ Edite=
d Properties
@@ -1322,39 +1322,39 @@
=
- If the style class isn't chosen, the tab doesn't sho=
w any properties.
+ If the style class isn't chosen, the tab doesn't show any prope=
rties.
=
-
- Edited Properties
-
-
-
+
+ Edited Properties
+
+
+
=
- The
- Preview tab
- is for observing the content of the chosen=
CSS file. This tab is hidden if no CSS file is chosen.
+ The
+ Preview tab
+ is=
for observing the content of the chosen CSS file. This tab is hidden if no=
CSS file is chosen.
=
-
- Preview Tab
-
-
-
+
+ Preview Tab
+
+
+
=
- At the top of the CSS St=
yle Class Dialog
- you can see a preview box which visualizes the result.=
To edit the preview you should double click in the box. To leave the focus=
, use
- Ctrl + Tab.=
+ At the top=
of the CSS Style Class Dialog=
+ you can see a preview box which visualizes the result.=
To edit the preview you should double click in the box. To leave the focus=
, use
+ Ctrl + Tab.<=
/para>
=
-
- Editing the Preview
-
-
-
+
+ Editing the Preview
+
+
+
@@ -1444,38 +1444,38 @@
Advanced Settings
=
In the left vertical pane of the Visual part there are t=
hree buttons:
- Preferences
+ Preferences
(
-
-
-
+
+
+
-
+
),
=
=
=
=
-
+ Refresh
-
+
(
-
-
-
+
+
+
-
+
)
- and
- Page Design Options ( =
-
-
-
+ and
+ Page Design Options ( =
+
+
+
-
+
)
=
- .
+ .
=
Buttons on the Visual Part of VPE
@@ -1490,20 +1490,20 @@
Preferences
- button
+ bu=
tton
(
-
-
-
+
+
+
-
+
)
=
=
=
=
=
- provides a quick access to Visual Page
+ provides a quick access to Visual Page
Editor preferences.
=
@@ -1519,15 +1519,15 @@
Clicking on Refresh
- button =
+ bu=
tton =
=
=
(
-
-
-
+
+
+
-
+
) =
=
=
@@ -1536,30 +1536,30 @@
=
=
=
- you refresh the displayed information.
+ you refresh the displayed information.
=
Page Design Option=
s
- button =
+ bu=
tton =
( =
-
-
-
+
+
+
-
+
)
=
=
leads to a window which helps you specify necessa=
ry
references of the resources. It is represented by =
a window with 4 tabs. The
- first one,
- Actual Run-Time fo=
lders,
- is used to replace absolute and relati=
ve path values when
- generating a preview:
+ first one,
+ Actual Run-Time folders,
+ is used to replace absolute and relative path values w=
hen
+ generating a preview:
- Page Design Options: Actual Run-Time folder=
s
+ P=
age Design Options: Actual Run-Time folders
@@ -1568,16 +1568,16 @@
=
=
- The second tab,
- Included CSS files=
- , is used to add CSS files to be linked=
by Visual Page Editor
- when generating a preview:
+ The second tab,
+ Included CSS files
+ , is used to add CSS files to be linked by Visual Page Editor
+ when generating a preview:
=
-
- Page Design Options: Included CSS files
-
-
-
+
+ Page Design Options: Included CSS files
+
+
+
@@ -1585,36 +1585,36 @@
=
=
=
- The third one,
- Included tag libs<=
/property>, can be used to add Taglibs that can be used by the e=
ditor for
- getting appropriate templates to generate a previe=
w:
+ The third one,
+ Included tag libs, can be=
used to add Taglibs that can be used by the editor for
+ getting appropriate templates to generate a previe=
w:
=
-
- Page Design Options: Included tag libs
-
-
-
+
+ Page Design Options: Included tag libs
+
+
+
=
- And finally, the
- Substituted El exp=
ressions
- tab is used to add El expressions that=
will be substituted by
- the editor when generating a preview:
+ And fina=
lly, the
+ Substituted El expressions
+ tab is used to add El expressions that will be substituted by
+ the editor when generating a preview:
=
-
- Page Design Options: Substituted El express=
ions
-
-
-
+
+ Page Design Options: Substituted El expressions
+
+
+
=
=
- The first two tabs of the window let you define =
actual runtime folders.
- The example below will help you understand how thi=
s can be done.
+ The fi=
rst two tabs of the window let you define actual runtime folders.
+ The example below will help you understand how thi=
s can be done.
=
Suppose you have the following project structure=
:
=
@@ -1649,8 +1649,8 @@
pages' and you will see the image a=
ppeared.
=
- Let' consider an example for other tabs. For ins=
tance, the
- definition of your CSS on the page is the next:
+ Let' c=
onsider an example for other tabs. For instance, the
+ definition of your CSS on the page is the next:
=
<=
![CDATA[
@@ -2278,9 +2278,11 @@
=
-
+
=
- =
+
+ =
+ =
@@ -2843,101 +2845,100 @@
=
=
-
-
-
-
- JBoss Developer Studio
- JBDS
- RichFaces
+
+
+
+ JBoss Developer Studio
+ JBDS
+ RichFaces
=
RichFaces Support
=
- JBoss Developer Studio co=
mes with a tight integration with RichFaces component framework.
+ JBoss Developer Studio co=
mes with a tight integration with RichFaces component framework.
=
-
- Note:
- RichFaces
- 3.3 is fully supported in the current version of JBoss Developer Studio (i. e. 2.0.0.GA) a=
nd JBoss Tools 3.0.0.GA.
+
+ Note:
+ RichFaces
+ 3.3 is fully supported in the current version of JBoss Developer Studio (i. e. 2.0.0.GA) and JBoss Tools 3.0.0.GA.
=
- The following features are implemented and fully supported for t=
he current version of the RichFaces components:
+ =
The following features are implemented and fully supported for the current =
version of the RichFaces components:
=
-
- Content Assis=
t
- OpenOn=
listitem>
- Representing in JB=
oss Tools Palette
+
+ Content Assist
+ OpenOn
+ Representing in JBoss Tools Palette
=
- All you have to do is to download and install RichFaces libraries int=
o your
- project, i. e. just put
- richfaces-*.jar
- files into the
- /lib
- project folder. Also how to get started with RichFaces you can find in RichFaces documentation.
+ =
All you have to do is to download and install RichFaces libraries into your
+ project, i. e. just put
+ richfaces-*.jar
+ files into the=
+ /lib
+ project folder=
. Also how to get started with RichFaces<=
/diffmk:wrapper> you can=
find in RichFaces documentation.
=
-
- Code Assist for RichFaces
+
+ Code Assist for RichFaces
=
- JBDS/JBoss Tools inde=
ed provide code completion for RichFaces framework
- components.
+ JBDS/JBoss Tools indeed pr=
ovide code completion for RichFaces framework
+ components.
=
-
- Tip:
+
+ Tip:
=
- RichFaces 3.3 is now fully supported in code completion.=
+ RichFaces 3.3 is now fully supported in code completion.
=
-
- Content Assist for RichFaces Components
-
-
-
+
+ Content Assist for RichFaces Components
+
+
+
=
=
-
- OpenOn for RichFaces
+
+ OpenOn for RichFaces
=
- Working with
- .jsp/.xhtml =
pages in VPE you can also take the a=
dvantage of
- OpenOn f=
eature for the RichFaces components.=
+ Working with
+ .jsp/.xhtml pages in VPE you can also take the advantage of
+ OpenOn feature for the RichFaces components.
=
- For example, Richfaces tags
- <rich:insert>
- and
- <a4j:include>
- has OpenOn supp=
ort.
+ For example, Richfaces tags
+ <rich:insert>
+ and
+ <a4j:include>
+ has OpenOn support.
=
-
- OpenOn With Richfaces Tag
-
-
-
+
+ OpenOn With Richfaces Tag
+
+
+
=
-
- OpenOn With A4j Tag
-
-
-
+
+ OpenOn With A4j Tag
+
+
+
=
-
- RichFaces in the JBoss Tools Palette
+
+ RichFaces in the JBoss Tools Palette
=
- RichFaces and Ajax4jsf tag libraries always exist in JBoss Tools
- Palette.
+ RichFaces and Ajax4jsf tag libraries always exist in <=
link linkend=3D"palette">JBoss Tools
+ Palette.
=
RichFaces Components
@@ -2948,45 +2949,45 @@
=
- To insert a RichFaces=
component on a page:
-
-
- expand
- JBoss RichFaces
- group on the palette
+ To insert a RichFaces component on a page:
+
+
+ expand
+ JBoss RichFaces
+ group =
on the palette
=
-
- click on some component
+
+ click on some component
=
-
- put the needed attributes in the
- Insert Tag
- dialog and click
- Finish
- button =
-
+
+ put the needed attributes in the
+ Insert Tag
+ dial=
og and click
+ Finish
+ butt=
on =
+
=
-
- Inserting Tag
-
-
-
+
+ Inser=
ting Tag
+
+
+
=
- The RichFaces compone=
nt will be inserted on your page and displayed in source and visual
- modes:
+ The Ri=
chFaces=
component will be inserted on your page and displayed in source and visual
+ modes:
=
-
- RichFaces Component
-
-
-
+
+ RichFaces Component
+
+
+
@@ -2996,8 +2997,8 @@
Relevant Resources Links
=
- To get more in-depth information on RichFaces framework refer to RichFaces Developer Guide.
- It may be also helpful for you to look through the movies where there are on=
es that demonstrate the usage of RichFaces components.
+ To get more in-depth=
information on RichFaces framework refer to RichFaces Developer Gui=
de.
+ It may be also helpful for you to look through the
movies where there are ones that demonstrate the=
usage of RichFaces components.
=
@@ -4471,6 +4472,4 @@
-->
-
- =
-
+
Modified: trunk/seam/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/seam/docs/reference/en/master_output.xml 2009-03-11 14:34:56 UTC =
(rev 14170)
+++ trunk/seam/docs/reference/en/master_output.xml 2009-03-11 16:04:53 UTC =
(rev 14171)
@@ -38,19 +38,19 @@
Seam Dev Tools Reference GuideAnatolyFedosik<=
/author>
OlgaChikvina
- MichaelSorokin=
author>
+ Michael=
Sorokin
=
SvetlanaMukhinas=
mukhina(a)exadel.com
=
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a di=
vision of Red Hat
-
+
Version: 3.0.0.GA
-
+
=
@@ -111,7 +111,7 @@
=
=
-
+
@@ -121,8 +121,8 @@
Creating a New Seam Project via the New Seam Project wizard
- In this chapter we provide you with the necessary steps to start=
working with Seam
- Framework.
+ In this chapter we pro=
vide you with the necessary steps to start working with Seam
+ Framework.
=
At first, we suggest setting the specific Seam perspective that =
combines a number of
different views and editors needed for work with resources concern=
ed. For that select
@@ -130,7 +130,7 @@
or you can also access it through the button in the ri=
ght top corner.
=
- Seam Perspective Icon
+ Seam Perspective =
Icon
@@ -138,14 +138,14 @@
=
- Also the
- Open Web Browser=
action is directly available in the Seam persp=
ective.
+ =
Also the
+ Open Web Browser action is directly available=
in the Seam perspective=
.
=
-
- Embedded Web Browser Button
-
-
-
+
+ Embedded Web Browser Button
+
+
+
@@ -174,14 +174,14 @@
=
- On the figure above you can see the runtime and the server a=
lready created.
+ On the figure above =
you can see the runtime and the server already created.
=
- If you need to create a new runtime, click on the
+ If you need to create a new runtime, click on the New...
- button in the Target R=
untime section. It brings up the
+ button in the Target R=
untime section. It bri=
ngs up the
wizard where you can specify a new JBoss Server Runtime enviro=
nment or the other type of
runtime appropriate for configuring your project. Let's create=
one more JBoss 4.2
- Runtime. Hence, after choosing it click on
+ Runtime. Hence, after choosing it click on Next
button.
=
@@ -211,18 +211,18 @@
=
Clicking on Finish
- returns you to the New Seam Project
- wizard page.
+ returns you to the New Seam Project
+ wizard page.
=
- The next step is to define a Server that you can do by c=
licking
- on
+ The next step is to define a Server that you can do by clicking
+ on New...
- button in the Target S=
erver section. In appeared
- New Server dialog t=
he last server which matches the runtime
- will be selected.
+ button in the Target S=
erver section. In appe=
ared
+ New Server dialog<=
diffmk:wrapper diffmk:change=3D"changed"> the last server which matches the=
runtime
+ will be selected.
=
- All declared runtimes are listed in the combo box under the =
servers view. Here, you
- can indicate a server runtime that you need. Click
+ All declared runti=
mes are listed in the combo box under the servers view. Here, you
+ can indicate a server runtime that you need. Click Add if you want to add a new Server Runtime.
=
@@ -235,8 +235,8 @@
=
- Next page allows you to verify the information for chosen se=
rver. Leave everything as
- it is and click on
+ Next page allows y=
ou to verify the information for chosen server. Leave everything as
+ it is and click on Next.
=
@@ -249,8 +249,8 @@
=
- On the last wizard step you can modify your projects to conf=
igure them on the
- Server.
+ On the last wizard=
step you can modify your projects to configure them on the
+ Server.
=
Project Modification for Configuring on the Server
@@ -282,10 +282,10 @@
=
- The last section on this wizard step is Configuration. Here, you
+ The last section on this wizard step is Configuration. Here, you
can select one of the pre-defined project configurations eithe=
r associated with Seam
1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create yo=
ur own configuration by
- pressing the
+ pressing the Modify... button. It will open the dialog which allows to co=
nfigure your own set of
facets for adding extra functionality to your project.
@@ -625,8 +625,8 @@
tests via Run As > Te=
stNG Test.In order to deploy WAR project on server, right-click on the=
project and select Run As > Run on Server. Studio will deploy
- WAR project into one web application on server to deploy
- folder.
+ WAR project into one web application on server to deploy
+ folder.
=
=
@@ -653,84 +653,84 @@
and war modules of the =
EAR project.
=
-
+
=
- Changing the Seam Version
+ Changing the Seam Version
=
- To upgrade or downgrade your projects Seam version use the f=
acet preferences. You
- should right-click your project and choose
- Project Facets
- category. Next select
- Seam
- and change its version to needed one.
+ To upgrade or downgrade your projects Seam version use the facet prefer=
ences. You
+ should right-click your project and choose
+ Project Facets
+ category. =
Next select
+ Seam
+ and change=
its version to needed one.
=
-
- Changing the Seam Facet Version
-
-
-
+
+ Changing the Seam Facet Version
+
+
+
=
- After pressing
- Apply
- the wizard for adjusting new Seam runtime settings=
appears.
+ After pressing
+ Apply
+ the wizard=
for adjusting new Seam runtime settings appears.
=
-
- Changing the Seam Facet Version
-
-
-
+
+ Changing the Seam Facet Version
+
+
+
=
- If you need to update the libraries for you project, check t=
he
- Update libraries
- option. All libraries you checked will be removed =
and the libraries from the
- new Seam distribution will be added after clicking
- Ok.
+ If you need to update the libraries for you project, check the
+ Update libraries
+ option. Al=
l libraries you checked will be removed and the libraries from the
+ new Seam distribution will be added after clicking
+ Ok.
=
-
- Changing the Seam Facet Version
-
-
-
+
+ Changing the Seam Facet Version
+
+
+
=
-
- Note:
+
+ Note:
=
- The note "Seam configuration files and their XSDs won't =
be changed" is
+ The note "Seam configuration files and their XSDs won't be changed"=
is
meant that the libraries, Seam facet and runtime version w=
ill be changed, but
configuration files that refer to the old version will hav=
e to be manually
- updated.
+ updated.
=
-
- Changing Seam Parent Project
+
+ Changing Seam Parent Project
=
- Starting from the 2.0.0.CR2 version of JBoss Tools it is possible
+ Starting from the 2.0.0.CR2 version of JBoss Tools it is possible
to change the Seam parent project. In earlier versions this wa=
s only controllable at a
- project creation time, now it can be changed for existing proj=
ects too.
+ project creation time, now it can be changed for existing proj=
ects too.
=
- Go to your project preferences and select
- Seam Settings
- category on the left. Press the
- Browse
- button next to the
- Main Seam Project
- section to select the other Seam parent project.=
para>
+ Go to your project preferences and select
+ Seam Settings
+ category o=
n the left. Press the
+ Browse
+ button nex=
t to the
+ Main Seam Project
+ section to=
select the other Seam parent project.
=
-
- Changing Seam Parent Project
-
-
-
+
+ Changing Seam Parent Project
+
+
+
@@ -759,10 +759,10 @@
Refactor > Move...
(or Shift + Alt + V
- ), if you need to move
- <project_name>/WebContent folde=
r,
- <project_name>/ejbModule folder=
or
- <project_name>/test-src folder =
in the other place
+ ), if you=
need to move
+ <project_name>/WebContent=
folder,
+ <project_name>/ejbModule<=
/emphasis> folder or
+ <project_name>/test-src=
emphasis> folder in the other place
within the Project structure.
@@ -1143,8 +1143,8 @@
Seam Wizards
=
This chapter introduces you with Seam Components.
- All the Seam component generations options known from Seam-gen a=
re available as wizards
- (with sensible auto-defaulting) for creating various common Seam c=
omponents:
+ All the Seam component=
generations options known from Seam-gen are available as wizards
+ (with sensible auto-defaulting) for creating various common Seam c=
omponents:
=
@@ -1182,8 +1182,8 @@
=
- The wizards create multiple resources and place it in the approp=
riate folders depending on
- your project structure (WAR or EAR).
+ The wizards create mul=
tiple resources and place it in the appropriate folders depending on
+ your project structure (WAR or EAR).Let's create a WAR project using the New Seam Project wizard.
=
@@ -1203,10 +1203,10 @@
New Seam Action
=
In this and following sections you can see example creating =
Seam Components.
- To create a New Seam Action you should select a necessary pr=
oject, type a name for
- Seam component, POJO class,
- Method, Page and select a
- Package using the <=
emphasis>
+ To create a New Se=
am Action you should select a necessary project, type a name for
+ Seam componen=
t, POJO class,
+ Method, Page and select a
+ Package using the =
Browse button.
=
@@ -1219,19 +1219,19 @@
=
- If you specify a class which already exists, the wizard will=
warn you about it.
+ If you specify a cla=
ss which already exists, the wizard will warn you about it.
=
-
- Wizard Warning against Existing File
-
-
-
+
+ Wizard Warning against Existing File
+
+
+
=
- You can see the action page in W=
ebContent folder. Click on it to
- open in JBoss Tools HTML Editor.
+ You can see the action page in WebContent folder. Click on it to
+ open in JBoss Tools HTML Editor.
=
Action Page in JBoss Tools HTML Editor.
@@ -1245,13 +1245,13 @@
=
Note:
- You don't need to restart the server to see how the acti=
on component works. Just
- use context menu Run=
As > Run On
- Server.
+ You don't need=
to restart the server to see how the action component works. Just
+ use context menu Run As > Run On
+ Server.
=
- Action component was hot-deployed. Forms and Conversations w=
ill work the same
- way.
+ Action component w=
as hot-deployed. Forms and Conversations will work the same
+ way.
=
Action Component
@@ -1268,12 +1268,12 @@
New Seam Form
=
- Click on actionMethod=
in the internal browser and add a form in
- your project using the New Seam Form wizard File > New > Seam
- Form.
- Select a necessary project, type a name for Seam component,
- POJO class, Method,
- Page and select a <=
property moreinfo=3D"none">Package using
+ Click on actionMethod=
in the internal browser and add =
a form in
+ your project using the New Seam Form wizard <=
emphasis>File > New > Seam
+ Form.
+ Select a necessary project, type a name for Seam component,
+ POJO class, Method,
+ Page and select a Package using Browse
button.
=
@@ -1286,18 +1286,18 @@
=
- If you specify a class which already exists, the wizard will=
warn you about it.
+ If you specify a cla=
ss which already exists, the wizard will warn you about it.
=
-
- Wizard Warning against Existing File
-
-
-
+
+ Wizard Warning against Existing File
+
+
+
=
- The Form Page was created in Web=
Content folder.
+ The Form Page was created in WebContent folder.
=
Form Page in JBoss Tools HTML Editor.
@@ -1308,8 +1308,8 @@
=
- Deploy the form on server. Right click on Form Page, select =
Run As
- > Run On Server.
+ Deploy the form on server. Right click on Form Page, select =
Run As
+ > Run On Server.
=
Form Component
@@ -1327,13 +1327,13 @@
New Seam Conversation
=
- Enter some value in the text field (e.g. value1) and click on
- formMethod.
- Add a conversation using the New Seam Conversation wizard File >
- New > Seam Form.
- You should select a necessary project, type a name for Seam
- component, POJO cla=
ss, Method,
- Page and select a <=
property moreinfo=3D"none">Package using
+ Enter some value in the text field (e.g. value1) and =
click on
+ formMethod.
+ Add a conversation=
using the New Seam Conversation wizard File >
+ New > Seam Form.
+ You should select a necessary project, type a name for Seam
+ component, POJO class, =
Method,
+ Page and select a Package using Browse button.
=
@@ -1347,18 +1347,18 @@
=
- If you specify a class which already exists, the wizard will=
warn you about it.
+ If you specify a cla=
ss which already exists, the wizard will warn you about it.
=
-
- Wizard Warning against Existing File
-
-
-
+
+ Wizard Warning against Existing File
+
+
+
=
- Conversation page was created in WebContent folder.
+ Conversation page was created in WebContent folder.
=
Conversation Page in JBoss Tools HTML Editor.
@@ -1369,8 +1369,8 @@
=
- Right click on Conversation page, select Run As > Run On
- Server.
+ Right click on Conversation page, select Run As > Ru=
n On
+ Server.
=
Conversation Component
@@ -1382,8 +1382,8 @@
=
Conversation component was hot-deployed.
- Click on Begin and
Increment buttons to
- check the conversation functionality.
+ Click on Begin and
Increment buttons to
+ check the conversation functionality.
=
=
@@ -1392,15 +1392,15 @@
New Seam Entity
=
Entities cannot be hot-deployed, so we need to stop the serv=
er.
- Create an Entity using the New Entity wizard File > New > Seam
- Entity.
+ Create an Entity using the New Entity wizard File > =
New > Seam
+ Entity.
=
- You should select a necessary project, type a name for Entity
- class, select a Pac=
kage using
+ You should select a necessary project, type a name for Entity
+ class, select a Pa=
ckage using Browse
- button, type a name for Master Page and
- Page.
+ button, type a name for Master Page and
+ Page.
=
New Seam Entity Wizard
@@ -1411,19 +1411,19 @@
=
- If you specify a class which already exists, the wizard will=
warn you about it.
+ If you specify a class which already exists, the wizard will warn you a=
bout it.
=
-
- Wizard Warning against Existing File
-
-
-
+
+ Wizard Warning against Existing File
+
+
+
=
- The Master Page and the Entity were created in WebContent
- folder.
+ The Master Page and the Entity were created in WebContent
+ folder.
=
Master Page in JBoss Tools HTML Editor.
@@ -1455,10 +1455,10 @@
- Let's create two customers c1 and c2. Enter
- the name in the text field and press the Save button. Customer
- should be successfully created. Press Done. Do the same for
- c2 customer. The re=
sult should be:
+ Let's create two customers c1 and c2. Enter
+ the name in the text field and press the Save button. Customer
+ should be successfully created. Press Done. Do the same for
+ c2=
customer. The result should be:
=
Two Customers Are Created
@@ -1533,15 +1533,359 @@
=
- Seam Editors Features
+ Seam Editors
+ =
+ =
+ =
This chapter tells about Seam Editors and their features.<=
/para>
+ =
+
+ Visual Page Editor
+ Visual Page Editor fits perfectly for authoring view Seam pages. The ma=
jor features of VPE are listed in Main =
Features of Seam Editors
+ You can also read more about Visual Page Editor in
Visual Page Editor chapter of "Visual Web Tools Reference Guide".
+
+ =
+ =
+ =
+ =
+
+ Seam Pages Editor
+ =
+ =
+
+ Seam Pages Editor<=
diffmk:wrapper diffmk:change=3D"added"> provides a handy way to edit the =
diffmk:wrapper>pages.xml file.
+ =
+
+ =
+
+ You can edit the pages.xml file in three modes: Graphical, Tre=
e and Source.
+ =
+
+ =
+
+ Graphical Mode
+ =
+ =
+ Graphical mode provides you with a set of visual tools to organize your=
project pageflow, exception handling etc.
+
+ Seam Pages Editor: Graphical View
+
+
+
+
+
+
+ =
+ The Graphical part of the editor has some visual elements. The table be=
low shows graphical representation of the elements and explains their meani=
ngs.
=
+
+ Pages Editor: Graphical View. Visual elements =
+
+
+
+ Element
+ =
+ Description
+
+
+
+
+ =
+
+
+
+
+
+
+ A yellow box with a solid border=
represents a
+ <page>
+ el=
ement.
+
+ =
+
+ =
+
+
+
+
+
+
+ Pressing on the plus icon (
+
+
+
+ )
+ =
+ =
+ on the
+ <page>
+ el=
ement reveals a box that lists the parameters for the page.
+
+ =
+ =
+ =
+
+
+
+
+
+
+ =
+ A red cross in the upper left corner of the page box in=
dicates that the view-id is not found in the project.
+
+ =
+ =
+
+
+
+
+
+
+
+ A gray box with a dashed border represents a page =
that has navigation =
+ (navigation rule) to but the page is not defined i=
n the page.xml file.
+
+ =
+ =
+ =
+
+
+
+
+
+
+ An <exception> is =
represented by a blue box with a orange diamond.
+ =
+ =
+ =
+ =
+ =
+ =
+
+
+
+ =
+ =
+ =
Pageflow relations are shown with gray arrows, when you select a relationsh=
ip the arrow is changed to orange. =
+ =
+ =
+ =
+ On the lefthand side of the Graphical view of Seam Page Editor you can find a toolbar with a set of icons for the mos=
t frequently used commands. =
+
+
=
+ =
+ Context menus are also available when you click either on an item or=
a blank space.
+ =
+ =
+ A context menu called on a blank space of the diagram provides the f=
ollowing options:
+
+ Page creates a new page element on the diagram=
para>
+ Exception creates a new exception element on the diagram
+ Auto Layout formats the layout of the diagram automatically
+ Select Element calls the Select=
Element Wizard with a filter to perform a quick search through the pages file
+
+ Rightclicking on a
+ <page>
+ el=
ement calls a context menu where you can choose the following options if yo=
u click on the New menu item:
+ =
+ =
+ =
+
+ =
Rule defines a new navigation rule for the element =
+ =
Param adds a
+ <param> tag
+ to the
+ <page>
+ el=
ement
+
+
+ =
+ =
+
+ Tree Mode
+ =
+ Tree Mode provides a wider range of options and way to edit and mod=
ify the pages.xml file.
+ =
+ =
+ =
+
+ Seam Pages Editor: Tree View
+
+
+
+
+
+
+ =
+
+ In this mode all elements and attributes of the page.xml
+ file can be viewed and edited in a visual, user friendly w=
ay.
+
+ =
+
+ =
+ =
+
+ Outline Support for Seam Pages Editor
+ =
+ =
+ Seam Pages Editor provides Outlin=
e view =
support.
+ You can explore the pages.xml using Outline view in two mo=
des: <=
diffmk:wrapper diffmk:change=3D"added">Tree (
+
+
+
+ ) and Diagram Navigation ( <=
inlinemediaobject diffmk:change=3D"added">
+
+
+
+ ).
+ =
+
+ The Diagram Navigation mode of Outline view gives a birds-=
view of the layout to allow quick navigation for large-scale applications. =
+
+ =
+
+ Outline view: Diagram Navigation mode
+
+
+
+
+
+
+ =
+ =
+ The Tree mode shows a tree for every element in the pages.xml file.=
You can get a quick overview of the whole file and selecting an element th=
e related element is highlighted in the Graphical, Tree or Source page of S=
eam Pages Editor.
+ =
+ =
+ =
+
+ Outline view: Tree mode
+
+
+
+
+
+
+ =
+ =
+ =
+ =
+
+ =
+ =
+
+ =
+ =
+
+ =
+ =
+ Seam Components Editor
+ =
+ When editing components.xml a structured tre=
e editor is available
+ in addition to pure source editing. It has a graphical view (T=
ree tab) and source
+ (Source tab).
+ =
+
+ component.xml Editor
+
+
+
+
+
+
+ =
+
+ Note:
+ =
+ You can view and edit components.=
xml and=
other xml files
+ directly in the Project Explorer and Properties sheet with=
out opening the
+ components.xml editor.
+
+
+ component.xml Editor
+
+
+
+
+
+
+ =
+
+ =
+ =
+ =
+
+ Main Features of Seam Editors
+
+ =
+ =
In this chapter you will know what Seam Editors features are and=
how to work with them.
=
=
Content Assist
=
- Content Assist (Ctrl =
+ Space) is available when using EL variables in the following file formats=
:
+ Content Assist (Ctrl + Space) is available when using =
EL expressions in the following file formats:JSP
@@ -1623,13 +1967,13 @@
=
- OpenOn is also supported in Page Descriptors(page.xml). You =
can Ctrl + left click on the bean to=
open navigate to the bean you clicked on.
+ OpenOn is also supported in Page Descriptors(page.xml). You can Ctrl + left click on the bean to open navigate to the b=
ean you clicked on.
=
-
- OpenOn in page.xml file
-
-
-
+
+ OpenOn in page.xml file
+
+
+
@@ -1644,7 +1988,7 @@
Validation of various possible problematic definitions is im=
plemented for Seam
applications.
=
- If an issue is found it will be shown in the standard Problems
+ If an issue is fou=
nd it will be shown in the standard Problems
View.
=
@@ -1672,48 +2016,15 @@
=
- On WTP projects validation are enabled by default and thus e=
xecuted automatically, but
+ On WTP projects va=
lidation are enabled by default and thus executed automatically, but
on normal Java projects you will have to go and add the Valida=
tion builder of your
project . It is available in the properties of your project un=
der
- Validation. The val=
idations can be run manually by clicking
+ Validation. The validations can be run manually by clicking
Validate via the co=
ntext menu on your project which will
execute all the active WTP validations.
=
-
- Structured components.xml Editor
-
- When editing components.xml a structured tree editor is available
- in addition to pure source editing. It has a graphical view (T=
ree tab) and source
- (Source tab).
-
-
- component.xml Editor
-
-
-
-
-
-
-
-
- Note:
-
- You can view and edit compon=
ents.xml and other xml files
- directly in the Project Explorer and Properties sheet with=
out opening the
- components.xml editor.
-
-
- component.xml Editor
-
-
-
-
-
-
-
-
-
+
=
=
@@ -1917,22 +2228,22 @@
=
- Notice, that in the
- Expression language
- section there is now a preference for setting =
severity of EL
- Syntax. You can select whether the Seam validator displays=
an error, a warning or just ignore the EL Syntax error.
+ Notice, that in =
the
+ Expression language<=
/property>
+ sectio=
n there is now a preference for setting severity of EL
+ Syntax. You can select whether the Seam validator displays=
an error, a warning or just ignore the EL Syntax error.=
para>
=
-
- Severity Preference for EL Syntax
-
-
-
+
+ Severity Preference for EL Syntax
+
+
+
=
- In the upper right corner of the page there is a Configure Project
- Specific Settings link. Clicking on it you =
get the form where you can choose a
+ In the upper right corner of the=
page there is a Configure Project
+ Specific Settings link. Cl=
icking on it you get the form where you can choose a
project for specific setting. Project specific configurati=
on allows you to have
different validator settings for each project. Check the <=
property moreinfo=3D"none">Show only
projects with project specific settings if =
you want to see the
@@ -1999,10 +2310,10 @@
Folders.
=
- Also notice, you are not required to use the New Seam Project
- wizard to benefit from Seam artifact wizards. Y=
ou can just enable Seam on
- your existing project by checking =
Seam Support and targeting to
- Seam Runtime, and then configure the folders as you want.
+ Also notice, you are not required to use the New Seam Project
+ wizard to benefit from Seam artifact wizards. You can just enab=
le Seam on
+ your existing project by checking Seam Support and targeting to
+ Seam Runtime, and then configure the folders as you want.
=
Properties for Seam Project
Modified: trunk/struts/docs/struts_tools_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/struts/docs/struts_tools_ref_guide/en/master_output.xml 2009-03-1=
1 14:34:56 UTC (rev 14170)
+++ trunk/struts/docs/struts_tools_ref_guide/en/master_output.xml 2009-03-1=
1 16:04:53 UTC (rev 14171)
@@ -37,12 +37,12 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a di=
vision of Red Hat
-
+
Version: 3.0.0.GA
-
+
=
Modified: trunk/struts/docs/struts_tools_tutorial/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/struts/docs/struts_tools_tutorial/en/master_output.xml 2009-03-11=
14:34:56 UTC (rev 14170)
+++ trunk/struts/docs/struts_tools_tutorial/en/master_output.xml 2009-03-11=
16:04:53 UTC (rev 14171)
@@ -34,12 +34,12 @@
April 20082007
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a div=
ision of Red Hat
-
+
Version: 3.0.0.GA
-
+
=
Modified: trunk/ws/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/ws/docs/reference/en/master_output.xml 2009-03-11 14:34:56 UTC (r=
ev 14170)
+++ trunk/ws/docs/reference/en/master_output.xml 2009-03-11 16:04:53 UTC (r=
ev 14171)
@@ -16,12 +16,12 @@
July 20082008
- 2009
- JBoss, a division of Red Hat
+ 2009
+ JBoss, a divi=
sion of Red Hat
-
- Version: 3.0.0.GA
-
+
+ Version: 1.0.0.GA
+
@@ -237,7 +237,7 @@
=
=
-
+ Creating a Web service from a Java bean using JBossWS runtime=
The Web Service wizard assists you in creating a new Web servi=
ce, configuring it for
deployment, and then deploying it to the server.
@@ -326,7 +326,7 @@
=
Select your server: the default server is displaye=
d. If you want to deploy
your service to a different server click the link to spe=
cify a different server.
-
+ Select your runtime: ensure the JBoss WS runtime i=
s selected.
@@ -423,7 +423,7 @@
=
=
-
+Creating a Web Service Client from a WSDL Document using JBoss WS=
To create a Web Service Client from a WSDL Document using JBoss WS=
:Setup JBoss WS and development enviro=
nment.
@@ -496,7 +496,7 @@
=
=
-
+JBoss WS and development environmentJBossWS Preferences
@@ -505,8 +505,8 @@
development process.
=
JBossWS preferences can be set on the JBossWS preference pag=
e. Click on
- Window > Preferences >=
; JBoss Tools > Web > JBossWS
- Preferences.
+ Window > Pref=
erences > JBoss Tools > Web > JBossWS
+ Preferences.
=
On this page you can manage the JBossWS Runtime. Use the app=
ropriate buttons to
Add more runtimes o=
r to Remove those that
@@ -538,8 +538,40 @@
+ =
+ =
+ =
+ =
+ WS container allows Source and JavaDoc locations to be set via the Prop=
erties dialog on each contained .jar: right-click on any .jar file in the P=
roject Explorer view, select Properties. Choose Java Source Attachment and select=
location (folder, JAR or zip) containing new source for the chosen .jar us=
ing one of the suggested options (workspace, external folder or file) or en=
ter the path manually:
+ =
+
+ Classpath Container: Java Source Attachment
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+ Click on Apply and then on Ok.
+ =
+ =
+ =
+ =
+ =
+ =
-
+ Default Server and RuntimeOpen Window > Preferences > W=
eb Services > Server and Runtime
@@ -556,12 +588,13 @@
=
- On the whole, this guide covers the fundamental concepts of=
work with tooling for
- JBossWS. It describes =
how to easily create a Web Service and a Web Service Client using
+ On the whole, this guide covers the fundamental concepts of =
work with tooling for
+ JBossWS. It describes h=
ow to easily create a Web Service and a Web Service Client using
JBossWS Runtime and adjust JBossWS and development environment=
as well.
=
- If the information on JBossWS tools in this guide isn't eno=
ugh for you, ask
- questions on our forum. Your comments =
and suggestions are also welcome.
+ If the information on JBossWS tools in this guide isn't enou=
gh for you, ask
+ questions on our forum. Your comments a=
nd suggestions are also welcome.
-
+
+
--===============4170970672792194128==--