Pivotal GemFire Native C++ Reference  10.2.0
apache::geode::client::AuthenticatedView Class Reference

Creates an authenticated cache view to allow credential based access to region services. More...

Inherits apache::geode::client::RegionService.

Public Member Functions

 AuthenticatedView (std::shared_ptr< Properties > credentials, std::shared_ptr< Pool > pool, CacheImpl *cacheImpl)
 constructors More...
 
void close () override
 Terminates this object cache and releases all the local resources. More...
 
PdxInstanceFactory createPdxInstanceFactory (const std::string &className) const override
 Returns a factory that can create a PdxInstance. More...
 
PdxInstanceFactory createPdxInstanceFactory (const std::string &className, bool expectDomainClass) const override
 Returns a factory that can create a PdxInstance. More...
 
std::shared_ptr< QueryServicegetQueryService () override
 Gets the QueryService from which a new Query can be obtained. More...
 
std::shared_ptr< RegiongetRegion (const std::string &path) const override
 Look up a region with the full path from root. More...
 
bool isClosed () const override
 public methods More...
 
std::vector< std::shared_ptr< Region > > rootRegions () const override
 Returns a set of root regions in the cache. More...
 
virtual ~AuthenticatedView ()
 destructor More...
 

Detailed Description

Creates an authenticated cache view to allow credential based access to region services.

Constructor & Destructor Documentation

◆ ~AuthenticatedView()

virtual apache::geode::client::AuthenticatedView::~AuthenticatedView ( )
virtual

destructor

◆ AuthenticatedView()

apache::geode::client::AuthenticatedView::AuthenticatedView ( std::shared_ptr< Properties credentials,
std::shared_ptr< Pool pool,
CacheImpl *  cacheImpl 
)

constructors

Member Function Documentation

◆ close()

void apache::geode::client::AuthenticatedView::close ( )
overridevirtual

Terminates this object cache and releases all the local resources.

After this cache is closed, any further method call on this cache or any region object will throw CacheClosedException, unless otherwise noted.

Exceptions
CacheClosedException,ifthe cache is already closed.

Implements apache::geode::client::RegionService.

◆ createPdxInstanceFactory() [1/2]

PdxInstanceFactory apache::geode::client::AuthenticatedView::createPdxInstanceFactory ( const std::string &  className) const
overridevirtual

Returns a factory that can create a PdxInstance.

Parameters
classNamethe fully qualified class name that the PdxInstance will become when it is fully deserialized.
Returns
the factory

Implements apache::geode::client::RegionService.

◆ createPdxInstanceFactory() [2/2]

PdxInstanceFactory apache::geode::client::AuthenticatedView::createPdxInstanceFactory ( const std::string &  className,
bool  expectDomainClass 
) const
overridevirtual

Returns a factory that can create a PdxInstance.

Parameters
classNamethe fully qualified class name that the PdxInstance will become when it is fully deserialized.
expectDomainClassWhether or not created PdxType represents a Java domain class.
Returns
the factory

Implements apache::geode::client::RegionService.

◆ getQueryService()

std::shared_ptr<QueryService> apache::geode::client::AuthenticatedView::getQueryService ( )
overridevirtual

Gets the QueryService from which a new Query can be obtained.

Returns
A smart pointer to the QueryService.

Implements apache::geode::client::RegionService.

◆ getRegion()

std::shared_ptr<Region> apache::geode::client::AuthenticatedView::getRegion ( const std::string &  path) const
overridevirtual

Look up a region with the full path from root.

Parameters
paththe region's path, such as RootA/Sub1/Sub1A.
Returns
region, or nullptr if no such region exists.

Implements apache::geode::client::RegionService.

◆ isClosed()

bool apache::geode::client::AuthenticatedView::isClosed ( ) const
overridevirtual

public methods

Indicates if this cache has been closed. After a new cache object is created, this method returns false; After the close is called on this cache object, this method returns true.

Returns
true, if this cache is closed; false, otherwise

Implements apache::geode::client::RegionService.

◆ rootRegions()

std::vector<std::shared_ptr<Region> > apache::geode::client::AuthenticatedView::rootRegions ( ) const
overridevirtual

Returns a set of root regions in the cache.

This set is a snapshot and is not backed by the Cache. The vector passed in is cleared and the regions are added to it.

Implements apache::geode::client::RegionService.


Apache Geode C++ Cache API Documentation