ossim::StreamFactoryRegistry Class Reference

This is a generic stream registry. More...

#include <ossimStreamFactoryRegistry.h>

Inheritance diagram for ossim::StreamFactoryRegistry:

Classes
class	BufferInfo
	This is an internal class used to store the buffer information loaded from the preferences. More...

Public Member Functions
virtual	~StreamFactoryRegistry ()
void	registerFactory (StreamFactoryBase *factory)
	Registers a stream factory. More...
void	unregisterFactory (StreamFactoryBase *factory)
	Removes a factory from the registry. More...
virtual std::shared_ptr< ossim::istream >	createIstream (const std::string &connectionString, const ossimKeywordlist &options=ossimKeywordlist(), std::ios_base::openmode mode=std::ios_base::in|std::ios_base::binary) const
	Will try to creates an istream interface to the connectionString passed in. More...
virtual std::shared_ptr< ossim::ostream >	createOstream (const std::string &connectionString, const ossimKeywordlist &options=ossimKeywordlist(), std::ios_base::openmode mode=std::ios_base::out|std::ios_base::binary) const
	Will try to creates an ostream interface to the connectionString passed in. More...
virtual std::shared_ptr< ossim::iostream >	createIOstream (const std::string &connectionString, const ossimKeywordlist &options=ossimKeywordlist(), std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out|std::ios_base::binary) const
	Will try to creates an iostream interface to the connectionString passed in. More...
bool	exists (const std::string &connectionString) const
	Methods to test if connection exists. More...
virtual bool	exists (const std::string &connectionString, bool &continueFlag) const
	Methods to test if connection exists. More...
void	loadPreferences ()
	This will load the buffer information from the preferences. More...
Public Member Functions inherited from ossim::StreamFactoryBase
virtual	~StreamFactoryBase ()

Static Public Member Functions
static StreamFactoryRegistry *	instance ()

Protected Member Functions
	StreamFactoryRegistry ()

Private Member Functions
	StreamFactoryRegistry (const StreamFactoryRegistry &)
	copy constructor hidden from use More...
bool	getBufferInfo (BufferInfo &bufferInfo, const ossimString &connectionString) const

Private Attributes
std::vector< StreamFactoryBase * >	m_factoryList
std::vector< BufferInfo >	m_bufferInfoList
ossimRegExp	m_patternMatcher
std::mutex	m_mutex

Static Private Attributes
static StreamFactoryRegistry *	m_instance = 0

Detailed Description

This is a generic stream registry.

We could try to create streams for http, https, s3 protocols as well as local file. We have also exposed an exists for supporting exists() calls for different stream types.

We have added support for Buffered reads. You can enable buffered reads to be block boundary. If it's not block then it will use a pubsetbuf for a buffered I/O It will read the

See also

ossimPreferences for the prefix key ossim.stream.factory.registry.istream.buffer[0-9]+ Example key list:

ossim.stream.factory.registry.istream.buffer1.enabled: false
ossim.stream.factory.registry.istream.buffer1.includePattern: ^/
ossim.stream.factory.registry.istream.buffer1.enableBlocked: true
ossim.stream.factory.registry.istream.buffer1.size: 65536

The includePattern keyword is a regular expression. Examples:

• ^/ Anything that starts with /
• ^s3:// Anything starting with s3://

Local file example:

ossimString connectionString = "/data/foo.ntf"
std::shared_ptr<ossim::istream> in = ossim::StreamFactoryRegistry::instance()->createIstream(connectionString);
if(in)
{
  std::vector<char> buf(1024)
  in->seekg(0);
  in->read(&buf.front(), buf.size());
}

S3 file example:

ossimString connectionString = "s3://foo-bucket/path/foo.ntf"
std::shared_ptr<ossim::istream> in = ossim::StreamFactoryRegistry::instance()->createIstream(connectionString);
if(in)
{
  std::vector<char> buf(1024)
  in->seekg(0);
  in->read(&buf.front(), buf.size());
}

https or https file example:

ossimString connectionString = "https://foo-host/path/foo.ntf"
std::shared_ptr<ossim::istream> in = ossim::StreamFactoryRegistry::instance()->createIstream(connectionString);
if(in)
{
  std::vector<char> buf(1024)
  in->seekg(0);
  in->read(&buf.front(), buf.size());
}

Definition at line 84 of file ossimStreamFactoryRegistry.h.

Constructor & Destructor Documentation

~StreamFactoryRegistry()

