diff options
Diffstat (limited to 'configmgr/source/backend/backendfactory.cxx')
| -rw-r--r-- | configmgr/source/backend/backendfactory.cxx | 332 |
1 files changed, 332 insertions, 0 deletions
diff --git a/configmgr/source/backend/backendfactory.cxx b/configmgr/source/backend/backendfactory.cxx new file mode 100644 index 000000000000..f5989f008a86 --- /dev/null +++ b/configmgr/source/backend/backendfactory.cxx @@ -0,0 +1,332 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: backendfactory.cxx,v $ + * $Revision: 1.12 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +// MARKER(update_precomp.py): autogen include statement, do not remove +#include "precompiled_configmgr.hxx" + +#include "backendfactory.hxx" + +#ifndef CONFIGMGR_API_FACTORY_HXX_ +#include "confapifactory.hxx" +#endif +#include "bootstrapcontext.hxx" +#include "bootstrap.hxx" +#include "backendaccess.hxx" +#include "serviceinfohelper.hxx" +#include "wrapexception.hxx" + + +#include <com/sun/star/configuration/CannotLoadConfigurationException.hpp> +#include <com/sun/star/configuration/backend/XBackend.hpp> +#include <com/sun/star/configuration/backend/XMultiLayerStratum.hpp> + +namespace configmgr +{ +// ------------------------------------------------------------------------- + namespace backend + { +// ------------------------------------------------------------------------- + namespace uno = ::com::sun::star::uno; + namespace lang = ::com::sun::star::lang; + namespace backenduno = ::com::sun::star::configuration::backend; +// ------------------------------------------------------------------------- +const sal_Char k_DefaultBackendWrapper[] = "com.sun.star.comp.configuration.backend.SingleBackendAdapter"; +const sal_Char k_DefaultBackendService[] = "com.sun.star.comp.configuration.backend.LocalSingleBackend"; + +// ------------------------------------------------------------------------- +const sal_Char k_DefaultBackendServiceAndImplName[] = K_DefaultBackendServiceAndImplName ; + +// ------------------------------------------------------------------------- +const sal_Char k_GenericBackendServiceAndImplName[] = "com.sun.star.configuration.backend.Backend" ; + +// ------------------------------------------------------------------------- +static sal_Char const * const k_BackendServiceNames [] = +{ + k_DefaultBackendServiceAndImplName, + k_GenericBackendServiceAndImplName, + 0 +}; +// ------------------------------------------------------------------------- +static const ServiceRegistrationInfo k_DefaultBackendServiceInfo = +{ + k_DefaultBackendServiceAndImplName, + k_BackendServiceNames +}; +// ------------------------------------------------------------------------- +static const ServiceRegistrationInfo k_GenericBackendServiceInfo = +{ + k_GenericBackendServiceAndImplName, + k_BackendServiceNames + 1 +}; +// ------------------------------------------------------------------------- +static const SingletonRegistrationInfo k_DefaultBackendSingletonInfo = +{ + K_DefaultBackendSingletonName, + k_DefaultBackendServiceAndImplName, + k_DefaultBackendServiceAndImplName, + & k_GenericBackendServiceInfo +}; +// ------------------------------------------------------------------------- +// ------------------------------------------------------------------------- +const SingletonRegistrationInfo * getDefaultBackendSingletonInfo() +{ + return & k_DefaultBackendSingletonInfo; +} +// ------------------------------------------------------------------------- + +const ServiceRegistrationInfo * getDefaultBackendServiceInfo() +{ + return & k_DefaultBackendServiceInfo; +} +// ------------------------------------------------------------------------- +// ------------------------------------------------------------------------- + +uno::Reference<uno::XInterface> SAL_CALL + getDefaultBackendSingleton( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > const& xContext ) +{ + OSL_ENSURE( xContext.is(), "ERROR: NULL context has no singletons" ); + + UnoContextTunnel aTunnel; + aTunnel.passthru( xContext ); + + uno::Reference<uno::XInterface> xResult; + + if (xContext.is()) + try + { + xContext->getValueByName(SINGLETON(K_DefaultBackendSingletonName)) + >>= xResult; + } + catch (uno::Exception & ) + { + // to do: really use the tunneled failure when that is set properly + if ( aTunnel.recoverFailure(true).hasValue() ) + { + // have a failure, but can't recover it + // -> try to regenerate + instantiateDefaultBackend(xContext); + + OSL_ENSURE(false, "Cannot recreate configuration backend instantiation failure - using generic error"); + } + // cannot recover any failure + throw; + } + + return xResult; +} +// ------------------------------------------------------------------------- + +// ------------------------------------------------------------------------- +// ------------------------------------------------------------------------- + +static +uno::Sequence< uno::Any > createInitArgs(ContextReader const & _aContext) +{ + OSL_ASSERT(_aContext.hasBootstrapContext()); + uno::Sequence< uno::Any > aResult( 1 ); + aResult[0] <<= _aContext.getBootstrapContext(); + return aResult; +} +// ------------------------------------------------------------------------- + +static +inline +uno::Reference< uno::XInterface > createService(ContextReader const & _aCtx, uno::Sequence< uno::Any > const & _aInitArgs, rtl::OUString const & _aSvc) +{ + uno::Reference< lang::XMultiComponentFactory > xFactory = _aCtx.getServiceManager(); + OSL_ENSURE(xFactory.is(),"ERROR: ComponentContext has no service manager\n"); + if (!xFactory.is()) throw uno::RuntimeException( rtl::OUString::createFromAscii("ERROR: ComponentContext has no service manager\n"), NULL ); + return xFactory->createInstanceWithArgumentsAndContext( _aSvc, _aInitArgs, _aCtx.getBaseContext()); +} +// ------------------------------------------------------------------------- + +static +uno::Reference< backenduno::XBackend > wrapSingleBackend(ContextReader const & _aSettings, uno::Sequence< uno::Any > const & _aInitArgs, uno::Reference< backenduno::XMultiLayerStratum > const & _xWrappedBackend) +{ + OSL_ASSERT(_aSettings.hasUnoBackendWrapper() || _aSettings.hasBootstrapContext()); + + rtl::OUString aWrapperSvc = _aSettings.hasUnoBackendWrapper() ? + _aSettings.getUnoBackendWrapper() : + rtl::OUString::createFromAscii(k_DefaultBackendWrapper); + + OSL_ENSURE (aWrapperSvc.getLength(), "ERROR: No wrapper service for wrapped configuration"); + OSL_ENSURE (_xWrappedBackend.is(), "ERROR: No backend to wrap for wrapped configuration"); + + sal_Int32 const nBaseArgsCount = _aInitArgs.getLength(); + uno::Sequence< uno::Any > aExtendedArgs( _aInitArgs ); + aExtendedArgs.realloc( nBaseArgsCount + 1 ); + aExtendedArgs[nBaseArgsCount] <<= _xWrappedBackend; + + return uno::Reference< backenduno::XBackend >::query( createService(_aSettings,aExtendedArgs,aWrapperSvc) ); +} +// ------------------------------------------------------------------------- + +static +uno::Reference< backenduno::XBackend > createOfflineBackend(ContextReader const & _aSettings, uno::Sequence< uno::Any > const & _aInitArgs) +{ + OSL_ASSERT(_aSettings.hasUnoBackendWrapper() || _aSettings.hasBootstrapContext()); + + uno::Reference< backenduno::XBackend > xResult; + if ( _aSettings.hasUnoBackendWrapper() ) + { + rtl::OUString const aWrapperSvc = _aSettings.getUnoBackendWrapper(); + + xResult = uno::Reference< backenduno::XBackend >::query( createService(_aSettings,_aInitArgs,aWrapperSvc) ); + } + + return xResult; +} +// ------------------------------------------------------------------------- + +static +uno::Reference< uno::XInterface > createRealBackend(ContextReader const & _aSettings, uno::Sequence< uno::Any > const & _aInitArgs) +{ + OSL_ASSERT(_aSettings.hasUnoBackendService() || _aSettings.hasBootstrapContext()); + + rtl::OUString const aBackendServiceName = _aSettings.hasUnoBackendService() ? + _aSettings.getUnoBackendService() : + rtl::OUString::createFromAscii(k_DefaultBackendService); + + uno::Reference< uno::XInterface > xResult = + createService(_aSettings,_aInitArgs,aBackendServiceName); + + return xResult; +} +// ------------------------------------------------------------------------- + +static +uno::Reference< backenduno::XBackend > createOnlineBackend(ContextReader const & _aSettings, uno::Sequence< uno::Any > const & _aInitArgs) +{ + OSL_ENSURE( _aSettings.isUnoBackend(), "ERROR - BackendFactory: For legacy backends use createSessionBackend()"); + + uno::Reference< backenduno::XBackend > xResult; + + uno::Reference< uno::XInterface > xRealBackend = createRealBackend(_aSettings,_aInitArgs); + + if (_aSettings.hasUnoBackendWrapper()) + { + // try wrapping a single backend + uno::Reference< backenduno::XMultiLayerStratum > xSingleRealBackend( xRealBackend, uno::UNO_QUERY); + if (xSingleRealBackend.is()) + xResult = wrapSingleBackend(_aSettings,_aInitArgs,xSingleRealBackend); + + // if we don't have one, try using it as unwrapped backend + else + xResult.set(xRealBackend, uno::UNO_QUERY); + } + else + { + // look for a direct implementation of XBackend + xResult.set(xRealBackend, uno::UNO_QUERY); + if (!xResult.is()) + { + // try the default wrapper if we only have a single backend + uno::Reference< backenduno::XMultiLayerStratum > xSingleRealBackend( xRealBackend, uno::UNO_QUERY); + if (xSingleRealBackend.is()) + xResult = wrapSingleBackend(_aSettings,_aInitArgs,xSingleRealBackend); + + else + OSL_ENSURE( !xRealBackend.is(), "Configuration Backend implements no known backend interface" ); + } + } + + return xResult; +} +// ------------------------------------------------------------------------- + +static uno::Reference< backenduno::XBackend > createUnoBackend(com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > const& _xCtx) +{ + ContextReader aSettings(_xCtx); + OSL_ENSURE( aSettings.isUnoBackend(), "ERROR - BackendFactory: Legacy backends are not supported any more"); + + uno::Sequence< uno::Any > aArguments = createInitArgs(aSettings); + + sal_Bool bOffline = aSettings.hasOfflineSetting() ? aSettings.getOfflineSetting() : !aSettings.hasUnoBackendService(); + + uno::Reference< backenduno::XBackend > xResult; + + if (!bOffline) + xResult = createOnlineBackend (aSettings,aArguments); + + if (!xResult.is()) + xResult = createOfflineBackend(aSettings,aArguments); + + return xResult; +} +// ------------------------------------------------------------------------- +// to do: tunnel and raise fully typed exception information (and use it in the get..Singleton wrappers) + #define TUNNEL_ALL_EXCEPTIONS() \ + WRAP_CONFIGBACKEND_CREATION_EXCEPTIONS1( UnoContextTunnel::tunnelFailure, true ) + +// ------------------------------------------------------------------------- + +uno::Reference<uno::XInterface> SAL_CALL instantiateDefaultBackend( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > const& xTargetContext ) +{ + com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext = UnoContextTunnel::recoverContext(xTargetContext); + + try + { + return uno::Reference< uno::XInterface >( createUnoBackend(xContext), uno::UNO_QUERY ); + } + TUNNEL_ALL_EXCEPTIONS() + + OSL_ASSERT(!"unreached"); + return NULL; +} +// ------------------------------------------------------------------------- + +uno::Reference< backenduno::XBackend > BackendFactory::getUnoBackend() +{ + return uno::Reference< backenduno::XBackend >::query( getDefaultBackendSingleton(m_xCtx) ); +} +// ------------------------------------------------------------------------- + +rtl::Reference<IMergedDataProvider> BackendFactory::createBackend() +{ + rtl::Reference< IMergedDataProvider > xBackend; + + uno::Reference< backenduno::XBackend > xBackendService = this->getUnoBackend(); + + if (xBackendService.is()) + xBackend = new BackendAccess(xBackendService, m_xCtx); + + return xBackend; +} +// ------------------------------------------------------------------------- + +BackendFactory BackendFactory::instance(com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > const & _xCtx) +{ + return BackendFactory(_xCtx); +} + +//----------------------------------------------------------------------------- + } // namespace +//----------------------------------------------------------------------------- +} // namespace |