VMware Tanzu GemFire Native C++ Reference  10.1.5
AuthenticatedView.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #pragma once
19 
20 #ifndef GEODE_AUTHENTICATEDVIEW_H_
21 #define GEODE_AUTHENTICATEDVIEW_H_
22 
23 #include <geode/PoolFactory.hpp>
24 #include <geode/QueryService.hpp>
25 #include <geode/Region.hpp>
26 #include <geode/RegionService.hpp>
27 #include <geode/internal/geode_globals.hpp>
28 
33 namespace apache {
34 namespace geode {
35 namespace client {
36 
37 class GuardUserAttributes;
38 class UserAttributes;
39 class FunctionServiceImpl;
40 
46 class APACHE_GEODE_EXPORT AuthenticatedView : public RegionService {
50  public:
59  bool isClosed() const override;
60 
69  void close() override;
70 
75  std::shared_ptr<Region> getRegion(const std::string& path) const override;
76 
82  std::shared_ptr<QueryService> getQueryService() override;
83 
92  std::vector<std::shared_ptr<Region>> rootRegions() const override;
93 
97  virtual ~AuthenticatedView();
98 
102  AuthenticatedView(std::shared_ptr<Properties> credentials,
103  std::shared_ptr<Pool> pool, CacheImpl* cacheImpl);
104  AuthenticatedView(AuthenticatedView&& other) = default;
105  AuthenticatedView(const AuthenticatedView& other) = delete;
106 
115  const std::string& className) const override;
116 
117  AuthenticatedView& operator=(AuthenticatedView&& other) = default;
118  AuthenticatedView& operator=(const AuthenticatedView& other) = delete;
119 
120  private:
121  std::shared_ptr<UserAttributes> m_userAttributes;
122  bool m_isAuthenticatedViewClosed;
123  std::shared_ptr<QueryService> m_remoteQueryService;
124  CacheImpl* m_cacheImpl;
125 
126  friend class Pool;
127  friend class ProxyRegion;
128  friend class ProxyRemoteQueryService;
129  friend class RemoteQuery;
130  friend class ExecutionImpl;
131  friend class FunctionServiceImpl;
132  friend class FunctionService;
133  friend class GuardUserAttributes;
134  friend class CacheRegionHelper;
135 };
136 } // namespace client
137 } // namespace geode
138 } // namespace apache
139 
140 #endif // GEODE_AUTHENTICATEDVIEW_H_
apache::geode::client::AuthenticatedView::AuthenticatedView
AuthenticatedView(std::shared_ptr< Properties > credentials, std::shared_ptr< Pool > pool, CacheImpl *cacheImpl)
constructors
apache::geode::client::AuthenticatedView::close
void close() override
Terminates this object cache and releases all the local resources.
apache::geode::client::AuthenticatedView::getQueryService
std::shared_ptr< QueryService > getQueryService() override
Gets the QueryService from which a new Query can be obtained.
apache::geode::client::AuthenticatedView::getRegion
std::shared_ptr< Region > getRegion(const std::string &path) const override
Look up a region with the full path from root.
apache::geode::client::AuthenticatedView
Creates an authenticated cache view to allow credential based access to region services.
Definition: AuthenticatedView.hpp:46
apache::geode::client::AuthenticatedView::~AuthenticatedView
virtual ~AuthenticatedView()
destructor
apache::geode::client::Pool
A pool of connections to connect from a client to a set of Geode Cache Servers.
Definition: Pool.hpp:63
apache::geode::client::PdxInstanceFactory
PdxInstanceFactory gives you a way to create PdxInstances.
Definition: PdxInstanceFactory.hpp:52
PoolFactory.hpp
apache::geode::client::AuthenticatedView::createPdxInstanceFactory
PdxInstanceFactory createPdxInstanceFactory(const std::string &className) const override
Returns a factory that can create a PdxInstance.
apache::geode::client::AuthenticatedView::rootRegions
std::vector< std::shared_ptr< Region > > rootRegions() const override
Returns a set of root regions in the cache.
apache::geode::client::RegionService
A RegionService provides access to existing regions that exist in a Geode cache.
Definition: RegionService.hpp:62
apache::geode::client::FunctionService
entry point for function execution
Definition: FunctionService.hpp:45
QueryService.hpp
apache::geode::client::AuthenticatedView::isClosed
bool isClosed() const override
public methods
RegionService.hpp

Apache Geode C++ Cache API Documentation