/************************************************************************* * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: contenthandlerfactory.hxx,v $ * * $Revision: 1.3 $ * * last change: $Author: rt $ $Date: 2005-09-09 00:28:49 $ * * 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 __FRAMEWORK_SERVICES_CONTENTHANDLERFACTORY_HXX_ #define __FRAMEWORK_SERVICES_CONTENTHANDLERFACTORY_HXX_ //_________________________________________________________________________________________________________________ // my own includes //_________________________________________________________________________________________________________________ #ifndef __FRAMEWORK_CLASSES_FILTERCACHE_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_GENERIC_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_DEBUG_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_ #include #endif #ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_ #include #endif #ifndef __FRAMEWORK_THREADHELP_TRANSACTIONBASE_HXX_ #include #endif #ifndef __FRAMEWORK_GENERAL_H_ #include #endif //_________________________________________________________________________________________________________________ // interface includes //_________________________________________________________________________________________________________________ #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_ #include #endif #ifndef _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_ #include #endif #ifndef _COM_SUN_STAR_LANG_WRAPPEDTARGETEXCEPTION_HPP_ #include #endif #ifndef _COM_SUN_STAR_LANG_ILLEGALARGUMENTEXCEPTION_HPP_ #include #endif #ifndef _COM_SUN_STAR_CONTAINER_ELEMENTEXISTEXCEPTION_HPP_ #include #endif #ifndef _COM_SUN_STAR_CONTAINER_NOSUCHELEMENTEXCEPTION_HPP_ #include #endif #ifndef _COM_SUN_STAR_CONTAINER_XNAMECONTAINER_HPP_ #include #endif #ifndef _COM_SUN_STAR_CONTAINER_NOSUCHELEMENTEXCEPTION_HPP_ #include #endif #ifndef _COM_SUN_STAR_IO_XINPUTSTREAM_HPP_ #include #endif #ifndef _COM_SUN_STAR_UTIL_XFLUSHABLE_HPP_ #include #endif //_________________________________________________________________________________________________________________ // other includes //_________________________________________________________________________________________________________________ #ifndef _CPPUHELPER_INTERFACECONTAINER_HXX_ #include #endif #ifndef _CPPUHELPER_WEAK_HXX_ #include #endif //_________________________________________________________________________________________________________________ // namespace //_________________________________________________________________________________________________________________ namespace framework{ //_________________________________________________________________________________________________________________ // exported const //_________________________________________________________________________________________________________________ //_________________________________________________________________________________________________________________ // exported definitions //_________________________________________________________________________________________________________________ /*-************************************************************************************************************//** @short factory to create handler-objects @descr These class can be used to create new handler for specified contents. We use cached values of our configuration to lay down, which handler match a given URL or handlername. (use service TypeDetection to do that) With a detected type name you can search a registered handler and create it with these factory. @implements XInterface XTypeProvider XServiceInfo XMultiServiceFactory XNameContainer XNameReplace XNameAccess XElementAccess XFlushable @base ThreadHelpBase OWeakObject @devstatus ready to use @threadsafe yes *//*-*************************************************************************************************************/ class ContentHandlerFactory : // interfaces public css::lang::XTypeProvider , public css::lang::XServiceInfo , public css::lang::XMultiServiceFactory , public css::container::XNameContainer , // => XNameReplace => XNameAccess => XElementAccess public css::util::XFlushable , // base classes // Order is neccessary for right initialization of it! private ThreadHelpBase , private TransactionBase , public ::cppu::OWeakObject { //------------------------------------------------------------------------------------------------------------- // public methods //------------------------------------------------------------------------------------------------------------- public: //--------------------------------------------------------------------------------------------------------- // constructor / destructor //--------------------------------------------------------------------------------------------------------- ContentHandlerFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ); virtual ~ContentHandlerFactory( ); //--------------------------------------------------------------------------------------------------------- // XInterface, XTypeProvider, XServiceInfo //--------------------------------------------------------------------------------------------------------- DECLARE_XINTERFACE DECLARE_XTYPEPROVIDER DECLARE_XSERVICEINFO //--------------------------------------------------------------------------------------------------------- // XMultiServiceFactory //--------------------------------------------------------------------------------------------------------- virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance ( const ::rtl::OUString& sTypeName ) throw( css::uno::Exception , css::uno::RuntimeException ); virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstanceWithArguments( const ::rtl::OUString& sTypeName , const css::uno::Sequence< css::uno::Any >& lArguments ) throw( css::uno::Exception, css::uno::RuntimeException ); virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getAvailableServiceNames ( ) throw( css::uno::RuntimeException ); //--------------------------------------------------------------------------------------------------------- // XNameContainer //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL insertByName( const ::rtl::OUString& sHandlerName , const css::uno::Any& aHandlerProperties ) throw( css::lang::IllegalArgumentException , css::container::ElementExistException , css::lang::WrappedTargetException , css::uno::RuntimeException ); virtual void SAL_CALL removeByName( const ::rtl::OUString& sHandlerName ) throw( css::container::NoSuchElementException , css::lang::WrappedTargetException , css::uno::RuntimeException ); //--------------------------------------------------------------------------------------------------------- // XNameReplace //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL replaceByName( const ::rtl::OUString& sHandlerName , const css::uno::Any& aHandlerProperties ) throw( css::lang::IllegalArgumentException , css::container::NoSuchElementException , css::lang::WrappedTargetException , css::uno::RuntimeException ); //--------------------------------------------------------------------------------------------------------- // XNameAccess //--------------------------------------------------------------------------------------------------------- virtual css::uno::Any SAL_CALL getByName ( const ::rtl::OUString& sName ) throw( css::container::NoSuchElementException , css::lang::WrappedTargetException , css::uno::RuntimeException ); virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames( ) throw( css::uno::RuntimeException ); virtual sal_Bool SAL_CALL hasByName ( const ::rtl::OUString& sName ) throw( css::uno::RuntimeException ); //--------------------------------------------------------------------------------------------------------- // XElementAccess //--------------------------------------------------------------------------------------------------------- virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException ); virtual sal_Bool SAL_CALL hasElements () throw( css::uno::RuntimeException ); //--------------------------------------------------------------------------------------------------------- // XFlushable //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL flush ( ) throw ( css::uno::RuntimeException ); virtual void SAL_CALL addFlushListener ( const css::uno::Reference< css::util::XFlushListener >& xListener ) throw ( css::uno::RuntimeException ); virtual void SAL_CALL removeFlushListener( const css::uno::Reference< css::util::XFlushListener >& xListener ) throw ( css::uno::RuntimeException ); //------------------------------------------------------------------------------------------------------------- // protected methods //------------------------------------------------------------------------------------------------------------- protected: //------------------------------------------------------------------------------------------------------------- // debug methods // (should be private everyway!) //------------------------------------------------------------------------------------------------------------- /*-****************************************************************************************************//** @short debug-method to check incoming parameter of some other mehods of this class @descr The following methods are used to check parameters for other methods of this class. The return value is used directly for an ASSERT(...). @seealso ASSERTs in implementation! @param references to checking variables @return sal_False ,on invalid parameter @return sal_True ,otherwise @onerror - *//*-*****************************************************************************************************/ #ifdef ENABLE_ASSERTIONS private: static sal_Bool implcp_ContentHandlerFactory ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ); static sal_Bool implcp_createInstanceWithArguments ( const ::rtl::OUString& sTypeName , const css::uno::Sequence< css::uno::Any >& lArguments ); static sal_Bool implcp_getByName ( const ::rtl::OUString& sName ); static sal_Bool implcp_hasByName ( const ::rtl::OUString& sName ); static sal_Bool implcp_removeByName ( const ::rtl::OUString& sHandlerName ); #endif // #ifdef ENABLE_ASSERTIONS //------------------------------------------------------------------------------------------------------------- // private variables // (should be private everyway!) //------------------------------------------------------------------------------------------------------------- private: css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ; FilterCache m_aCache ; // ::cppu::OMultiTypeInterfaceContainerHelper m_aListenerContainer ; }; // class ContentHandlerFactory } // namespace framework #endif // #ifndef __FRAMEWORK_SERVICES_CONTENTHANDLERFACTORY_HXX_