OWBI1_OperationContext.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2003-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 
00035 #ifndef OWBI1_OPERATION_CONTEXT_HPP_INCLUDE_GUARD_
00036 #define OWBI1_OPERATION_CONTEXT_HPP_INCLUDE_GUARD_
00037 #include "OWBI1_config.h"
00038 #include "OWBI1_IntrusiveCountableBase.hpp"
00039 #include "OWBI1_CommonFwd.hpp"
00040 #include "OWBI1_Exception.hpp"
00041 #include "OWBI1_String.hpp"
00042 
00043 // The classes and functions defined in this file are not meant for general
00044 // use, they are internal implementation details.  They may change at any time.
00045 
00046 namespace OWBI1
00047 {
00048 
00049 OWBI1_DECLARE_APIEXCEPTION(ContextDataNotFound, OWBI1_COMMON_API);
00050 
00063 class OWBI1_OWBI1PROVIFC_API OperationContext : public IntrusiveCountableBase
00064 {
00065 public:
00066    
00067    OperationContext();
00068    virtual ~OperationContext();
00069 
00075    virtual void removeData(const String& key) = 0;
00076    
00082    virtual bool keyHasData(const String& key) const = 0;
00083    
00088    virtual void setStringData(const String& key, const String& str) = 0;
00089 
00093    virtual String getStringData(const String& key) const = 0;
00094 
00098    virtual String getStringDataWithDefault(const String& key, const String& def = String() ) const = 0;
00099    
00100    // Keys values we use.
00101    static const char* const USER_NAME;
00102    static const char* const USER_PASSWD;
00103    static const char* const HTTP_PATH;
00104    static const char* const CURUSER_UIDKEY;
00105    static const char* const BYPASS_LOCKERKEY;
00106    static const char* const SESSION_LANGUAGE_KEY;
00107    static const char* const HTTP_ACCEPT_LANGUAGE_KEY;
00108    static const char* const CLIENT_IPADDR;
00109 
00110 
00111    // non-copyable
00112    OperationContext(const OperationContext&);
00113    OperationContext& operator=(const OperationContext&);
00114 };
00115 
00116 } // end namespace OWBI1
00117 
00118 #endif
00119 
00120 

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