OW_NAMESPACE::HTTPXMLCIMListener Class Reference

#include <OW_HTTPXMLCIMListener.hpp>

Collaboration diagram for OW_NAMESPACE::HTTPXMLCIMListener:


Public Member Functions
	HTTPXMLCIMListener (const LoggerRef &logger=LoggerRef(0), const String &certFileName=String(), const String &keyFileName=String())
	~HTTPXMLCIMListener ()
String	registerForIndication (const String &url, const String &ns, const String &filter, const String &querylanguage, const String &sourceNamespace, const CIMListenerCallbackRef &cb, const ClientAuthCBIFCRef &authCb=ClientAuthCBIFCRef())
	Register for an indication.
void	deregisterForIndication (const String &handle)
	De-register for an indication.
void	shutdownHttpServer ()
	Shut down the http server that is listening for indications.
Private Attributes
IntrusiveReference< ListenerAuthenticator >	m_pLAuthenticator
IntrusiveReference< HTTPServer >	m_httpServer
UInt16	m_httpListenPort
UInt16	m_httpsListenPort
IntrusiveReference< Thread >	m_httpThread
UnnamedPipeRef	m_stopHttpPipe
String	m_certFileName
String	m_keyFileName
HTTPXMLCIMListenerCallbackRef	m_callback
RequestHandlerIFCRef	m_XMLListener

Detailed Description

Definition at line 60 of file OW_HTTPXMLCIMListener.hpp.

Constructor & Destructor Documentation

OW_NAMESPACE::HTTPXMLCIMListener::HTTPXMLCIMListener ( const LoggerRef & logger = LoggerRef(0),

const String & certFileName = String(),

const String & keyFileName = String()

)

Parameters:

logger If a logger specified then it will receive log messages, otherwise all log messages will be discarded.

certFileName Filename of a certificate to use for HTTPS. If none specified, listner will receive over HTTP instead.

keyFileName Filename of a private key to use for HTTPS. If none specified, will attempt to use a key found in the same file as the certificate.

Definition at line 564 of file OW_HTTPXMLCIMListener.cpp.
References OW_NAMESPACE::FileSystem::canRead(), OW_NAMESPACE::String::empty(), and OW_THROW_ERRNO_MSG.

OW_NAMESPACE::HTTPXMLCIMListener::~HTTPXMLCIMListener ( )

Definition at line 610 of file OW_HTTPXMLCIMListener.cpp.
References m_pLAuthenticator, and shutdownHttpServer().

Member Function Documentation

void OW_NAMESPACE::HTTPXMLCIMListener::deregisterForIndication ( const String & handle )

De-register for an indication.

Parameters:

handle The string returned from registerForIndication

authCb If authentication is necessary, and authCb != NULL, then authCb->getCredentials() will be called to obtain credentials.

Definition at line 656 of file OW_HTTPXMLCIMListener.cpp.
References m_callback.

String OW_NAMESPACE::HTTPXMLCIMListener::registerForIndication ( const String & url,

const String & ns,

const String & filter,

const String & querylanguage,

const String & sourceNamespace,

const CIMListenerCallbackRef & cb,

const ClientAuthCBIFCRef & authCb = ClientAuthCBIFCRef()

)

Register for an indication.
The destructor will attempt to deregister any subscriptions which are still outstanding at the time.
Parameters:

url The url identifying the cimom

ns The namespace where the indication subscription and related objects will be created.

filter The filter for the indication subscription

querylanguage The language of the filter (typically wql1)

sourceNamespace The path to a local namespace where the Indications originate. If empty, the namespace of the Filter registration is assumed.

cb An object derived from CIMListenerCallback. When an indication is received, the doIndicationOccured member function will be called

authCb If authentication is necessary, and authCb != NULL, then authCb->getCredentials() will be called to obtain credentials.

Returns:
A unique handle identifying the indication subscription and callback. Use this handle to de-register the listener.

Definition at line 641 of file OW_HTTPXMLCIMListener.cpp.
References m_callback, m_httpListenPort, m_httpsListenPort, and ns.

void OW_NAMESPACE::HTTPXMLCIMListener::shutdownHttpServer ( )

Shut down the http server that is listening for indications.
This function blocks until all threads that are running callbacks have terminated.
Definition at line 623 of file OW_HTTPXMLCIMListener.cpp.
References m_httpServer, and m_httpThread.
Referenced by ~HTTPXMLCIMListener().