nsIHttpServer.idl

Go to the documentation of this file.

/* ***** 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 the httpd.js server.
 *
 * The Initial Developer of the Original Code is
 * Mozilla Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Jeff Walden <jwalden+code@mit.edu>          (original author)
 *   Robert Sayre <sayrer@gmail.com>
 *
 * 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 "nsIPropertyBag.idl"

interface nsIInputStream;
interface nsILocalFile;
interface nsIOutputStream;
interface nsISimpleEnumerator;

interface nsIHttpServer;
interface nsIHttpServerStoppedCallback;
interface nsIHttpRequestHandler;
interface nsIHttpRequestMetadata;
interface nsIHttpResponse;
interface nsIHttpServerIdentity;

[scriptable, uuid(79e0d43a-1dd2-11b2-870f-f94d22a28b27)]
interface nsIHttpServer : nsISupports
{
  void start(in long port);

  void stop(in nsIHttpServerStoppedCallback callback);

  void registerFile(in string path, in nsILocalFile file);

  void registerPathHandler(in string path, in nsIHttpRequestHandler handler);

  void registerPrefixHandler(in string prefix, in nsIHttpRequestHandler handler);

  void registerErrorHandler(in unsigned long code, in nsIHttpRequestHandler handler);

  void registerDirectory(in string path, in nsILocalFile dir);

  void registerContentType(in string extension, in string type);

  void setIndexHandler(in nsIHttpRequestHandler handler);

  readonly attribute nsIHttpServerIdentity identity;

  AString getState(in AString path, in AString key);

  void setState(in AString path, in AString key, in AString value);

  AString getSharedState(in AString key);

  void setSharedState(in AString key, in AString value);

  nsISupports getObjectState(in AString key);

  void setObjectState(in AString key, in nsISupports value);
};

[scriptable, function, uuid(925a6d33-9937-4c63-abe1-a1c56a986455)]
interface nsIHttpServerStoppedCallback : nsISupports
{
  void onStopped();
};

[scriptable, uuid(a89de175-ae8e-4c46-91a5-0dba99bbd284)]
interface nsIHttpServerIdentity : nsISupports
{
  readonly attribute string primaryScheme;

  readonly attribute string primaryHost;

  readonly attribute long primaryPort;

  void add(in string scheme, in string host, in long port);

  PRBool remove(in string scheme, in string host, in long port);

  PRBool has(in string scheme, in string host, in long port);

  string getScheme(in string host, in long port);
  
  void setPrimary(in string scheme, in string host, in long port);
};

[scriptable, function, uuid(2bbb4db7-d285-42b3-a3ce-142b8cc7e139)]
interface nsIHttpRequestHandler : nsISupports
{
  void handle(in nsIHttpRequestMetadata metadata, in nsIHttpResponse response);
};


[scriptable, uuid(80cbca71-dc51-4fa0-9010-1cec262dbd4a)]
interface nsIHttpRequestMetadata : nsIPropertyBag
{
  readonly attribute string method;

  readonly attribute string scheme;

  readonly attribute string host;

  readonly attribute unsigned long port;

  readonly attribute string path;

  readonly attribute string queryString;

  readonly attribute string httpVersion;

  string getHeader(in string fieldName);

  boolean hasHeader(in string fieldName);

  readonly attribute nsISimpleEnumerator headers;

  readonly attribute nsIInputStream bodyInputStream;
};


[scriptable, uuid(1acd16c2-dc59-42fa-9160-4f26c43c1c21)]
interface nsIHttpResponse : nsISupports
{
  void setStatusLine(in string httpVersion,
                     in unsigned short statusCode,
                     in string description);

  void setHeader(in string name, in string value, in boolean merge);

  readonly attribute nsIOutputStream bodyOutputStream;

  void write(in string data);

  void processAsync();

  void seizePower();

  void finish();
};