OW_NAMESPACE::XMLListener Class Reference

#include <OW_XMLListener.hpp>

Inheritance diagram for OW_NAMESPACE::XMLListener:

[legend]Collaboration diagram for OW_NAMESPACE::XMLListener:

[legend]List of all members.

Public Member Functions
	XMLListener (const CIMListenerCallbackRef &callback)
	Create a new XMLListener.
virtual	~XMLListener ()
virtual RequestHandlerIFC *	clone () const
virtual StringArray	getSupportedContentTypes () const
virtual String	getContentType () const
virtual String	getName () const
	Every service may have a name.
virtual void	init (const ServiceEnvironmentIFCRef &env)
	init() will be called to give the derived class an opportunity to initialize itself.
virtual void	shutdown ()
	The service must shutdown completely before returning from this function.
Protected Member Functions
virtual int	executeXML (CIMXMLParser &parser, std::ostream *ostrEntity, std::ostream *ostrError, OperationContext &context)
	After doProcess is called, and the XML is parsed, executeXML is called on the root node.
virtual void	doOptions (CIMFeatures &cf, OperationContext &context)
	Based on a path, what options are available?
virtual void	outputError (CIMException::ErrNoType errorCode, const String &msg, std::ostream &ostr)
Private Member Functions
void	processSimpleExpReq (CIMXMLParser &parser, std::ostream &ostrEntity, std::ostream &ostrError, const String &messageId, OperationContext &context)
Private Attributes
CIMListenerCallbackRef	m_callback

---

Detailed Description

Definition at line 50 of file OW_XMLListener.hpp.

---

Constructor & Destructor Documentation

OW_NAMESPACE::XMLListener::XMLListener (  const CIMListenerCallbackRef &  callback  )

Create a new XMLListener. Parameters: callback  a pointer to a CIMListenerCallback object whose method should be called when an indication occurrs. Definition at line 56 of file OW_XMLListener.cpp. Referenced by clone().

OW_NAMESPACE::XMLListener::~XMLListener (   )  [virtual]

Definition at line 61 of file OW_XMLListener.cpp.

---

Member Function Documentation

RequestHandlerIFC * OW_NAMESPACE::XMLListener::clone (   )  const [virtual]

Implements OW_NAMESPACE::RequestHandlerIFC. Definition at line 72 of file OW_XMLListener.cpp. References XMLListener().

void OW_NAMESPACE::XMLListener::doOptions (  CIMFeatures &  cf, OperationContext &  context )  [protected, virtual]

Based on a path, what options are available? Parameters: cf  a CIMFeatures object to fill out. context  the operation context. Implements OW_NAMESPACE::RequestHandlerIFC. Definition at line 129 of file OW_XMLListener.cpp. References OW_NAMESPACE::CIMFeatures::cimom, OW_NAMESPACE::CIMFeatures::cimProduct, OW_NAMESPACE::Array< T >::clear(), OW_NAMESPACE::CIMFeatures::extURL, OW_NAMESPACE::CIMFeatures::LISTENER, OW_NAMESPACE::CIMFeatures::protocolVersion, OW_NAMESPACE::Array< T >::push_back(), OW_NAMESPACE::CIMFeatures::supportedGroups, OW_NAMESPACE::CIMFeatures::supportedQueryLanguages, OW_NAMESPACE::CIMFeatures::supportsBatch, and OW_NAMESPACE::CIMFeatures::validation.

virtual int OW_NAMESPACE::XMLListener::executeXML (  CIMXMLParser &  parser, std::ostream *  ostrEntity, std::ostream *  ostrError, OperationContext &  context )  [protected, virtual]

After doProcess is called, and the XML is parsed, executeXML is called on the root node. Parameters: node  the root node. ostrEntity  the ostream to write to if no errors occurr ostrError  the ostream to write to if an error occurred. context  the operation context Returns: a HTTP status code, I think. Implements OW_NAMESPACE::RequestHandlerIFCXML.

String OW_NAMESPACE::XMLListener::getContentType (   )  const [virtual]

Reimplemented from OW_NAMESPACE::RequestHandlerIFCXML. Definition at line 214 of file OW_XMLListener.cpp.

String OW_NAMESPACE::XMLListener::getName (   )  const [virtual]

Every service may have a name. The name is used to calculate dependencies, other services can return the name from getDependencies(), to instruct the cimom about which order to start and shutdown all the services. The default is to have no name, in that case, no other service can depend on it. Reimplemented from OW_NAMESPACE::ServiceIFC. Definition at line 66 of file OW_XMLListener.cpp. References OW_NAMESPACE::ServiceIFCNames::XMLListener.

StringArray OW_NAMESPACE::XMLListener::getSupportedContentTypes (   )  const [virtual]

Reimplemented from OW_NAMESPACE::RequestHandlerIFCXML. Definition at line 205 of file OW_XMLListener.cpp. References OW_NAMESPACE::Array< T >::push_back().

void OW_NAMESPACE::XMLListener::init (  const ServiceEnvironmentIFCRef &  env  )  [virtual]

init() will be called to give the derived class an opportunity to initialize itself. Do not create threads which interact with the environment until start() is called. During the loading/initializing phase, the environment is single-threaded. Parameters: env  The service's interface to it's environment. A copy of this may be saved and re-used. All copies of env or objects obtained by calling member functions of env should be set to 0 in shutdown() to prevent circular reference counts. Implements OW_NAMESPACE::ServiceIFC. Definition at line 221 of file OW_XMLListener.cpp.

virtual void OW_NAMESPACE::XMLListener::outputError (  CIMException::ErrNoType  errorCode, const String &  msg, std::ostream &  ostr )  [protected, virtual]

Implements OW_NAMESPACE::RequestHandlerIFCXML.

void OW_NAMESPACE::XMLListener::processSimpleExpReq (  CIMXMLParser &  parser, std::ostream &  ostrEntity, std::ostream &  ostrError, const String &  messageId, OperationContext &  context )  [private]

void OW_NAMESPACE::XMLListener::shutdown (   )  [virtual]

The service must shutdown completely before returning from this function. All copies of the service environment or objects obtained from it should be set to 0 to avoid circular reference counts. Implements OW_NAMESPACE::ServiceIFC. Definition at line 227 of file OW_XMLListener.cpp.

---

Member Data Documentation

CIMListenerCallbackRef OW_NAMESPACE::XMLListener::m_callback [private]

Definition at line 89 of file OW_XMLListener.hpp.

---

The documentation for this class was generated from the following files:

• OW_XMLListener.hpp
• OW_XMLListener.cpp

---