ossim::StreamFactoryRegistry::~StreamFactoryRegistry ( )

virtual

Definition at line 31 of file ossimStreamFactoryRegistry.cpp.

{
}

StreamFactoryRegistry() [1/2]

ossim::StreamFactoryRegistry::StreamFactoryRegistry ( )

protected

Definition at line 26 of file ossimStreamFactoryRegistry.cpp.

{
}

StreamFactoryRegistry() [2/2]

ossim::StreamFactoryRegistry::StreamFactoryRegistry ( const StreamFactoryRegistry &  )

private

copy constructor hidden from use

Member Function Documentation

createIOstream()

std::shared_ptr< ossim::iostream > ossim::StreamFactoryRegistry::createIOstream ( const std::string &  connectionString, const ossimKeywordlist &  options = ossimKeywordlist(), std::ios_base::openmode  mode = std::ios_base::in|std::ios_base::out|std::ios_base::binary  ) const

virtual

Will try to creates an iostream interface to the connectionString passed in.

Parameters

connectionString	Is the connection string used to create the stream
options	If a stream is found then this holds specific options for the stream. Defaults to empty options
mode	Is the mode to be used. Defaults to a binary output stream.

Returns

A shared pointer to an ostream if successful.

Implements ossim::StreamFactoryBase.

Definition at line 200 of file ossimStreamFactoryRegistry.cpp.

{
   std::shared_ptr<ossim::iostream> result(0);
   return result;
}

createIstream()

std::shared_ptr< ossim::istream > ossim::StreamFactoryRegistry::createIstream ( const std::string &  connectionString, const ossimKeywordlist &  options = ossimKeywordlist(), std::ios_base::openmode  mode = std::ios_base::in|std::ios_base::binary  ) const

virtual

Will try to creates an istream interface to the connectionString passed in.

Parameters

connectionString	Is the connection string used to create a stream. Possible examples: s3://<bucket>/path or /data/foo.tif or https://<host>/<path>
options	If a stream is found then this holds specific options for the stream. Defaults to empty options
mode	Is the mode to be used. Defaults to a binary input stream.

Returns

A shared pointer to an istream if successful.

Implements ossim::StreamFactoryBase.

Definition at line 148 of file ossimStreamFactoryRegistry.cpp.

Referenced by ossimSrtmSupportData::computeMinMaxTemplate(), ossimImageHandler::initVertices(), ossimImageHandler::loadMetaData(), ossimTiffInfo::open(), and ossimNitfTileSource::open().

{
   std::shared_ptr<ossim::istream> result(0);
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_WARN)
      << "ossim::StreamFactoryRegistry::createIstream: ....... entered: "<< connectionString << "\n";
   }

   ossim_uint32 i = 0;
   for(i = 0; (i < m_factoryList.size())&&(!result); ++i)
   {
      result = m_factoryList[i]->createIstream(connectionString, options, openMode);

      if(result)
      {
         BufferInfo bufferInfo;
         if(getBufferInfo(bufferInfo, connectionString))
         {
            if(bufferInfo.m_enableBlocked)
            {
               result = std::make_shared<ossim::BlockIStream>(result, bufferInfo.m_size);
            }
            else
            {
               result = std::make_shared<ossimBufferedInputStream>(result, bufferInfo.m_size);
            }
         }
      }
   }

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_WARN)
      << "ossim::StreamFactoryRegistry::createIstream: ....... leaving!\n";
   }

   return result;
}

createOstream()

std::shared_ptr< ossim::ostream > ossim::StreamFactoryRegistry::createOstream ( const std::string &  connectionString, const ossimKeywordlist &  options = ossimKeywordlist(), std::ios_base::openmode  mode = std::ios_base::out|std::ios_base::binary  ) const

virtual

Will try to creates an ostream interface to the connectionString passed in.

Parameters

connectionString	Is the connection string used to create the stream
options	If a stream is found then this holds specific options for the stream. Defaults to empty options
mode	Is the mode to be used. Defaults to a binary output stream.

Returns

A shared pointer to an ostream if successful.

Implements ossim::StreamFactoryBase.

Definition at line 191 of file ossimStreamFactoryRegistry.cpp.

{
   std::shared_ptr<ossim::ostream> result(0);
   return result;
}

exists() [1/2]

bool ossim::StreamFactoryRegistry::exists

(

const std::string &

connectionString

)

const

Methods to test if connection exists.

Returns

true on success, false, if not.

Definition at line 209 of file ossimStreamFactoryRegistry.cpp.

