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