320 lines
14 KiB
C++
320 lines
14 KiB
C++
|
/*************************************************************************
|
||
|
|
*
|
||
|
|
* $RCSfile: servicehandler.cxx,v $
|
||
|
|
*
|
||
|
|
* $Revision: 1.1 $
|
||
|
|
*
|
||
|
|
* last change: $Author: as $ $Date: 2002-05-02 11:36:24 $
|
||
|
|
*
|
||
|
|
* 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): _______________________________________
|
||
|
|
*
|
||
|
|
*
|
||
|
|
************************************************************************/
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// my own includes
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
#ifndef __FRAMEWORK_DISPATCH_SERVICEHANDLER_HXX_
|
||
|
|
#include <dispatch/servicehandler.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
|
||
|
|
#include <threadhelp/readguard.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef __FRAMEWORK_GENERAL_H_
|
||
|
|
#include <general.h>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef __FRAMEWORK_SERVICES_H_
|
||
|
|
#include <services.h>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// interface includes
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
#ifndef _COM_SUN_STAR_FRAME_DISPATCHRESULTSTATE_HPP_
|
||
|
|
#include <com/sun/star/frame/DispatchResultState.hpp>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// includes of other projects
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
#include <vcl/svapp.hxx>
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// namespace
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
namespace framework{
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// non exported const
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// non exported definitions
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// declarations
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// XInterface, XTypeProvider, XServiceInfo
|
||
|
|
|
||
|
|
DEFINE_XINTERFACE_4(ServiceHandler ,
|
||
|
|
OWeakObject ,
|
||
|
|
DIRECT_INTERFACE(css::lang::XTypeProvider ),
|
||
|
|
DIRECT_INTERFACE(css::lang::XServiceInfo ),
|
||
|
|
DIRECT_INTERFACE(css::frame::XNotifyingDispatch),
|
||
|
|
DIRECT_INTERFACE(css::frame::XDispatch ))
|
||
|
|
|
||
|
|
DEFINE_XTYPEPROVIDER_4(ServiceHandler ,
|
||
|
|
css::lang::XTypeProvider ,
|
||
|
|
css::lang::XServiceInfo ,
|
||
|
|
css::frame::XNotifyingDispatch,
|
||
|
|
css::frame::XDispatch )
|
||
|
|
|
||
|
|
DEFINE_XSERVICEINFO_MULTISERVICE(ServiceHandler ,
|
||
|
|
::cppu::OWeakObject ,
|
||
|
|
SERVICENAME_PROTOCOLHANDLER ,
|
||
|
|
IMPLEMENTATIONNAME_SERVICEHANDLER)
|
||
|
|
|
||
|
|
DEFINE_INIT_SERVICE(ServiceHandler,
|
||
|
|
{
|
||
|
|
/*Attention
|
||
|
|
I think we don't need any mutex or lock here ... because we are called by our own static method impl_createInstance()
|
||
|
|
to create a new instance of this class by our own supported service factory.
|
||
|
|
see macro DEFINE_XSERVICEINFO_MULTISERVICE and "impl_initService()" for further informations!
|
||
|
|
*/
|
||
|
|
}
|
||
|
|
)
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short standard ctor
|
||
|
|
@descr These initialize a new instance of ths class with needed informations for work.
|
||
|
|
|
||
|
|
@param xFactory
|
||
|
|
reference to uno servicemanager for creation of new services
|
||
|
|
|
||
|
|
@modified 02.05.2002 08:16, as96863
|
||
|
|
*/
|
||
|
|
ServiceHandler::ServiceHandler( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory )
|
||
|
|
// Init baseclasses first
|
||
|
|
: ThreadHelpBase( &Application::GetSolarMutex() )
|
||
|
|
, OWeakObject ( )
|
||
|
|
// Init member
|
||
|
|
, m_xFactory ( xFactory )
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short standard dtor
|
||
|
|
@descr -
|
||
|
|
|
||
|
|
@modified 02.05.2002 08:16, as96863
|
||
|
|
*/
|
||
|
|
ServiceHandler::~ServiceHandler()
|
||
|
|
{
|
||
|
|
m_xFactory = NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short dispatch URL with arguments
|
||
|
|
@descr We use threadsafe internal method to do so. It returns a state value - but we ignore it.
|
||
|
|
Because we doesn't support status listener notifications here.
|
||
|
|
|
||
|
|
@param aURL
|
||
|
|
uno URL which should be executed
|
||
|
|
@param lArguments
|
||
|
|
list of optional arguments for this request
|
||
|
|
|
||
|
|
@modified 02.05.2002 08:19, as96863
|
||
|
|
*/
|
||
|
|
void SAL_CALL ServiceHandler::dispatch( const css::util::URL& aURL ,
|
||
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException )
|
||
|
|
{
|
||
|
|
// dispatch() is an [oneway] call ... and may our user release his reference to us immediatly.
|
||
|
|
// So we should hold us self alive till this call ends.
|
||
|
|
css::uno::Reference< css::frame::XNotifyingDispatch > xSelfHold(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY);
|
||
|
|
implts_dispatch(aURL,lArguments);
|
||
|
|
// No notification for status listener!
|
||
|
|
}
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short dispatch with guaranteed notifications about success
|
||
|
|
@descr We use threadsafe internal method to do so. Return state of this function will be used
|
||
|
|
for notification if an optional listener is given.
|
||
|
|
|
||
|
|
@param aURL
|
||
|
|
uno URL which should be executed
|
||
|
|
@param lArguments
|
||
|
|
list of optional arguments for this request
|
||
|
|
@param xListener
|
||
|
|
optional listener for state events
|
||
|
|
|
||
|
|
@modified 30.04.2002 14:49, as96863
|
||
|
|
*/
|
||
|
|
void SAL_CALL ServiceHandler::dispatchWithNotification( const css::util::URL& aURL ,
|
||
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
|
||
|
|
const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw( css::uno::RuntimeException )
|
||
|
|
{
|
||
|
|
// This class was designed to die by reference. And if user release his reference to us immediatly after calling this method
|
||
|
|
// we can run into some problems. So we hold us self alive till this method ends.
|
||
|
|
// Another reason: We can use this reference as source of sending event at the end too.
|
||
|
|
css::uno::Reference< css::frame::XNotifyingDispatch > xThis(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY);
|
||
|
|
|
||
|
|
css::uno::Reference< css::uno::XInterface > xService = implts_dispatch(aURL,lArguments);
|
||
|
|
if (xListener.is())
|
||
|
|
{
|
||
|
|
css::frame::DispatchResultEvent aEvent;
|
||
|
|
if (xService.is())
|
||
|
|
aEvent.State = css::frame::DispatchResultState::SUCCESS;
|
||
|
|
else
|
||
|
|
aEvent.State = css::frame::DispatchResultState::FAILURE;
|
||
|
|
aEvent.Result <<= xService; // may NULL for state=FAILED!
|
||
|
|
aEvent.Source = xThis;
|
||
|
|
|
||
|
|
xListener->dispatchFinished( aEvent );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short threadsafe helper for dispatch calls
|
||
|
|
@descr We support two interfaces for the same process - dispatch URLs. That the reason for this internal
|
||
|
|
function. It implements the real dispatch operation and returns a state value which inform caller
|
||
|
|
about success. He can notify listener then by using this return value.
|
||
|
|
|
||
|
|
@param aURL
|
||
|
|
uno URL which should be executed
|
||
|
|
@param lArguments
|
||
|
|
list of optional arguments for this request
|
||
|
|
|
||
|
|
@return <NULL/> if requested service couldn't be created successullfy;
|
||
|
|
a valid reference otherwise. This return value can be used to indicate,
|
||
|
|
if dispatch was successfully or not.
|
||
|
|
|
||
|
|
@modified 02.05.2002 10:51, as96863
|
||
|
|
*/
|
||
|
|
css::uno::Reference< css::uno::XInterface > ServiceHandler::implts_dispatch( const css::util::URL& aURL ,
|
||
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException )
|
||
|
|
{
|
||
|
|
css::uno::Reference< css::uno::XInterface > xService;
|
||
|
|
|
||
|
|
// don't accept other protocols
|
||
|
|
// Normaly we shouldn't be used for other URLs then "service:" ...
|
||
|
|
// but ...
|
||
|
|
if (aURL.Complete.compareToAscii("service:",8)==0)
|
||
|
|
{
|
||
|
|
css::uno::Reference< css::lang::XMultiServiceFactory > xFactory;
|
||
|
|
/* SAFE */{
|
||
|
|
ReadGuard aReadLock( m_aLock );
|
||
|
|
xFactory = m_xFactory;
|
||
|
|
/* SAFE */}
|
||
|
|
|
||
|
|
if (xFactory.is())
|
||
|
|
{
|
||
|
|
// extract service name from given URL and use it to create the component
|
||
|
|
// Arguments are not supported yet.
|
||
|
|
::rtl::OUString sServiceName = aURL.Complete.copy(8);
|
||
|
|
if (sServiceName.getLength()>0)
|
||
|
|
xService = xFactory->createInstance(sServiceName);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return xService;
|
||
|
|
}
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short add/remove listener for state events
|
||
|
|
@descr We use an internal container to hold such registered listener. This container lives if we live.
|
||
|
|
And if call pas registration as non breakable transaction - we can accept the request without
|
||
|
|
any explicit lock. Because we share our mutex with this container.
|
||
|
|
|
||
|
|
@param xListener
|
||
|
|
reference to a valid listener for state events
|
||
|
|
@param aURL
|
||
|
|
URL about listener will be informed, if something occured
|
||
|
|
|
||
|
|
@modified 30.04.2002 14:49, as96863
|
||
|
|
*/
|
||
|
|
void SAL_CALL ServiceHandler::addStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
|
||
|
|
const css::util::URL& aURL ) throw( css::uno::RuntimeException )
|
||
|
|
{
|
||
|
|
// not suported yet
|
||
|
|
}
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
void SAL_CALL ServiceHandler::removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
|
||
|
|
const css::util::URL& aURL ) throw( css::uno::RuntimeException )
|
||
|
|
{
|
||
|
|
// not suported yet
|
||
|
|
}
|
||
|
|
|
||
|
|
} // namespace framework
|