office-gobmx/configmgr/source/api2/provider.hxx
2003-03-19 15:20:19 +00:00

194 lines
7.8 KiB
C++

/*************************************************************************
*
* $RCSfile: provider.hxx,v $
*
* $Revision: 1.4 $
*
* last change: $Author: hr $ $Date: 2003-03-19 16:18:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_API_PROVIDER_HXX_
#define CONFIGMGR_API_PROVIDER_HXX_
#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#endif
#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEXT_HPP_
#include <com/sun/star/uno/XComponentContext.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_ILLEGALARGUMENTEXCEPTION_HDL_
#include <com/sun/star/lang/IllegalArgumentException.hdl>
#endif
#ifndef CONFIGMGR_API_SVCCOMPONENT_HXX_
#include "confsvccomponent.hxx"
#endif
#ifndef _RTL_USTRING_HXX_
#include <rtl/ustring.hxx>
#endif
#ifndef _VOS_REF_HXX_
#include <vos/ref.hxx>
#endif
#ifndef _CPPUHELPER_IMPLBASE1_HXX_
#include <cppuhelper/implbase1.hxx>
#endif
#ifndef _COMPHELPER_PROPERTYCONTAINER_HXX_
#include <comphelper/propertycontainer.hxx>
#endif
namespace configmgr
{
namespace css = ::com::sun::star;
namespace uno = css::uno;
namespace lang = css::lang;
using ::rtl::OUString;
using ::vos::ORef;
class Module;
class ContextReader;
class OProviderImpl;
typedef ::cppu::ImplHelper1 < lang::XMultiServiceFactory
// ,lang::XUnoTunnel
> OProvider_Base;
//==========================================================================
//= OProvider
//==========================================================================
/** Base class to receive access to the configuration data. A provider for configuration is
a factory for service which allow a readonly or update access to the configuration trees.
*/
class OProvider : protected ServiceComponentImpl
, protected ::comphelper::OPropertyContainer
// don't want to allow our derivees to access the mutex of ServiceComponentImpl
// (this helps to prevent deadlocks: The mutex of the base class is used by the OComponentHelper to
// protect addEvenetListener calls. Unfortunately these calls are made from within API object we create,
// too, which can lead do deadlocks ....)
, public OProvider_Base
{
// friend class OProviderFactory;
friend class OProviderDisposingListener;
protected:
uno::Reference< uno::XComponentContext > m_xContext;
uno::Reference< lang::XEventListener > m_xDisposeListener;
public:
// make ServiceComponentImpl allocation functions public
static void * SAL_CALL operator new( size_t nSize ) throw()
{ return ServiceComponentImpl::operator new( nSize ); }
static void SAL_CALL operator delete( void * pMem ) throw()
{ ServiceComponentImpl::operator delete( pMem ); }
typedef uno::Reference< uno::XComponentContext > CreationContext;
OProvider(CreationContext const & xContext, ServiceImplementationInfo const* pInfo);
virtual ~OProvider();
/// XTypeOProvider
virtual uno::Sequence< uno::Type > SAL_CALL getTypes( ) throw(uno::RuntimeException);
/// XInterface
virtual void SAL_CALL acquire() throw() { ServiceComponentImpl::acquire(); }
virtual void SAL_CALL release() throw() { ServiceComponentImpl::release(); }
virtual uno::Any SAL_CALL queryInterface(uno::Type const& rType) throw (uno::RuntimeException);
// XPropertySet
virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo( ) throw(::com::sun::star::uno::RuntimeException);
// OPropertSetHelper
virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
sal_Int32 nHandle,
const ::com::sun::star::uno::Any& rValue
)
throw (::com::sun::star::uno::Exception)
{
OPropertyContainer::setFastPropertyValue_NoBroadcast(nHandle, rValue);
}
static sal_Int32 countServices(ServiceRegistrationInfo const* aInfo) { return ServiceRegistrationHelper(aInfo).countServices(); }
protected:
// creates a new session
void implConnect(OProviderImpl& rFreshProviderImpl, const ContextReader& _rSettings) throw (uno::Exception);
protected:
/// Component Helper override
virtual void SAL_CALL disposing();
virtual void SAL_CALL disposing(com::sun::star::lang::EventObject const& rEvt) throw();
// OPropertyContainer
void registerProperty(const ::rtl::OUString& _rName, sal_Int32 _nHandle, sal_Int32 _nAttributes,
void* _pPointerToMember, const ::com::sun::star::uno::Type& _rMemberType)
{ OPropertyContainer::registerProperty(_rName, _nHandle, _nAttributes, _pPointerToMember, _rMemberType);}
void describeProperties(::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rProps) const
{ OPropertyContainer::describeProperties(_rProps);}
uno::Any SAL_CALL queryPropertyInterface(uno::Type const& rType) throw (uno::RuntimeException)
{ return OPropertyContainer::queryInterface(rType);}
private:
void attachToContext();
uno::Reference< lang::XComponent > releaseContext();
void discardContext(uno::Reference< lang::XComponent > const & xContext);
};
} // namespace configmgr
#endif // CONFIGMGR_API_PROVIDER_HXX_