| # Gaudi Framework, version v21r9 |

Home |  | Generated: 3 May 2010

# VFSSvc Class Reference

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

`#include <VFSSvc.h>`

Inheritance diagram for VFSSvc:

[legend]
Collaboration diagram for VFSSvc:

[legend]

List of all members.

## Public Member Functions
virtual StatusCode | initialize ()
| Initialize Service.
virtual StatusCode | finalize ()
| Finalize Service.
virtual std::auto_ptr < std::istream > | open (const std::string &url)
virtual const std::vector < std::string > & | protocols () const
## Protected Member Functions
| VFSSvc (const std::string &name, ISvcLocator *svcloc)
| Standard constructor.
virtual | ~VFSSvc ()
| Destructor.
## Private Attributes
std::vector< std::string > | m_urlHandlersNames
| Names of the handlers to use.
std::vector< std::string > | m_protocols
| Protocols registered.
std::string | m_fallBackProtocol
| Protocol to use in case there is not a specific tool to handle the URL.
GaudiUtils::HashMap < std::string, IFileAccess * > | m_urlHandlers
| Map of the tools handling the known protocols.
SmartIF< IToolSvc > | m_toolSvc
| Handle to the tool service.
std::list< IAlgTool * > | m_acquiredTools
| List of acquired tools (needed to release them).
## Friends
class | SvcFactory< VFSSvc >

## 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 28 of file VFSSvc.h.

## Constructor & Destructor Documentation

VFSSvc::VFSSvc | ( | const std::string & | name,
|  | ISvcLocator * | svcloc |
| ) |  |  | `[protected]`

Standard constructor.

Definition at line 11 of file VFSSvc.cpp.

    00011                                                      :
    00012   base_class(name,svc) {
    00013
    00014   m_urlHandlersNames.push_back("FileReadTool");
    00015
    00016   declareProperty("FileAccessTools",m_urlHandlersNames,
    00017                   "List of tools implementing the IFileAccess interface.");
    00018
    00019   declareProperty("FallBackProtocol",m_fallBackProtocol = "file",
    00020                   "URL prefix to use if the prefix is not present.");
    00021 }
    //------------------------------------------------------------------------------

VFSSvc::~VFSSvc | ( |  | ) | `[protected, virtual]`

Destructor.

Definition at line 23 of file VFSSvc.cpp.

    00023 {}

## Member Function Documentation

StatusCode VFSSvc::initialize | ( |  | ) | `[virtual]`

Initialize Service.

Reimplemented from Service.

Definition at line 25 of file VFSSvc.cpp.

    00025                               {
    00026   StatusCode sc = Service::initialize();
    00027   if (sc.isFailure()){
    00028     return sc;
    00029   }
    00030
    00031   MsgStream log(msgSvc(), name());
    00032
    00033   m_toolSvc = serviceLocator()->service("ToolSvc");
    00034   if (!m_toolSvc.isValid()){
    00035     log << MSG::ERROR << "Cannot locate ToolSvc" << endmsg;
    00036     return StatusCode::FAILURE;
    00037   }
    00038
    00039   IAlgTool *tool;
    00040   IFileAccess *hndlr;
    00041   std::vector<std::string>::iterator i;
    00042   for(i = m_urlHandlersNames.begin(); i != m_urlHandlersNames.end(); ++i){
    00043     // retrieve the tool and the pointer to the interface
    00044     sc = m_toolSvc->retrieve(*i,IAlgTool::interfaceID(),tool,0,true);
    00045     if (sc.isFailure()){
    00046       log << MSG::ERROR << "Cannot get tool " << *i << endmsg;
    00047       return sc;
    00048     }
    00049     m_acquiredTools.push_front(tool); // this is one tool that we will have to release
    00050     sc = tool->queryInterface(IFileAccess::interfaceID(),pp_cast<void>(&hndlr));
    00051     if (sc.isFailure()){
    00052       log << MSG::ERROR << *i << " does not implement IFileAccess" << endmsg;
    00053       return sc;
    00054     }
    00055     // We do not need to increase the reference count for the IFileAccess interface
    00056     // because we hold the tool by its IAlgTool interface.
    00057     hndlr->release();
    00058     // loop over the list of supported protocols and add them to the map (for quick access)
    00059     for ( std::vector<std::string>::const_iterator prot = hndlr->protocols().begin();
    00060           prot != hndlr->protocols().end(); ++prot ){
    00061       m_urlHandlers[*prot] = hndlr;
    00062     }
    00063   }
    00064
    00065   // Now let's check if we can handle the fallback protocol
    00066   if ( m_urlHandlers.find(m_fallBackProtocol) == m_urlHandlers.end() ) {
    00067     log << MSG::ERROR << "No handler specified for fallback protocol prefix "
    00068         << m_fallBackProtocol << endmsg;
    00069     return StatusCode::FAILURE;
    00070   }
    00071
    00072   // Note: the list of handled protocols will be filled only if requested
    00073
    00074   return sc;
    00075 }

