ossim::AwsStreamFactory Class Reference

#include <ossimAwsStreamFactory.h>

Inheritance diagram for ossim::AwsStreamFactory:

Public Member Functions
virtual	~AwsStreamFactory ()
virtual std::shared_ptr< ossim::istream >	createIstream (const std::string &connectionString, const ossimKeywordlist &options, std::ios_base::openmode openMode) const
virtual std::shared_ptr< ossim::ostream >	createOstream (const std::string &connectionString, const ossimKeywordlist &options, std::ios_base::openmode openMode) const
virtual std::shared_ptr< ossim::iostream >	createIOstream (const std::string &connectionString, const ossimKeywordlist &options, std::ios_base::openmode openMode) const
bool	exists (const std::string &connectionString, bool &continueFlag) const
	Methods to test if connection exists. More...
std::shared_ptr< Aws::S3::S3Client >	getSharedS3Client () const
Public Member Functions inherited from ossim::StreamFactoryBase
virtual	~StreamFactoryBase ()

Static Public Member Functions
static AwsStreamFactory *	instance ()

Protected Member Functions
bool	isS3Url (const ossimFilename &file) const
void	initClient () const
	AwsStreamFactory ()
	AwsStreamFactory (const AwsStreamFactory &)

Protected Attributes
std::shared_ptr< Aws::S3::S3Client >	m_client

Static Protected Attributes
static AwsStreamFactory *	m_instance = 0

Detailed Description

Definition at line 27 of file ossimAwsStreamFactory.h.

Constructor & Destructor Documentation

~AwsStreamFactory()

ossim::AwsStreamFactory::~AwsStreamFactory ( )

virtual

Definition at line 32 of file ossimAwsStreamFactory.cpp.

{
}

AwsStreamFactory() [1/2]

ossim::AwsStreamFactory::AwsStreamFactory ( )

protected

Definition at line 168 of file ossimAwsStreamFactory.cpp.

{
   // the stream is now shared so we must allocate here.  
   // 
   initClient();
}

AwsStreamFactory() [2/2]

ossim::AwsStreamFactory::AwsStreamFactory ( const AwsStreamFactory &  )

protected

Definition at line 176 of file ossimAwsStreamFactory.cpp.

{
}

Member Function Documentation

createIOstream()

std::shared_ptr< ossim::iostream > ossim::AwsStreamFactory::createIOstream ( const std::string &  connectionString, const ossimKeywordlist &  options, std::ios_base::openmode  openMode  ) const

virtual

Implements ossim::StreamFactoryBase.

Definition at line 87 of file ossimAwsStreamFactory.cpp.

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

createIstream()

std::shared_ptr< ossim::istream > ossim::AwsStreamFactory::createIstream ( const std::string &  connectionString, const ossimKeywordlist &  options, std::ios_base::openmode  openMode  ) const

virtual

Implements ossim::StreamFactoryBase.

Definition at line 45 of file ossimAwsStreamFactory.cpp.

{
   std::shared_ptr<ossim::S3IStream> result = std::make_shared<ossim::S3IStream>();
   if(traceDebug())
   {
     ossimNotify(ossimNotifyLevel_WARN) << "ossim::AwsStreamFactory::createIstream: Entered...............\n";
   }
   
   //---
   // Hack for upstream code calling ossimFilename::convertToNative()
   // wrecking s3 url.
   //---
#if defined(_WIN32)
   ossimFilename f = connectionString;
   result->open( f.string(), options, openMode) ;
#else
   result->open( connectionString, options, openMode );
#endif
  
  if(!result->good())
  {
    result.reset();
  }
   if(traceDebug())
   {
     ossimNotify(ossimNotifyLevel_WARN) << "ossim::AwsStreamFactory::createIstream: Leaving...............\n";
   }

  return result;
}

createOstream()

std::shared_ptr< ossim::ostream > ossim::AwsStreamFactory::createOstream ( const std::string &  connectionString, const ossimKeywordlist &  options, std::ios_base::openmode  openMode  ) const

virtual

Implements ossim::StreamFactoryBase.

Definition at line 79 of file ossimAwsStreamFactory.cpp.

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

exists()

