OW_RequestHandlerIFC.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, 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_REQUESTHANDLERIFC_HPP_
#define OW_REQUESTHANDLERIFC_HPP_
#include "OW_config.h"
#include "OW_Types.hpp"
#include "OW_String.hpp"
#include "OW_SharedLibraryReference.hpp"
#include "OW_SortedVectorMap.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_ServiceIFC.hpp"
#include "OW_IfcsFwd.hpp"
#include "OW_CommonFwd.hpp"

#include <iosfwd>

// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

namespace OW_NAMESPACE
{

class OW_COMMON_API RequestHandlerIFC : public ServiceIFC
{
public:
   RequestHandlerIFC();
   virtual ~RequestHandlerIFC();
   void process(std::istream* istr, std::ostream* ostrEntity,
      std::ostream* ostrError, OperationContext& context);
   bool hasError(Int32& errCode, String& errDescr);
   bool hasError() { return m_hasError; }
   void options(CIMFeatures& cf, OperationContext& context)
      {  doOptions(cf, context); }
   virtual RequestHandlerIFC* clone() const = 0;
   ServiceEnvironmentIFCRef getEnvironment() const;
   virtual void setEnvironment(const ServiceEnvironmentIFCRef& env);
   virtual StringArray getSupportedContentTypes() const = 0;
   virtual String getContentType() const = 0;
   String getCIMError() const { return m_cimError; }
   void setError(Int32 errorCode, const String& errorDescription)
   {
      m_hasError = true;
      m_errorCode = errorCode;
      m_errorDescription = errorDescription;
   }
   void clearError()
   {
      m_hasError = false;
      m_errorCode = 0;
      m_errorDescription.erase();
   }
protected:
   virtual void doProcess(std::istream* istr, std::ostream* ostrEntity,
      std::ostream* ostrError, OperationContext& context) = 0;
   virtual void doOptions(CIMFeatures& cf, OperationContext& context) = 0;
   String m_cimError;
   String getHost();
   String m_cachedHost;
private:
   // set these through setError() and clearError()
   bool m_hasError;
   Int32 m_errorCode;
   String m_errorDescription;

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   ServiceEnvironmentIFCRef m_env;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

};

} // end namespace OW_NAMESPACE


#if !defined(OW_STATIC_SERVICES)
#define OW_REQUEST_HANDLER_FACTORY(derived, handlerName) \
extern "C" OW_EXPORT OW_NAMESPACE::RequestHandlerIFC* \
createRequestHandler() \
{ \
   return new derived; \
} \
extern "C" OW_EXPORT const char* \
getOWVersion() \
{ \
   return OW_VERSION; \
}
#else
#define OW_REQUEST_HANDLER_FACTORY(derived, handlerName) \
extern "C" OW_NAMESPACE::RequestHandlerIFC* \
createRequestHandler_##handlerName() \
{ \
   return new derived; \
}
#endif /* !defined(OW_STATIC_SERVICES) */

#endif

---