Back to index

lightning-sunbird  0.9+nobinonly
nsICacheEntryDescriptor.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is nsICacheEntryDescriptor.idl, released
00017  * February 10, 2001.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 2001
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *   Gordon Sheridan <gordon@netscape.com>
00026  *   Patrick Beard   <beard@netscape.com>
00027  *   Darin Fisher    <darin@netscape.com>
00028  *
00029  * Alternatively, the contents of this file may be used under the terms of
00030  * either the GNU General Public License Version 2 or later (the "GPL"), or
00031  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00032  * in which case the provisions of the GPL or the LGPL are applicable instead
00033  * of those above. If you wish to allow use of your version of this file only
00034  * under the terms of either the GPL or the LGPL, and not to allow others to
00035  * use your version of this file under the terms of the MPL, indicate your
00036  * decision by deleting the provisions above and replace them with the notice
00037  * and other provisions required by the GPL or the LGPL. If you do not delete
00038  * the provisions above, a recipient may use your version of this file under
00039  * the terms of any one of the MPL, the GPL or the LGPL.
00040  *
00041  * ***** END LICENSE BLOCK ***** */
00042 
00043 #include "nsICacheVisitor.idl"
00044 #include "nsICache.idl"
00045 
00046 interface nsISimpleEnumerator;
00047 interface nsICacheListener;
00048 interface nsIInputStream;
00049 interface nsIOutputStream;
00050 interface nsIFile;
00051 interface nsICacheMetaDataVisitor;
00052 
00053 
00054 [scriptable, uuid(49c1a11d-f5d2-4f09-8262-551e64908ada)]
00055 interface nsICacheEntryDescriptor : nsICacheEntryInfo
00056 {
00061     void setExpirationTime(in PRUint32 expirationTime);
00062 
00067     void setDataSize(in unsigned long size);
00068 
00081     nsIInputStream openInputStream(in unsigned long offset);
00082 
00098     nsIOutputStream openOutputStream(in unsigned long offset);
00099 
00105     attribute nsISupports cacheElement;
00106      
00112     readonly attribute nsCacheAccessMode accessGranted;
00113     
00118     attribute nsCacheStoragePolicy storagePolicy;
00119 
00123     readonly attribute nsIFile file;
00124 
00129     attribute nsISupports securityInfo;
00130     
00140     void doom();
00141     void doomAndFailPendingRequests(in nsresult status);
00142     
00147     void markValid();
00148 
00153     void close();
00154 
00160     string getMetaDataElement(in string key);
00161     void   setMetaDataElement(in string key, in string value);
00162     
00166     void   visitMetaData(in nsICacheMetaDataVisitor  visitor);
00167 };
00168 
00169 
00170 
00171 [scriptable, uuid(22f9a49c-3cf8-4c23-8006-54efb11ac562)]
00172 interface nsICacheMetaDataVisitor : nsISupports
00173 {
00177     boolean visitMetaDataElement(in string  key,
00178                                  in string  value);
00179 };