19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.content; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Parcelable; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Parcel; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 2320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Used to record various statistics about the result of a sync operation. The SyncManager 2420c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * gets access to these via a {@link SyncResult} and uses some of them to determine the 2520c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * disposition of the sync. See {@link SyncResult} for further dicussion on how the 2620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * SyncManager uses these values. 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class SyncStats implements Parcelable { 2920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 3020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * The SyncAdapter was unable to authenticate the {@link android.accounts.Account} 3120c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * that was specified in the request. The user needs to take some action to resolve 3220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * before a future request can expect to succeed. This is considered a hard error. 3320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numAuthExceptions; 3520c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 3620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 3720c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * The SyncAdapter had a problem, most likely with the network connectivity or a timeout 3820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * while waiting for a network response. The request may succeed if it is tried again 3920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * later. This is considered a soft error. 4020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numIoExceptions; 4220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 4320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 4420c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * The SyncAdapter had a problem with the data it received from the server or the storage 4520c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * later. This problem will likely repeat if the request is tried again. The problem 4620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * will need to be cleared up by either the server or the storage layer (likely with help 4720c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * from the user). If the SyncAdapter cleans up the data itself then it typically won't 4820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * increment this value although it may still do so in order to record that it had to 4920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * perform some cleanup. E.g., if the SyncAdapter received a bad entry from the server 5020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * when processing a feed of entries, it may choose to drop the entry and thus make 5120c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * progress and still increment this value just so the SyncAdapter can record that an 5220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * error occurred. This is considered a hard error. 5320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numParseExceptions; 5520c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 5620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 5720c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * The SyncAdapter detected that there was an unrecoverable version conflict when it 5820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * attempted to update or delete a version of a resource on the server. This is expected 5920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * to clear itself automatically once the new state is retrieved from the server, 6020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * though it may remain until the user intervenes manually, perhaps by clearing the 6120c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * local storage and starting over frmo scratch. This is considered a hard error. 6220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numConflictDetectedExceptions; 6420c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 6520c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 6620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Counter for tracking how many inserts were performed by the sync operation, as defined 6720c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * by the SyncAdapter. 6820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numInserts; 7020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 7120c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 7220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Counter for tracking how many updates were performed by the sync operation, as defined 7320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * by the SyncAdapter. 7420c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numUpdates; 7620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 7720c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 7820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Counter for tracking how many deletes were performed by the sync operation, as defined 7920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * by the SyncAdapter. 8020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numDeletes; 8220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 8320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 8420c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Counter for tracking how many entries were affected by the sync operation, as defined 8520c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * by the SyncAdapter. 8620c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numEntries; 8820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana 8920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 9020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Counter for tracking how many entries, either from the server or the local store, were 9120c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * ignored during the sync operation. This could happen if the SyncAdapter detected some 9220c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * unparsable data but decided to skip it and move on rather than failing immediately. 9320c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long numSkippedEntries; 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SyncStats() { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numAuthExceptions = 0; 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numIoExceptions = 0; 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numParseExceptions = 0; 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numConflictDetectedExceptions = 0; 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numInserts = 0; 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numUpdates = 0; 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numDeletes = 0; 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numEntries = 0; 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numSkippedEntries = 0; 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SyncStats(Parcel in) { 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numAuthExceptions = in.readLong(); 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numIoExceptions = in.readLong(); 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numParseExceptions = in.readLong(); 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numConflictDetectedExceptions = in.readLong(); 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numInserts = in.readLong(); 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numUpdates = in.readLong(); 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numDeletes = in.readLong(); 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numEntries = in.readLong(); 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numSkippedEntries = in.readLong(); 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringBuilder sb = new StringBuilder(); 12377709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana sb.append(" stats ["); 12477709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numAuthExceptions > 0) sb.append(" numAuthExceptions: ").append(numAuthExceptions); 12577709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numIoExceptions > 0) sb.append(" numIoExceptions: ").append(numIoExceptions); 12677709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numParseExceptions > 0) sb.append(" numParseExceptions: ").append(numParseExceptions); 12777709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numConflictDetectedExceptions > 0) 12877709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana sb.append(" numConflictDetectedExceptions: ").append(numConflictDetectedExceptions); 12977709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numInserts > 0) sb.append(" numInserts: ").append(numInserts); 13077709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numUpdates > 0) sb.append(" numUpdates: ").append(numUpdates); 13177709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numDeletes > 0) sb.append(" numDeletes: ").append(numDeletes); 13277709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numEntries > 0) sb.append(" numEntries: ").append(numEntries); 13377709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana if (numSkippedEntries > 0) sb.append(" numSkippedEntries: ").append(numSkippedEntries); 13477709755b74bcc852cd511ff833c2827c0f0e1aaFred Quintana sb.append("]"); 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sb.toString(); 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13820c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana /** 13920c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana * Reset all the counters to 0. 14020c640e0f4c11f56cb02abaac0a25fe84ebfa487Fred Quintana */ 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void clear() { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numAuthExceptions = 0; 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numIoExceptions = 0; 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numParseExceptions = 0; 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numConflictDetectedExceptions = 0; 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numInserts = 0; 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numUpdates = 0; 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numDeletes = 0; 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numEntries = 0; 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project numSkippedEntries = 0; 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int describeContents() { 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return 0; 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void writeToParcel(Parcel dest, int flags) { 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numAuthExceptions); 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numIoExceptions); 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numParseExceptions); 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numConflictDetectedExceptions); 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numInserts); 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numUpdates); 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numDeletes); 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numEntries); 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(numSkippedEntries); 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Creator<SyncStats> CREATOR = new Creator<SyncStats>() { 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SyncStats createFromParcel(Parcel in) { 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new SyncStats(in); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SyncStats[] newArray(int size) { 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new SyncStats[size]; 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }; 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 179