OW_NAMESPACE::XMLExecute

OW_NAMESPACE::XMLExecute Class Reference

#include <OW_XMLExecute.hpp>

Inheritance diagram for OW_NAMESPACE::XMLExecute:

Inheritance graph
[legend]
Collaboration diagram for OW_NAMESPACE::XMLExecute:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 XMLExecute ()
virtual ~XMLExecute ()
int executeXML (CIMXMLParser &parser, std::ostream *ostrEntity, std::ostream *ostrError, OperationContext &userName)
 After doProcess is called, and the XML is parsed, executeXML is called on the root node.
virtual RequestHandlerIFC * clone () const

Protected Member Functions

virtual void doOptions (CIMFeatures &cf, OperationContext &context)
 Fill out the Features that the request handler at the path supports.
virtual void outputError (CIMException::ErrNoType errorCode, const String &msg, std::ostream &ostr)
virtual String getName () const
 Every service may have a name.
virtual StringArray getDependencies () const
 Get the list of services this service depends on.
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.

Private Types

typedef void(XMLExecute::* execFuncPtr_t )(std::ostream &ostr, CIMXMLParser &qualNode, const String &ns, CIMOMHandleIFC &hdl)

Private Member Functions

void executeIntrinsic (std::ostream &osrt, CIMXMLParser &parser, CIMOMHandleIFC &hdl, const String &ns)
 
Exceptions:
IOException 

