mojo/application/public/interfaces/shell.mojom

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 module mojo;
   6
   7 import "mojo/application/public/interfaces/service_provider.mojom";
   8 import "network/public/interfaces/url_loader.mojom";
   9
  10 // Specifies a whitelist of applications and services an application can connect
  11 // to. Connections to applications not explicitly specified here as a key are
  12 // rejected. Connections to services not specified in an application's allowed
  13 // interfaces value are not made.
  14 // A "*" value as the only key in an otherwise empty map means the application
  15 // may connect to any other application.
  16 // A "*" value as the only string in an otherwise empty array of interface names
  17 // means the application may connect to any service in that application.
  18 // An empty interface name array means the application may not connect to any
  19 // services exposed by the application it is connecting to.
  20 struct CapabilityFilter {
  21   map<string, array<string>> filter;
  22 };
  23
  24 // An interface through which a Mojo application may communicate with the Mojo
  25 // system and request connections to other applications.
  26 interface Shell {
  27   // Used to indicate the app was not launched by a content handler.
  28   const uint32 kInvalidContentHandlerID = 0;
  29
  30   // Establishes a connection with another application ("target application")
  31   // (located at |request->url|) through which the calling application and the
  32   // target application may request services from one another.
  33   // |application_url| is a URLRequest in case this is called for an HTTP
  34   // navigation, in which case HTTP specific information like POST data,
  35   // referrer header etc... needed.
  36   //
  37   // If the calling application would like to request services from the target
  38   // application, it should pass a valid interface request in the |services|
  39   // parameter (i.e. one containing a valid message pipe endpoint). If the
  40   // target application does not wish to offer services, it may either not bind
  41   // an implementation to the interface request, or else bind an implementation
  42   // that will reject some or all service requests.
  43   //
  44   // If the calling application would like to offer services to the target
  45   // application, it should pass a bound interface through the
  46   // |exposed_services| parameter. The target application may then request
  47   // services through that interface.
  48   //
  49   // At least one of |services| or |exposed_services| should be valid/bound in
  50   // the call.
  51   //
  52   // If the |application_url| does not contain a domain, but is of the form
  53   // "mojo:{service}", it is up to the Mojo shell to select an appropriate
  54   // application for the service. Currently, the shell does this based on the
  55   // value of its --origin flag.
  56   //
  57   // |filter| is a whitelist of application URLs and services that the target
  58   // application is permitted to connect to. See documentation for
  59   // CapabilityFilter above. Note also that this parameter may be NULL, which
  60   // has the same meaning as allowing the target application to connect to
  61   // any application and service.
  62   //
  63   // If the connection to |application_url| involves a content handler, then
  64   // |content_handler_id| is the id of the deepest content handler used to
  65   // establish the connection to |application_url|. If no content handler is
  66   // used |content_handler_id| is kInvalidContentHandlerID.
  67   // TODO(beng): determine if we need to expose the target application id also.
  68   ConnectToApplication(URLRequest application_url,
  69                        ServiceProvider&? services,
  70                        ServiceProvider? exposed_services,
  71                        CapabilityFilter? filter) => (uint32 content_handler_id);
  72
  73   // When there are no more instantiated services in an application, it should
  74   // start its shutdown process by calling this method. Additionally, it should
  75   // keep track of any new service requests that come in. The shell will then
  76   // call Application::OnQuitRequested and start queueing new service requests.
  77   // If the application didn't get any new service requests in the meantime, it
  78   // should call the callback with a true value. Otherwise it should call it
  79   // with false.
  80   QuitApplication();
  81 };