Referenced by ossimFilename::exists().

{
   bool continueFlag = true;
   return exists( connectionString, continueFlag );
}

exists() [2/2]

bool ossim::StreamFactoryRegistry::exists ( const std::string &  connectionString, bool &  continueFlag  ) const

virtual

Methods to test if connection exists.

Parameters

connectionString
continueFlag	Initializes by this, if set to true, indicates factory handles file/url and no more factory checks are necessary.

Returns

true on success, false, if not.

Implements ossim::StreamFactoryBase.

Definition at line 215 of file ossimStreamFactoryRegistry.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_WARN)
      << "ossim::StreamFactoryRegistry::exists: ....... entered: "<< connectionString << "\n";
   }
   bool result = false;
   for(auto factory:m_factoryList)
   {

      result = factory->exists( connectionString, continueFlag );
      if ( ( result == true ) || (continueFlag == false ) ) break;
   }

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_WARN)
      << "ossim::StreamFactoryRegistry::createIstream: ....... leaving!\n";
   }
   return result;
}

getBufferInfo()

bool ossim::StreamFactoryRegistry::getBufferInfo ( BufferInfo &  bufferInfo, const ossimString &  connectionString  ) const

private

Parameters

bufferInfo	Holds the result of the first buffer info matching the connection string
connecitonString	The connection string

Definition at line 120 of file ossimStreamFactoryRegistry.cpp.

References ossimString::c_str().

{
   bool result = false;

   for(std::vector<BufferInfo>::const_iterator iter = m_bufferInfoList.begin();
      iter != m_bufferInfoList.end(); 
      ++iter)
   {
      if(iter->m_enabled)
      {
         m_patternMatcher.compile(iter->m_pattern);
         if(m_patternMatcher.is_valid())
         {
            if(m_patternMatcher.find(connectionString.c_str()))
            {
               bufferInfo = *iter;
               result = true;
               break;
            }            
         }
      }
   }

   return result;
}

instance()

ossim::StreamFactoryRegistry * ossim::StreamFactoryRegistry::instance ( )

static

Definition at line 35 of file ossimStreamFactoryRegistry.cpp.

Referenced by ossimSrtmSupportData::computeMinMaxTemplate(), ossimInfoFactoryRegistry::create(), ossimFilename::exists(), ossimFilename::fileSize(), for(), ossimNitfFile::getNewDataExtensionSegment(), ossimNitfFile::getNewImageHeader(), ossimNitfFile::getNewLabelHeader(), ossimNitfFile::getNewSymbolHeader(), ossimNitfFile::getNewTextHeader(), ossimAuxXmlSupportData::getProjection(), ossimMultiResLevelHistogram::importHistogram(), ossimInit::initializeDefaultFactories(), ossimImageHandler::initVertices(), ossimApplanixEOFile::isEOFile(), ossimSensorModelFactory::isNitf(), ossimImageHandler::loadMetaData(), ossimNitfInfo::open(), ossimDemInfo::open(), ossimCcfInfo::open(), ossimInfoBase::open(), ossimDemHeader::open(), ossimTiffInfo::open(), ossimNitfTileSource::open(), ossimDtedHandler::open(), ossimFfRevb::ossimFfRevb(), ossimFfRevc::ossimFfRevc(), ossimSharedLibraryFinalize(), ossimSharedLibraryInitialize(), ossimCcfHead::parseCcfHeader(), ossimApplanixEOFile::parseFile(), ossimKeywordlist::parseFile(), and ossimApplanixEOFile::parseHeader().

{
   // because of the loadPreferences for this factory and the fact that
   // create stream could be recursive the lock and unlock are
   // a little different here.  We will unlock as quickly as we can
   // After the unlock then call load preferences
   m_instanceMutex.lock();
   if(!m_instance)
   {
      m_instance = new ossim::StreamFactoryRegistry();
      m_instance->registerFactory(ossim::StreamFactory::instance());
      m_instanceMutex.unlock();
      m_instance->loadPreferences();
   }
   else
   {
      m_instanceMutex.unlock();
   }

   return m_instance;
}

loadPreferences()

void ossim::StreamFactoryRegistry::loadPreferences

(

)

This will load the buffer information from the preferences.

