udkapi/com/sun/star/bridge/XBridgeFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XBridgeFactory.idl,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _COM_SUN_STAR_BRIDGE_XBRIDGEFACTORY_IDL_
  31 #define _COM_SUN_STAR_BRIDGE_XBRIDGEFACTORY_IDL_
  32
  33 #include <com/sun/star/lang/IllegalArgumentException.idl>
  34
  35 #include <com/sun/star/connection/XConnection.idl>
  36 #include <com/sun/star/bridge/XBridge.idl>
  37 #include <com/sun/star/bridge/BridgeExistsException.idl>
  38 #include <com/sun/star/bridge/XInstanceProvider.idl>
  39
  40  module com {  module sun {  module star {  module bridge {
  41
  42 /** factory to create interprocess bridges.
  43  */
  44 published interface XBridgeFactory: com::sun::star::uno::XInterface
  45 {
  46     /** tries to create a UNO interprocess bridge.
  47
  48         @param sName
  49             The name of the bridge. This allows other components to reuse
  50              an already created bridge (using getBridge).
  51              <p>
  52              If empty, an anonymous bridge is created, which cannot be retrieved with
  53              getBridge(). No BridgeExistsException can be thrown in this case.
  54
  55         @param sProtocol
  56             The protocol, that will be used on the connection (e.g., urp) plus additional
  57             comma separated name=value protocol properties.
  58
  59         @param aConnection
  60             The connection, which is used to transfer the calls. The bridge expects to
  61             own the connection, thus it will close the connection, in case it does not
  62             need it anymore.
  63
  64         @param anInstanceProvider
  65             gets called, when a request from remote comes in. You can pass a null reference
  66             in case you don't want to export any objects.
  67
  68         @throws BridgeExistsException
  69             There is already a bridge registered with this name.  Use getBridge instead.
  70
  71         @throws IllegalArgumentException
  72             The protocol is unknown or the connection is null.
  73      */
  74     XBridge createBridge(
  75         [in] string sName,
  76         [in] string sProtocol ,
  77         [in] com::sun::star::connection::XConnection aConnection ,
  78         [in] XInstanceProvider anInstanceProvider )
  79         raises ( BridgeExistsException , com::sun::star::lang::IllegalArgumentException );
  80
  81
  82     /** tries to get a bridge by this name.
  83         <p> Cannot be retrieved, when the bridge got disposed before.
  84
  85         @return An existing remote bridge or a null reference.
  86      */
  87     XBridge getBridge( [in] string  sName );
  88
  89     /** returns the sequence of all named and unnamed UNO interprocess
  90         bridges that are instantiated at the time the call is made.
  91      */
  92     sequence < XBridge > getExistingBridges( );
  93 };
  94
  95
  96 };};};};
  97
  98 #endif