third_party/WebKit/public/platform/WebStorageNamespace.h

   1 /*
   2  * Copyright (C) 2009 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebStorageNamespace_h
  32 #define WebStorageNamespace_h
  33
  34 #include "WebCommon.h"
  35
  36 namespace blink {
  37
  38 class WebStorageArea;
  39 class WebString;
  40
  41 // WebStorageNamespace represents a collection of StorageAreas. Typically, you'll have
  42 // multiple StorageNamespaces to represent the SessionStorage for each tab and a single
  43 // StorageNamespace to represent LocalStorage for the entire browser.
  44 class WebStorageNamespace {
  45 public:
  46     virtual ~WebStorageNamespace() { }
  47
  48     // Create a new WebStorageArea object. Two subsequent calls with the same origin
  49     // will return two different WebStorageArea objects that share the same backing store.
  50     // You should call delete on the returned object when you're finished.
  51     virtual WebStorageArea* createStorageArea(const WebString& origin) = 0;
  52
  53     // Returns true of the two instances represent the same storage namespace.
  54     virtual bool isSameNamespace(const WebStorageNamespace&) const { return false; }
  55 };
  56
  57 } // namespace blink
  58
  59 #endif // WebStorageNamespace_h