StatusCode VFSSvc::finalize | ( | void |  | ) | `[virtual]`

Finalize Service.

Reimplemented from Service.

Definition at line 77 of file VFSSvc.cpp.

    00077                             {
    00078   m_urlHandlers.clear(); // clear the map
    00079   m_protocols.clear();
    00080
    00081   if (m_toolSvc) {
    00082     // release the acquired tools (from the last acquired one)
    00083     while ( m_acquiredTools.begin() != m_acquiredTools.end() ){
    00084       m_toolSvc->releaseTool(*m_acquiredTools.begin()).ignore();
    00085       m_acquiredTools.pop_front();
    00086     }
    00087     m_toolSvc->release(); // release the tool service
    00088     m_toolSvc = 0;
    00089   }
    00090   return Service::finalize();
    00091 }

std::auto_ptr< std::istream > VFSSvc::open | ( | const std::string & | url | ) | `[virtual]`

See also:
  IFileAccess::open

Implements IFileAccess.

Definition at line 93 of file VFSSvc.cpp.

    00093                                                         {
    00094
    00095   // get the url prefix endpos
    00096   std::string::size_type pos = url.find("://");
    00097
    00098   if (std::string::npos == pos) { // no url prefix
    00099     return m_urlHandlers[m_fallBackProtocol]->open(url);
    00100   }
    00101
    00102   std::string url_prefix(url,0,pos);
    00103   if ( m_urlHandlers.find(url_prefix) == m_urlHandlers.end() ) {
    00104     // if we do not have a handler for the URL prefix,
    00105     // use the fall back one and pass only the path
    00106     return m_urlHandlers[m_fallBackProtocol]->open(url.substr(pos+3));
    00107   }
    00108   return m_urlHandlers[url_prefix]->open(url);
    00109 }

const std::vector< std::string > & VFSSvc::protocols | ( |  | ) | const`[virtual]`

See also:
  IFileAccess::protocols

Implements IFileAccess.

Definition at line 128 of file VFSSvc.cpp.

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

## Friends And Related Function Documentation

friend class SvcFactory< VFSSvc >`[friend]`

Definition at line 50 of file VFSSvc.h.

## Member Data Documentation

std::vector<std::string> VFSSvc::m_urlHandlersNames`[private]`

Names of the handlers to use.

Definition at line 53 of file VFSSvc.h.

std::vector<std::string> VFSSvc::m_protocols`[private]`

Protocols registered.

Definition at line 56 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 59 of file VFSSvc.h.

GaudiUtils::HashMap<std::string,IFileAccess*> VFSSvc::m_urlHandlers`[private]`

Map of the tools handling the known protocols.

Definition at line 62 of file VFSSvc.h.

SmartIF<IToolSvc> VFSSvc::m_toolSvc`[private]`

Handle to the tool service.

Definition at line 65 of file VFSSvc.h.

std::list<IAlgTool*> VFSSvc::m_acquiredTools`[private]`

List of acquired tools (needed to release them).

Definition at line 68 of file VFSSvc.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v21r9/GaudiSvc/src/VFSSvc/VFSSvc.h
- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v21r9/GaudiSvc/src/VFSSvc/VFSSvc.cpp