The client deployment descriptor editor is organized with scrollable pages
and collapsible sections that represent the various properties and settings
that can be defined in the deployment descriptor (application-client.xml)
and other extensions and bindings files. The editor is dynamic, and sections
and pages are created based on the client deployment descriptor version and
the workbench capabilities preferences.
The core function is typically located at the top of the page. The extensions
and bindings are usually nested sections at the bottom of the editor pages.
Collapsing a section hides the content, but leaves the heading information.
This is useful in filtering through the data and properties on each page.
Depending on the properties of the project and the enabled capabilities,
the client deployment descriptor editor typically helps you to modify the
following resources:
- application-client.xml
- ibm-application-client-bnd.xmi
- ibm-application-client-ext.xmi
- webservicesclient.xml
- ibm-webservicesclient-bnd.xmi
- ibm-webservicesclient-ext.xmi
The client deployment descriptor editor typically displays the following
pages:
Overview page
The Overview page in the client editor
provides a quick summary of the contents in the client deployment descriptor.
This page includes the following sections:
- General Information section
- Use the General Information section to view and edit the display name
and description for the application client.
- References section
- On the Overview page, the References section shows the currently defined
references and links you to the References page of the editor.
- Environment Variables
- Use the Environment Variables section to define environment variables
for the application client module.
- Icons section
- Use the Icons section to choose icons that represent your client application.
These icons are mainly used for identification on the server. In order to
use an icon, you must first import the graphic file into the enterprise application
project (basically, it must be contained inside the EAR file in order for
it to be found at deploy time). Once the file has been imported into the project,
you will be able to select it within the icon dialog on the client deployment
descriptor editor. If you do not import the file into the project, you will
not see any icons within the dialogs.
- Main-Class section
- Use the Main-Class section to edit or refresh the Main-Class for the application
client. Clicking Edit opens the JAR dependency editor
where the Main-Class attribute is defined. Clicking Refresh forces
an update of the field in the application client editor.
- Callback Handler
- For J2EE 1.3 and 1.4 only, use the Callback Handler section to specify
the class that the application client will use for handling callback.
- WebSphere® Extensions
- This section shows additional extension properties that you can define
specifically for the WebSphere Application Server. For example, you could specify
whether you want to allow JTA demarcation.
References page
Use the References page to define references
for the application client deployment descriptor. See
Defining
references for J2EE modules for more information.
On this page, you
can also define a JNDI name for the reference. This is a WebSphere Application
Server binding property. For more information, see the WebSphere Application
Server documentation.
WS Extension page
For J2EE 1.4 project only, use
this page to define Web service client security extensions for WebSphere Application
Server.
WS Binding page
For J2EE 1.4 project only, use this
page to define Web service client bindings for WebSphere Application Server.
WS Handler page
For J2EE 1.3 and 1.4 project only,
use the Handlers page to define Web service handlers for each Web service
reference that is defined for the enterprise beans in the EJB module. See Defining Web service handlers for
more information.
Source page
Use the Source page to view and modify
the XML source code directly. The XML on the source page changes dynamically
when the deployment descriptor is edited, and the other pages of the application
deployment descriptor editor reflect changes that you make on the Source page.
Editing the XML source is not the recommended method for editing the deployment
descriptor. It is suggested that you make as many changes as possible using
the other pages and sections of the editor.