include/anna/dbms.oracle/Connection.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_dbms_oracle_Connection_hpp
  38 #define anna_dbms_oracle_Connection_hpp
  39
  40 struct OCIServer;
  41 struct OCISession;
  42 struct OCISvcCtx;
  43
  44 #include <anna/dbms/Connection.hpp>
  45 #include <anna/dbms/DatabaseException.hpp>
  46
  47 namespace anna {
  48
  49 namespace dbms {
  50
  51 class Database;
  52
  53 namespace oracle {
  54
  55 class Database;
  56
  57 /**
  58    Clase que modela la conexion con el RDBMS Oracle (tm).
  59
  60    Esta clase no puede usarse directamente, ya que la capa ANNA.dbms obliga a que todas las peticiones
  61    se hagan atraves de una instancia anna::dbms::Connection.
  62
  63    Para obtener una conexion a una determinada base de datos habra que instanciar dicha base de datos
  64    e invocar al metodo createConnection. Independientemente del tipo de conexion particular que la
  65    base de datos retorne, debemos asignarlo a un puntero de tipo anna::dbms::Connection.
  66 */
  67 class Connection : public dbms::Connection {
  68 public:
  69   /**
  70      Devuelve una cadena con la informacion referente a esta instancia.
  71      @return Una cadena con la informacion referente a esta instancia.
  72   */
  73   std::string asString() const throw();
  74
  75   /**
  76      Operador de conversion.
  77      \return El puntero al contexto asociado a este conexion.
  78   */
  79   operator OCISvcCtx*() throw() { return a_context; }
  80
  81 private:
  82   Database& a_oracleDatabase;
  83   OCISvcCtx* a_context;
  84   OCISession* a_session;
  85   OCIServer* a_server;
  86
  87   Connection(Database& database, const std::string& name, const char* user, const char* password);
  88   bool isAvailable() const throw(RuntimeException) { return a_context != NULL && a_session != NULL && a_server != NULL; }
  89   void do_commit() throw(RuntimeException, DatabaseException);
  90   void do_rollback() throw();
  91   void open() throw(DatabaseException);
  92   void close() throw();
  93
  94   friend class anna::dbms::oracle::Database;
  95 };
  96
  97 }
  98 }
  99 }
 100
 101 #endif