#include </builds/gaudi/Gaudi/GaudiUtils/src/component/VFSSvc.h>

Inheritance diagram for VFSSvc:

[legend]

Collaboration diagram for VFSSvc:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialize Service. More...

StatusCode	finalize () override
	Finalize Service. More...

std::unique_ptr< std::istream >	open (const std::string &url) override

const std::vector< std::string > &	protocols () const override

Public Member Functions inherited from extends< Service, IFileAccess >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service More...

StatusCode	sysStart () override
	Initialize Service More...

StatusCode	sysStop () override
	Initialize Service More...

StatusCode	sysFinalize () override
	Finalize Service More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator More...

StatusCode	setProperties ()

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_urlHandlersNames

Gaudi::Property< std::string >	m_fallBackProtocol

std::vector< std::string >	m_protocols
	Protocols registered. More...

GaudiUtils::HashMap< std::string, std::vector< IFileAccess * > >	m_urlHandlers
	Map of the tools handling the known protocols. More...

SmartIF< IToolSvc >	m_toolSvc
	Handle to the tool service. More...

std::vector< IAlgTool * >	m_acquiredTools
	List of acquired tools (needed to release them). More...

Additional Inherited Members
Public Types inherited from extends< Service, IFileAccess >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override
	Standard Destructor More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}

Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}

Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}

Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}

Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}

Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}

Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}

Gaudi::Property< bool >	m_autoRetrieveTools {this, "AutoRetrieveTools", true, "retrieve all AlgTools during initialize"}

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Simple service that allows to read files independently from the storage. The service uses tools to resolve URLs and serve the files as input streams. The basic implementations read from the filesystem, and simple extensions allow to read from databases, web...

Author: Marco Clemencic

Date: 2008-01-18

Definition at line 36 of file VFSSvc.h.

Member Function Documentation

◆ finalize()

StatusCode VFSSvc::finalize ( )

override

Finalize Service.

Definition at line 61 of file VFSSvc.cpp.

                             {
   m_urlHandlers.clear(); // clear the map
   m_protocols.clear();
  
   if ( m_toolSvc ) {
     // release the acquired tools (from the last acquired one)
     while ( !m_acquiredTools.empty() ) {
       m_toolSvc->releaseTool( m_acquiredTools.back() ).ignore();
       m_acquiredTools.pop_back();
     }
     m_toolSvc.reset(); // release the tool service
   }
   return Service::finalize();
 }

◆ initialize()

StatusCode VFSSvc::initialize ( )

override

Initialize Service.

Definition at line 20 of file VFSSvc.cpp.

                               {
   StatusCode sc = Service::initialize();
   if ( sc.isFailure() ) return sc;
  
   m_toolSvc = serviceLocator()->service( "ToolSvc" );
   if ( !m_toolSvc ) {
     error() << "Cannot locate ToolSvc" << endmsg;
     return StatusCode::FAILURE;
   }
  
   IAlgTool* tool;
   for ( const auto& i : m_urlHandlersNames ) {
     // retrieve the tool and the pointer to the interface
     sc = m_toolSvc->retrieve( i, IAlgTool::interfaceID(), tool, nullptr, true );
     if ( sc.isFailure() ) {
       error() << "Cannot get tool " << i << endmsg;
       return sc;
     }
     m_acquiredTools.push_back( tool ); // this is one tool that we will have to release
     auto hndlr = SmartIF<IFileAccess>( tool );
     if ( !hndlr ) {
       error() << i << " does not implement IFileAccess" << endmsg;
       return StatusCode::FAILURE;
     }
     // We do not need to increase the reference count for the IFileAccess interface
     // because we hold the tool by its IAlgTool interface.
     // loop over the list of supported protocols and add them to the map (for quick access)
     for ( const auto& prot : hndlr->protocols() ) m_urlHandlers[prot].emplace_back( hndlr.get() );
   }
  
   // Now let's check if we can handle the fallback protocol
   if ( m_urlHandlers.find( m_fallBackProtocol ) == m_urlHandlers.end() ) {
     error() << "No handler specified for fallback protocol prefix " << m_fallBackProtocol.value() << endmsg;
     return StatusCode::FAILURE;
   }
  
   // Note: the list of handled protocols will be filled only if requested
  
   return sc;
 }

◆ open()

std::unique_ptr< std::istream > VFSSvc::open ( const std::string & url )

override

See also: IFileAccess::open

Definition at line 76 of file VFSSvc.cpp.

                                                              {
   // get the url prefix endpos
   auto pos = url.find( "://" );
  
   if ( std::string::npos == pos ) {
     // no url prefix, try fallback protocol
     return VFSSvc::open( m_fallBackProtocol + "://" + url );
   }
  
   const std::string url_prefix( url, 0, pos );
   const auto        handlers = m_urlHandlers.find( url_prefix );
   if ( handlers == m_urlHandlers.end() ) {
     // if we do not have a handler for the URL prefix,
     // use the fall back one
     return VFSSvc::open( m_fallBackProtocol + url.substr( pos ) );
   }
  
   std::unique_ptr<std::istream> out; // this might help RVO
   // try the hendlers for the protocol one after the other until one succeds
   for ( auto hndlr : handlers->second ) {
     out = hndlr->open( url );
     if ( out ) break;
   }
   return out;
 }

◆ protocols()

const std::vector< std::string > & VFSSvc::protocols ( ) const

override

See also: IFileAccess::protocols

Definition at line 113 of file VFSSvc.cpp.

                                                     {
   if ( m_protocols.empty() ) {
     // prepare the list of handled protocols
     std::transform( m_urlHandlers.begin(), m_urlHandlers.end(),
                     std::back_inserter( const_cast<VFSSvc*>( this )->m_protocols ), select1st );
   }
   return m_protocols;
 }

Member Data Documentation

◆ m_acquiredTools

std::vector<IAlgTool*> VFSSvc::m_acquiredTools

private

List of acquired tools (needed to release them).

Definition at line 67 of file VFSSvc.h.

◆ m_fallBackProtocol

Gaudi::Property<std::string> VFSSvc::m_fallBackProtocol

private

Initial value:

{this, "FallBackProtocol", "file",

"URL prefix to use if the prefix is not present."}

Definition at line 54 of file VFSSvc.h.

◆ m_protocols

std::vector<std::string> VFSSvc::m_protocols

private

Protocols registered.

Definition at line 58 of file VFSSvc.h.

◆ m_toolSvc

SmartIF<IToolSvc> VFSSvc::m_toolSvc

private

Handle to the tool service.

Definition at line 64 of file VFSSvc.h.

◆ m_urlHandlers

GaudiUtils::HashMap<std::string, std::vector<IFileAccess*> > VFSSvc::m_urlHandlers

private

Map of the tools handling the known protocols.

Definition at line 61 of file VFSSvc.h.

◆ m_urlHandlersNames

Gaudi::Property<std::vector<std::string> > VFSSvc::m_urlHandlersNames

private

Initial value:

{

this, "FileAccessTools", {{"FileReadTool"}}, "List of tools implementing the IFileAccess interface."}

Definition at line 52 of file VFSSvc.h.

The documentation for this class was generated from the following files:

GaudiUtils/src/component/VFSSvc.h
GaudiUtils/src/component/VFSSvc.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ finalize()

◆ initialize()

◆ open()

◆ protocols()

Member Data Documentation

◆ m_acquiredTools

◆ m_fallBackProtocol

◆ m_protocols

◆ m_toolSvc

◆ m_urlHandlers

◆ m_urlHandlersNames