odk/examples/DevelopersGuide/Database/DriverSkeleton/SConnection.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  the BSD license.
   6  *
   7  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *  1. Redistributions of source code must retain the above copyright
  14  *     notice, this list of conditions and the following disclaimer.
  15  *  2. Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in the
  17  *     documentation and/or other materials provided with the distribution.
  18  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  31  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  32  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *************************************************************************/
  35
  36 #include "SConnection.hxx"
  37
  38 #include "SDatabaseMetaData.hxx"
  39 #include "SDriver.hxx"
  40 #include "SStatement.hxx"
  41 #include "SPreparedStatement.hxx"
  42 #include <com/sun/star/sdbc/ColumnValue.hpp>
  43 #include <com/sun/star/sdbc/XRow.hpp>
  44 #include <com/sun/star/sdbc/TransactionIsolation.hpp>
  45 #include <com/sun/star/lang/DisposedException.hpp>
  46
  47 using namespace connectivity::skeleton;
  48
  49
  50 using namespace com::sun::star::uno;
  51 using namespace com::sun::star::lang;
  52 using namespace com::sun::star::beans;
  53 using namespace com::sun::star::sdbc;
  54
  55 OConnection::OConnection(SkeletonDriver*    _pDriver)
  56                          : OSubComponent<OConnection, OConnection_BASE>((::cppu::OWeakObject*)_pDriver, this),
  57                          OMetaConnection_BASE(m_aMutex),
  58                          m_pDriver(_pDriver),
  59                          m_bClosed(sal_False),
  60                          m_xMetaData(NULL),
  61                          m_bUseCatalog(sal_False),
  62                          m_bUseOldDateFormat(sal_False)
  63 {
  64     m_pDriver->acquire();
  65 }
  66
  67 OConnection::~OConnection()
  68 {
  69     if(!isClosed())
  70         close();
  71     m_pDriver->release();
  72     m_pDriver = NULL;
  73 }
  74
  75 void SAL_CALL OConnection::release() throw()
  76 {
  77     release_ChildImpl();
  78 }
  79
  80
  81 void OConnection::construct(const ::rtl::OUString& url,const Sequence< PropertyValue >& info)  throw(SQLException)
  82 {
  83     osl_atomic_increment( &m_refCount );
  84
  85     // some example code how to get the information out of the sequence
  86
  87     sal_Int32 nLen = url.indexOf(':');
  88     nLen = url.indexOf(':',nLen+1);
  89     ::rtl::OUString aDSN("DSN="), aUID, aPWD, aSysDrvSettings;
  90     aDSN += url.copy(nLen+1);
  91
  92     const char* pUser       = "user";
  93     const char* pTimeout    = "Timeout";
  94     const char* pSilent     = "Silent";
  95     const char* pPwd        = "password";
  96     const char* pUseCatalog = "UseCatalog";
  97     const char* pSysDrv     = "SystemDriverSettings";
  98
  99     sal_Int32 nTimeout = 20;
 100     sal_Bool bSilent = sal_True;
 101     const PropertyValue *pBegin = info.getConstArray();
 102     const PropertyValue *pEnd   = pBegin + info.getLength();
 103     for(;pBegin != pEnd;++pBegin)
 104     {
 105         if(pBegin->Name.equalsAscii(pTimeout))
 106             pBegin->Value >>= nTimeout;
 107         else if(pBegin->Name.equalsAscii(pSilent))
 108             pBegin->Value >>= bSilent;
 109         else if(pBegin->Name.equalsAscii(pUser))
 110         {
 111             pBegin->Value >>= aUID;
 112             aDSN += ";UID=" + aUID;
 113         }
 114         else if(pBegin->Name.equalsAscii(pPwd))
 115         {
 116             pBegin->Value >>= aPWD;
 117             aDSN += ";PWD=" + aPWD;
 118         }
 119         else if(pBegin->Name.equalsAscii(pUseCatalog))
 120         {
 121             pBegin->Value >>= m_bUseCatalog;
 122         }
 123         else if(pBegin->Name.equalsAscii(pSysDrv))
 124         {
 125             pBegin->Value >>= aSysDrvSettings;
 126             aDSN += ";";
 127             aDSN += aSysDrvSettings;
 128         }
 129     }
 130     m_sUser = aUID;
 131
 132     osl_atomic_decrement( &m_refCount );
 133 }
 134 // XServiceInfo
 135
 136 IMPLEMENT_SERVICE_INFO(OConnection, "com.sun.star.sdbc.drivers.skeleton.OConnection", "com.sun.star.sdbc.Connection")
 137
 138
 139 Reference< XStatement > SAL_CALL OConnection::createStatement(  ) throw(SQLException, RuntimeException)
 140 {
 141     ::osl::MutexGuard aGuard( m_aMutex );
 142     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 143
 144     // create a statement
 145     // the statement can only be executed once
 146     Reference< XStatement > xReturn = new OStatement(this);
 147     m_aStatements.push_back(WeakReferenceHelper(xReturn));
 148     return xReturn;
 149 }
 150
 151 Reference< XPreparedStatement > SAL_CALL OConnection::prepareStatement( const ::rtl::OUString& _sSql ) throw(SQLException, RuntimeException)
 152 {
 153     ::osl::MutexGuard aGuard( m_aMutex );
 154     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 155
 156     // the pre
 157     if(m_aTypeInfo.empty())
 158         buildTypeInfo();
 159
 160     // create a statement
 161     // the statement can only be executed more than once
 162     Reference< XPreparedStatement > xReturn = new OPreparedStatement(this,m_aTypeInfo,_sSql);
 163     m_aStatements.push_back(WeakReferenceHelper(xReturn));
 164     return xReturn;
 165 }
 166
 167 Reference< XPreparedStatement > SAL_CALL OConnection::prepareCall( const ::rtl::OUString& _sSql ) throw(SQLException, RuntimeException)
 168 {
 169     ::osl::MutexGuard aGuard( m_aMutex );
 170     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 171
 172     // not implemented yet :-) a task to do
 173     return NULL;
 174 }
 175
 176 ::rtl::OUString SAL_CALL OConnection::nativeSQL( const ::rtl::OUString& _sSql ) throw(SQLException, RuntimeException)
 177 {
 178     ::osl::MutexGuard aGuard( m_aMutex );
 179     // when you need to transform SQL92 to you driver specific you can do it here
 180
 181     return _sSql;
 182 }
 183
 184 void SAL_CALL OConnection::setAutoCommit( sal_Bool autoCommit ) throw(SQLException, RuntimeException)
 185 {
 186     ::osl::MutexGuard aGuard( m_aMutex );
 187     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 188     // here you have to set your commit mode please have a look at the jdbc documentation to get a clear explanation
 189 }
 190
 191 sal_Bool SAL_CALL OConnection::getAutoCommit(  ) throw(SQLException, RuntimeException)
 192 {
 193     ::osl::MutexGuard aGuard( m_aMutex );
 194     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 195     // you have to distinguish which if you are in autocommit mode or not
 196     // at normal case true should be fine here
 197
 198     return sal_True;
 199 }
 200
 201 void SAL_CALL OConnection::commit(  ) throw(SQLException, RuntimeException)
 202 {
 203     ::osl::MutexGuard aGuard( m_aMutex );
 204     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 205
 206     // when your database does support transactions you should commit here
 207 }
 208
 209 void SAL_CALL OConnection::rollback(  ) throw(SQLException, RuntimeException)
 210 {
 211     ::osl::MutexGuard aGuard( m_aMutex );
 212     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 213
 214
 215     // same as commit but for the other case
 216 }
 217
 218 sal_Bool SAL_CALL OConnection::isClosed(  ) throw(SQLException, RuntimeException)
 219 {
 220     ::osl::MutexGuard aGuard( m_aMutex );
 221
 222     // just simple -> we are close when we are disposed that means someone called dispose(); (XComponent)
 223     return OConnection_BASE::rBHelper.bDisposed;
 224 }
 225
 226 Reference< XDatabaseMetaData > SAL_CALL OConnection::getMetaData(  ) throw(SQLException, RuntimeException)
 227 {
 228     ::osl::MutexGuard aGuard( m_aMutex );
 229     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 230
 231     // here we have to create the class with biggest interface
 232     // The answer is 42 :-)
 233     Reference< XDatabaseMetaData > xMetaData = m_xMetaData;
 234     if(!xMetaData.is())
 235     {
 236         xMetaData = new ODatabaseMetaData(this); // need the connection because it can return it
 237         m_xMetaData = xMetaData;
 238     }
 239
 240     return xMetaData;
 241 }
 242
 243 void SAL_CALL OConnection::setReadOnly( sal_Bool readOnly ) throw(SQLException, RuntimeException)
 244 {
 245     ::osl::MutexGuard aGuard( m_aMutex );
 246     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 247
 248     // set you connection to readonly
 249 }
 250
 251 sal_Bool SAL_CALL OConnection::isReadOnly(  ) throw(SQLException, RuntimeException)
 252 {
 253     ::osl::MutexGuard aGuard( m_aMutex );
 254     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 255
 256     // return if your connection to readonly
 257     return sal_False;
 258 }
 259
 260 void SAL_CALL OConnection::setCatalog( const ::rtl::OUString& catalog ) throw(SQLException, RuntimeException)
 261 {
 262     ::osl::MutexGuard aGuard( m_aMutex );
 263     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 264
 265     // if your database doesn't work with catalogs you go to next method otherwise you know what to do
 266 }
 267
 268 ::rtl::OUString SAL_CALL OConnection::getCatalog(  ) throw(SQLException, RuntimeException)
 269 {
 270     ::osl::MutexGuard aGuard( m_aMutex );
 271     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 272
 273
 274     // return your current catalog
 275     return ::rtl::OUString();
 276 }
 277
 278 void SAL_CALL OConnection::setTransactionIsolation( sal_Int32 level ) throw(SQLException, RuntimeException)
 279 {
 280     ::osl::MutexGuard aGuard( m_aMutex );
 281     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 282
 283     /// set your isolation level
 284     /// please have a look at @see com.sun.star.sdbc.TransactionIsolation
 285 }
 286
 287 sal_Int32 SAL_CALL OConnection::getTransactionIsolation(  ) throw(SQLException, RuntimeException)
 288 {
 289     ::osl::MutexGuard aGuard( m_aMutex );
 290     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 291
 292
 293     // please have a look at @see com.sun.star.sdbc.TransactionIsolation
 294     return TransactionIsolation::NONE;
 295 }
 296
 297 Reference< ::com::sun::star::container::XNameAccess > SAL_CALL OConnection::getTypeMap(  ) throw(SQLException, RuntimeException)
 298 {
 299     ::osl::MutexGuard aGuard( m_aMutex );
 300     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 301
 302     // if your driver has special database types you can return it here
 303
 304     return NULL;
 305 }
 306
 307 void SAL_CALL OConnection::setTypeMap( const Reference< ::com::sun::star::container::XNameAccess >& typeMap ) throw(SQLException, RuntimeException)
 308 {
 309     // the other way around
 310 }
 311
 312 // XCloseable
 313 void SAL_CALL OConnection::close(  ) throw(SQLException, RuntimeException)
 314 {
 315     // we just dispose us
 316     {
 317         ::osl::MutexGuard aGuard( m_aMutex );
 318         checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 319
 320     }
 321     dispose();
 322 }
 323
 324 // XWarningsSupplier
 325 Any SAL_CALL OConnection::getWarnings(  ) throw(SQLException, RuntimeException)
 326 {
 327     // when you collected some warnings -> return it
 328     return Any();
 329 }
 330
 331 void SAL_CALL OConnection::clearWarnings(  ) throw(SQLException, RuntimeException)
 332 {
 333     // you should clear your collected warnings here
 334 }
 335
 336 void OConnection::buildTypeInfo() throw( SQLException)
 337 {
 338     ::osl::MutexGuard aGuard( m_aMutex );
 339
 340     Reference< XResultSet> xRs = getMetaData ()->getTypeInfo ();
 341     Reference< XRow> xRow(xRs,UNO_QUERY);
 342     // Information for a single SQL type
 343
 344     // Loop on the result set until we reach end of file
 345
 346     while (xRs->next ())
 347     {
 348         OTypeInfo aInfo;
 349         aInfo.aTypeName         = xRow->getString   (1);
 350         aInfo.nType             = xRow->getShort    (2);
 351         aInfo.nPrecision        = xRow->getInt      (3);
 352         aInfo.aLiteralPrefix    = xRow->getString   (4);
 353         aInfo.aLiteralSuffix    = xRow->getString   (5);
 354         aInfo.aCreateParams     = xRow->getString   (6);
 355         aInfo.bNullable         = xRow->getBoolean  (7);
 356         aInfo.bCaseSensitive    = xRow->getBoolean  (8);
 357         aInfo.nSearchType       = xRow->getShort    (9);
 358         aInfo.bUnsigned         = xRow->getBoolean  (10);
 359         aInfo.bCurrency         = xRow->getBoolean  (11);
 360         aInfo.bAutoIncrement    = xRow->getBoolean  (12);
 361         aInfo.aLocalTypeName    = xRow->getString   (13);
 362         aInfo.nMinimumScale     = xRow->getShort    (14);
 363         aInfo.nMaximumScale     = xRow->getShort    (15);
 364         aInfo.nNumPrecRadix     = (sal_Int16)xRow->getInt(18);
 365
 366
 367         // Now that we have the type info, save it
 368         // in the Hashtable if we don't already have an
 369         // entry for this SQL type.
 370
 371         m_aTypeInfo.push_back(aInfo);
 372     }
 373
 374     // Close the result set/statement.
 375
 376     Reference< XCloseable> xClose(xRs,UNO_QUERY);
 377     xClose->close();
 378 }
 379
 380 void OConnection::disposing()
 381 {
 382     // we noticed that we should be destroyed in near future so we have to dispose our statements
 383     ::osl::MutexGuard aGuard(m_aMutex);
 384
 385     for (OWeakRefArray::iterator i = m_aStatements.begin(); m_aStatements.end() != i; ++i)
 386     {
 387         Reference< XComponent > xComp(i->get(), UNO_QUERY);
 388         if (xComp.is())
 389             xComp->dispose();
 390     }
 391     m_aStatements.clear();
 392
 393     m_bClosed   = sal_True;
 394     m_xMetaData = ::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XDatabaseMetaData>();
 395
 396     dispose_ChildImpl();
 397     OConnection_BASE::disposing();
 398 }
 399
 400
 401 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */