Simple service that allows to read files independently from the storage. More...

#include <src/component/VFSSvc.h>

Inheritance diagram for VFSSvc:

Collaboration diagram for VFSSvc:

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

	VFSSvc (const std::string &name, ISvcLocator *svcloc)
	Standard constructor. More...

	~VFSSvc () override=default
	Destructor. More...

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...

	~extends () override=default
	Virtual destructor. 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...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

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

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

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

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

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

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

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

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

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

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

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Attributes
std::vector< std::string >	m_urlHandlersNames = { { "FileReadTool" } }
	Names of the handlers to use. More...

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

std::string	m_fallBackProtocol
	Protocol to use in case there is not a specific tool to handle the URL. More...

GaudiUtils::HashMap< std::string, 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
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

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
	~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 > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

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

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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 26 of file VFSSvc.h.

Constructor & Destructor Documentation

VFSSvc::VFSSvc	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Standard constructor.

Definition at line 10 of file VFSSvc.cpp.

                                                      :
   base_class(name,svc)
 {
   declareProperty("FileAccessTools",m_urlHandlersNames,
                   "List of tools implementing the IFileAccess interface.");
 
   declareProperty("FallBackProtocol",m_fallBackProtocol = "file",
                   "URL prefix to use if the prefix is not present.");
 }

VFSSvc::~VFSSvc ( )

overridedefault

Destructor.

Member Function Documentation

StatusCode VFSSvc::finalize ( )

override

Finalize Service.

Definition at line 63 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();
 }

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] = 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 << endmsg;
     return StatusCode::FAILURE;
   }
 
   // Note: the list of handled protocols will be filled only if requested
 
   return sc;
 }

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

override

See also: IFileAccess::open

Definition at line 78 of file VFSSvc.cpp.

                                                           {
 
   // get the url prefix endpos
   auto pos = url.find("://");
 
   if (std::string::npos == pos) { // no url prefix
     return m_urlHandlers[m_fallBackProtocol]->open(url);
   }
 
   std::string url_prefix(url,0,pos);
   if ( m_urlHandlers.find(url_prefix) == m_urlHandlers.end() ) {
     // if we do not have a handler for the URL prefix,
     // use the fall back one and pass only the path
     return m_urlHandlers[m_fallBackProtocol]->open(url.substr(pos+3));
   }
   return m_urlHandlers[url_prefix]->open(url);
 }

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

override

See also: IFileAccess::protocols

Definition at line 106 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

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

private

List of acquired tools (needed to release them).

Definition at line 63 of file VFSSvc.h.

std::string VFSSvc::m_fallBackProtocol

private

Protocol to use in case there is not a specific tool to handle the URL.

Definition at line 54 of file VFSSvc.h.

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

private

Protocols registered.

Definition at line 51 of file VFSSvc.h.

SmartIF<IToolSvc> VFSSvc::m_toolSvc

private

Handle to the tool service.

Definition at line 60 of file VFSSvc.h.

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

private

Map of the tools handling the known protocols.

Definition at line 57 of file VFSSvc.h.

std::vector<std::string> VFSSvc::m_urlHandlersNames = { { "FileReadTool" } }

private

Names of the handlers to use.

Definition at line 48 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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation