Configure the client deployment descriptor for handler classes with an assembly tool

This topic explains how to use an assembly tool to configure the client deployment descriptor for user-provided handler classes.

 

Before you begin

You need an EAR file for the applications that you want to configure. For some handler use, such as logging or tracing, only the server or client application needs to be configured. For other handler use, including sending information in SOAP headers, the client and server applications must be configured with symmetrical handlers.

The modules in the EAR file should contain the handler classes to configure. These classes implement the javax.xml.rpc.handler.Handler interface. For more information on writing handler classes, see chapter 6 of the Web Services for Java 2 Platform, Enterprise Edition (J2EE) specification and chapter 12 of the Java API for XML-based remote procedure call (JAX-RPC) specification available through Web services: Resources for learning. The application modules must contain the webservices.xml(for server) and the client deployment descriptors.

You must configure the assembly tool before use it.

 

Overview

Configure a handler in the client deployment descriptor by following the steps provided:

 

Procedure

  1. Start an assembly tool. The Eclipse assembly tools, Application Server Toolkit (AST) and Rational Web Developer, provide a graphical interface for developing code artifacts, assembling the code artifacts into various archives (modules) and configuring related J2EE V1.2, 1.3 or 1.4 compliant deployment descriptors.

  2. Click File > Import and import the EAR file into the assembly tool.

  3. Open the J2EE perspective by clicking Windows >Open Perspective > Other >J2EE.

  4. Click the Navigator tab to switch to the Navigator pane.

  5. Locate the project that contains the client deployment descriptor. Expand the directories under the project until the META-INF or WEB-INF directory and its contents, including the client deployment descriptor file, are visible.

  6. Right-click the client deployment descriptor file. The client deployment descriptor information is located in the web.xml file for web clients; the ejb-jar.xml file for EJB clients; or in the application-client.xml file for application clients.

  7. Click Open. The Deployment Descriptor editor is opened.

  8. Click the WS Handler tab at the bottom of the editor window.

    1. Select the service_reference for which you want to configure the handler.

  9. Click Add at the bottom of the Handlers section. A New Handler window opens. Select Browse and a Class browser opens.

  10. Browse for the name of the Handler class in the module. When it displays in the Matching types field, select the class and click OK.

  11. (Optional) Configure properties in the Handlers pane. See Handler class properties for a list of the properties one can configure in this step.

  12. Type ctrl-s to save the changes.

 

Result

You have a client deployment descriptor that is configured.

 

What to do next

Test the Web services client. This task explains how to test an unmanaged client Java archive (JAR) file and an unmanaged client application.

 

See also


Handler class properties
Example: Configuring handler classes for Web services deployment descriptors

 

See Also


../../../../com.ibm.websphere.pmc.nd.doc/concepts/cjw_handler.html../../../../com.ibm.websphere.pmc.nd.doc/concepts/cjw_handler.html

 

Related Tasks


Configuring the webservices.xml deployment descriptor for handler classes