197 lines
7.3 KiB
C++
197 lines
7.3 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: backendaccess.hxx,v $
|
|
*
|
|
* $Revision: 1.13 $
|
|
*
|
|
* last change: $Author: rt $ $Date: 2005-09-08 03:23:13 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library 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 for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef CONFIGMGR_BACKEND_BACKENDACCESS_HXX_
|
|
#define CONFIGMGR_BACKEND_BACKENDACCESS_HXX_
|
|
|
|
#ifndef CONFIGMGR_BACKEND_BACKENDNOTIFIER_HXX
|
|
#include "backendnotifier.hxx"
|
|
#endif // CONFIGMGR_BACKEND_BACKENDNOTIFIER_HXX
|
|
|
|
#ifndef CONFIGMGR_BACKEND_MERGEDDATAPROVIDER_HXX
|
|
#include "mergeddataprovider.hxx"
|
|
#endif // CONFIGMGR_BACKEND_MERGEDDATAPROVIDER_HXX
|
|
|
|
#ifndef CONFIGMGR_BACKEND_MERGEDCOMPONENTDATA_HXX
|
|
#include "mergedcomponentdata.hxx"
|
|
#endif // CONFIGMGR_BACKEND_MERGEDCOMPONENTDATA_HXX
|
|
|
|
#ifndef CONFIGMGR_MATCHLOCALE_HXX
|
|
#include "matchlocale.hxx"
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XLAYER_HPP_
|
|
#include <com/sun/star/configuration/backend/XLayer.hpp>
|
|
#endif // _COM_SUN_STAR_CONFIGURATION_BACKEND_XLAYER_HPP_
|
|
|
|
#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XSCHEMA_HPP_
|
|
#include <com/sun/star/configuration/backend/XSchema.hpp>
|
|
#endif // _COM_SUN_STAR_CONFIGURATION_BACKEND_XSCHEMA_HPP_
|
|
|
|
#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XBACKEND_HPP_
|
|
#include <com/sun/star/configuration/backend/XBackend.hpp>
|
|
#endif // _COM_SUN_STAR_CONFIGURATION_BACKEND_XBACKEND_HPP_
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEXT_HPP_
|
|
#include <com/sun/star/uno/XComponentContext.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
|
|
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
|
|
#endif
|
|
|
|
#ifndef CONFIGMGR_BINARYCACHE_HXX
|
|
#include "binarycache.hxx"
|
|
#endif //CONFIGMGR_BINARYWRITER_HXX
|
|
|
|
#ifndef _COM_SUN_STAR_CONFIGURATION_BACKEND_XBACKENDCHANGESNOTIFIER_HPP_
|
|
#include <com/sun/star/configuration/backend/XBackendChangesNotifier.hpp>
|
|
#endif
|
|
|
|
|
|
namespace configmgr { namespace backend {
|
|
|
|
namespace css = com::sun::star ;
|
|
namespace uno = css::uno ;
|
|
namespace lang = css::lang ;
|
|
namespace backenduno = css::configuration::backend ;
|
|
|
|
/**
|
|
Implementation of IMergedDataProvider handling the access
|
|
to the configuration data.
|
|
*/
|
|
class BackendAccess : public IMergedDataProvider
|
|
{
|
|
public :
|
|
/**
|
|
Constructor using an XBackend implementation and a
|
|
service factory.
|
|
|
|
@param xBackend backend used for access to data
|
|
@param xContext uno context for instantiation of services
|
|
*/
|
|
BackendAccess( const uno::Reference<backenduno::XBackend>& xBackend,
|
|
const uno::Reference<uno::XComponentContext>& xContext) ;
|
|
/** Destructor */
|
|
~BackendAccess(void) ;
|
|
|
|
// IMergedDataProvider
|
|
virtual ComponentResult getNodeData(const ComponentRequest& aRequest,
|
|
ITemplateDataProvider* aTemplateProvider,
|
|
INodeDataListener *aListener = NULL)
|
|
CFG_UNO_THROW_ALL() ;
|
|
virtual void removeRequestListener(INodeDataListener *aListener,
|
|
const ComponentRequest& aRequest)
|
|
CFG_NOTHROW();
|
|
virtual void updateNodeData(const UpdateRequest& aUpdate)
|
|
CFG_UNO_THROW_ALL() ;
|
|
virtual NodeResult getDefaultData(const NodeRequest& aRequest)
|
|
CFG_UNO_THROW_ALL() ;
|
|
virtual TemplateResult getTemplateData(const TemplateRequest& aRequest)
|
|
CFG_UNO_THROW_ALL() ;
|
|
virtual bool isStrippingDefaults(void) CFG_NOTHROW() { return false ; }
|
|
|
|
private :
|
|
|
|
/**
|
|
Retrieves the schema of a component.
|
|
*/
|
|
uno::Reference< backenduno::XSchema > getSchema(const OUString& aComponent) ;
|
|
|
|
/**
|
|
Retrieves the schema version of a component.
|
|
*/
|
|
OUString getSchemaVersion(const OUString& aComponent) ;
|
|
|
|
/**
|
|
Retrieves the layers for a request.
|
|
*/
|
|
uno::Sequence< uno::Reference<backenduno::XLayer> > getLayers(const OUString& aComponent,const RequestOptions& aOptions) ;
|
|
|
|
/**
|
|
Reads merged default data with a given number of layers.
|
|
*/
|
|
bool readDefaultData( MergedComponentData & aComponentData,
|
|
OUString const & aComponent,
|
|
RequestOptions const & aOptions,
|
|
bool bIncludeTemplates,
|
|
const uno::Reference<backenduno::XLayer> * pLayers,
|
|
sal_Int32 nNumLayers,
|
|
ITemplateDataProvider *aTemplateProvider,
|
|
sal_Int32 * pLayersMerged = 0)
|
|
CFG_UNO_THROW_ALL();
|
|
/**
|
|
Merges layers onto component data.
|
|
*/
|
|
void merge(
|
|
MergedComponentData& aData,
|
|
const uno::Reference<backenduno::XLayer> * pLayers,
|
|
sal_Int32 aNumLayers,
|
|
localehelper::Locale const & aRequestedLocale,
|
|
localehelper::LocaleSequence & inoutMergedLocales,
|
|
ITemplateDataProvider *aTemplateProvider,
|
|
sal_Int32 * pLayersMerged = 0)
|
|
CFG_UNO_THROW_ALL();
|
|
private :
|
|
/**
|
|
Decides if merging should be retried after an exception.
|
|
|
|
@throws com::sun::star::uno::Exception
|
|
if not approved
|
|
*/
|
|
bool approveRecovery(
|
|
const uno::Any & aMergeException,
|
|
const uno::Reference<backenduno::XLayer> & aBrokenLayer,
|
|
bool bUserLayerData)
|
|
CFG_UNO_THROW_ALL();
|
|
|
|
private :
|
|
/** Get the factory used for service invocation */
|
|
uno::Reference<lang::XMultiServiceFactory> getServiceFactory() const;
|
|
/** UNO context to which this backend belongs */
|
|
uno::Reference<uno::XComponentContext> mContext ;
|
|
/** Backend being accessed */
|
|
uno::Reference<backenduno::XBackend> mBackend ;
|
|
/** Binary cache of default data */
|
|
BinaryCache mBinaryCache;
|
|
/** Manages Nofification from the Backends */
|
|
uno::Reference<backenduno::XBackendChangesListener> mXNotifier;
|
|
|
|
BackendChangeNotifier * mNotifier;
|
|
|
|
} ;
|
|
|
|
} } // configmgr.backend
|
|
|
|
#endif // CONFIGMGR_BACKEND_BACKENDACCESS_HXX_
|