OW_ProviderAgent.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
* Copyright (C) 2004 Novell, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_PROVIDERAGENT_HPP_INCLUDE_GUARD_
#define OW_PROVIDERAGENT_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_String.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_RequestHandlerIFC.hpp"
#include "OW_Logger.hpp"
#include "OW_ConfigFile.hpp"
#include "OW_UnnamedPipe.hpp"
#include "OW_CppProviderBaseIFC.hpp"
#include "OW_AuthenticatorIFC.hpp"
#include "OW_CommonFwd.hpp"
#include "OW_ServicesHttpFwd.hpp"
#include "OW_ProviderAgentFwd.hpp"
#include "OW_ProviderAgentLifecycleCallbackIFC.hpp"
#include "OW_ProviderAgentLockerIFC.hpp"
#include "OW_IntrusiveCountableBase.hpp"

namespace OW_NAMESPACE
{


class OW_PROVIDERAGENT_API ProviderAgent : public IntrusiveCountableBase
{
public:
   // option which specifies the locking strategy.
   // Valid values are LockingTypeNone ("none"), LockingTypeSWMR ("swmr"), or LockingTypeSingleThreaded ("single_threaded")
   // If not specified the default of LockingTypeNone is assumed.
   static const char* const LockingType_opt;

   // option value which specifies that no locking will be done.
   static const char* const LockingTypeNone;

   // option value which specifies that single-writer, multiple-reader locking will be done.
   static const char* const LockingTypeSWMR;

   // option value which specifies that full locking will be done. All requests will be serialized.
   static const char* const LockingTypeSingleThreaded;

   // option which specifies the timeout to use if the LockingType option specifies SWMR locking (LockingTypeSWMR).
   // valid values are positive integers.
   // If not specified the default of 300 is assumed.
   static const char* const LockingTimeout_opt;

   // option which specifies whether classes will be retrieved using the callbackURL.
   // valid values are "true" or "false".
   // If not specified the default of "false" is assumed.
   static const char* const DynamicClassRetrieval_opt;

   // option which specifies whether to use the connection credentials when calling back into the cimom
   // valid values are "true" or "false".
   // If not specified the default of "false" is assumed.
   static const char* const UseConnectionCredentials_opt;

   ProviderAgent(
      const ConfigFile::ConfigMap& configMap,
      const Array<CppProviderBaseIFCRef>& providers,
      const Array<CIMClass>& classes,
      const Array<RequestHandlerIFCRef>& requestHandlers,
      const AuthenticatorIFCRef& authenticator,
      const LoggerRef& logger = LoggerRef(),
      const String& callbackURL = String(""),
      const ProviderAgentLockerIFCRef& locker = ProviderAgentLockerIFCRef(),
      const ProviderAgentLifecycleCallbackIFCRef& lifecycleCB = ProviderAgentLifecycleCallbackIFCRef());
   virtual ~ProviderAgent();
   void shutdownHttpServer();
private:
   HTTPServerRef m_httpServer;
   ThreadRef m_httpThread;
   UnnamedPipeRef m_stopHttpPipe;
   ProviderAgentLifecycleCallbackIFCRef m_lifecycleCB;
};

} // end namespace OW_NAMESPACE

#endif //#ifndef OW_PROVIDERAGENT_HPP_INCLUDE_GUARD_

---