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
  11 namespace base {
  12 class DictionaryValue;
  13 }
  14
  15 namespace chromeos {
  16 namespace onc {
  17
  18 struct OncValueSignature;
  19
  20 // Translates a hierarchical ONC dictionary |onc_object| to a flat Shill
  21 // dictionary. The |signature| declares the type of |onc_object| and must point
  22 // to one of the signature objects in "onc_signature.h". The resulting Shill
  23 // dictionary is returned.
  24 //
  25 // This function is used to translate network settings from ONC to Shill's
  26 // format before sending them to Shill.
  27 CHROMEOS_EXPORT
  28 scoped_ptr<base::DictionaryValue> TranslateONCObjectToShill(
  29     const OncValueSignature* signature,
  30     const base::DictionaryValue& onc_object);
  31
  32 // Translates a |shill_dictionary| to an ONC object according to the given
  33 // |onc_signature|. |onc_signature| must point to a signature object in
  34 // "onc_signature.h". The resulting ONC object is returned.
  35 //
  36 // This function is used to translate network settings coming from Shill to ONC
  37 // before sending them to the UI. The result doesn't have to be valid ONC, but
  38 // only a subset of it and includes only the values that are actually required
  39 // by the UI.
  40 CHROMEOS_EXPORT
  41 scoped_ptr<base::DictionaryValue> TranslateShillServiceToONCPart(
  42     const base::DictionaryValue& shill_dictionary,
  43     const OncValueSignature* onc_signature);
  44
  45 }  // namespace onc
  46 }  // namespace chromeos
  47
  48 #endif  // CHROMEOS_NETWORK_ONC_ONC_TRANSLATOR_H_