Reviewed by Darin
[WebKit-https.git] / 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 NSString *WebDatabaseDisplayNameKey;
30 extern NSString *WebDatabaseExpectedSizeKey;
31 extern 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 // The notification object will be a WebSecurityOrigin object corresponding to the origin.
35 extern NSString *WebDatabaseDidModifyOriginNotification;
36
37 // Posted when a database is created, its size increases, its display name changes, or its estimated size changes, or the database is removed
38 // The notification object will be a WebSecurityOrigin object corresponding to the origin.
39 // The notification userInfo will have a WebDatabaseNameKey whose value is the database name.
40 extern NSString *WebDatabaseDidModifyDatabaseNotification;
41 extern NSString *WebDatabaseIdentifierKey;
42
43 @class WebSecurityOrigin;
44
45 @interface WebDatabaseManager : NSObject
46 {
47 }
48
49 + (WebDatabaseManager *) sharedWebDatabaseManager;
50
51 // Will return an array of WebSecurityOrigins
52 - (NSArray *)origins;
53
54 // Will return an array of strings, the names of each database in the given origin
55 - (NSArray *)databasesWithOrigin:(WebSecurityOrigin *)origin;
56
57 // Will return the dictionary describing everything about the database for the passed origin and name
58 - (NSDictionary *)detailsForDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
59
60 - (void)deleteAllDatabases;
61 - (void)deleteOrigin:(WebSecurityOrigin *)origin;
62 - (void)deleteDatabasesWithOrigin:(WebSecurityOrigin *)origin;
63 - (void)deleteDatabase:(NSString *)databaseIdentifier withOrigin:(WebSecurityOrigin *)origin;
64
65 @end