Summary: This document provides information about the extension providing JAX-WS support for Web Services.
Please see JAX-WS - 1.0 - What's new for more information.
In what situation should you install this extension?
The main purpose of this extension is to create entry points, to enable linking from the server services side to the client side. Therefore if your JEE application contains source code which uses JAX-WS (JSR 224) and you want to view these object types and their links with other objects, then you should install this extension.
This extension handles JAX-WS Web Services (particularly SOAP services) used in JEE applications. JAX-WS is a collection of annotations that enables the definition of the web service contract directly inside the java code.:
JAX-WS Service is basically defined by a javax.jws.WebService (@WebService) annotation set on top of a class. This annotation may also be set on top of an interface, in this case, the interface will be the "Service Endpoint Interface" and no new web service will be created during the analysis
- An operation represents an action that can be triggered by a client application. It is represented by an object called "SOAP Java Operation". One operation represents a Java method of a @WebService class that is an annotation with @WebMethod.
- A port type represents a collection of operations, it is represented by an object called "SOAP Java Port Type" which is a child of the java file containing the class annotated by @WebService.
- The JAX-WS Extension also handles the annotation @WebServiceClient and @WebEndpoint. Two different types of object are created to represent these items: "SOAP Java Client" and "Soap Client end point". Each web end point contains a list of operations called "SOAP Java Client Operation" and they represent the operations that can be remotely invoked on the server offering the web service.
Support of Apache CXF
The Apache CXF API offers a mechanism where the Web service implementation is not annotated. It is instead specified inside an XML file (cxf-context.xml file). This is in fact a kind of integration with Spring. This extension will handle JAX-WS Web services generated using the Apache CXF framework.
A JAX-WS Web service implemented by a Spring bean defined in a Spring XML configuration file and declared via the Apache CXF should be correctly detected and created with this extension. All expected operations and links will be created.
Support of Spring-WS
Spring-WS provides a client-side Web service API that allows for consistent, XML-driven access to Web services. The WebServiceTemplate is the core class for client-side Web service access in Spring-WS. It contains methods for sending Source objects, and receiving response messages as either Source or Result. This extension will identify client-side services using WebServiceTemplate Methods that are used to invoke the webservice.
Support of Handlerchain
This extension handles the links to the close, handleMessage and handleFault methods which will be called for the request or response. @HandlerChain annotation provides the xml file where the handle class name is specified. This extension finds the the handler class and creates the links from the operations to the methods.
|Quality and Sizing|
CAST AIP release
Supported DBMS servers
This extension is compatible with the following DBMS servers:
|CAST AIP release||CSS||Oracle||Microsoft|
|All supported releases (see above)|
An installation of any compatible release of CAST AIP (see table above)
Dependencies with other extensions
Some CAST extensions require the presence of other CAST extensions in order to function correctly. The JAX-WS extension requires that the following other CAST extensions are also installed:
- Web services linker service (internal technical extension).
Download and installation instructions
The latest release status of this extension can be seen when downloading it from the CAST Extend server.
CAST Transaction Configuration Center (TCC) Entry Points
In JAX-WS ≥ 1.0.x, a set of JAX-WS Transaction Entry / End Points for use in the CAST Transaction Configuration Center is delivered in the extension via a .TCCSetup file. Therefore If you are using JAX-WS ≥ 1.0.x:
- with CAST AIP ≥ 8.3.x, there is nothing for you to do: these entry / end points will be automatically imported during the extension installation and will be available in the CAST Transaction Configuration Center under "Entry Points > Free Definition".
- with CAST AIP ≤ 8.2.x, you can manually import the file Configuration\TCC\Base_JAXWS.TCCSetup to obtain your entry / end points in the "Free Definition" section (see instructions below).
Manual import action for CAST AIP ≤ 8.2.x
- Locate the .TCCSetup file in the extension folder: Configuration\TCC\Base_JAXWS.TCCSetup
- In the CAST Transaction Configuration Center, ensure you have selected the Templates node:
- This .TCCSetup file is to be imported into the CAST Transaction Calibration Center using either the:
- File > Import Configuration menu option:
- Or right clicking on the Template node and selecting Import Configuration:
- The import of the "Configuration\TCC\Base_JAXWS.TCCSetup" file will provide you with a sample Transaction Entry point in the Free Definition node under Templates.
- Now right click the "Standard Entry Point" item and select copy:
- Paste the item into the equivalent node under the Application, for example, below we have copied it into the Application MEUDON:
- Repeat for any additional items or generic sets that have been imported from the .TCCSetup file.
Packaging, delivering and analyzing your source code
Once the extension is installed, no further configuration changes are required before you can package your source code and run an analysis. The process of packaging, delivering and analyzing your source code does not change in any way:
- Package and deliver your application (that includes source code which uses JAX-WS) in the exact same way as you always have. You can refer to the existing official CAST documentation for more information about this - http://doc.castsoftware.com/display/DOC83/Source+Code+Delivery+Guide+for+Application+Teams for more details.
- Analyze your delivered application source code in the CAST Management Studio in the exact same way as you always have - the source code which uses JAX-WS will be detected and handled correctly. You can refer to the existing official CAST documentation for more information about configuring an analysis - see:
What results can you expect?
- The extension is shipped with a set of CAST Transaction Configuration Center Entry Points, specifically related to JAX-WS Please see CAST Transaction Configuration Center (TCC) Entry Points for more information about this.
- Once the analysis/snapshot generation has completed, HTTP API transaction entry points will be available for use when configuring the CAST Transaction Configuration Center. In addition, you can view the results in the normal manner (for example via CAST Enlighten).
The following objects are displayed in CAST Enlighten:
|SOAP Java Web Service|
|SOAP Java Port Type|
|SOAP Java Operation|
|SOAP Java Client Operation|
|SOAP Java Client|
|SOAP Client end point|