| // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef SHILL_VPN_PROVIDER_ |
| #define SHILL_VPN_PROVIDER_ |
| |
| #include <string> |
| #include <vector> |
| |
| #include <base/basictypes.h> |
| #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| |
| #include "shill/provider_interface.h" |
| #include "shill/refptr_types.h" |
| |
| namespace shill { |
| |
| class ControlInterface; |
| class Error; |
| class EventDispatcher; |
| class KeyValueStore; |
| class Manager; |
| class Metrics; |
| |
| class VPNProvider : public ProviderInterface { |
| public: |
| VPNProvider(ControlInterface *control_interface, |
| EventDispatcher *dispatcher, |
| Metrics *metrics, |
| Manager *manager); |
| virtual ~VPNProvider(); |
| |
| // Called by Manager as a part of the Provider interface. The attributes |
| // used for matching services for the VPN provider are the ProviderType, |
| // ProviderHost mode and Name parameters. |
| virtual void CreateServicesFromProfile(const ProfileRefPtr &profile) override; |
| virtual ServiceRefPtr FindSimilarService( |
| const KeyValueStore &args, Error *error) const override; |
| virtual ServiceRefPtr GetService(const KeyValueStore &args, |
| Error *error) override; |
| virtual ServiceRefPtr CreateTemporaryService( |
| const KeyValueStore &args, Error *error) override; |
| virtual void Start() override; |
| virtual void Stop() override; |
| |
| // Offers an unclaimed interface to VPN services. Returns true if this |
| // device has been accepted by a service. |
| virtual bool OnDeviceInfoAvailable(const std::string &link_name, |
| int interface_index); |
| |
| // Clean up a VPN services that has been unloaded and will be deregistered. |
| // This removes the VPN provider's reference to this service in its |
| // services_ vector. |
| void RemoveService(VPNServiceRefPtr service); |
| |
| // Returns true if any of the managed VPN services is connecting or connected. |
| virtual bool HasActiveService() const; |
| |
| private: |
| friend class VPNProviderTest; |
| FRIEND_TEST(VPNProviderTest, CreateService); |
| FRIEND_TEST(VPNProviderTest, OnDeviceInfoAvailable); |
| FRIEND_TEST(VPNProviderTest, RemoveService); |
| FRIEND_TEST(VPNServiceTest, Unload); |
| |
| // Create a service of type |type| and storage identifier |storage_id| |
| // and initial parameters |args|. Returns a service reference pointer |
| // to the newly created service, or populates |error| with an the error |
| // that caused this to fail. |
| VPNServiceRefPtr CreateServiceInner(const std::string &type, |
| const std::string &name, |
| const std::string &storage_id, |
| Error *error); |
| |
| // Calls CreateServiceInner above, and on success registers and adds this |
| // service to the provider's list. |
| VPNServiceRefPtr CreateService(const std::string &type, |
| const std::string &name, |
| const std::string &storage_id, |
| Error *error); |
| |
| // Finds a service of type |type| with its Name property set to |name| and its |
| // Provider.Host property set to |host|. |
| VPNServiceRefPtr FindService(const std::string &type, |
| const std::string &name, |
| const std::string &host) const; |
| |
| // Populates |type_ptr|, |name_ptr| and |host_ptr| with the appropriate |
| // values from |args|. Returns True on success, otherwise if any of |
| // these arguments are not available, |error| is populated and False is |
| // returned. |
| static bool GetServiceParametersFromArgs(const KeyValueStore &args, |
| std::string *type_ptr, |
| std::string *name_ptr, |
| std::string *host_ptr, |
| Error *error); |
| |
| ControlInterface *control_interface_; |
| EventDispatcher *dispatcher_; |
| Metrics *metrics_; |
| Manager *manager_; |
| std::vector<VPNServiceRefPtr> services_; |
| |
| DISALLOW_COPY_AND_ASSIGN(VPNProvider); |
| }; |
| |
| } // namespace shill |
| |
| #endif // SHILL_VPN_PROVIDER_ |