offapi/com/sun/star/ucb/UniversalContentBroker.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_UniversalContentBroker_idl__
  20 #define __com_sun_star_ucb_UniversalContentBroker_idl__
  21
  22 #include <com/sun/star/ucb/XUniversalContentBroker.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** is a one-instance service that provides access to a set of
  28     Contents via ContentProviders.
  29
  30     <p>Traditionally, this service implements
  31     com::sun::star::lang::XInitialization and needed to be
  32     instantiated once with two arguments via
  33     com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext()
  34     for configuration before it could be obtained via plain
  35     com::sun::star::lang::XMultiComponentFactory::createInstanceWithContext().
  36
  37     <p>However, the only pair of initialization arguments used in practice is
  38     <code>"Local"</code>/<code>"Office"</code>, so this service is simplified
  39     now to automatically configure itself with that argument pair upon first
  40     instantiation.
  41
  42     <p>(For backwards compatibility, the service implementation still supports
  43     com::sun::star::lang::XInitialization and can still
  44     explicitly be initialized via
  45     com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext()
  46     with two arguments of type string.  These strings are used as a pair of keys
  47     to retrieve a set of content provider descriptions from the configuration
  48     management (stored at
  49     <code>org.openoffice.ucb.Configuration.ContentProviders.<var>key<sub>1</sub></var>.SecondaryKeys.<var>key<sub>2</sub></var>.ProviderData</code>
  50     within the configuration management's hierarchy).  The retrieved
  51     descriptions are in turn used to register the corresponding content provider
  52     services at the broker.)
  53 */
  54 published service UniversalContentBroker : XUniversalContentBroker
  55 {
  56     /** The (default) constructor.
  57
  58         <p>(This default constructor is only mentioned explicitly for technical
  59         reasons, so that its implementation calls the service implementation's
  60         com::sun::star::lang::XInitialization::initialize().)
  61      */
  62     create();
  63 };
  64
  65
  66 }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */