Home | History | Annotate | Download | only in cloud 
      1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef COMPONENTS_POLICY_CORE_COMMON_CLOUD_DEVICE_MANAGEMENT_SERVICE_H_
      6 #define COMPONENTS_POLICY_CORE_COMMON_CLOUD_DEVICE_MANAGEMENT_SERVICE_H_
      7 
      8 #include <deque>
      9 #include <map>
     10 #include <string>
     11 #include <vector>
     12 
     13 #include "base/basictypes.h"
     14 #include "base/callback.h"
     15 #include "base/compiler_specific.h"
     16 #include "base/memory/weak_ptr.h"
     17 #include "components/policy/core/common/cloud/cloud_policy_constants.h"
     18 #include "components/policy/policy_export.h"
     19 #include "net/url_request/url_fetcher_delegate.h"
     20 #include "policy/proto/device_management_backend.pb.h"
     21 
     22 namespace net {
     23 class URLRequestContextGetter;
     24 }
     25 
     26 namespace policy {
     27 
     28 class DeviceManagementRequestJobImpl;
     29 class DeviceManagementService;
     30 
     31 // DeviceManagementRequestJob describes a request to send to the device
     32 // management service. Jobs are created by DeviceManagementService. They can be
     33 // canceled by deleting the object.
     34 class POLICY_EXPORT DeviceManagementRequestJob {
     35  public:
     36   // Describes the job type.
     37   enum JobType {
     38     TYPE_AUTO_ENROLLMENT,
     39     TYPE_REGISTRATION,
     40     TYPE_API_AUTH_CODE_FETCH,
     41     TYPE_POLICY_FETCH,
     42     TYPE_UNREGISTRATION,
     43     TYPE_UPLOAD_CERTIFICATE,
     44   };
     45 
     46   typedef base::Callback<
     47       void(DeviceManagementStatus, int,
     48            const enterprise_management::DeviceManagementResponse&)> Callback;
     49 
     50   typedef base::Callback<void(DeviceManagementRequestJob*)> RetryCallback;
     51 
     52   virtual ~DeviceManagementRequestJob();
     53 
     54   // Functions for configuring the job. These should only be called before
     55   // Start()ing the job, but never afterwards.
     56   void SetGaiaToken(const std::string& gaia_token);
     57   void SetOAuthToken(const std::string& oauth_token);
     58   void SetUserAffiliation(UserAffiliation user_affiliation);
     59   void SetDMToken(const std::string& dm_token);
     60   void SetClientID(const std::string& client_id);
     61   enterprise_management::DeviceManagementRequest* GetRequest();
     62 
     63   // A job may automatically retry if it fails due to a temporary condition, or
     64   // due to proxy misconfigurations. If a |retry_callback| is set then it will
     65   // be invoked with the DeviceManagementRequestJob as an argument when that
     66   // happens, so that the job's owner can customize the retry request before
     67   // it's sent.
     68   void SetRetryCallback(const RetryCallback& retry_callback);
     69 
     70   // Starts the job. |callback| will be invoked on completion.
     71   void Start(const Callback& callback);
     72 
     73  protected:
     74   typedef std::vector<std::pair<std::string, std::string> > ParameterMap;
     75 
     76   DeviceManagementRequestJob(JobType type,
     77                              const std::string& agent_parameter,
     78                              const std::string& platform_parameter);
     79 
     80   // Appends a parameter to |query_params|.
     81   void AddParameter(const std::string& name, const std::string& value);
     82 
     83   // Fires the job, to be filled in by implementations.
     84   virtual void Run() = 0;
     85 
     86   ParameterMap query_params_;
     87   std::string gaia_token_;
     88   std::string dm_token_;
     89   enterprise_management::DeviceManagementRequest request_;
     90   RetryCallback retry_callback_;
     91 
     92   Callback callback_;
     93 
     94  private:
     95   DISALLOW_COPY_AND_ASSIGN(DeviceManagementRequestJob);
     96 };
     97 
     98 // The device management service is responsible for everything related to
     99 // communication with the device management server. It creates the backends
    100 // objects that the device management policy provider and friends use to issue
    101 // requests.
    102 class POLICY_EXPORT DeviceManagementService : public net::URLFetcherDelegate {
    103  public:
    104   // Obtains the parameters used to contact the server.
    105   // This allows creating the DeviceManagementService early and getting these
    106   // parameters later. Passing the parameters directly in the ctor isn't
    107   // possible because some aren't ready during startup. http://crbug.com/302798
    108   class POLICY_EXPORT Configuration {
    109    public:
    110     virtual ~Configuration() {}
    111 
    112     // Server at which to contact the service.
    113     virtual std::string GetServerUrl() = 0;
    114 
    115     // Agent reported in the "agent" query parameter.
    116     virtual std::string GetAgentParameter() = 0;
    117 
    118     // The platform reported in the "platform" query parameter.
    119     virtual std::string GetPlatformParameter() = 0;
    120   };
    121 
    122   explicit DeviceManagementService(scoped_ptr<Configuration> configuration);
    123   virtual ~DeviceManagementService();
    124 
    125   // The ID of URLFetchers created by the DeviceManagementService. This can be
    126   // used by tests that use a TestURLFetcherFactory to get the pending fetchers
    127   // created by the DeviceManagementService.
    128   static const int kURLFetcherID;
    129 
    130   // Creates a new device management request job. Ownership is transferred to
    131   // the caller.
    132   virtual DeviceManagementRequestJob* CreateJob(
    133       DeviceManagementRequestJob::JobType type,
    134       net::URLRequestContextGetter* request_context);
    135 
    136   // Schedules a task to run |Initialize| after |delay_milliseconds| had passed.
    137   void ScheduleInitialization(int64 delay_milliseconds);
    138 
    139   // Makes the service stop all requests.
    140   void Shutdown();
    141 
    142   // Gets the URL that the DMServer requests are sent to.
    143   std::string GetServerUrl();
    144 
    145  private:
    146   typedef std::map<const net::URLFetcher*,
    147                    DeviceManagementRequestJobImpl*> JobFetcherMap;
    148   typedef std::deque<DeviceManagementRequestJobImpl*> JobQueue;
    149 
    150   friend class DeviceManagementRequestJobImpl;
    151 
    152   // net::URLFetcherDelegate override.
    153   virtual void OnURLFetchComplete(const net::URLFetcher* source) OVERRIDE;
    154 
    155   // Starts processing any queued jobs.
    156   void Initialize();
    157 
    158   // Starts a job.
    159   void StartJob(DeviceManagementRequestJobImpl* job);
    160 
    161   // Adds a job. Caller must make sure the job pointer stays valid until the job
    162   // completes or gets canceled via RemoveJob().
    163   void AddJob(DeviceManagementRequestJobImpl* job);
    164 
    165   // Removes a job. The job will be removed and won't receive a completion
    166   // callback.
    167   void RemoveJob(DeviceManagementRequestJobImpl* job);
    168 
    169   // A Configuration implementation that is used to obtain various parameters
    170   // used to talk to the device management server.
    171   scoped_ptr<Configuration> configuration_;
    172 
    173   // The jobs we currently have in flight.
    174   JobFetcherMap pending_jobs_;
    175 
    176   // Jobs that are registered, but not started yet.
    177   JobQueue queued_jobs_;
    178 
    179   // If this service is initialized, incoming requests get fired instantly.
    180   // If it is not initialized, incoming requests are queued.
    181   bool initialized_;
    182 
    183   // Used to create tasks to run |Initialize| delayed on the UI thread.
    184   base::WeakPtrFactory<DeviceManagementService> weak_ptr_factory_;
    185 
    186   DISALLOW_COPY_AND_ASSIGN(DeviceManagementService);
    187 };
    188 
    189 }  // namespace policy
    190 
    191 #endif  // COMPONENTS_POLICY_CORE_COMMON_CLOUD_DEVICE_MANAGEMENT_SERVICE_H_
    192