Index: gecko-sdk/idl/nsIIOService.idl |
=================================================================== |
--- gecko-sdk/idl/nsIIOService.idl (revision 0) |
+++ gecko-sdk/idl/nsIIOService.idl (revision 0) |
@@ -0,0 +1,146 @@ |
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
+/* ***** BEGIN LICENSE BLOCK ***** |
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
+ * |
+ * The contents of this file are subject to the Mozilla Public License Version |
+ * 1.1 (the "License"); you may not use this file except in compliance with |
+ * the License. You may obtain a copy of the License at |
+ * http://www.mozilla.org/MPL/ |
+ * |
+ * Software distributed under the License is distributed on an "AS IS" basis, |
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
+ * for the specific language governing rights and limitations under the |
+ * License. |
+ * |
+ * The Original Code is mozilla.org code. |
+ * |
+ * The Initial Developer of the Original Code is |
+ * Netscape Communications Corporation. |
+ * Portions created by the Initial Developer are Copyright (C) 1998 |
+ * the Initial Developer. All Rights Reserved. |
+ * |
+ * Contributor(s): |
+ * |
+ * Alternatively, the contents of this file may be used under the terms of |
+ * either the GNU General Public License Version 2 or later (the "GPL"), or |
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
+ * in which case the provisions of the GPL or the LGPL are applicable instead |
+ * of those above. If you wish to allow use of your version of this file only |
+ * under the terms of either the GPL or the LGPL, and not to allow others to |
+ * use your version of this file under the terms of the MPL, indicate your |
+ * decision by deleting the provisions above and replace them with the notice |
+ * and other provisions required by the GPL or the LGPL. If you do not delete |
+ * the provisions above, a recipient may use your version of this file under |
+ * the terms of any one of the MPL, the GPL or the LGPL. |
+ * |
+ * ***** END LICENSE BLOCK ***** */ |
+ |
+#include "nsISupports.idl" |
+ |
+interface nsIProtocolHandler; |
+interface nsIChannel; |
+interface nsIURI; |
+interface nsIFile; |
+ |
+/** |
+ * nsIIOService provides a set of network utility functions. This interface |
+ * duplicates many of the nsIProtocolHandler methods in a protocol handler |
+ * independent way (e.g., NewURI inspects the scheme in order to delegate |
+ * creation of the new URI to the appropriate protocol handler). nsIIOService |
+ * also provides a set of URL parsing utility functions. These are provided |
+ * as a convenience to the programmer and in some cases to improve performance |
+ * by eliminating intermediate data structures and interfaces. |
+ * |
+ * @status FROZEN |
+ */ |
+[scriptable, uuid(bddeda3f-9020-4d12-8c70-984ee9f7935e)] |
+interface nsIIOService : nsISupports |
+{ |
+ /** |
+ * Returns a protocol handler for a given URI scheme. |
+ * |
+ * @param aScheme the URI scheme |
+ * @return reference to corresponding nsIProtocolHandler |
+ */ |
+ nsIProtocolHandler getProtocolHandler(in string aScheme); |
+ |
+ /** |
+ * Returns the protocol flags for a given scheme. |
+ * |
+ * @param aScheme the URI scheme |
+ * @return value of corresponding nsIProtocolHandler::protocolFlags |
+ */ |
+ unsigned long getProtocolFlags(in string aScheme); |
+ |
+ /** |
+ * This method constructs a new URI by determining the scheme of the |
+ * URI spec, and then delegating the construction of the URI to the |
+ * protocol handler for that scheme. QueryInterface can be used on |
+ * the resulting URI object to obtain a more specific type of URI. |
+ * |
+ * @see nsIProtocolHandler::newURI |
+ */ |
+ nsIURI newURI(in AUTF8String aSpec, |
+ in string aOriginCharset, |
+ in nsIURI aBaseURI); |
+ |
+ /** |
+ * This method constructs a new URI from a nsIFile. |
+ * |
+ * @param aFile specifies the file path |
+ * @return reference to a new nsIURI object |
+ */ |
+ nsIURI newFileURI(in nsIFile aFile); |
+ |
+ /** |
+ * Creates a channel for a given URI. |
+ * |
+ * @param aURI nsIURI from which to make a channel |
+ * @return reference to the new nsIChannel object |
+ */ |
+ nsIChannel newChannelFromURI(in nsIURI aURI); |
+ |
+ /** |
+ * Equivalent to newChannelFromURI(newURI(...)) |
+ */ |
+ nsIChannel newChannel(in AUTF8String aSpec, |
+ in string aOriginCharset, |
+ in nsIURI aBaseURI); |
+ |
+ /** |
+ * Returns true if networking is in "offline" mode. When in offline mode, |
+ * attempts to access the network will fail (although this is not |
+ * necessarily corrolated with whether there is actually a network |
+ * available -- that's hard to detect without causing the dialer to |
+ * come up). |
+ */ |
+ attribute boolean offline; |
+ |
+ /** |
+ * Checks if a port number is banned. This involves consulting a list of |
+ * unsafe ports, corresponding to network services that may be easily |
+ * exploitable. If the given port is considered unsafe, then the protocol |
+ * handler (corresponding to aScheme) will be asked whether it wishes to |
+ * override the IO service's decision to block the port. This gives the |
+ * protocol handler ultimate control over its own security policy while |
+ * ensuring reasonable, default protection. |
+ * |
+ * @see nsIProtocolHandler::allowPort |
+ */ |
+ boolean allowPort(in long aPort, in string aScheme); |
+ |
+ /** |
+ * Utility to extract the scheme from a URL string, consistently and |
+ * according to spec (see RFC 2396). |
+ * |
+ * NOTE: Most URL parsing is done via nsIURI, and in fact the scheme |
+ * can also be extracted from a URL string via nsIURI. This method |
+ * is provided purely as an optimization. |
+ * |
+ * @param aSpec the URL string to parse |
+ * @return URL scheme |
+ * |
+ * @throws NS_ERROR_MALFORMED_URI if URL string is not of the right form. |
+ */ |
+ ACString extractScheme(in AUTF8String urlString); |
+}; |
Property changes on: gecko-sdk\idl\nsIIOService.idl |
___________________________________________________________________ |
Added: svn:eol-style |
+ LF |