void executeExtrinsic (std::ostream &ostr, CIMXMLParser &parser, CIMOMHandleIFC &lch)
void doInvokeMethod (std::ostream &ostr, CIMXMLParser &parser, const String &methodName, CIMOMHandleIFC &lch)
void processSimpleReq (CIMXMLParser &parser, std::ostream &ostrEntity, std::ostream &ostrError, OperationContext &context)
void associatorNames (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void associators (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void createClass (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void modifyClass (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void deleteClass (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void createInstance (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void deleteInstance (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void modifyInstance (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void setProperty (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void enumerateClassNames (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void enumerateClasses (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void enumerateInstanceNames (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void enumerateInstances (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void getClass (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void getInstance (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void getProperty (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void getQualifier (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void referenceNames (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void references (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void setQualifier (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void deleteQualifier (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void enumerateQualifiers (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)
void execQuery (std::ostream &ostr, CIMXMLParser &parser, const String &ns, CIMOMHandleIFC &hdl)

Static Private Member Functions

static void getParameters (CIMXMLParser &parser, CIMParamValueArray &params)
static bool funcEntryCompare (const FuncEntry &f1, const FuncEntry &f2)

Private Attributes

std::ostream * m_ostrEntity
std::ostream * m_ostrError
bool m_isIntrinsic
String m_functionName
CIMObjectPath m_commMechPath
CIMObjectPath m_hostedAccessPointPath
CIMObjectPath m_commMechForManager

Static Private Attributes

static FuncEntry g_funcs []
static FuncEntry * g_funcsEnd

Classes

struct  FuncEntry

Detailed Description

Definition at line 53 of file OW_XMLExecute.hpp.

Member Typedef Documentation

typedef void(XMLExecute::* OW_NAMESPACE::XMLExecute::execFuncPtr_t)(std::ostream &ostr, CIMXMLParser &qualNode, const String &ns, CIMOMHandleIFC &hdl) [private]
 

Definition at line 150 of file OW_XMLExecute.hpp.

Constructor & Destructor Documentation

OW_NAMESPACE::XMLExecute::XMLExecute (   ) 
 

Definition at line 161 of file OW_XMLExecute.cpp.

Referenced by clone().

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

Definition at line 173 of file OW_XMLExecute.cpp.

Member Function Documentation

void OW_NAMESPACE::XMLExecute::associatorNames (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::associators (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

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

Implements OW_NAMESPACE::RequestHandlerIFC.

Definition at line 1418 of file OW_XMLExecute.cpp.

References m_ostrEntity, m_ostrError, OW_ASSERT, and XMLExecute().

void OW_NAMESPACE::XMLExecute::createClass (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::createInstance (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::deleteClass (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::deleteInstance (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::deleteQualifier (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::doInvokeMethod (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  methodName,
CIMOMHandleIFC &  lch
)  [private]
 

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

Fill out the Features that the request handler at the path supports.

Parameters:
cf The features to fill out.
path The requested path

Implements OW_NAMESPACE::RequestHandlerIFC.

Definition at line 1411 of file OW_XMLExecute.cpp.

References context, and OW_NAMESPACE::RequestHandlerIFC::getEnvironment().

void OW_NAMESPACE::XMLExecute::enumerateClasses (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::enumerateClassNames (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::enumerateInstanceNames (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::enumerateInstances (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::enumerateQualifiers (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::execQuery (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::executeExtrinsic (  std::ostream &  ostr,
CIMXMLParser &  parser,
CIMOMHandleIFC &  lch
)  [private]
 

void OW_NAMESPACE::XMLExecute::executeIntrinsic (  std::ostream &  osrt,
CIMXMLParser &  parser,
CIMOMHandleIFC &  hdl,
const String &  ns
)  [private]
 

Exceptions:
IOException 

int OW_NAMESPACE::XMLExecute::executeXML (  CIMXMLParser &  parser,
std::ostream *  ostrEntity,
std::ostream *  ostrError,
OperationContext &  userName
)  [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.

bool OW_NAMESPACE::XMLExecute::funcEntryCompare (  const FuncEntry &  f1,
const FuncEntry &  f2
)  [static, private]
 

Definition at line 155 of file OW_XMLExecute.cpp.

References OW_NAMESPACE::XMLExecute::FuncEntry::name.

void OW_NAMESPACE::XMLExecute::getClass (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

StringArray OW_NAMESPACE::XMLExecute::getDependencies (   )  const [protected, virtual]
 

Get the list of services this service depends on.

The returned services will be started before and shutdown after this service. It is an error to return the name of a non-existent service, and the cimom startup will fail. The default is to have no dependencies.

Reimplemented from OW_NAMESPACE::ServiceIFC.

Definition at line 184 of file OW_XMLExecute.cpp.

References OW_NAMESPACE::ServiceIFCNames::CIMServer, and OW_NAMESPACE::Array< T >::push_back().

void OW_NAMESPACE::XMLExecute::getInstance (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

String OW_NAMESPACE::XMLExecute::getName (   )  const [protected, 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 178 of file OW_XMLExecute.cpp.

References OW_NAMESPACE::ServiceIFCNames::XMLExecute.

void OW_NAMESPACE::XMLExecute::getParameters (  CIMXMLParser &  parser,
CIMParamValueArray &  params
)  [static, private]
 

Definition at line 326 of file OW_XMLExecute.cpp.

References OW_NAMESPACE::CIMXMLParser::A_NAME, OW_NAMESPACE::CIMXMLParser::A_PARAMTYPE, OW_NAMESPACE::CIMXMLParser::E_PARAMVALUE, OW_NAMESPACE::String::empty(), OW_NAMESPACE::XMLPullParser::getAttribute(), OW_NAMESPACE::XMLPullParser::mustGetAttribute(), and OW_NAMESPACE::CIMXMLParser::tokenIsId().

void OW_NAMESPACE::XMLExecute::getProperty (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::getQualifier (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::init (  const ServiceEnvironmentIFCRef &  env  )  [protected, 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 1464 of file OW_XMLExecute.cpp.

References OW_NAMESPACE::COMPONENT_NAME, context, OW_NAMESPACE::ConfigOpts::DISABLE_INDICATIONS_opt, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMObjectPath::getKeyValue(), hdl, OW_NAMESPACE::ConfigOpts::INTEROP_SCHEMA_NAMESPACE_opt, logger, OW_DEFAULT_DISABLE_INDICATIONS, OW_DEFAULT_INTEROP_SCHEMA_NAMESPACE, OW_THROWCIMMSG, OW_NAMESPACE::Array< T >::push_back(), and OW_NAMESPACE::RequestHandlerIFC::setEnvironment().

void OW_NAMESPACE::XMLExecute::modifyClass (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::modifyInstance (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

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

Implements OW_NAMESPACE::RequestHandlerIFCXML.

void OW_NAMESPACE::XMLExecute::processSimpleReq (  CIMXMLParser &  parser,
std::ostream &  ostrEntity,
std::ostream &  ostrError,
OperationContext &  context
)  [private]
 

void OW_NAMESPACE::XMLExecute::referenceNames (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::references (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::setProperty (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::setQualifier (  std::ostream &  ostr,
CIMXMLParser &  parser,
const String &  ns,
CIMOMHandleIFC &  hdl
)  [private]
 

void OW_NAMESPACE::XMLExecute::shutdown (   )  [protected, 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 1669 of file OW_XMLExecute.cpp.

References OW_NAMESPACE::cleanupInteropInstance(), OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::RequestHandlerIFC::getEnvironment(), logger, m_commMechForManager, m_commMechPath, m_hostedAccessPointPath, OW_ASSERT, and OW_NAMESPACE::RequestHandlerIFC::setEnvironment().

Member Data Documentation

XMLExecute::FuncEntry OW_NAMESPACE::XMLExecute::g_funcs [static, private]
 

Definition at line 158 of file OW_XMLExecute.hpp.

XMLExecute::FuncEntry * OW_NAMESPACE::XMLExecute::g_funcsEnd [static, private]
 

Initial value:

 &XMLExecute::g_funcs[0] +
   (sizeof(XMLExecute::g_funcs)/sizeof(*XMLExecute::g_funcs)) - 1

Definition at line 160 of file OW_XMLExecute.hpp.

CIMObjectPath OW_NAMESPACE::XMLExecute::m_commMechForManager [private]
 

Definition at line 167 of file OW_XMLExecute.hpp.

Referenced by shutdown().

CIMObjectPath OW_NAMESPACE::XMLExecute::m_commMechPath [private]
 

Definition at line 163 of file OW_XMLExecute.hpp.

Referenced by shutdown().

String OW_NAMESPACE::XMLExecute::m_functionName [private]
 

Definition at line 76 of file OW_XMLExecute.hpp.

CIMObjectPath OW_NAMESPACE::XMLExecute::m_hostedAccessPointPath [private]
 

Definition at line 165 of file OW_XMLExecute.hpp.

Referenced by shutdown().

bool OW_NAMESPACE::XMLExecute::m_isIntrinsic [private]
 

Definition at line 75 of file OW_XMLExecute.hpp.

std::ostream* OW_NAMESPACE::XMLExecute::m_ostrEntity [private]
 

Definition at line 73 of file OW_XMLExecute.hpp.

Referenced by clone().

std::ostream* OW_NAMESPACE::XMLExecute::m_ostrError [private]
 

Definition at line 74 of file OW_XMLExecute.hpp.

Referenced by clone().

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:16:48 2006 for openwbem by  doxygen 1.4.6