Given the command
<prompt> rwsfgen -projectname MyProject MyService.wsdl |
HydraExpress generates a project named MyProject containing server and client side code, and creates a code generation directory MyProject, where it places all the generated files.
HydraExpress supports only file paths without spaces, so when naming your project, do not include spaces, since HydraExpress uses the project name as a basis for the name of the code generation directory.
Section 20.4.1 illustrates the architecture of the generated classes. Section 20.4.2 describes the generated output.
The generator creates a log file rwsfgen.log, located in the directory where the generator was invoked, listing all generated files. It also produces errors and warnings for unrecognized or unsupported features in the WSDL file. Errors halt the generation process; warnings are treated as diagnostic messages only, so the generator attempts to produce code from any WSDL document, regardless of whether it is valid. Providing an invalid document to the generator may result in code that does not compile.
Errors halt the code generation process by default. You may override this with the switch -nohaltonerror; however using this switch may result in code generation errors or uncompilable code.
HydraExpress creates several subdirectories containing the generated files, as well as a project file reflecting the various options used when generating the project. For more detail on the project file and the code generation directory, see Chapter 21, "The Project File and Directory Structure."
This section includes UML diagrams of the interfaces that HydraExpress creates.
Additional files may be generated, depending on your project. For instance, if you use a -standalone option when generating code, a special standalone server is generated; or if your WSDL contains the message pattern notification, notification classes are generated.
The server-side class architecture shown above supports the common Web service request-response message pattern and the one-way, client-to-server message pattern.
The servlet processes service messages through the message handlers configured in <servicecontextname>_handlers.xml. The above diagram shows the minimum number of such handlers, <binding>Skeleton, which handles the SOAP binding, and <portType>Imp, which is the server implementation containing the business logic.
Both the binding skeleton and the service implementation derive from base classes, the library class rwsf::ServiceSkeletonBase for the binding, and the generated class <portType>Base for the implementation. By default, HydraExpress generates a sample implementation, <portType>Imp. You can implement your service by editing this file, or you can derive your own implementation class from <portType>Base. If you use a different name for your own derived class, there are a few changes you need to make to the configuration. See Section 8.2.2, "Using the Server Implementation."
HydraExpress generates a client proxy class, <binding>Proxy, which contains the service operation methods, and a sample client implementation, <port>Client. The implementation obtains an instance of the proxy by calling one of several make() convenience functions in the proxy class. The make() methods handle the details of obtaining a rwsf::Transport instance of the correct type for communicating with the server. The transports in HydraExpress are message handlers, derived from rwsf::MessageHandler.
Table 11 shows the output files the HydraExpress code generator would produce for the command line
<prompt> rwsfgen -projectname MyProject MyService.wsdl |
where MyProject is the project name, and therefore MyProject is the code generation directory into which HydraExpress will place the generated code.
The output listing assumes
that the service name, service binding, and service port type are all specified in the WSDL as "MyService".
that the WSDL does not include notification or solicit-response message patterns. If your WSDL contains these patterns, the output results in additional files not listed here. For more information on notification, see Chapter 9, "Introduction to Message Patterns." For more information on solicit-response, see Section 9.2.5, "The Solicit-Response Pattern."
| Directory | Files | Description |
| MyProject/ | MyProject.xml | The project file defining all project elements (options, configurations, schemas, WSDLs, etc.). See Section 21.2, "The Project File." |
| makefile makefile_debug |
Project-level makefiles. Calls all makefiles in subdirectories. Overwrite-protected. | |
| makefile.include | Include makefile. Contains all makefile compiler and linker options. Edits to this file cascade down to all makefiles. Overwrite-protected. | |
| MyProject.sln | MSVC solution file. Generated for Windows platforms. | |
| app/ | makefile makefile_debug |
Makefiles. Calls all makefiles in subdirectories. Overwrite-protected. |
| /client | <MyService>Client.cpp | Sample client implementation using the client proxy. Overwrite-protected. |
| makefile makefile_debug |
Makefiles. Builds contents of app/client directory. Overwrite-protected. | |
| <MyService>Client.vcproj | MSVC project file generated for Windows platforms. | |
| /server | <MyService>Imp.cpp <MyService>Imp.h |
Sample service implementation and header files. Derives from MyService Base. You can implement your service by implementing the methods of this class, or you can derive your own class from MyServiceBase. Overwrite-protected. |
| makefile makefile_debug |
Makefiles. Builds contents of app/server directory. Overwrite-protected. | |
| <MyService>ServiceSample.vcproj | MSVC project file generated for Windows platforms. | |
| /data | <MySchema>_main.cpp | Generated sample implementation for marshaling and unmarshaling XML. Generated only if the WSDL contains or references a schema. Overwrite-protected. |
| makefile makefile_debug |
Makefiles. Builds contents of app/data directory. Overwrite-protected. | |
| <MySchema>_main.vcproj | MSVC project file generated for Windows platforms. | |
| codegen/ | makefile makefile_debug |
Makefiles. Builds contents of codegen/directory. Overwrite-protected. |
| /client | MyServiceProxy.cpp | Implementation file for the generated client proxy class. |
| makefile makefile_debug |
Makefiles. Builds contents of codegen/client directory. Overwrite-protected. | |
| MyService.vcproj | MSVC project file generated for Windows platforms. | |
| /common | [fault_message.cpp] | Optional common directory contains source files common to both client and server, generally faults. |
| makefile makefile_debug |
Makefiles. Builds contents of codegen/common directory. Overwrite-protected. | |
| project-<name>_sxcommonLibrary.vcproj | MSVC project file generated for Windows platforms. | |
| /etc | [marshallers.xml] | Contains marshalling configuration file for any generated datatypes. Generated only if datatype classes are generated. |
| /server | <MyService>Skeleton.cpp <MyService>Base.cpp |
Implementation files for the class that handles messaging and the base class for the server-side implementation. |
| makefile makefile_debug |
Makefiles. Builds contents of codegen/server directory. Overwrite-protected. | |
| <MyService>Service.vcproj | MSVC project file generated for Windows platforms. | |
| /data | makefile makefile_debug |
Makefiles. Builds contents of codegen/data directory. Overwrite-protected. |
| [<MySchema>Statics.cpp] | Static element names class, generated when the property -noTopLevelClasses is specified. | |
| <datatype>_1.vcproj | MSVC project file generated for Windows platforms. | |
| <namespace> | <Datatype>.cpp <Datatype>Marshal.cpp |
The implementation file(s) and marshaler classes for all datatypes generated, if the file input to the generator is or contains a schema. |
| conf/ | transports.xml client-transports.xml |
Configuration files for: 1. Server and client transports. |
| <servicecontextname>_handlers.xml | 2. Server-side handlers to support handler chaining and configuration. | |
| client-handlers.xml | 3. Client-side handlers containing default client logger. | |
| <servicecontextname>_objects.xml | 4. All named objects required by this service. These are registered and created when the Agent is started. | |
| <servicecontextname>_web.xml | 5. Service descriptor XML file for the service. | |
| makefile makefile_debug |
Deployment makefiles. Overwrite-protected. | |
| docs/ | index.html | The generated documentation. Use index.html as the entry point to all docs contained in the docs subdirectories. |
| include/ | Header files, as follows: | |
| /MyProject | subdirectory <projectname> | |
| <MyService>Proxy.h | Client proxy class. | |
| <MyService>Skeleton.h | Class that handles messaging. | |
| <MyService>Base.h | Base class for the server-side implementation. | |
| <datatype>_Converter.h | Conversion utility class (converts the simple types defined in the datamap to and from the underlying string class, string). | |
| [<fault>_message.h] | Fault class headers (optional). | |
| [<MySchema>Statics.h] | Static element names class, generated when the property -noTopLevelClasses is specified. | |
| /<namespace> | <datatype>.h | Datatype header file, if there was a datatype generated. |
| <datatype>Marshal.h | Datatype marshaling class, if there was a datatype generated. |
HTML API documentation is generated for each client and server class, the datatype classes, and all sample implementations. To view the HTML API documentation, open the index.html file in the docs directory. For documentation about the non-generated classes on which these generated classes may depend, see the HydraExpress C++ API Reference Guide.
If the WSDL defines XML Schema types, a data subdirectory under the directories apps, codegen, docs, and include contain generated files and documentation for the C++ XML binding classes.
The generator may produce other support files. The generator uses the support files while generating code, but the files are not required for compiling and running the generated code. These files can be preserved with the -noclean option.
To help you build the C++ generated libraries and sample applications, HydraExpress also generates the following versions of makefiles:
a debug version: makefile_debug
a non-debug version: makefile
A project-level makefile is generated in the code generation directory. This makefile builds the entire project. Makefiles are also generated in the each subdirectory in the event that you wish to build individual directories.
For Windows users with Microsoft Visual C++, HydraExpress also generates project files and solutions for MSVC.
Copyright © Rogue Wave Software, Inc. All Rights Reserved.
The Rogue Wave name and logo are registered trademarks of Rogue Wave Software, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.