Source/WebCore/Modules/indexeddb/IDBFactoryBackendInterface.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28 #ifndef IDBFactoryBackendInterface_h
  29 #define IDBFactoryBackendInterface_h
  30
  31 #include "IDBBackingStoreInterface.h"
  32 #include "IndexedDB.h"
  33
  34 #include <wtf/PassRefPtr.h>
  35 #include <wtf/RefCounted.h>
  36 #include <wtf/text/WTFString.h>
  37
  38 #if ENABLE(INDEXED_DATABASE)
  39
  40 namespace WebCore {
  41
  42 class IDBCallbacks;
  43 class IDBDatabase;
  44 class IDBDatabaseBackendInterface;
  45 class IDBDatabaseCallbacks;
  46 class IDBTransactionBackend;
  47 class SecurityOrigin;
  48 class ScriptExecutionContext;
  49
  50 typedef int ExceptionCode;
  51
  52 // This class is shared by IDBFactory (async) and IDBFactorySync (sync).
  53 // This is implemented by IDBFactoryBackendImpl and optionally others (in order to proxy
  54 // calls across process barriers). All calls to these classes should be non-blocking and
  55 // trigger work on a background thread if necessary.
  56 class IDBFactoryBackendInterface : public RefCounted<IDBFactoryBackendInterface> {
  57 public:
  58     static PassRefPtr<IDBFactoryBackendInterface> create(const String& databaseDirectoryIdentifier);
  59     virtual ~IDBFactoryBackendInterface() { }
  60
  61     virtual void getDatabaseNames(PassRefPtr<IDBCallbacks>, PassRefPtr<SecurityOrigin>, ScriptExecutionContext*, const String& dataDir) = 0;
  62     virtual void open(const String& name, uint64_t version, int64_t transactionId, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBDatabaseCallbacks>, const SecurityOrigin& openingOrigin, const SecurityOrigin& mainFrameOrigin) = 0;
  63     virtual void deleteDatabase(const String& name, PassRefPtr<IDBCallbacks>, PassRefPtr<SecurityOrigin>, ScriptExecutionContext*, const String& dataDir) = 0;
  64
  65     virtual void removeIDBDatabaseBackend(const String& uniqueIdentifier) = 0;
  66
  67     virtual PassRefPtr<IDBTransactionBackend> maybeCreateTransactionBackend(IDBDatabaseBackendInterface*, int64_t transactionId, PassRefPtr<IDBDatabaseCallbacks>, const Vector<int64_t>& objectStoreIds, IndexedDB::TransactionMode) = 0;
  68
  69     virtual PassRefPtr<IDBCursorBackend> createCursorBackend(IDBTransactionBackend&, IDBBackingStoreCursorInterface&, IndexedDB::CursorType, IDBDatabaseBackendInterface::TaskType, int64_t objectStoreId) = 0;
  70 };
  71
  72 } // namespace WebCore
  73
  74 #endif // IDBFactoryBackendInterface_h
  75
  76 #endif // IDBFactoryBackendInterface_h