VFSSvc Class Reference

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
virtual StatusCode	initialize ()
	Initialize Service. More...
virtual StatusCode	finalize ()
	Finalize Service. More...
virtual std::auto_ptr < std::istream >	open (const std::string &url)
virtual const std::vector < std::string > &	protocols () const
	VFSSvc (const std::string &name, ISvcLocator *svcloc)
	Standard constructor. More...
virtual	~VFSSvc ()
	Destructor. More...
Public Member Functions inherited from extends1< Service, IFileAccess >
	extends1 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...
	extends1 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...
	extends1 (A1 a1)
	Templated constructor with 1 argument. More...
	extends1 ()
	Default constructor. More...
virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...
virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...
virtual	~extends1 ()
	Virtual destructor. More...
Public Member Functions inherited from Service
virtual unsigned long	release ()
	Release Interface instance. More...
virtual const std::string &	name () const
	Retrieve name of the service. More...
virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...
virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...
virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...
virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...
virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...
virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...
virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
virtual StatusCode	sysInitialize ()
	Initialize Service. More...
virtual StatusCode	sysStart ()
	Initialize Service. More...
virtual StatusCode	sysStop ()
	Initialize Service. More...
virtual StatusCode	sysFinalize ()
	Finalize Service. More...
virtual StatusCode	sysReinitialize ()
	Re-initialize the Service. More...
virtual StatusCode	sysRestart ()
	Re-initialize the Service. More...
virtual StatusCode	setProperty (const Property &p)
	Set the property by property. More...
virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...
virtual StatusCode	getProperty (Property *p) const
	Get the property by property. More...
virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...
virtual const std::vector < Property * > &	getProperties () const
	Get list of properties. More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
	Service (const std::string &name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const
	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<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...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
	CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
	Templated constructor with 3 arguments. More...
	CommonMessaging (const A1 &a1, const A2 &a2)
	Templated constructor with 2 arguments. More...
	CommonMessaging (const A1 &a1)
	Templated constructor with 1 argument. More...
	CommonMessaging ()
	Default constructor. More...
virtual	~CommonMessaging ()
	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...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces3< IService, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...
Public Member Functions inherited from IService
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID. More...
virtual	~IService ()
	virtual destructor More...
Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...
virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...
Public Member Functions inherited from IInterface
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual	~IInterface ()
	Virtual destructor. More...
Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...
Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...
virtual	~IStateful ()
Public Member Functions inherited from extend_interfaces1< IFileAccess >
virtual	~extend_interfaces1 ()
	Virtual destructor. More...
Public Member Functions inherited from IFileAccess
	DeclareInterfaceID (IFileAccess, 2, 0)
	InterfaceID. More...
virtual	~IFileAccess ()

Private Attributes
std::vector< std::string >	m_urlHandlersNames
	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::list< IAlgTool * >	m_acquiredTools
	List of acquired tools (needed to release them). More...

Additional Inherited Members
Public Types inherited from extends1< Service, IFileAccess >
typedef extends1	base_class
	Typedef to this class. More...
typedef extend_interfaces1 < IFileAccess >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
Public Types inherited from Service
typedef Gaudi::PluginService::Factory < IService *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
typedef CommonMessaging	base_class
Public Types inherited from implements3< IService, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...
typedef extend_interfaces3 < IService, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
Public Types inherited from extend_interfaces3< IService, IProperty, IStateful >
typedef mpl::fold< typename IService::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...
Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...
typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...
Public Types inherited from extend_interfaces1< IFileAccess >
typedef IFileAccess::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...
Protected Member Functions inherited from Service
virtual	~Service ()
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...
Protected Attributes inherited from Service
IntegerProperty	m_outputLevel
	Service output level. More...
Gaudi::StateMachine::State	m_state
	Service state. More...
Gaudi::StateMachine::State	m_targetState
	Service state. More...
Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...
std::auto_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...
bool	m_streamWithService
	Flag to create a new MsgStream if it was created without the message 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 27 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) {

  m_urlHandlersNames.push_back("FileReadTool");

  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 ( )

virtual

Destructor.

Definition at line 22 of file VFSSvc.cpp.

{}

Member Function Documentation

StatusCode VFSSvc::finalize ( )

virtual

Finalize Service.

Reimplemented from Service.

Definition at line 76 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.begin() != m_acquiredTools.end() ){
      m_toolSvc->releaseTool(*m_acquiredTools.begin()).ignore();
      m_acquiredTools.pop_front();
    }
    m_toolSvc->release(); // release the tool service
    m_toolSvc = 0;
  }
  return Service::finalize();
}

StatusCode VFSSvc::initialize ( )

virtual

Initialize Service.

Reimplemented from Service.

Definition at line 24 of file VFSSvc.cpp.

                              {
  StatusCode sc = Service::initialize();
  if (sc.isFailure()){
    return sc;
  }

  MsgStream log(msgSvc(), name());

  m_toolSvc = serviceLocator()->service("ToolSvc");
  if (!m_toolSvc.isValid()){
    log << MSG::ERROR << "Cannot locate ToolSvc" << endmsg;
    return StatusCode::FAILURE;
  }

  IAlgTool *tool;
  IFileAccess *hndlr;
  std::vector<std::string>::iterator i;
  for(i = m_urlHandlersNames.begin(); i != m_urlHandlersNames.end(); ++i){
    // retrieve the tool and the pointer to the interface
    sc = m_toolSvc->retrieve(*i,IAlgTool::interfaceID(),tool,0,true);
    if (sc.isFailure()){
      log << MSG::ERROR << "Cannot get tool " << *i << endmsg;
      return sc;
    }
    m_acquiredTools.push_front(tool); // this is one tool that we will have to release
    sc = tool->queryInterface(IFileAccess::interfaceID(),pp_cast<void>(&hndlr));
    if (sc.isFailure()){
      log << MSG::ERROR << *i << " does not implement IFileAccess" << endmsg;
      return sc;
    }
    // We do not need to increase the reference count for the IFileAccess interface
    // because we hold the tool by its IAlgTool interface.
    hndlr->release();
    // loop over the list of supported protocols and add them to the map (for quick access)
    for ( std::vector<std::string>::const_iterator prot = hndlr->protocols().begin();
          prot != hndlr->protocols().end(); ++prot ){
      m_urlHandlers[*prot] = hndlr;
    }
  }

  // Now let's check if we can handle the fallback protocol
  if ( m_urlHandlers.find(m_fallBackProtocol) == m_urlHandlers.end() ) {
    log << MSG::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::auto_ptr< std::istream > VFSSvc::open ( const std::string &  url )

virtual

See also

IFileAccess::open

Implements IFileAccess.

Definition at line 92 of file VFSSvc.cpp.

                                                        {

  // get the url prefix endpos
  std::string::size_type 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

virtual

See also

IFileAccess::protocols

Implements IFileAccess.

Definition at line 127 of file VFSSvc.cpp.

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

Member Data Documentation

std::list<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

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