From jbosstools-commits at lists.jboss.org Sun Jan 30 21:22:46 2011 Content-Type: multipart/mixed; boundary="===============8265104472312573986==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r28740 - trunk/as/docs/reference/en-US. Date: Sun, 30 Jan 2011 21:22:45 -0500 Message-ID: <201101310222.p0V2MjBk027196@svn01.web.mwc.hst.phx2.redhat.com> --===============8265104472312573986== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mcaspers Date: 2011-01-30 21:22:45 -0500 (Sun, 30 Jan 2011) New Revision: 28740 Modified: trunk/as/docs/reference/en-US/perspective.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/perspective.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-US/perspective.xml 2011-01-31 01:54:21 UTC (= rev 28739) +++ trunk/as/docs/reference/en-US/perspective.xml 2011-01-31 02:22:45 UTC (= rev 28740) @@ -1,519 +1,473 @@ - - - - JBoss Developer Studio - Eclipse - Deploy - Deployment - JBoss - - + + + + JBoss Developer Studio + Eclipse + Deploy + Deployment + JBoss + + = - JBoss AS Perspective + JBoss AS Perspective = - This chapter tells how to manage installed JBoss Serve= r via - JBoss AS perspective. + This chapter describes how to manage installed JBoss S= ervers via the JBoss AS perspective. = - The JBoss AS perspective is similar to the = Java - perspective, but it contains a few additional views= . Two of the additional - views are standard views, specifically the Console view<= /property> and the - Properties view. The other two views that= are added are the - Project archives view and the S= ervers - view. + + The JBoss AS perspective is similar to the Java perspective, but it contains a few additional views. The = Console view and the Properties view are standard views. The other two views that are added are the Project archives view and the Servers vie= w. + = -
- - The Servers view +
+ + The Servers view = - The Servers view is built on Common Nav= igator Framework - allowing extensions and is using label decorators what makes t= he UI enough compact - without loosing the vital information. + + The Servers view is built on the Common Navigator = Framework allowing extensions and is using label decorators that make the U= I compact enough without loosing the vital information. + = - Let's have a look at the Servers v= iew and inspect - in detail all parts it consists of. -
- The Servers view - - - - - -
+ Let's have a detailed look at the Servers view and its constituent components. +
+ The Servers view + + + + + +
= -
- Servers view Toolbar - In the right top corner of the Servers view there is a - special toolbar which provides a quick access to starting = a server (in the debug - mode, run mode, or profile mode), restarting a server, sto= pping a server and a - possibility to publish to a server. +
+ Servers view Toolbar + + In the right top corner of the Servers view there= is a special toolbar which provides a quick access for starting a server (= in the debug mode, run mode, or profile mode), restarting a server, stoppin= g a server and a publishing to a server. + = -
- The Servers view Toolbar - - - - - -
+
+ The Servers 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. + + In order to debug your applications or EJB's that are deployed to the = server, the server must be started in debug mode. By starting the server in= debug mode, Eclipse will allow you to set breakpoints on code in your work= space and step through the code. + = - - Start the server in profiling mode - button allows to enable profiling actions for = your application. For more - details on how to start using TPTP profiling with JBoss Tools - refer to TPTP Support chapter. + + The Start the server in profiling mode button a= llows you to enable profiling actions for your application. For more detail= s on how to start using TPTP profiling with JBoss Tools see . + = - - 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. + + The Publish to the server button will republish= any modules where it has determined that the workspace is out of sync with= the server. It will attempt to do an incremental publish if the module in = question is capable of doing one. + = -
+
= -
- Servers view Structure - The Servers view displays all decla= red 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. +
+ Servers view Structure + + The Servers view displays all defined servers as = well as their current status (that is whether they are started or stopped) = in square brackets next to the server name. + = -
- The Servers view - - - - - -
+
+ The Servers view + + + + + +
= - The following table lists possible server statuses. + The following table lists possible server statuses. = - - Server Publish Status - - - +
+ Server Publish Status + + + = = - - - Status + + + Status = - Description - - + Description + + = - - - - Republish - + + + + Republish + = - - The status which allows you to see i= f changes are - awaiting - - - - - Publishing... - + + The status which allows you to see if changes are awaiting + + + + + Publishing... + = - - The status which shows if changes ar= e being updated - - - - - Synchronized - + + The status which shows if changes are being updated + + + + + Synchronized + = - - The status which allows you to see i= f changes are - in-sync - - - - -
+ + The status which allows you to see if 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. + You can control a server behavior as well as adjust a number of s= erver preferences through the context menu. = -
- Context Menu Commands - - - - - -
+
+ Context Menu Commands + + + + + +
= - All available context menu commands are described in the= following table. - - Server Properties through the Context Menu - - - + All available context menu commands are described in the followin= g table. +
+ Server Properties through the Context Menu + + + = - - - - Name - + + + + Name + = - - Description - - - + + Description + + + = - - - - New Server - - - The option allows to define a new se= rver - - + + + + New Server + + + The option allows you to define a new server + + = - - - Open - - - The option opens the Server editor - - + + + Open + + + The option opens the Server editor + + = - - - Show in - - - This option gives an easy access to = the next views: Console, - Debug view, Server Log or MBean Explor= er - - + + + Show in + + + This option provides easy access to the Console, Debug, Serv= er Log or MBean Explorer views + + = - - - Delete - - - Standard option that allows to delet= e the chosen server - - + + + Delete + + + Standard option that allows you to delete the chosen server<= /para> + + = - - - Start - - - The action for stating a server in a= run mode - - + + + Start + + + This will start the server in a run mode + + = - - - Debug - - - The action for stating a server in a= debug mode - - + + + Debug + + + This will start the server in a debug mode + + = - - - Stop - - - The action for stopping a declared s= erver - - + + + Stop + + + this will stop the server + + = - - - Publish - - - The action for synchronizing the pub= lish information between - the server and workspace - - + + + Publish + + + This will synchronize the publish information between the se= rver and workspace + + = - - - Explore - - - This action uses the native OS file = explorer to browse the - deploy destination. Note: The option i= s also available for - deployed resources/projects (see the f= igure below). - - + + + Explore + + + + This action uses the native OS file explorer to browse the deploy= destination. Note: The option is also available for deployed resources an= d projects (see the figure below). + + + = - - - Add and Remove Projects - - - The option allows to publish a new p= roject to the server (if - its type is supported) - - + + + Add and Remove Projects + + + This option will publish a new project to the server (if its= type is supported) + + = - - - Monitoring - - - Possibility to add ports to be monit= ored on the current - server - - + + + Monitoring + + + Allows you to add ports to be monitored on the current serve= r + + = - - - Properties - - - Opens the window to adjust the curre= nt server - preferences - - + + + Properties + + + Opens a window that allows you to adjust the current server = preferences + + = - - -
+ + + = - Under the server element in the Servers view, you can - see currently deployed to the server modules and some serv= er extensions which - provide the additional information on the server. + + Under the server element in the Servers view, you= can see modules that are currently deployed to the server and some server = extensions that provide 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. + The context menu for any module allows you to remove it from the = server, and force a full or incremental republish upon it. = -
- Modules Action - - - - - -
+
+ Modules Action + + + + + +
= -
- Filesets +
+ Filesets = - The - Filesets - category in the Servers v= iew is intended - for files filtering. + The Filesets category in the Serv= ers view provides a way to filter files. = - To add a new file filter, right-click the - Filesets - category and select - Create File Filter. - The New File - Filter wizard should appear. + + To add a new file filter, right-click the Filesets category and select the Create File Filter op= tion. + + The New File Filter wizard should appear. = -
- Creating a New File Filter - - - - - -
+
+ 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 (see the figures bellow). - In order to set up a default fileset relative to the co= ncrete configuration of the server runtime, use the following variable: = - ${jboss_config}, i. e. you should type in= the - Root Directory something li= ke server/${jboss_config}/. - This is implemented in order you can modify the runtime&apos= ;s configuration and not have to manually update paths. -
- New File Filter Wizard - - - - - -
- = - Notice, that the - Browse button still returns = an absolute path: + + The wizard asks you to enter the filter name and add includes and exc= ludes patterns. The preview box underneath provides a list of files matched= to the defined patterns (see the figures bellow). + + + In order to set up a default fileset relative to the fixed configurat= ion of the server runtime, use the following variable: ${jboss_co= nfig}, i. e. you should enter server/${jboss_config}/<= /filename> in the Root Directory option. This allows y= ou to modify the runtime's configuration and not have to manually upda= te paths. + +
+ New File Filter Wizard + + + + + +
= -
- New File Filter Wizard - - - - - -
+ Notice, that the + Browse + button still returns an absolute path: = - After the filter is created, you can observe it by e= xpanding the - Filesets - category in the Servers view. +
+ New File Filter Wizard + + + + + +
= - It's possible now to edit files directly from t= he - 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. + + After the filter is created, you can explore it by expanding the Filesets category in the Servers view. + = -
- Direct Editing from the Filesets - - - - - -
+ + It is now possible to edit files directly from the Filesets= category. Double clicking on a file from Filesets opens up the editor automatically, or you can use the = Edit File context menu command. + = - To delete a file filter (or just a file) from the - Filesets, right-cl= ick a file filter (or the - unnecessary file) and select the - Delete File Filter - - (Delete File) command. +
+ Direct Editing from the Filesets + + + + + +
= -
- Deleting the File from the Filesets - - - - - -
- If you want to set filesets for some server types, y= ou should open = - Window>Preferences = - and then select Server > Default = Filesets = - from the categories available on the left. + + To delete a file filter (or just a file) from the Filesets<= /guilabel>, right-click a file filter or file and select the D= elete File Filter or Delete File c= ommand. + + +
+ Deleting the File from the Filesets + + + + + +
+ + If you want to set filesets for some server types, select WindowPreferences and then select ServerDefault from the categories available = on the left. + + +
+ Deleting the File from the Filesets + + + + + +
+ + On this preference page you can add a fileset to any server type or t= o all servers at once. To do this you should select the server type in the = combo box and click the Add fileset... button. In th= e opened New File Filter wizard follow the steps descr= ibed in , and finally click the Apply button on the preference page. + + The defined file filter will be automatically added to new serve= rs during their creation. = -
- Deleting the File from the Filesets - - - - - -
- On this preference page you can add a fileset = - to any server type or to all servers at once.To do thi= s you should select the server type in the combo box and click Add fileset... button. = - In the opened New File - Filter wizard follow the steps describe= d before and finally click Apply button on the preference page. - The defined file filter will be automaticall= y added to new servers during creation. - = - = -
= -
- XML Configuration - The - XML Configuration - category allows you to quickly browse to d= escriptor files in your - server's deploy directory and check or change the valu= es. Basically, - XML Configuration - includes XML XPaths where an xpath is a pa= th 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. - +
+ XML Configuration + + The XML Configuration category allows you to qui= ckly browse to descriptor files in your server's deploy directory and check= or change the values. Basically, XML Configuration in= cludes XML XPaths, where an XPath is a path used to access some specific pa= rt of an XML document. + = - 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. + + Note: + + This document assumes that you are familiar with XPath. If not, we h= ighly suggested that you look through an appropriate manual or tutorial on = the topic. + + = -
- XML Configuration - - - - - -
+ + The XML Configuration category itself contains o= nly a list of categories. Ports are provided by defaul= t, and display many of the most commonly used ports in the JBo= ss Server. + = +
+ 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 - Servers view. Look= for them in the - Inactive Categories - afterwards to re-enable. + + By right-clicking on the XML Configuration node = you can create a new category. Besides, context menu for XML Configuration category makes possible to disab= le it. You can disable any category in the bottom part of the Ser= vers view. Look for them in the Inactive Categories afterwards to re-enable. + = -
- Adding New Category - - - - - -
+
+ Adding New Category + + + + + +
= - By right-clicking on + By right-clicking on Ports - or any other category in + or any other category in XML Configuration - , you can create a new xpath. + , you can create a new xpath. = -
- Adding New XPath - - - - - -
+
+ Adding New XPath + + + + + +
= - After that, the dialog shown below will appear. + After that, the dialog shown below will appear. = -
- Adding New XPath - - - - - -
+
+ Adding New XPath + + + + + +
= - The goal here is to get an end result where the XPat= h matches up with a + The goal here 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 <mbean>, t= hen your XPath Patten - should end with mbean = and your + should end with mbean and your Attribute Name - should be name like o= n the next figure. + should be name like on the next figu= re. = - ... ]]> = -
- XPath Preview - - - - - -
+
+ XPath Preview + + + + + +
= - - Tip: - Notice, when you type the fields autocomplete to= help you locate exactly + + Tip: + Notice, when you type the fields autocomplete to help you locat= e exactly what xpath you're looking for. - + = - Then, on the other hand, if your desired field is th= e text of an element + Then, on the other hand, if your desired field is the text of an= element <description>, your XPath Patten - should end with description and + should end with description and Attribute Name - field should be left blank. When finished,= click + field should be left blank. When finished, click Preview - to see how many matches you have for that = particular XPath. + to see how many matches you have for that particular XPat= h. = -
- XPath Preview - - - - - -
+
+ XPath Preview + + + + + +
= -
-
+
+
= -
- Drag-n-Drop to Servers view +
+ Drag-n-Drop to Servers view = - Starting from 2.0.0.CR2 version of JBoss AS To= ols the + Starting from 2.0.0.CR2 version of JBoss AS Tools the Servers view supports drag-n-drop= of deployable and runnable projects/resources. = -
- Dragging to the Servers view - - - - - -
+
+ Dragging to the Servers view + + + + + +
= - With drag-n-drop the following actions can be performed:= + 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 + + + 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 + + dragging an .xhtml - file from + file from WebContent - will do the same and show the correspo= nding page in a + will do the same and show the corresponding page in a browser - + = - - dragging a deployable resource (i.e. a datasourc= e ( + + dragging a deployable resource (i.e. a datasource ( -ds.xml - ) file that has been made deployable) w= ill simply deploy that + ) file that has been made deployable) will simply deploy = that resource directly to the server - - + + = - In short, the feature does the same thing as if you used= the + In short, the feature does the same thing as if you used the Run On Server - option or + option or Add and Remove Projects - option in the context menu of the server. -
+ option in the context menu of the server. +
= -
- Server Log View +
+ Server Log View = - You can monitor the current server behavior with the hel= p of the Server + You can monitor the current server behavior with the help of the = Server Log. To open a server in the Serv= er Log view you should right-click on the server and follow to - Open in > Server Log.<= /para> + Open in > Server Log. + = - The + The Server Log - shows relevant information to your server&apos= ;s startup, shutdown, + shows 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 - - - - - -
+
+ Event Log Actions + + + + + +
= - The Server Log toolbar contains sev= eral icons that perform + The Server Log toolbar contains several icon= s that perform the following actions: = - - Server Log Toolbar Icons - - - +
+ Server Log Toolbar Icons + + + = - - - - Name - + + + + Name + = - - Description - - - + + Description + + + = - - - - Export Log - - - Possibility to export the log into a= text file - - + + + + Export Log + + + Possibility to export the log into a text file + + = - - - Clear Log Viewer - - - The option clears the current server= log - - + + + Clear Log Viewer + + + The option clears the current server log + + = - - - Delete Log - - - Click to delete the server log - - + + + Delete Log + + + Click to delete the server log + + = - - - Open Log - - - Click to open the server log text fi= le - - + + + Open Log + + + Click to open the server log text file + + = - - - Restore Log - - - Click to restore the server log - - + + + Restore Log + + + Click to restore the server log + + = - - -
+ + + = -
+
= -
- Server Editor - By double-clicking on any server, an editor window will = appear allowing you to +
+ Server Editor + By double-clicking on any server, an editor window will appear al= lowing you to edit parts of that server. = -
- Preferences Page for the Chosen 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 + + Tip: + On the figure you can see that a username/password is available = in the UI when configuring the server. If you get a SecurityException= when trying to launch the server, it is most likely because your server is prote= cted and hence you need to fill the username/password fields with appropriate val= ues. - - = - Under the - Publishing section it' poss= ible to disable/inable the automatic publishing of the changes in the works= pace. + = - It should be pointed out that our server adapter by defa= ult tries to automatically + Under the + Publishing + section it' possible to disable/inable the automatic = publishing of the changes in the workspace. + + It should be pointed out that our server adapter by default 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 Server editor is provided where the + section in the Server editor is provi= ded where the port settings are configurable. Click the Configure... - link to bring up the wizard for adjusting the = settings for the + link to bring up the wizard for adjusting the settings for= the ports. = -
- Server Ports Preferences - - - - - -
+
+ Server Ports Preferences + + + + + +
= - Press + Press Edit XPath - button for the chosen port to configure its XP= ath's values. + button for the chosen port to configure its XPath's values= . = -
- XPath Pattern for a Server Port - - - - - -
+
+ XPath Pattern for a Server Port + + + + + +
= - In the Server editor you are able t= o edit the timeouts and the server pollers to use. - = - - Note: - By default, the Startup poller is set to JMX Pol= ler (see the - Server Polling section= ). If you change the Startup poller + In the Server editor you are able to edit th= e timeouts and the server pollers to use. + + + Note: + By default, the Startup poller is set to JMX Poller (see the + Server Polling + section). If you change the Startup poller to Timeout Poller (it may need in case, for example, you&a= pos;re using the minimal configuration for your server), this will do no po= lling at all and will only set the server state to - "Started" af= ter your startup timeout is reached. - + "Started" + after your startup timeout is reached. + = - Server editor m= akes it also possible to + + Server editor makes it also possible to modify the server's launch configuration. It's j= ust after clicking Open launch configuration - link. In the open window there are the tabs fo= r setting command line + link. In the open window there are the tabs for setting co= mmand line arguments, main, classpaths and other things that are rele= vant to launching the server. = -
- Launch Configuration Properties - - - - - -
+
+ Launch Configuration Properties + + + + + +
= - = - The first tab shows the Jboss server arguments - Look up AS Installation Guide to find parameters whi= ch can be specified for JBoss + + The first tab shows the Jboss server arguments + Look up AS Installation Guide to find p= arameters which can be specified for JBoss Server. = - - Note: - Please note, that the Launch Configurations for JBos= s Servers are enough + + Note: + Please note, that the Launch Configurations for JBoss Servers ar= e enough strict in enforcing the configured values in the serve= r in order to avoid inconsistencies between server's and their config= ured runtime. = - For example, if you change the launch configuration = program arguments to + For example, if you change the launch configuration program argu= ments to "-c myConfig" but d= o not change the targeted runtime configuration, then your program argu= ments will be ignored. The server runtime "wins" so to speak. This ensu= res consistency and if you change the location of the runtime, your la= unch configurations will automatically pick that up. = - Values are not controlled by the server and its runt= ime setup will be passed + Values are not controlled by the server and its runtime setup wi= ll be passed on unaltered. - - = - On the second tab you find the main class used for launc= hing JBoss AS (default is org.jboss.Main), you can change it, if necessary.= + = - Until 3.0.0.GA release of JBoss Tools, the servers classpath + On the second tab you find the main class used for launching JBos= s AS (default is org.jboss.Main), you can change it, if necessary. + + Until 3.0.0.GA release of JBoss Tools, the s= ervers classpath was readonly, but that caused problems for users wanting t= o add their own jars in the startup classpath. That is relevant if you need to pat= ch the server, add a custom charset or other tweaks that require early access t= o the classpath. = - Now all servers have a custom 'server runtime class= path + Now all servers have a custom 'server runtime classpath container', which is there by default and point to th= e default jars in JBoss. You can now adjust the classpath. Then just make su= re this container is there if you want the classpath to be picked up. = -
- Server Classpaths - - - - - -
+
+ Server Classpaths + + + + + +
= - If for some reason you have a launch configuration witho= ut this container, + If for some reason you have a launch configuration without this c= ontainer, Restore Default Entries - should add it properly. Also, + should add it properly. Also, Restore Default Entries - will also remove any extra entries you added y= ourself. - Using Deployment tab you configure = local deployment settings. + will also remove any extra entries you added yourself. + Using Deployment tab you configure local dep= loyment settings. = - = -
- Deployment tab - - - - - -
- Using the group of radio buttons in Default Se= ttings section = + +
+ Deployment tab + + + + + +
+ Using the group of radio buttons in Default Settings se= ction = a user can set where the application will = be deployed to.By default it is deployed to the user's wor= kspace folder, = exactly to [workspaceDirecotry]\.metadata\.plugi= ns.If you would like the application to be deployed to your Jboss - server deploy folder select Use the JB= oss deploy folder. + server deploy folder select Use the JB= oss deploy folder + . The option to specify your custom deploy folder is also av= ailable. -
+
= -
- Relevant Resources Links - Find more about XPath in the XPath +
+ 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, +
+ Project Archives View + Every application, whether Plain Old Java, J2EE, or some other lan= guage 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 + + Note: + Those who use ANT will appreciate how the Project Archives Ant ta= sk is now improved: it supports variables and gives more informative= error/logging messages when something goes wrong. - + = - But JBoss Tools come with our own Archi= ves tool with a bit easier + But JBoss Tools come with our own Archives to= ol 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 Project Archives view, to set up each packaging configuration. - So far, let's look through all functionality that the <= property>Project + So far, let's look through all functionality that the Project Archives view provides. = -
- Overview +
+ Overview = - The packaging configuration for each project is stored i= n the project's root + The packaging configuration for each project is stored in the pro= ject's root folder, and is in a file named .packages - , which has a fairly simple XML structure. Modi= fying the file by hand is + , which has a fairly simple XML structure. Modifying the fi= le by hand is neither required nor recommended, and using the UI is the = official way of modifying your packaging structure. = -
- Archives View - - - - - -
+
+ Archives View + + + + + +
= - A project's configuration contains archives. As you= can see on the image + 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, + In the upper right corner of the view you can see an icon which, = when clicked, will build the selected top-level archive. Additionally, y= ou can select Project > Build Packages - when a project is selected in the Pa= ckages View to + when a project is selected in the Packages View<= /property> to build all declared packages in that project's .packages - file. This will execute a full build on all de= clared archives. -
+ file. This will execute a full build on all declared archi= ves. +
= -
- Creating an Archive +
+ Creating an Archive = - When you open the Project archives view for the first time, + When you open the Project archives view for = the first time, it asks you to select the project for what you want to cre= ate an archive. = -
- Archives View - - - - - -
+
+ Archives View + + + + + +
= - When creating a new archive for selected project, you ha= ve some different options + When creating a new archive for selected project, you have some d= ifferent options at your disposal. You need right-click inside the view and= select New Archive - to see your archive type options. + to see your archive type options. = -
- Create an Archive - - - - - -
+
+ Create an Archive + + + + + +
= - - Note: - If you see only JAR from the list of available archi= ve types, you should + + Note: + If you see only JAR from the list of available archive types, yo= u 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 standard archive type, a= nd does very little + + JAR is the standard archive type, and does very l= ittle 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, + The other types, for the most part, simply start off with a defau= lt 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, the archive will be = created with a few filesets relevant to the known structure of the project. = - Here is the first page of all New archive wizards. It is= the same for any archive + 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 - - - - - -
+
+ New WAR Wizard + + + + + +
= - The page is pretty simple. First it asks to set the name= of your new archive and a + 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 + The destination of an archive can be anywhere on the file 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 + or file system - ) for marking the destination as related to eit= her workspace or file + ) for marking the destination as related to either workspac= e 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 + button. At the bottom of the list, you'll see archive= s that have been declared in the workspace. = -
- Selecting the destination 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 + Also in the wizard for creating a new archive you can choose whet= her 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 + section. + If a build or incremental update fails Project Archives will show= an error dialog: -
- Selecting the destination in the workspace - - - - - -
- Click in +
+ Selecting the destination in the workspace + + + + + +
+ Click in Details - to see detailed information about what caused = the error. + to see detailed information about what caused the error. = - In the Package Explorer you can obs= erve the created + In the Package Explorer you can observe the = created archive. -
- The Archive in the Package Explorer - - - - - -
+
+ The Archive in the Package Explorer + + + + + +
= - If you use the exploded type of archiving, instead of a = single file archive the + If you use the exploded type of archiving, instead of a single fi= le archive the result put into a folder is displayed in the Pac= kage Explorer. -
- The Exploded Archive 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 +
+ Creating a Folder + Creating a folder is much easier. You simply right-click on an a= rchive 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 +
+
+ Creating a FileSet + To create a new fileset, you click on an available target locati= on such as an archive, a nested archive, or a folder within an archi= ve, and select - New Fileset. - The New Fileset wizard requires= a destination (where the + New Fileset. + + The New Fileset wizard requires a destinati= on (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 - - - - - -
+
+ Adding a New FileSet + + + + + +
= - Below that, the fileset requires only an includes pa= ttern and an excludes + Below that, the fileset requires only an includes pattern 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 flattening or without = it. Look at the difference + You can create a Fileset with flattening or without it. Look at = the difference on the figure below. = -
- The FileSet with flattening and without it</tit= le> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/perspective/persp= ective_24a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>The FileSet with flattening and without it + + + + + +
= -
- = -
- Creating User Library FileSet - = - If you use user libraries in your projects you can a= lso refer to these from project archives and have all the .jar/.zip files t= hey refer included into the archive. - To add a new user libraries file set, call the right= -click menu on the necessary archive and choose " New User Libraries F= ileSet" item - = -
- Adding New User Library Fileset - - - - - -
- = - You can edit the existing user libraries as well usi= ng "User Libraries Fileset Wizard". Call the right-click menu on = the library fileset and choose "Edit Fileset " item - = -
- Editing User Library Fileset - - - - - -
- = -
- = -
+
= -
- Archive Actions -
- Context Menu on the Item - - - - - -
- The context menu on the items in the view is extendable,= but there are several +
+ Creating User Library FileSet + + If you use user libraries in your projects you can also refer to= these from project archives and have all the .jar/.zip files they refer in= cluded into the archive. + To add a new user libraries file set, call the right-click menu = on the necessary archive and choose " New User Libraries FileSet"= item + +
+ Adding New User Library Fileset + + + + + +
+ + You can edit the existing user libraries as well using "Use= r Libraries Fileset Wizard". Call the right-click menu on the library = fileset and choose "Edit Fileset " item + +
+ Editing User Library Fileset + + + + + +
+ +
+ +
+ +
+ Archive Actions +
+ Context Menu on the Item + + + + + +
+ The context menu on the items in the view is extendable, but ther= e are several that come standard. = - - Context Menu on the Item - - - +
+ Context Menu on the Item + + + = = - - - - Name - + + + + Name + = - - Description - - - + + Description + + + = - + = - - - Build Archive (Full) - + + + Build Archive (Full) + = - - The action enabled only on top-level= archives, which initiates + + The action enabled only on top-level archives, which initiat= es a full build on that archive - - + + = - - - Edit Archive - + + + Edit Archive + = - - Standard action that brings up the w= izard associated with that + + Standard action that brings up the wizard associated with th= at particular node type and allows the de= tails to be changed - - + + = - - - Delete Archive - + + + Delete Archive + = - - Deleting node is standard action wit= h deletion not needing an + + Deleting node is standard action with deletion not needing an explanation - - + + = - - - Publish To Server - + + + Publish To Server + = - - The action means the ability to publ= ish to a declared + + The action means the ability to publish to a declared server - - + + = - - - Edit publish settings - + + + Edit publish settings + = - - Gives possibility to edit an archive= publish settings - - + + Gives possibility to edit an archive publish settings + + = - - -
- = - - Note: - When editing an archive, it is also updated in all f= olders and other archives where it is nested. - -
+ + + = -
- Publishing to Server - Finally, you'll need to publish your application to= a server. Here, we + + Note: + When editing an archive, it is also updated in all folders and o= ther archives where it is nested. + +
+ +
+ Publishing to Server + Finally, you'll need to publish your application to a server= . Here, we show you how to do it with the help of - Archives View. + Archives View. + = -
- Context Menu on the Item - - - - - -
- The dialog above appears after selecting +
+ 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 + action on that particular Archive to publish always to tha= t 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 + The automatic publishing feature is nice if, for example, your pa= ckage'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. -
- + +
= -
+
= = --===============8265104472312573986==--