Home | History | Annotate | Download | only in Storage
      1 /*
      2  * Copyright (C) 2007, 2008 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 #if ENABLE(DATABASE)
     30 
     31 extern NSString *WebDatabaseDirectoryDefaultsKey;
     32 
     33 extern NSString *WebDatabaseDisplayNameKey;
     34 extern NSString *WebDatabaseExpectedSizeKey;
     35 extern NSString *WebDatabaseUsageKey;
     36 
     37 // Posted with an origin is created from scratch, gets a new database, has a database deleted, has a quota change, etc
     38 // The notification object will be a WebSecurityOrigin object corresponding to the origin.
     39 extern NSString *WebDatabaseDidModifyOriginNotification;
     40 
     41 // Posted when a database is created, its size increases, its display name changes, or its estimated size changes, or the database is removed
     42 // The notification object will be a WebSecurityOrigin object corresponding to the origin.
     43 // The notification userInfo will have a WebDatabaseNameKey whose value is the database name.
     44 extern NSString *WebDatabaseDidModifyDatabaseNotification;
     45 extern NSString *WebDatabaseIdentifierKey;
     46 
     47 @class WebSecurityOrigin;
     48 
     49 @interface WebDatabaseManager : NSObject
     50 
     51 + (WebDatabaseManager *)sharedWebDatabaseManager;
     52 
     53 // Will return an array of WebSecurityOrigin objects.
     54 - (NSArray *)origins;
     55 
     56 // Will return an array of strings, the identifiers of each database in the given origin.
     57 - (NSArray *)databasesWithOrigin:(WebSecurityOrigin *)origin;
     58 
     59 // Will return the dictionary describing everything about the database for the passed identifier and origin.
     60 - (NSDictionary *)detailsForDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
     61 
     62 - (void)deleteAllDatabases; // Deletes all databases and all origins.
     63 - (BOOL)deleteOrigin:(WebSecurityOrigin *)origin;
     64 - (BOOL)deleteDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
     65 
     66 @end
     67 
     68 #endif
     69