bool ossim::AwsStreamFactory::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 95 of file ossimAwsStreamFactory.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossim::AwsStreamFactory::exists() DEBUG: entered.....\n";

   }
   bool result = false;
   
   // ossimTimer::Timer_t startTimer = ossimTimer::instance()->tick();

   if ( connectionString.size() )
   {
      // Check for url string:
      std::size_t pos = connectionString.find( "://" );
      if ( pos != std::string::npos )
      {
         ossimUrl url(connectionString);
         if( (url.getProtocol() == "s3") || (url.getProtocol() == "S3") )
         {
            continueFlag = false; // Set to false to stop registry search.
            
            ossim_int64 filesize;
            if(ossim::S3HeaderCache::instance()->getCachedFilesize(connectionString, filesize))
            {
               if(filesize >=0)
               {
                  result = true;
               }
            }
            else
            {
               std::string bucket = url.getIp().string();
               std::string key    = url.getPath().string();
               Aws::S3::Model::HeadObjectRequest headObjectRequest;
               headObjectRequest.WithBucket( bucket.c_str() )
                  .WithKey( key.c_str() );
               auto headObject = m_client->HeadObject(headObjectRequest);
               if(headObject.IsSuccess())
               {
                  result = true;
                  filesize = headObject.GetResult().GetContentLength();
                  ossim::S3HeaderCache::Node_t nodePtr = std::make_shared<ossim::S3HeaderCacheNode>(filesize);
                  ossim::S3HeaderCache::instance()->addHeader(connectionString, nodePtr);               
               }
               else
               {
                  result = false;                  
                  ossim::S3HeaderCache::Node_t nodePtr = std::make_shared<ossim::S3HeaderCacheNode>(-1);
                  ossim::S3HeaderCache::instance()->addHeader(connectionString, nodePtr);               
               }
            }
         }
      }
   }

   // ossimTimer::Timer_t endTimer = ossimTimer::instance()->tick();
   // cout << "time: " << ossimTimer::instance()->delta_s(startTimer, endTimer) << endl;

   // std::cout << "aws result: " << result << std::endl;
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossim::AwsStreamFactory::exists() DEBUG: leaving.....\n";

   }
   
   return result;
}

getSharedS3Client()

std::shared_ptr<Aws::S3::S3Client> ossim::AwsStreamFactory::getSharedS3Client ( ) const

inline

Definition at line 58 of file ossimAwsStreamFactory.h.

References m_client.

Referenced by ossim::S3StreamBuffer::S3StreamBuffer().

{return m_client;}

initClient()

void ossim::AwsStreamFactory::initClient ( ) const

protected

Definition at line 180 of file ossimAwsStreamFactory.cpp.

References ossimPreferences::instance().

{
   Aws::Client::ClientConfiguration config;
   
   // Look for AWS S3 region override:
   std::string region = ossimPreferences::instance()->
      preferencesKWL().findKey(std::string("ossim.plugins.aws.s3.region"));
   if ( region.size() )
   {
      config.region = region.c_str();
   }
   
   m_client = std::make_shared<Aws::S3::S3Client>(config);
//new Aws::S3::S3Client( config );
}

instance()

ossim::AwsStreamFactory * ossim::AwsStreamFactory::instance ( )

static

Definition at line 36 of file ossimAwsStreamFactory.cpp.

Referenced by ossimSharedLibraryFinalize(), ossimSharedLibraryInitialize(), and ossim::S3StreamBuffer::S3StreamBuffer().

{
   if( !m_instance )
   {
      m_instance = new ossim::AwsStreamFactory();
   }
   return m_instance;
}

isS3Url()

bool ossim::AwsStreamFactory::isS3Url ( const ossimFilename &  file ) const

protected

Returns

true if starts with "s3://" or "S3://"

Member Data Documentation

m_client

std::shared_ptr<Aws::S3::S3Client> ossim::AwsStreamFactory::m_client

mutableprotected

Definition at line 73 of file ossimAwsStreamFactory.h.

Referenced by getSharedS3Client().

m_instance

ossim::AwsStreamFactory * ossim::AwsStreamFactory::m_instance = 0

staticprotected

Definition at line 75 of file ossimAwsStreamFactory.h.

---

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

• ossimAwsStreamFactory.h
• ossimAwsStreamFactory.cpp