connectivity/source/inc/odbc/OConnection.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef _CONNECTIVITY_ODBC_OCONNECTION_HXX_
  29 #define _CONNECTIVITY_ODBC_OCONNECTION_HXX_
  30
  31 #include <com/sun/star/sdbc/SQLWarning.hpp>
  32 #include <com/sun/star/beans/PropertyValue.hpp>
  33 #include "odbc/OFunctiondefs.hxx"
  34 #include "odbc/odbcbasedllapi.hxx"
  35 #include "connectivity/OSubComponent.hxx"
  36 #include "connectivity/CommonTools.hxx"
  37 #include "TConnection.hxx"
  38 #include "OTypeInfo.hxx"
  39 #include <cppuhelper/weakref.hxx>
  40 #include "AutoRetrievingBase.hxx"
  41 #include <osl/module.h>
  42
  43
  44 #include <map>
  45
  46 namespace connectivity
  47 {
  48     namespace odbc
  49     {
  50
  51         class OStatement_Base;
  52         class ODBCDriver;
  53         class ODatabaseMetaData;
  54
  55         typedef connectivity::OMetaConnection OConnection_BASE;
  56         typedef ::std::vector< ::connectivity::OTypeInfo>   TTypeInfoVector;
  57
  58         class OOO_DLLPUBLIC_ODBCBASE OConnection :
  59                             public OConnection_BASE,
  60                             public connectivity::OSubComponent<OConnection, OConnection_BASE>,
  61                             public OAutoRetrievingBase
  62         {
  63             friend class connectivity::OSubComponent<OConnection, OConnection_BASE>;
  64
  65         protected:
  66             //====================================================================
  67             // Data attributes
  68             //====================================================================
  69             ::std::map< SQLHANDLE,OConnection*> m_aConnections; // holds all connectionas which are need for serveral statements
  70             TTypeInfoVector                     m_aTypeInfo;    //  vector containing an entry
  71                                                         //  for each row returned by
  72                                                         //  DatabaseMetaData.getTypeInfo.
  73
  74
  75             ::com::sun::star::sdbc::SQLWarning  m_aLastWarning; //      Last SQLWarning generated by
  76                                                         //  an operation
  77             ::rtl::OUString m_sUser;        // the user name
  78             ODBCDriver*     m_pDriver;      //  Pointer to the owning
  79                                             //  driver object
  80
  81             SQLHANDLE       m_aConnectionHandle;
  82             SQLHANDLE       m_pDriverHandleCopy;    // performance reason
  83             sal_Int32       m_nStatementCount;
  84             sal_Bool        m_bClosed;
  85             sal_Bool        m_bUseCatalog;  // should we use the catalog on filebased databases
  86             sal_Bool        m_bUseOldDateFormat;
  87             sal_Bool        m_bParameterSubstitution;
  88             sal_Bool        m_bIgnoreDriverPrivileges;
  89             sal_Bool        m_bPreventGetVersionColumns;    // #i60273#
  90             sal_Bool        m_bReadOnly;
  91
  92
  93             SQLRETURN       OpenConnection(const ::rtl::OUString& aConnectStr,sal_Int32 nTimeOut, sal_Bool bSilent);
  94
  95             virtual OConnection*    cloneConnection(); // creates a new connection
  96
  97         public:
  98             oslGenericFunction  getOdbcFunction(sal_Int32 _nIndex)  const;
  99             virtual SQLRETURN       Construct( const ::rtl::OUString& url,const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info) throw(::com::sun::star::sdbc::SQLException);
 100
 101             OConnection(const SQLHANDLE _pDriverHandle,ODBCDriver*  _pDriver);
 102             //  OConnection(const SQLHANDLE _pConnectionHandle);
 103             virtual ~OConnection();
 104
 105             void closeAllStatements () throw( ::com::sun::star::sdbc::SQLException);
 106
 107             // OComponentHelper
 108             virtual void SAL_CALL disposing(void);
 109             // XInterface
 110             virtual void SAL_CALL release() throw();
 111
 112             // XServiceInfo
 113             DECLARE_SERVICE_INFO();
 114             // XConnection
 115             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XStatement > SAL_CALL createStatement(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 116             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XPreparedStatement > SAL_CALL prepareStatement( const ::rtl::OUString& sql ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 117             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XPreparedStatement > SAL_CALL prepareCall( const ::rtl::OUString& sql ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 118             virtual ::rtl::OUString SAL_CALL nativeSQL( const ::rtl::OUString& sql ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 119             virtual void SAL_CALL setAutoCommit( sal_Bool autoCommit ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 120             virtual sal_Bool SAL_CALL getAutoCommit(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 121             virtual void SAL_CALL commit(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 122             virtual void SAL_CALL rollback(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 123             virtual sal_Bool SAL_CALL isClosed(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 124             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData > SAL_CALL getMetaData(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 125             virtual void SAL_CALL setReadOnly( sal_Bool readOnly ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 126             virtual sal_Bool SAL_CALL isReadOnly(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 127             virtual void SAL_CALL setCatalog( const ::rtl::OUString& catalog ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 128             virtual ::rtl::OUString SAL_CALL getCatalog(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 129             virtual void SAL_CALL setTransactionIsolation( sal_Int32 level ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 130             virtual sal_Int32 SAL_CALL getTransactionIsolation(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 131             virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > SAL_CALL getTypeMap(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 132             virtual void SAL_CALL setTypeMap( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 133             // XCloseable
 134             virtual void SAL_CALL close(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 135             // XWarningsSupplier
 136             virtual ::com::sun::star::uno::Any SAL_CALL getWarnings(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 137             virtual void SAL_CALL clearWarnings(  ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 138             //
 139             SQLHANDLE       getConnection() { return m_aConnectionHandle; }
 140
 141             // should we use the catalog on filebased databases
 142             inline sal_Bool     isCatalogUsed()                     const { return m_bUseCatalog; }
 143             inline sal_Bool     isParameterSubstitutionEnabled()    const { return m_bParameterSubstitution; }
 144             inline sal_Bool     isIgnoreDriverPrivilegesEnabled()   const { return m_bIgnoreDriverPrivileges; }
 145             inline sal_Bool     preventGetVersionColumns()          const { return m_bPreventGetVersionColumns; }
 146             inline sal_Bool     useOldDateFormat()                  const { return m_bUseOldDateFormat; }
 147             inline SQLHANDLE        getDriverHandle()               const { return m_pDriverHandleCopy;}
 148             inline ODBCDriver*      getDriver()                     const { return m_pDriver;}
 149             inline ::rtl::OUString getUserName()                    const { return m_sUser; }
 150
 151             SQLHANDLE       createStatementHandle();
 152             // close and free the handle and set it to SQL_NULLHANDLE
 153             void            freeStatementHandle(SQLHANDLE& _pHandle);
 154
 155             const TTypeInfoVector&  getTypeInfo() const { return m_aTypeInfo; }
 156         };
 157     }
 158 }
 159 #endif // _CONNECTIVITY_ODBC_OCONNECTION_HXX_
 160
 161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */