OWBI1::OperationContext Class Reference

This class is used to store general information (the context) of a WBEM operation. More...

#include <OWBI1_OperationContext.hpp>

Inheritance diagram for OWBI1::OperationContext:

[legend]Collaboration diagram for OWBI1::OperationContext:

[legend]List of all members.

Public Member Functions
	OperationContext ()
virtual	~OperationContext ()
virtual void	removeData (const String &key)=0
	Remove the data identified by key.
virtual bool	keyHasData (const String &key) const =0
	Test whether there is data for the key.
virtual void	setStringData (const String &key, const String &str)=0
	These are for convenience, and are implemented in terms of the first 2 functions.
virtual String	getStringData (const String &key) const =0
	Exceptions: ContextDataNotFoundException  if key is not found
virtual String	getStringDataWithDefault (const String &key, const String &def=String()) const =0
	OperationContext (const OperationContext &)
OperationContext &	operator= (const OperationContext &)
Static Public Attributes
static const char *const	USER_NAME
static const char *const	USER_PASSWD
static const char *const	HTTP_PATH
static const char *const	CURUSER_UIDKEY
static const char *const	BYPASS_LOCKERKEY
static const char *const	SESSION_LANGUAGE_KEY
static const char *const	HTTP_ACCEPT_LANGUAGE_KEY
static const char *const	CLIENT_IPADDR

---

Detailed Description

This class is used to store general information (the context) of a WBEM operation.

It works like an associative container, with a String key, and the data is an OperationContext::DataRef. The idea is for a client of this class to create a subclass of OperationContext::Data and then pass a smart pointer to it into setData(). Convenience functions (and a subclass) are provided to use a String for the Data.

Thread safety: None Copy Semantics: Non-copyable

Definition at line 63 of file OWBI1_OperationContext.hpp.

---

Constructor & Destructor Documentation

OWBI1::OperationContext::OperationContext (   )

Definition at line 46 of file OWBI1_OperationContext.cpp.

OWBI1::OperationContext::~OperationContext (   )  [virtual]

Definition at line 51 of file OWBI1_OperationContext.cpp.

OWBI1::OperationContext::OperationContext (  const OperationContext &   )

---

Member Function Documentation

virtual String OWBI1::OperationContext::getStringData (  const String &  key  )  const [pure virtual]

Exceptions: ContextDataNotFoundException  if key is not found

virtual String OWBI1::OperationContext::getStringDataWithDefault (  const String &  key, const String &  def = String() )  const [pure virtual]

Returns: def if key is not found

virtual bool OWBI1::OperationContext::keyHasData (  const String &  key  )  const [pure virtual]

Test whether there is data for the key. Parameters: key  The key to test. Returns: true if there is data for the key.

OperationContext& OWBI1::OperationContext::operator= (  const OperationContext &   )

virtual void OWBI1::OperationContext::removeData (  const String &  key  )  [pure virtual]

Remove the data identified by key. It is not an error if key has not already been added to the context with setData(). Parameters: key  Identifies the data to remove.

virtual void OWBI1::OperationContext::setStringData (  const String &  key, const String &  str )  [pure virtual]

These are for convenience, and are implemented in terms of the first 2 functions.

---

Member Data Documentation

const char* const OWBI1::OperationContext::BYPASS_LOCKERKEY [static]

Definition at line 105 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::CLIENT_IPADDR [static]

Definition at line 108 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::CURUSER_UIDKEY [static]

Definition at line 104 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::HTTP_ACCEPT_LANGUAGE_KEY [static]

Definition at line 107 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::HTTP_PATH [static]

Definition at line 103 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::SESSION_LANGUAGE_KEY [static]

Definition at line 106 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::USER_NAME [static]

Definition at line 101 of file OWBI1_OperationContext.hpp.

const char* const OWBI1::OperationContext::USER_PASSWD [static]

Definition at line 102 of file OWBI1_OperationContext.hpp.

---

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

• OWBI1_OperationContext.hpp
• OWBI1_OperationContext.cpp

---