Rogue Wave banner
Previous fileTop of DocumentContentsIndex pageNext file
HydraExpress C++ API Reference Guide
Rogue Wave web site:  Home Page  |  Main Documentation Page

2.4 Web Services Classes

Table 3: Web Services Classes

Class NameDescription

rwsf::ArrayBody

All generated SOAP array bodies derive from rwsf::ArrayBody<T> instantiated on the type of element contained in the array.

rwsf::ArrayHandle

All generated SOAP-Encoded arrays are derived from rwsf::ArrayHandle<T> instantiated on the type of element contained in the array.

rwsf::AsyncHandle

rwsf::AsyncHandle is used to represent an asynchronous operation. An instance of this class is a handle returned by an asynchronous Start() method and required for an asynchronous End() method.

rwsf::AsyncHandleImp

rwsf::AsyncHandleImp is used to create asynchronous clients.

rwsf::AsyncThread

rwsf::AsyncThread is used internally by rwsf to support the implementation of asynchronous clients.

rwsf::CallInfo

An instance of rwsf::CallInfo contains data about a message, including session or transaction data, SOAP headers, or transport headers. This class can also be used to hold any other desired data relevant to this SOAP message. A rwsf::CallInfo object is passed from the client to the transport on the client side, and from the servlet to the skeleton and down to the service implementation on the server side.

rwsf::Client

All generated client proxies derive from rwsf::Client. Clients are handlers in rwsf, so this class derives from rwsf::MessageHandler. rwsf::Client includes methods to add various handlers to the client.

rwsf::ClientFault

An instance of class rwsf::ClientFault extends rwsf::Fault to represent a SOAP client fault. A SOAP client fault is used to indicate an error caused by incorrect information from the client or a bad SOAP request.

rwsf::ClientImp

All generated client proxies derive from rwsf::ClientImp. Clients are handlers in rwsf, so this class derives from rwsf::MessageHandlerImp.

rwsf::Fault

rwsf::Fault and its derived classes rwsf::ClientFault and rwsf::ServerFault represent SOAP faults. In addition, if a fault is specified in the WSDL, rwsf generates a special class for it, which also derives from rwsf::Fault. On the client, generic faults that are not defined in the WSDL are propagated out to the client and thrown as a rwsf::SoapFaultException. To see how WSDL-defined and generic faults work, run the example Fault in your installdir\examples\webservices\Fault directory.

rwsf::HandlerManager

rwsf::HandlerManager loads, stores, and locates handlers for a service. In generated clients, it is used to set a logger. In addition, clients accessing a service through a notification-type method -- which requires setting up a listener on the client -- also use this class to initialize the client-handlers.xml configuration file.

rwsf::MessageAttachment

In generated code, rwsf represents any message parts specified in a WSDL with a Multipurpose Internet Mail Extensions (MIME) binding as type rwsf::MessageAttachment. This class encapsulates the message payload, its Content-Type, and any custom- defined Content-Id or Content-Locationdata.

rwsf::MessageHandler

The handle class of all proxies, services, skeletons, loggers, and transports are either of type rwsf::MessageHandler or derive from it.

rwsf::MessageHandlerImp

rwsf::MessageHandlerImp provides an interface for processing messages. All message handler bodies derive from this base class, including generated proxies, services, skeletons, and loggers.

rwsf::MessageListener

rwsf::MessageListener is the handle class for all listeners.

rwsf::MessageListenerImp

rwsf::MessageListenerImp is the abstract base class from which all listener body classes derive. Since listeners are handlers in rwsf, rwsf::MessageListenerImp derives from rwsf::MessageHandlerImp.

rwsf::MessageProperties

The base class for rwsf::CallInfo. Includes functionality to get and set various message and service properties, including transport properties, SOAP header properties, logging levels, and so on.

rwsf::ServerFault

An instance of class rwsf::ServerFault extends rwsf::Fault to represent a SOAP server fault.

rwsf::ServiceShutdownException

Class rwsf::ServiceShutdownException provides a means to shut down a service from within the service implementation.

rwsf::ServiceSkeletonBase

Class rwsf::ServiceSkeletonBase is an abstract base class for all generated skeletons. Its derived classes handle the details of marshaling and unmarshaling a SOAP message and trapping exceptions, which they translate into SOAP fault messages.

rwsf::SoapArray

An instance of rwsf::SoapArray is contained in rwsf::ArrayBody, from which all generated SOAP arrays derive. All methods from the generated array handle are passed to the rwsf::SoapArray body, and then on to the instance of rwsf::SoapArray that provides the typical container methods for the array.

rwsf::SoapBase

Class rwsf::SoapBase is the common abstract base class for all SOAP parsing objects, and contains functionality to get and set values for all xsi attributes, including xsi:type, xsi:nil, xsi:schemaLocation, and xsi:noNamespaceSchemaLocation.

rwsf::SoapBodyType

An instance of rwsf::SoapBodyType represents a SOAP body. This class contains unmarshaling methods to parse this SOAP message.

rwsf::SoapDetail

An instance of rwsf::SoapDetail contains the value of the optional detail element of a SOAP fault. It is used by rwsf::SoapFault.

rwsf::SoapEnvelopeType

An instance of rwsf::SoapEnvelopeType represents a SOAP envelope.

rwsf::SoapFault

rwsf::SoapFault represents a SOAP fault. A SOAP fault must contain a primary faultcode element and a faultstring element. Depending on what caused the fault, a SOAP fault may also contain a faultactor element or a detail element.

rwsf::SoapFaultException

rwsf::SoapFaultException represents generic SOAP faults in the proxy. If a fault is defined in the WSDL, a special class is generated for it; however, if it is not defined, an instance of rwsf::SoapFaultException is thrown from the client.

rwsf::SoapHeaderType

rwsf::SoapHeaderType corresponds to the SOAP header element. Each instance contains a collection of rwsf::XmlName instances representing the four SOAP header elements:

rwsf::Transport

rwsf::Transport is the handle class for all transport implementations (body classes which derive from rwsf::TransportImp). A transport is a message handler, so this class derives from rwsf::MessageHandler. Generated proxy classes hold a transport handle which is either directly passed in or inferred from a URL. Generated clients have a member of this type.

rwsf::TransportImp

rwsf::TransportImp is an abstract base class and the body of the handle represented by rwsf::Transport.

rwsf::TransportManager

The class rwsf::TransportManager manages the use of transports and listeners for a message. It is used by the generated proxy to initialize the appropriate transport or listener for that proxy.

rwsf::WebServiceServlet

The class rwsf::WebServiceServlet is the class from which all servlets in HydraExpress are derived. The servlet is automatically instantiated by the rwsf server when the server is started, and is based on the web.xml file generated by HydraExpress for your project. The servlet creates a rwsf::NamingContext context object for each service. This context contains all rwsf::NamedObject objects that are required by the service.



Previous fileTop of DocumentContentsIndex pageNext file

© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.