chromeos/network/onc/onc_translator.h

   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 CHROMEOS_NETWORK_ONC_ONC_TRANSLATOR_H_
   6 #define CHROMEOS_NETWORK_ONC_ONC_TRANSLATOR_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "chromeos/chromeos_export.h"
  10 #include "components/onc/onc_constants.h"
  11
  12 namespace base {
  13 class DictionaryValue;
  14 }
  15
  16 namespace chromeos {
  17
  18 class NetworkState;
  19
  20 namespace onc {
  21
  22 struct OncValueSignature;
  23
  24 // Translates a hierarchical ONC dictionary |onc_object| to a flat Shill
  25 // dictionary. The |signature| declares the type of |onc_object| and must point
  26 // to one of the signature objects in "onc_signature.h". The resulting Shill
  27 // dictionary is returned.
  28 //
  29 // This function is used to translate network settings from ONC to Shill's
  30 // format before sending them to Shill.
  31 CHROMEOS_EXPORT
  32 scoped_ptr<base::DictionaryValue> TranslateONCObjectToShill(
  33     const OncValueSignature* signature,
  34     const base::DictionaryValue& onc_object);
  35
  36 // Translates a |shill_dictionary| to an ONC object according to the given
  37 // |onc_signature|. |onc_signature| must point to a signature object in
  38 // "onc_signature.h". The resulting ONC object is returned.
  39 //
  40 // This function is used to translate network settings coming from Shill to ONC
  41 // before sending them to the UI. The result doesn't have to be valid ONC, but
  42 // only a subset of it and includes only the values that are actually required
  43 // by the UI. If |onc_source| != ONC_SOURCE_UNKNOWN then the 'Source' property
  44 // of the ONC dictionary will be set accordingly. Note: ONC_SOURCE_USER_IMPORT
  45 // is treated the same as ONC_SOURCE_NONE. If |network_state| is provided it
  46 // will be used to set the ErrorState property. Otherwise ErrorState will not
  47 // be set.
  48 CHROMEOS_EXPORT
  49 scoped_ptr<base::DictionaryValue> TranslateShillServiceToONCPart(
  50     const base::DictionaryValue& shill_dictionary,
  51     ::onc::ONCSource onc_source,
  52     const OncValueSignature* onc_signature,
  53     const NetworkState* network_state);
  54
  55 }  // namespace onc
  56 }  // namespace chromeos
  57
  58 #endif  // CHROMEOS_NETWORK_ONC_ONC_TRANSLATOR_H_