sync/protocol/sync_protocol_error.h

   1 // Copyright 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 #ifndef SYNC_PROTOCOL_SYNC_PROTOCOL_ERROR_H_
   5 #define SYNC_PROTOCOL_SYNC_PROTOCOL_ERROR_H_
   6
   7 #include <string>
   8
   9 #include "base/values.h"
  10 #include "sync/base/sync_export.h"
  11 #include "sync/internal_api/public/base/model_type.h"
  12
  13 namespace syncer{
  14
  15 enum SyncProtocolErrorType {
  16   // Success case.
  17   SYNC_SUCCESS,
  18
  19   // Birthday does not match that of the server.
  20   NOT_MY_BIRTHDAY,
  21
  22   // Server is busy. Try later.
  23   THROTTLED,
  24
  25   // Clear user data is being currently executed by the server.
  26   CLEAR_PENDING,
  27
  28   // Server cannot service the request now.
  29   TRANSIENT_ERROR,
  30
  31   // Server does not wish the client to retry any more until the action has
  32   // been taken.
  33   NON_RETRIABLE_ERROR,
  34
  35   // Indicates the datatypes have been migrated and the client should resync
  36   // them to get the latest progress markers.
  37   MIGRATION_DONE,
  38
  39   // Invalid Credential.
  40   INVALID_CREDENTIAL,
  41
  42   // An administrator disabled sync for this domain.
  43   DISABLED_BY_ADMIN,
  44
  45   // Client told to stop syncing this device and roll back local data.
  46   USER_ROLLBACK,
  47
  48   // Some of servers are busy. Try later with busy servers.
  49   PARTIAL_FAILURE,
  50
  51   // The default value.
  52   UNKNOWN_ERROR
  53 };
  54
  55 enum ClientAction {
  56   // Upgrade the client to latest version.
  57   UPGRADE_CLIENT,
  58
  59   // Clear user data and setup sync again.
  60   CLEAR_USER_DATA_AND_RESYNC,
  61
  62   // Set the bit on the account to enable sync.
  63   ENABLE_SYNC_ON_ACCOUNT,
  64
  65   // Stop sync and restart sync.
  66   STOP_AND_RESTART_SYNC,
  67
  68   // Wipe this client of any sync data.
  69   DISABLE_SYNC_ON_CLIENT,
  70
  71   // Account is disabled by admin. Stop sync, clear prefs and show message on
  72   // settings page that account is disabled.
  73   STOP_SYNC_FOR_DISABLED_ACCOUNT,
  74
  75   // Disable sync and roll back local model to pre-sync state.
  76   DISABLE_SYNC_AND_ROLLBACK,
  77
  78   // Generated by SyncRollbackManager to notify ProfileSyncService that
  79   // rollback is finished.
  80   ROLLBACK_DONE,
  81
  82   // The default. No action.
  83   UNKNOWN_ACTION
  84 };
  85
  86 struct SYNC_EXPORT SyncProtocolError {
  87   SyncProtocolErrorType error_type;
  88   std::string error_description;
  89   std::string url;
  90   ClientAction action;
  91   ModelTypeSet error_data_types;
  92   SyncProtocolError();
  93   ~SyncProtocolError();
  94   base::DictionaryValue* ToValue() const;
  95 };
  96
  97 SYNC_EXPORT const char* GetSyncErrorTypeString(SyncProtocolErrorType type);
  98 SYNC_EXPORT const char* GetClientActionString(ClientAction action);
  99 }  // namespace syncer
 100 #endif  // SYNC_PROTOCOL_SYNC_PROTOCOL_ERROR_H_
 101