OW_RequestHandlerIFC.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
00003 *
00004 * Redistribution and use in source and binary forms, with or without
00005 * modification, are permitted provided that the following conditions are met:
00006 *
00007 *  - Redistributions of source code must retain the above copyright notice,
00008 *    this list of conditions and the following disclaimer.
00009 *
00010 *  - Redistributions in binary form must reproduce the above copyright notice,
00011 *    this list of conditions and the following disclaimer in the documentation
00012 *    and/or other materials provided with the distribution.
00013 *
00014 *  - Neither the name of Vintela, Inc. nor the names of its
00015 *    contributors may be used to endorse or promote products derived from this
00016 *    software without specific prior written permission.
00017 *
00018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00019 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00020 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00021 * ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
00022 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00023 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00024 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00025 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00026 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00027 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00028 * POSSIBILITY OF SUCH DAMAGE.
00029 *******************************************************************************/
00030 
00036 #ifndef OW_REQUESTHANDLERIFC_HPP_
00037 #define OW_REQUESTHANDLERIFC_HPP_
00038 #include "OW_config.h"
00039 #include "OW_Types.hpp"
00040 #include "OW_String.hpp"
00041 #include "OW_SharedLibraryReference.hpp"
00042 #include "OW_SortedVectorMap.hpp"
00043 #include "OW_IntrusiveReference.hpp"
00044 #include "OW_ServiceIFC.hpp"
00045 #include "OW_IfcsFwd.hpp"
00046 #include "OW_CommonFwd.hpp"
00047 
00048 #include <iosfwd>
00049 
00050 // The classes and functions defined in this file are not meant for general
00051 // use, they are internal implementation details.  They may change at any time.
00052 
00053 namespace OW_NAMESPACE
00054 {
00055 
00062 class OW_COMMON_API RequestHandlerIFC : public ServiceIFC
00063 {
00064 public:
00065    RequestHandlerIFC();
00066    virtual ~RequestHandlerIFC();
00076    void process(std::istream* istr, std::ostream* ostrEntity,
00077       std::ostream* ostrError, OperationContext& context);
00083    bool hasError(Int32& errCode, String& errDescr);
00084    bool hasError() { return m_hasError; }
00089    void options(CIMFeatures& cf, OperationContext& context)
00090       {  doOptions(cf, context); }
00091    virtual RequestHandlerIFC* clone() const = 0;
00092    ServiceEnvironmentIFCRef getEnvironment() const;
00093    virtual void setEnvironment(const ServiceEnvironmentIFCRef& env);
00094    virtual StringArray getSupportedContentTypes() const = 0;
00095    virtual String getContentType() const = 0;
00096    String getCIMError() const { return m_cimError; }
00097    void setError(Int32 errorCode, const String& errorDescription)
00098    {
00099       m_hasError = true;
00100       m_errorCode = errorCode;
00101       m_errorDescription = errorDescription;
00102    }
00103    void clearError()
00104    {
00105       m_hasError = false;
00106       m_errorCode = 0;
00107       m_errorDescription.erase();
00108    }
00109 protected:
00120    virtual void doProcess(std::istream* istr, std::ostream* ostrEntity,
00121       std::ostream* ostrError, OperationContext& context) = 0;
00127    virtual void doOptions(CIMFeatures& cf, OperationContext& context) = 0;
00128    String m_cimError;
00129    String getHost();
00130    String m_cachedHost;
00131 private:
00132    // set these through setError() and clearError()
00133    bool m_hasError;
00134    Int32 m_errorCode;
00135    String m_errorDescription;
00136 
00137 #ifdef OW_WIN32
00138 #pragma warning (push)
00139 #pragma warning (disable: 4251)
00140 #endif
00141 
00142    ServiceEnvironmentIFCRef m_env;
00143 
00144 #ifdef OW_WIN32
00145 #pragma warning (pop)
00146 #endif
00147 
00148 };
00149 
00150 } // end namespace OW_NAMESPACE
00151 
00152 
00153 #if !defined(OW_STATIC_SERVICES)
00154 #define OW_REQUEST_HANDLER_FACTORY(derived, handlerName) \
00155 extern "C" OW_EXPORT OW_NAMESPACE::RequestHandlerIFC* \
00156 createRequestHandler() \
00157 { \
00158    return new derived; \
00159 } \
00160 extern "C" OW_EXPORT const char* \
00161 getOWVersion() \
00162 { \
00163    return OW_VERSION; \
00164 }
00165 #else
00166 #define OW_REQUEST_HANDLER_FACTORY(derived, handlerName) \
00167 extern "C" OW_NAMESPACE::RequestHandlerIFC* \
00168 createRequestHandler_##handlerName() \
00169 { \
00170    return new derived; \
00171 }
00172 #endif /* !defined(OW_STATIC_SERVICES) */
00173 
00174 #endif

Generated on Thu Feb 9 08:48:10 2006 for openwbem by  doxygen 1.4.6