Definition at line 57 of file ossimStreamFactoryRegistry.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_WARN)
      << "ossim::StreamFactoryRegistry::loadPreferences: ....... entered!\n";
   }
   std::vector<ossimString> sortedList;
   ossimPreferences::instance()->preferencesKWL()
         .getSortedList(sortedList, ISTREAM_BUFFER_KW);
   if(sortedList.size())
   {
      m_bufferInfoList.resize(sortedList.size());
   }
   else
   {
      m_bufferInfoList.clear();
   }
   ossim_uint32 idx=0;
   for(std::vector<ossimString>::const_iterator iter = sortedList.begin();
       iter!=sortedList.end();
       ++iter,++idx)
   {
      ossimString prefix = *iter;
      ossimString bufferIStreamEnabled        = ossimPreferences::instance()->findPreference(prefix+".enabled");
      ossimString bufferIStreamBlockEnabled   = ossimPreferences::instance()->findPreference(prefix+".enableBlocked");
      ossimString bufferIStreamIncludePattern = ossimPreferences::instance()->findPreference(prefix+".includePattern");
      ossimString bufferIStreamSize           = ossimPreferences::instance()->findPreference(prefix+".size");

      if(!bufferIStreamSize.empty())
      {
         m_bufferInfoList[idx].m_size = bufferIStreamSize.toUInt64();
      }
      if(!bufferIStreamEnabled.empty())
      {
         m_bufferInfoList[idx].m_enabled = bufferIStreamEnabled.toBool();
      }
      if(!bufferIStreamBlockEnabled.empty())
      {
         m_bufferInfoList[idx].m_enableBlocked = bufferIStreamBlockEnabled.toBool();
      }
      if(!bufferIStreamIncludePattern.empty())
      {
         m_bufferInfoList[idx].m_pattern = bufferIStreamIncludePattern;
      }
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
         << "ossim::StreamFactoryRegistry adding BufferInfo: \n"
         << "enabled:       " << ossimString::toString(m_bufferInfoList[idx].m_enabled)<< "\n"
         << "enableBlocked: " << ossimString::toString(m_bufferInfoList[idx].m_enableBlocked)<< "\n"
         << "size:          " << m_bufferInfoList[idx].m_size << "\n"
         << "pattern:       " << m_bufferInfoList[idx].m_pattern << "\n";
      }

   }
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_WARN)
      << "ossim::StreamFactoryRegistry::loadPreferences: ....... leaving!\n";
   }
}

registerFactory()

void ossim::StreamFactoryRegistry::registerFactory

(

ossim::StreamFactoryBase *

factory

)

Registers a stream factory.

This allows for a pluggable stream Please see ossim-plugins and look at curl, aws for example stream definitions.

Parameters

factory

To be added to the registry

Definition at line 239 of file ossimStreamFactoryRegistry.cpp.

{
   std::vector<ossim::StreamFactoryBase*>::iterator iter = std::find(
      m_factoryList.begin(), m_factoryList.end(), factory);
   if(iter == m_factoryList.end())
   {
      m_factoryList.push_back(factory);
   }
}

unregisterFactory()

void ossim::StreamFactoryRegistry::unregisterFactory

(

StreamFactoryBase *

factory

)

Removes a factory from the registry.

Parameters

factory

To be removed from the registry

Definition at line 249 of file ossimStreamFactoryRegistry.cpp.

{
   // std::lock_guard<std::mutex> lock(m_factoryListMutex);
   std::vector<ossim::StreamFactoryBase*>::iterator iter = std::find(
      m_factoryList.begin(), m_factoryList.end(), factory);
   if(iter != m_factoryList.end())
   {
      m_factoryList.erase( iter );
   }
}

Member Data Documentation

m_bufferInfoList

std::vector<BufferInfo> ossim::StreamFactoryRegistry::m_bufferInfoList

private

Definition at line 215 of file ossimStreamFactoryRegistry.h.

m_factoryList

std::vector<StreamFactoryBase*> ossim::StreamFactoryRegistry::m_factoryList

private

Definition at line 214 of file ossimStreamFactoryRegistry.h.

m_instance

ossim::StreamFactoryRegistry * ossim::StreamFactoryRegistry::m_instance = 0

staticprivate

Definition at line 216 of file ossimStreamFactoryRegistry.h.

m_mutex

std::mutex ossim::StreamFactoryRegistry::m_mutex

mutableprivate

Definition at line 218 of file ossimStreamFactoryRegistry.h.

m_patternMatcher

ossimRegExp ossim::StreamFactoryRegistry::m_patternMatcher

mutableprivate

Definition at line 217 of file ossimStreamFactoryRegistry.h.

---

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

• ossimStreamFactoryRegistry.h
• ossimStreamFactoryRegistry.cpp