WebKit/mac/Storage/WebDatabaseManagerPrivate.h

   1 /*
   2  * Copyright (C) 2007 Apple 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
  29 extern const NSString *WebDatabaseDisplayNameKey;
  30 extern const NSString *WebDatabaseExpectedSizeKey;
  31 extern const NSString *WebDatabaseUsageKey;
  32
  33 // Posted with an origin is created from scratch, gets a new database, has a database deleted, has a quota change, etc
  34 extern const NSString *WebDatabaseDidModifyOriginNotification;
  35
  36 // Posted when a database is created, its size increases, its display name changes, or its estimated size changes, or the database is removed
  37 extern const NSString *WebDatabaseDidModifyDatabaseNotification;
  38
  39 @class WebSecurityOrigin;
  40
  41 @interface WebDatabaseManager : NSObject
  42 {
  43 }
  44
  45 + (WebDatabaseManager *) sharedWebDatabaseManager;
  46
  47 // Will return an array of WebSecurityOrigins
  48 - (NSArray *)origins;
  49
  50 // Will return an array of strings, the names of each database in the given origin
  51 - (NSArray *)databasesWithOrigin:(WebSecurityOrigin *)origin;
  52
  53 // Will return the dictionary describing everything about the database for the passed origin and name
  54 - (NSDictionary *)detailsForDatabase:(NSString *)databaseName withOrigin:(WebSecurityOrigin *)origin;
  55
  56 - (void)deleteAllDatabases;
  57 - (void)deleteDatabasesWithOrigin:(WebSecurityOrigin *)origin;
  58 - (void)deleteDatabase:(NSString *)databaseName withOrigin:(WebSecurityOrigin *)origin;
  59
  60 @end