connectivity/source/drivers/macab/MacabConnection.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MacabConnection.cxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_connectivity.hxx"
  33
  34 #include "MacabConnection.hxx"
  35 #include "MacabAddressBook.hxx"
  36 #include "MacabDatabaseMetaData.hxx"
  37 #include "MacabStatement.hxx"
  38 #include "MacabPreparedStatement.hxx"
  39 #include "MacabDriver.hxx"
  40 #include "MacabCatalog.hxx"
  41 #include <com/sun/star/sdbc/ColumnValue.hpp>
  42 #include <com/sun/star/sdbc/TransactionIsolation.hpp>
  43
  44 using namespace connectivity::macab;
  45 using namespace com::sun::star::uno;
  46 using namespace com::sun::star::lang;
  47 using namespace com::sun::star::beans;
  48 using namespace com::sun::star::sdbc;
  49 using namespace com::sun::star::sdbcx;
  50
  51 IMPLEMENT_SERVICE_INFO(MacabConnection, "com.sun.star.sdbc.drivers.MacabConnection", "com.sun.star.sdbc.Connection")
  52 //-----------------------------------------------------------------------------
  53 MacabConnection::MacabConnection(MacabDriver*   _pDriver)
  54          : OSubComponent<MacabConnection, MacabConnection_BASE>((::cppu::OWeakObject*)_pDriver, this),
  55          m_pAddressBook(NULL),
  56          m_pDriver(_pDriver)
  57 {
  58     m_pDriver->acquire();
  59 }
  60 //-----------------------------------------------------------------------------
  61 MacabConnection::~MacabConnection()
  62 {
  63     if (!isClosed())
  64         close();
  65
  66     m_pDriver->release();
  67     m_pDriver = NULL;
  68 }
  69 //-----------------------------------------------------------------------------
  70 void SAL_CALL MacabConnection::release() throw()
  71 {
  72     relase_ChildImpl();
  73 }
  74 // -----------------------------------------------------------------------------
  75 void MacabConnection::construct(const ::rtl::OUString&, const Sequence< PropertyValue >&) throw(SQLException)
  76 {
  77     osl_incrementInterlockedCount( &m_refCount );
  78
  79     // get the Mac OS X shared address book
  80     m_pAddressBook = new MacabAddressBook();
  81
  82     osl_decrementInterlockedCount( &m_refCount );
  83 }
  84 // XServiceInfo
  85 // --------------------------------------------------------------------------------
  86 Reference< XStatement > SAL_CALL MacabConnection::createStatement(  ) throw(SQLException, RuntimeException)
  87 {
  88     ::osl::MutexGuard aGuard( m_aMutex );
  89     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
  90
  91     // create a statement
  92     // the statement can only be executed once
  93     Reference< XStatement > xReturn = new MacabStatement(this);
  94     m_aStatements.push_back(WeakReferenceHelper(xReturn));
  95     return xReturn;
  96 }
  97 // --------------------------------------------------------------------------------
  98 Reference< XPreparedStatement > SAL_CALL MacabConnection::prepareStatement( const ::rtl::OUString& _sSql ) throw(SQLException, RuntimeException)
  99 {
 100     ::osl::MutexGuard aGuard( m_aMutex );
 101     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 102
 103     // create a statement
 104     // the statement can only be executed more than once
 105     Reference< XPreparedStatement > xReturn = new MacabPreparedStatement(this, _sSql);
 106     m_aStatements.push_back(WeakReferenceHelper(xReturn));
 107     return xReturn;
 108 }
 109 // --------------------------------------------------------------------------------
 110 Reference< XPreparedStatement > SAL_CALL MacabConnection::prepareCall( const ::rtl::OUString& ) throw(SQLException, RuntimeException)
 111 {
 112     ::osl::MutexGuard aGuard( m_aMutex );
 113     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 114
 115     // not implemented yet :-) a task to do
 116     return NULL;
 117 }
 118 // --------------------------------------------------------------------------------
 119 ::rtl::OUString SAL_CALL MacabConnection::nativeSQL( const ::rtl::OUString& _sSql ) throw(SQLException, RuntimeException)
 120 {
 121     ::osl::MutexGuard aGuard( m_aMutex );
 122     // when you need to transform SQL92 to you driver specific you can do it here
 123
 124     return _sSql;
 125 }
 126 // --------------------------------------------------------------------------------
 127 void SAL_CALL MacabConnection::setAutoCommit( sal_Bool ) throw(SQLException, RuntimeException)
 128 {
 129     ::osl::MutexGuard aGuard( m_aMutex );
 130     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 131     // here you  have to set your commit mode please have a look at the jdbc documentation to get a clear explanation
 132 }
 133 // --------------------------------------------------------------------------------
 134 sal_Bool SAL_CALL MacabConnection::getAutoCommit(  ) throw(SQLException, RuntimeException)
 135 {
 136     ::osl::MutexGuard aGuard( m_aMutex );
 137     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 138     // you have to distinguish which if you are in autocommit mode or not
 139     // at normal case true should be fine here
 140
 141     return sal_True;
 142 }
 143 // --------------------------------------------------------------------------------
 144 void SAL_CALL MacabConnection::commit(  ) throw(SQLException, RuntimeException)
 145 {
 146     ::osl::MutexGuard aGuard( m_aMutex );
 147     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 148
 149     // when you database does support transactions you should commit here
 150 }
 151 // --------------------------------------------------------------------------------
 152 void SAL_CALL MacabConnection::rollback(  ) throw(SQLException, RuntimeException)
 153 {
 154     ::osl::MutexGuard aGuard( m_aMutex );
 155     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 156
 157     // same as commit but for the other case
 158 }
 159 // --------------------------------------------------------------------------------
 160 sal_Bool SAL_CALL MacabConnection::isClosed(  ) throw(SQLException, RuntimeException)
 161 {
 162     ::osl::MutexGuard aGuard( m_aMutex );
 163
 164     // just simple -> we are closed when we are disposed, that means someone called dispose(); (XComponent)
 165     return MacabConnection_BASE::rBHelper.bDisposed;
 166 }
 167 // --------------------------------------------------------------------------------
 168 Reference< XDatabaseMetaData > SAL_CALL MacabConnection::getMetaData(  ) throw(SQLException, RuntimeException)
 169 {
 170     ::osl::MutexGuard aGuard( m_aMutex );
 171     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 172
 173     // here we have to create the class with biggest interface
 174     // The answer is 42 :-)
 175     Reference< XDatabaseMetaData > xMetaData = m_xMetaData;
 176     if (!xMetaData.is())
 177     {
 178         xMetaData = new MacabDatabaseMetaData(this); // need the connection because it can return it
 179         m_xMetaData = xMetaData;
 180     }
 181
 182     return xMetaData;
 183 }
 184 // --------------------------------------------------------------------------------
 185 void SAL_CALL MacabConnection::setReadOnly( sal_Bool ) throw(SQLException, RuntimeException)
 186 {
 187     ::osl::MutexGuard aGuard( m_aMutex );
 188     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 189
 190     // set you connection to readonly
 191 }
 192 // --------------------------------------------------------------------------------
 193 sal_Bool SAL_CALL MacabConnection::isReadOnly(  ) throw(SQLException, RuntimeException)
 194 {
 195     ::osl::MutexGuard aGuard( m_aMutex );
 196     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 197
 198     // return if your connection to readonly
 199     return sal_False;
 200 }
 201 // --------------------------------------------------------------------------------
 202 void SAL_CALL MacabConnection::setCatalog( const ::rtl::OUString& ) throw(SQLException, RuntimeException)
 203 {
 204     ::osl::MutexGuard aGuard( m_aMutex );
 205     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 206
 207     // if your database doesn't work with catalogs you go to next method otherwise you kjnow what to do
 208 }
 209 // --------------------------------------------------------------------------------
 210 ::rtl::OUString SAL_CALL MacabConnection::getCatalog(  ) throw(SQLException, RuntimeException)
 211 {
 212     ::osl::MutexGuard aGuard( m_aMutex );
 213     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 214
 215
 216     // return your current catalog
 217     return ::rtl::OUString();
 218 }
 219 // --------------------------------------------------------------------------------
 220 void SAL_CALL MacabConnection::setTransactionIsolation( sal_Int32 ) throw(SQLException, RuntimeException)
 221 {
 222     ::osl::MutexGuard aGuard( m_aMutex );
 223     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 224
 225     // set your isolation level
 226     // please have a look at @see com.sun.star.sdbc.TransactionIsolation
 227 }
 228 // --------------------------------------------------------------------------------
 229 sal_Int32 SAL_CALL MacabConnection::getTransactionIsolation(  ) throw(SQLException, RuntimeException)
 230 {
 231     ::osl::MutexGuard aGuard( m_aMutex );
 232     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 233
 234
 235     // please have a look at @see com.sun.star.sdbc.TransactionIsolation
 236     return TransactionIsolation::NONE;
 237 }
 238 // --------------------------------------------------------------------------------
 239 Reference< ::com::sun::star::container::XNameAccess > SAL_CALL MacabConnection::getTypeMap(  ) throw(SQLException, RuntimeException)
 240 {
 241     ::osl::MutexGuard aGuard( m_aMutex );
 242     checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 243
 244     // if your driver has special database types you can return it here
 245
 246     return NULL;
 247 }
 248 // --------------------------------------------------------------------------------
 249 void SAL_CALL MacabConnection::setTypeMap( const Reference< ::com::sun::star::container::XNameAccess >& ) throw(SQLException, RuntimeException)
 250 {
 251     // the other way around
 252 }
 253 // --------------------------------------------------------------------------------
 254 // XCloseable
 255 void SAL_CALL MacabConnection::close(  ) throw(SQLException, RuntimeException)
 256 {
 257     {
 258         ::osl::MutexGuard aGuard( m_aMutex );
 259         checkDisposed(MacabConnection_BASE::rBHelper.bDisposed);
 260     }
 261     dispose();
 262 }
 263 // --------------------------------------------------------------------------------
 264 // XWarningsSupplier
 265 Any SAL_CALL MacabConnection::getWarnings(  ) throw(SQLException, RuntimeException)
 266 {
 267     // when you collected some warnings -> return it
 268     return Any();
 269 }
 270 // --------------------------------------------------------------------------------
 271 void SAL_CALL MacabConnection::clearWarnings(  ) throw(SQLException, RuntimeException)
 272 {
 273     // you should clear your collected warnings here
 274 }
 275 //------------------------------------------------------------------------------
 276 void MacabConnection::disposing()
 277 {
 278     // we noticed that we should be destroied in near future so we have to dispose our statements
 279     ::osl::MutexGuard aGuard(m_aMutex);
 280
 281     for (OWeakRefArray::iterator i = m_aStatements.begin(); m_aStatements.end() != i; ++i)
 282     {
 283         Reference< XComponent > xComp(i->get(), UNO_QUERY);
 284         if (xComp.is())
 285             xComp->dispose();
 286     }
 287     m_aStatements.clear();
 288
 289     if (m_pAddressBook != NULL)
 290     {
 291         delete m_pAddressBook;
 292         m_pAddressBook = NULL;
 293     }
 294
 295     m_xMetaData = ::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XDatabaseMetaData>();
 296
 297     dispose_ChildImpl();
 298     MacabConnection_BASE::disposing();
 299 }
 300 // -----------------------------------------------------------------------------
 301 Reference< XTablesSupplier > SAL_CALL MacabConnection::createCatalog()
 302 {
 303     ::osl::MutexGuard aGuard( m_aMutex );
 304
 305     Reference< XTablesSupplier > xTab = m_xCatalog;
 306     if (!m_xCatalog.is())
 307     {
 308         MacabCatalog *pCat = new MacabCatalog(this);
 309         xTab = pCat;
 310         m_xCatalog = xTab;
 311     }
 312     return xTab;
 313 }
 314 // -----------------------------------------------------------------------------
 315 MacabAddressBook* MacabConnection::getAddressBook() const
 316 {
 317     return m_pAddressBook;
 318 }
 319 // -----------------------------------------------------------------------------
 320 extern "C" void*  SAL_CALL createMacabConnection( void* _pDriver )
 321 {
 322     MacabConnection* pConnection = new MacabConnection( static_cast< MacabDriver* >( _pDriver ) );
 323     // by definition, the pointer crossing library boundaries as void ptr is acquired once
 324     pConnection->acquire();
 325     return pConnection;
 326 }