Settings.java revision 3156bb00dd3ab3d6ec732bb6a64a2e84d08c34f0
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.provider;
18
19import com.google.android.collect.Maps;
20
21import org.apache.commons.codec.binary.Base64;
22
23import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
25import android.content.ContentQueryMap;
26import android.content.ContentResolver;
27import android.content.ContentValues;
28import android.content.Context;
29import android.content.Intent;
30import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Configuration;
33import android.content.res.Resources;
34import android.database.Cursor;
35import android.database.SQLException;
36import android.net.Uri;
37import android.os.*;
38import android.telephony.TelephonyManager;
39import android.text.TextUtils;
40import android.util.AndroidException;
41import android.util.Log;
42
43import java.net.URISyntaxException;
44import java.security.MessageDigest;
45import java.security.NoSuchAlgorithmException;
46import java.util.HashMap;
47import java.util.HashSet;
48
49
50/**
51 * The Settings provider contains global system-level device preferences.
52 */
53public final class Settings {
54
55    // Intent actions for Settings
56
57    /**
58     * Activity Action: Show system settings.
59     * <p>
60     * Input: Nothing.
61     * <p>
62     * Output: nothing.
63     */
64    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
65    public static final String ACTION_SETTINGS = "android.settings.SETTINGS";
66
67    /**
68     * Activity Action: Show settings to allow configuration of APNs.
69     * <p>
70     * Input: Nothing.
71     * <p>
72     * Output: nothing.
73     */
74    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
75    public static final String ACTION_APN_SETTINGS = "android.settings.APN_SETTINGS";
76
77    /**
78     * Activity Action: Show settings to allow configuration of current location
79     * sources.
80     * <p>
81     * In some cases, a matching Activity may not exist, so ensure you
82     * safeguard against this.
83     * <p>
84     * Input: Nothing.
85     * <p>
86     * Output: Nothing.
87     */
88    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
89    public static final String ACTION_LOCATION_SOURCE_SETTINGS =
90            "android.settings.LOCATION_SOURCE_SETTINGS";
91
92    /**
93     * Activity Action: Show settings to allow configuration of wireless controls
94     * such as Wi-Fi, Bluetooth and Mobile networks.
95     * <p>
96     * In some cases, a matching Activity may not exist, so ensure you
97     * safeguard against this.
98     * <p>
99     * Input: Nothing.
100     * <p>
101     * Output: Nothing.
102     */
103    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
104    public static final String ACTION_WIRELESS_SETTINGS =
105            "android.settings.WIRELESS_SETTINGS";
106
107    /**
108     * Activity Action: Show settings to allow entering/exiting airplane mode.
109     * <p>
110     * In some cases, a matching Activity may not exist, so ensure you
111     * safeguard against this.
112     * <p>
113     * Input: Nothing.
114     * <p>
115     * Output: Nothing.
116     */
117    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
118    public static final String ACTION_AIRPLANE_MODE_SETTINGS =
119            "android.settings.AIRPLANE_MODE_SETTINGS";
120
121    /**
122     * Activity Action: Show settings to allow configuration of security and
123     * location privacy.
124     * <p>
125     * In some cases, a matching Activity may not exist, so ensure you
126     * safeguard against this.
127     * <p>
128     * Input: Nothing.
129     * <p>
130     * Output: Nothing.
131     */
132    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
133    public static final String ACTION_SECURITY_SETTINGS =
134            "android.settings.SECURITY_SETTINGS";
135
136    /**
137     * Activity Action: Show settings to allow configuration of Wi-Fi.
138
139     * <p>
140     * In some cases, a matching Activity may not exist, so ensure you
141     * safeguard against this.
142     * <p>
143     * Input: Nothing.
144     * <p>
145     * Output: Nothing.
146
147     */
148    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
149    public static final String ACTION_WIFI_SETTINGS =
150            "android.settings.WIFI_SETTINGS";
151
152    /**
153     * Activity Action: Show settings to allow configuration of a static IP
154     * address for Wi-Fi.
155     * <p>
156     * In some cases, a matching Activity may not exist, so ensure you safeguard
157     * against this.
158     * <p>
159     * Input: Nothing.
160     * <p>
161     * Output: Nothing.
162     */
163    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
164    public static final String ACTION_WIFI_IP_SETTINGS =
165            "android.settings.WIFI_IP_SETTINGS";
166
167    /**
168     * Activity Action: Show settings to allow configuration of Bluetooth.
169     * <p>
170     * In some cases, a matching Activity may not exist, so ensure you
171     * safeguard against this.
172     * <p>
173     * Input: Nothing.
174     * <p>
175     * Output: Nothing.
176     */
177    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
178    public static final String ACTION_BLUETOOTH_SETTINGS =
179            "android.settings.BLUETOOTH_SETTINGS";
180
181    /**
182     * Activity Action: Show settings to allow configuration of date and time.
183     * <p>
184     * In some cases, a matching Activity may not exist, so ensure you
185     * safeguard against this.
186     * <p>
187     * Input: Nothing.
188     * <p>
189     * Output: Nothing.
190     */
191    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
192    public static final String ACTION_DATE_SETTINGS =
193            "android.settings.DATE_SETTINGS";
194
195    /**
196     * Activity Action: Show settings to allow configuration of sound and volume.
197     * <p>
198     * In some cases, a matching Activity may not exist, so ensure you
199     * safeguard against this.
200     * <p>
201     * Input: Nothing.
202     * <p>
203     * Output: Nothing.
204     */
205    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
206    public static final String ACTION_SOUND_SETTINGS =
207            "android.settings.SOUND_SETTINGS";
208
209    /**
210     * Activity Action: Show settings to allow configuration of display.
211     * <p>
212     * In some cases, a matching Activity may not exist, so ensure you
213     * safeguard against this.
214     * <p>
215     * Input: Nothing.
216     * <p>
217     * Output: Nothing.
218     */
219    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
220    public static final String ACTION_DISPLAY_SETTINGS =
221            "android.settings.DISPLAY_SETTINGS";
222
223    /**
224     * Activity Action: Show settings to allow configuration of locale.
225     * <p>
226     * In some cases, a matching Activity may not exist, so ensure you
227     * safeguard against this.
228     * <p>
229     * Input: Nothing.
230     * <p>
231     * Output: Nothing.
232     */
233    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
234    public static final String ACTION_LOCALE_SETTINGS =
235            "android.settings.LOCALE_SETTINGS";
236
237    /**
238     * Activity Action: Show settings to configure input methods, in particular
239     * allowing the user to enable input methods.
240     * <p>
241     * In some cases, a matching Activity may not exist, so ensure you
242     * safeguard against this.
243     * <p>
244     * Input: Nothing.
245     * <p>
246     * Output: Nothing.
247     */
248    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
249    public static final String ACTION_INPUT_METHOD_SETTINGS =
250            "android.settings.INPUT_METHOD_SETTINGS";
251
252    /**
253     * Activity Action: Show settings to manage the user input dictionary.
254     * <p>
255     * In some cases, a matching Activity may not exist, so ensure you
256     * safeguard against this.
257     * <p>
258     * Input: Nothing.
259     * <p>
260     * Output: Nothing.
261     */
262    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
263    public static final String ACTION_USER_DICTIONARY_SETTINGS =
264            "android.settings.USER_DICTIONARY_SETTINGS";
265
266    /**
267     * Activity Action: Show settings to allow configuration of application-related settings.
268     * <p>
269     * In some cases, a matching Activity may not exist, so ensure you
270     * safeguard against this.
271     * <p>
272     * Input: Nothing.
273     * <p>
274     * Output: Nothing.
275     */
276    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
277    public static final String ACTION_APPLICATION_SETTINGS =
278            "android.settings.APPLICATION_SETTINGS";
279
280    /**
281     * Activity Action: Show settings to allow configuration of application
282     * development-related settings.
283     * <p>
284     * In some cases, a matching Activity may not exist, so ensure you safeguard
285     * against this.
286     * <p>
287     * Input: Nothing.
288     * <p>
289     * Output: Nothing.
290     */
291    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
292    public static final String ACTION_APPLICATION_DEVELOPMENT_SETTINGS =
293            "android.settings.APPLICATION_DEVELOPMENT_SETTINGS";
294
295    /**
296     * Activity Action: Show settings to allow configuration of quick launch shortcuts.
297     * <p>
298     * In some cases, a matching Activity may not exist, so ensure you
299     * safeguard against this.
300     * <p>
301     * Input: Nothing.
302     * <p>
303     * Output: Nothing.
304     */
305    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
306    public static final String ACTION_QUICK_LAUNCH_SETTINGS =
307            "android.settings.QUICK_LAUNCH_SETTINGS";
308
309    /**
310     * Activity Action: Show settings to manage installed applications.
311     * <p>
312     * In some cases, a matching Activity may not exist, so ensure you
313     * safeguard against this.
314     * <p>
315     * Input: Nothing.
316     * <p>
317     * Output: Nothing.
318     */
319    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
320    public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS =
321            "android.settings.MANAGE_APPLICATIONS_SETTINGS";
322
323    /**
324     * Activity Action: Show settings for system update functionality.
325     * <p>
326     * In some cases, a matching Activity may not exist, so ensure you
327     * safeguard against this.
328     * <p>
329     * Input: Nothing.
330     * <p>
331     * Output: Nothing.
332     *
333     * @hide
334     */
335    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
336    public static final String ACTION_SYSTEM_UPDATE_SETTINGS =
337            "android.settings.SYSTEM_UPDATE_SETTINGS";
338
339    /**
340     * Activity Action: Show settings to allow configuration of sync settings.
341     * <p>
342     * In some cases, a matching Activity may not exist, so ensure you
343     * safeguard against this.
344     * <p>
345     * Input: Nothing.
346     * <p>
347     * Output: Nothing.
348     */
349    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
350    public static final String ACTION_SYNC_SETTINGS =
351            "android.settings.SYNC_SETTINGS";
352
353    /**
354     * Activity Action: Show settings for selecting the network operator.
355     * <p>
356     * In some cases, a matching Activity may not exist, so ensure you
357     * safeguard against this.
358     * <p>
359     * Input: Nothing.
360     * <p>
361     * Output: Nothing.
362     */
363    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
364    public static final String ACTION_NETWORK_OPERATOR_SETTINGS =
365            "android.settings.NETWORK_OPERATOR_SETTINGS";
366
367    /**
368     * Activity Action: Show settings for selection of 2G/3G.
369     * <p>
370     * In some cases, a matching Activity may not exist, so ensure you
371     * safeguard against this.
372     * <p>
373     * Input: Nothing.
374     * <p>
375     * Output: Nothing.
376     */
377    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
378    public static final String ACTION_DATA_ROAMING_SETTINGS =
379            "android.settings.DATA_ROAMING_SETTINGS";
380
381    /**
382     * Activity Action: Show settings for internal storage.
383     * <p>
384     * In some cases, a matching Activity may not exist, so ensure you
385     * safeguard against this.
386     * <p>
387     * Input: Nothing.
388     * <p>
389     * Output: Nothing.
390     */
391    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
392    public static final String ACTION_INTERNAL_STORAGE_SETTINGS =
393            "android.settings.INTERNAL_STORAGE_SETTINGS";
394    /**
395     * Activity Action: Show settings for memory card storage.
396     * <p>
397     * In some cases, a matching Activity may not exist, so ensure you
398     * safeguard against this.
399     * <p>
400     * Input: Nothing.
401     * <p>
402     * Output: Nothing.
403     */
404    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
405    public static final String ACTION_MEMORY_CARD_SETTINGS =
406            "android.settings.MEMORY_CARD_SETTINGS";
407
408    // End of Intent actions for Settings
409
410    private static final String JID_RESOURCE_PREFIX = "android";
411
412    public static final String AUTHORITY = "settings";
413
414    private static final String TAG = "Settings";
415
416    private static String sJidResource = null;
417
418    public static class SettingNotFoundException extends AndroidException {
419        public SettingNotFoundException(String msg) {
420            super(msg);
421        }
422    }
423
424    /**
425     * Common base for tables of name/value settings.
426     */
427    public static class NameValueTable implements BaseColumns {
428        public static final String NAME = "name";
429        public static final String VALUE = "value";
430
431        protected static boolean putString(ContentResolver resolver, Uri uri,
432                String name, String value) {
433            // The database will take care of replacing duplicates.
434            try {
435                ContentValues values = new ContentValues();
436                values.put(NAME, name);
437                values.put(VALUE, value);
438                resolver.insert(uri, values);
439                return true;
440            } catch (SQLException e) {
441                Log.e(TAG, "Can't set key " + name + " in " + uri, e);
442                return false;
443            }
444        }
445
446        public static Uri getUriFor(Uri uri, String name) {
447            return Uri.withAppendedPath(uri, name);
448        }
449    }
450
451    private static class NameValueCache {
452        private final String mVersionSystemProperty;
453        private final HashMap<String, String> mValues = Maps.newHashMap();
454        private long mValuesVersion = 0;
455        private final Uri mUri;
456
457        NameValueCache(String versionSystemProperty, Uri uri) {
458            mVersionSystemProperty = versionSystemProperty;
459            mUri = uri;
460        }
461
462        String getString(ContentResolver cr, String name) {
463            long newValuesVersion = SystemProperties.getLong(mVersionSystemProperty, 0);
464            if (mValuesVersion != newValuesVersion) {
465                mValues.clear();
466                mValuesVersion = newValuesVersion;
467            }
468            if (!mValues.containsKey(name)) {
469                String value = null;
470                Cursor c = null;
471                try {
472                    c = cr.query(mUri, new String[] { Settings.NameValueTable.VALUE },
473                            Settings.NameValueTable.NAME + "=?", new String[]{name}, null);
474                    if (c != null && c.moveToNext()) value = c.getString(0);
475                    mValues.put(name, value);
476                } catch (SQLException e) {
477                    // SQL error: return null, but don't cache it.
478                    Log.e(TAG, "Can't get key " + name + " from " + mUri, e);
479                } finally {
480                    if (c != null) c.close();
481                }
482                return value;
483            } else {
484                return mValues.get(name);
485            }
486        }
487    }
488
489    /**
490     * System settings, containing miscellaneous system preferences.  This
491     * table holds simple name/value pairs.  There are convenience
492     * functions for accessing individual settings entries.
493     */
494    public static final class System extends NameValueTable {
495        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_system_version";
496
497        private static volatile NameValueCache mNameValueCache = null;
498
499        private static final HashSet<String> MOVED_TO_SECURE;
500        static {
501            MOVED_TO_SECURE = new HashSet<String>(30);
502            MOVED_TO_SECURE.add(Secure.ADB_ENABLED);
503            MOVED_TO_SECURE.add(Secure.ANDROID_ID);
504            MOVED_TO_SECURE.add(Secure.BLUETOOTH_ON);
505            MOVED_TO_SECURE.add(Secure.DATA_ROAMING);
506            MOVED_TO_SECURE.add(Secure.DEVICE_PROVISIONED);
507            MOVED_TO_SECURE.add(Secure.HTTP_PROXY);
508            MOVED_TO_SECURE.add(Secure.INSTALL_NON_MARKET_APPS);
509            MOVED_TO_SECURE.add(Secure.LOCATION_PROVIDERS_ALLOWED);
510            MOVED_TO_SECURE.add(Secure.LOGGING_ID);
511            MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_ENABLED);
512            MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_LAST_UPDATE);
513            MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_REDIRECT_URL);
514            MOVED_TO_SECURE.add(Secure.SETTINGS_CLASSNAME);
515            MOVED_TO_SECURE.add(Secure.USB_MASS_STORAGE_ENABLED);
516            MOVED_TO_SECURE.add(Secure.USE_GOOGLE_MAIL);
517            MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON);
518            MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY);
519            MOVED_TO_SECURE.add(Secure.WIFI_NUM_OPEN_NETWORKS_KEPT);
520            MOVED_TO_SECURE.add(Secure.WIFI_ON);
521            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE);
522            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_AP_COUNT);
523            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS);
524            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED);
525            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS);
526            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT);
527            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_MAX_AP_CHECKS);
528            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ON);
529            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_COUNT);
530            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_DELAY_MS);
531            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS);
532        }
533
534        /**
535         * Look up a name in the database.
536         * @param resolver to access the database with
537         * @param name to look up in the table
538         * @return the corresponding value, or null if not present
539         */
540        public synchronized static String getString(ContentResolver resolver, String name) {
541            if (MOVED_TO_SECURE.contains(name)) {
542                Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
543                        + " to android.provider.Settings.Secure, returning read-only value.");
544                return Secure.getString(resolver, name);
545            }
546            if (mNameValueCache == null) {
547                mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
548            }
549            return mNameValueCache.getString(resolver, name);
550        }
551
552        /**
553         * Store a name/value pair into the database.
554         * @param resolver to access the database with
555         * @param name to store
556         * @param value to associate with the name
557         * @return true if the value was set, false on database errors
558         */
559        public static boolean putString(ContentResolver resolver, String name, String value) {
560            if (MOVED_TO_SECURE.contains(name)) {
561                Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
562                        + " to android.provider.Settings.Secure, value is unchanged.");
563                return false;
564            }
565            return putString(resolver, CONTENT_URI, name, value);
566        }
567
568        /**
569         * Construct the content URI for a particular name/value pair,
570         * useful for monitoring changes with a ContentObserver.
571         * @param name to look up in the table
572         * @return the corresponding content URI, or null if not present
573         */
574        public static Uri getUriFor(String name) {
575            if (MOVED_TO_SECURE.contains(name)) {
576                Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
577                    + " to android.provider.Settings.Secure, returning Secure URI.");
578                return Secure.getUriFor(Secure.CONTENT_URI, name);
579            }
580            return getUriFor(CONTENT_URI, name);
581        }
582
583        /**
584         * Convenience function for retrieving a single system settings value
585         * as an integer.  Note that internally setting values are always
586         * stored as strings; this function converts the string to an integer
587         * for you.  The default value will be returned if the setting is
588         * not defined or not an integer.
589         *
590         * @param cr The ContentResolver to access.
591         * @param name The name of the setting to retrieve.
592         * @param def Value to return if the setting is not defined.
593         *
594         * @return The setting's current value, or 'def' if it is not defined
595         * or not a valid integer.
596         */
597        public static int getInt(ContentResolver cr, String name, int def) {
598            String v = getString(cr, name);
599            try {
600                return v != null ? Integer.parseInt(v) : def;
601            } catch (NumberFormatException e) {
602                return def;
603            }
604        }
605
606        /**
607         * Convenience function for retrieving a single system settings value
608         * as an integer.  Note that internally setting values are always
609         * stored as strings; this function converts the string to an integer
610         * for you.
611         * <p>
612         * This version does not take a default value.  If the setting has not
613         * been set, or the string value is not a number,
614         * it throws {@link SettingNotFoundException}.
615         *
616         * @param cr The ContentResolver to access.
617         * @param name The name of the setting to retrieve.
618         *
619         * @throws SettingNotFoundException Thrown if a setting by the given
620         * name can't be found or the setting value is not an integer.
621         *
622         * @return The setting's current value.
623         */
624        public static int getInt(ContentResolver cr, String name)
625                throws SettingNotFoundException {
626            String v = getString(cr, name);
627            try {
628                return Integer.parseInt(v);
629            } catch (NumberFormatException e) {
630                throw new SettingNotFoundException(name);
631            }
632        }
633
634        /**
635         * Convenience function for updating a single settings value as an
636         * integer. This will either create a new entry in the table if the
637         * given name does not exist, or modify the value of the existing row
638         * with that name.  Note that internally setting values are always
639         * stored as strings, so this function converts the given value to a
640         * string before storing it.
641         *
642         * @param cr The ContentResolver to access.
643         * @param name The name of the setting to modify.
644         * @param value The new value for the setting.
645         * @return true if the value was set, false on database errors
646         */
647        public static boolean putInt(ContentResolver cr, String name, int value) {
648            return putString(cr, name, Integer.toString(value));
649        }
650
651        /**
652         * Convenience function for retrieving a single system settings value
653         * as a {@code long}.  Note that internally setting values are always
654         * stored as strings; this function converts the string to a {@code long}
655         * for you.  The default value will be returned if the setting is
656         * not defined or not a {@code long}.
657         *
658         * @param cr The ContentResolver to access.
659         * @param name The name of the setting to retrieve.
660         * @param def Value to return if the setting is not defined.
661         *
662         * @return The setting's current value, or 'def' if it is not defined
663         * or not a valid {@code long}.
664         */
665        public static long getLong(ContentResolver cr, String name, long def) {
666            String valString = getString(cr, name);
667            long value;
668            try {
669                value = valString != null ? Long.parseLong(valString) : def;
670            } catch (NumberFormatException e) {
671                value = def;
672            }
673            return value;
674        }
675
676        /**
677         * Convenience function for retrieving a single system settings value
678         * as a {@code long}.  Note that internally setting values are always
679         * stored as strings; this function converts the string to a {@code long}
680         * for you.
681         * <p>
682         * This version does not take a default value.  If the setting has not
683         * been set, or the string value is not a number,
684         * it throws {@link SettingNotFoundException}.
685         *
686         * @param cr The ContentResolver to access.
687         * @param name The name of the setting to retrieve.
688         *
689         * @return The setting's current value.
690         * @throws SettingNotFoundException Thrown if a setting by the given
691         * name can't be found or the setting value is not an integer.
692         */
693        public static long getLong(ContentResolver cr, String name)
694                throws SettingNotFoundException {
695            String valString = getString(cr, name);
696            try {
697                return Long.parseLong(valString);
698            } catch (NumberFormatException e) {
699                throw new SettingNotFoundException(name);
700            }
701        }
702
703        /**
704         * Convenience function for updating a single settings value as a long
705         * integer. This will either create a new entry in the table if the
706         * given name does not exist, or modify the value of the existing row
707         * with that name.  Note that internally setting values are always
708         * stored as strings, so this function converts the given value to a
709         * string before storing it.
710         *
711         * @param cr The ContentResolver to access.
712         * @param name The name of the setting to modify.
713         * @param value The new value for the setting.
714         * @return true if the value was set, false on database errors
715         */
716        public static boolean putLong(ContentResolver cr, String name, long value) {
717            return putString(cr, name, Long.toString(value));
718        }
719
720        /**
721         * Convenience function for retrieving a single system settings value
722         * as a floating point number.  Note that internally setting values are
723         * always stored as strings; this function converts the string to an
724         * float for you. The default value will be returned if the setting
725         * is not defined or not a valid float.
726         *
727         * @param cr The ContentResolver to access.
728         * @param name The name of the setting to retrieve.
729         * @param def Value to return if the setting is not defined.
730         *
731         * @return The setting's current value, or 'def' if it is not defined
732         * or not a valid float.
733         */
734        public static float getFloat(ContentResolver cr, String name, float def) {
735            String v = getString(cr, name);
736            try {
737                return v != null ? Float.parseFloat(v) : def;
738            } catch (NumberFormatException e) {
739                return def;
740            }
741        }
742
743        /**
744         * Convenience function for retrieving a single system settings value
745         * as a float.  Note that internally setting values are always
746         * stored as strings; this function converts the string to a float
747         * for you.
748         * <p>
749         * This version does not take a default value.  If the setting has not
750         * been set, or the string value is not a number,
751         * it throws {@link SettingNotFoundException}.
752         *
753         * @param cr The ContentResolver to access.
754         * @param name The name of the setting to retrieve.
755         *
756         * @throws SettingNotFoundException Thrown if a setting by the given
757         * name can't be found or the setting value is not a float.
758         *
759         * @return The setting's current value.
760         */
761        public static float getFloat(ContentResolver cr, String name)
762                throws SettingNotFoundException {
763            String v = getString(cr, name);
764            try {
765                return Float.parseFloat(v);
766            } catch (NumberFormatException e) {
767                throw new SettingNotFoundException(name);
768            }
769        }
770
771        /**
772         * Convenience function for updating a single settings value as a
773         * floating point number. This will either create a new entry in the
774         * table if the given name does not exist, or modify the value of the
775         * existing row with that name.  Note that internally setting values
776         * are always stored as strings, so this function converts the given
777         * value to a string before storing it.
778         *
779         * @param cr The ContentResolver to access.
780         * @param name The name of the setting to modify.
781         * @param value The new value for the setting.
782         * @return true if the value was set, false on database errors
783         */
784        public static boolean putFloat(ContentResolver cr, String name, float value) {
785            return putString(cr, name, Float.toString(value));
786        }
787
788        /**
789         * Convenience function to read all of the current
790         * configuration-related settings into a
791         * {@link Configuration} object.
792         *
793         * @param cr The ContentResolver to access.
794         * @param outConfig Where to place the configuration settings.
795         */
796        public static void getConfiguration(ContentResolver cr, Configuration outConfig) {
797            outConfig.fontScale = Settings.System.getFloat(
798                cr, FONT_SCALE, outConfig.fontScale);
799            if (outConfig.fontScale < 0) {
800                outConfig.fontScale = 1;
801            }
802        }
803
804        /**
805         * Convenience function to write a batch of configuration-related
806         * settings from a {@link Configuration} object.
807         *
808         * @param cr The ContentResolver to access.
809         * @param config The settings to write.
810         * @return true if the values were set, false on database errors
811         */
812        public static boolean putConfiguration(ContentResolver cr, Configuration config) {
813            return Settings.System.putFloat(cr, FONT_SCALE, config.fontScale);
814        }
815
816        public static boolean getShowGTalkServiceStatus(ContentResolver cr) {
817            return getInt(cr, SHOW_GTALK_SERVICE_STATUS, 0) != 0;
818        }
819
820        public static void setShowGTalkServiceStatus(ContentResolver cr, boolean flag) {
821            putInt(cr, SHOW_GTALK_SERVICE_STATUS, flag ? 1 : 0);
822        }
823
824        /**
825         * The content:// style URL for this table
826         */
827        public static final Uri CONTENT_URI =
828            Uri.parse("content://" + AUTHORITY + "/system");
829
830        /**
831         * Whether we keep the device on while the device is plugged in.
832         * Supported values are:
833         * <ul>
834         * <li>{@code 0} to never stay on while plugged in</li>
835         * <li>{@link BatteryManager#BATTERY_PLUGGED_AC} to stay on for AC charger</li>
836         * <li>{@link BatteryManager#BATTERY_PLUGGED_USB} to stay on for USB charger</li>
837         * </ul>
838         * These values can be OR-ed together.
839         */
840        public static final String STAY_ON_WHILE_PLUGGED_IN = "stay_on_while_plugged_in";
841
842        /**
843         * What happens when the user presses the end call button if they're not
844         * on a call.<br/>
845         * <b>Values:</b><br/>
846         * 0 - The end button does nothing.<br/>
847         * 1 - The end button goes to the home screen.<br/>
848         * 2 - The end button puts the device to sleep and locks the keyguard.<br/>
849         * 3 - The end button goes to the home screen.  If the user is already on the
850         * home screen, it puts the device to sleep.
851         */
852        public static final String END_BUTTON_BEHAVIOR = "end_button_behavior";
853
854        /**
855         * Whether Airplane Mode is on.
856         */
857        public static final String AIRPLANE_MODE_ON = "airplane_mode_on";
858
859        /**
860         * Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
861         */
862        public static final String RADIO_BLUETOOTH = "bluetooth";
863
864        /**
865         * Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
866         */
867        public static final String RADIO_WIFI = "wifi";
868
869        /**
870         * Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
871         */
872        public static final String RADIO_CELL = "cell";
873
874        /**
875         * A comma separated list of radios that need to be disabled when airplane mode
876         * is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are
877         * included in the comma separated list.
878         */
879        public static final String AIRPLANE_MODE_RADIOS = "airplane_mode_radios";
880
881        /**
882         * The policy for deciding when Wi-Fi should go to sleep (which will in
883         * turn switch to using the mobile data as an Internet connection).
884         * <p>
885         * Set to one of {@link #WIFI_SLEEP_POLICY_DEFAULT},
886         * {@link #WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED}, or
887         * {@link #WIFI_SLEEP_POLICY_NEVER}.
888         *
889         * @hide pending API council
890         */
891        public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
892
893        /**
894         * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
895         * policy, which is to sleep shortly after the turning off
896         * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
897         *
898         * @hide pending API council
899         */
900        public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
901
902        /**
903         * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
904         * the device is on battery, and never go to sleep when the device is
905         * plugged in.
906         *
907         * @hide pending API council
908         */
909        public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
910
911        /**
912         * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
913         *
914         * @hide pending API council
915         */
916        public static final int WIFI_SLEEP_POLICY_NEVER = 2;
917
918        /**
919         * Whether to use static IP and other static network attributes.
920         * <p>
921         * Set to 1 for true and 0 for false.
922         */
923        public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
924
925        /**
926         * The static IP address.
927         * <p>
928         * Example: "192.168.1.51"
929         */
930        public static final String WIFI_STATIC_IP = "wifi_static_ip";
931
932        /**
933         * If using static IP, the gateway's IP address.
934         * <p>
935         * Example: "192.168.1.1"
936         */
937        public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
938
939        /**
940         * If using static IP, the net mask.
941         * <p>
942         * Example: "255.255.255.0"
943         */
944        public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
945
946        /**
947         * If using static IP, the primary DNS's IP address.
948         * <p>
949         * Example: "192.168.1.1"
950         */
951        public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
952
953        /**
954         * If using static IP, the secondary DNS's IP address.
955         * <p>
956         * Example: "192.168.1.2"
957         */
958        public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
959
960        /**
961         * The number of radio channels that are allowed in the local
962         * 802.11 regulatory domain.
963         * @hide
964         */
965        public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
966
967        /**
968         * Determines whether remote devices may discover and/or connect to
969         * this device.
970         * <P>Type: INT</P>
971         * 2 -- discoverable and connectable
972         * 1 -- connectable but not discoverable
973         * 0 -- neither connectable nor discoverable
974         */
975        public static final String BLUETOOTH_DISCOVERABILITY =
976            "bluetooth_discoverability";
977
978        /**
979         * Bluetooth discoverability timeout.  If this value is nonzero, then
980         * Bluetooth becomes discoverable for a certain number of seconds,
981         * after which is becomes simply connectable.  The value is in seconds.
982         */
983        public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
984            "bluetooth_discoverability_timeout";
985
986        /**
987         * Whether autolock is enabled (0 = false, 1 = true)
988         */
989        public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
990
991        /**
992         * Whether lock pattern is visible as user enters (0 = false, 1 = true)
993         */
994        public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
995
996        /**
997         * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
998         */
999        public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
1000            "lock_pattern_tactile_feedback_enabled";
1001
1002
1003        /**
1004         * A formatted string of the next alarm that is set, or the empty string
1005         * if there is no alarm set.
1006         */
1007        public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1008
1009        /**
1010         * Scaling factor for fonts, float.
1011         */
1012        public static final String FONT_SCALE = "font_scale";
1013
1014        /**
1015         * Name of an application package to be debugged.
1016         */
1017        public static final String DEBUG_APP = "debug_app";
1018
1019        /**
1020         * If 1, when launching DEBUG_APP it will wait for the debugger before
1021         * starting user code.  If 0, it will run normally.
1022         */
1023        public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1024
1025        /**
1026         * Whether or not to dim the screen. 0=no  1=yes
1027         */
1028        public static final String DIM_SCREEN = "dim_screen";
1029
1030        /**
1031         * The timeout before the screen turns off.
1032         */
1033        public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1034
1035        /**
1036         * The screen backlight brightness between 0 and 255.
1037         */
1038        public static final String SCREEN_BRIGHTNESS = "screen_brightness";
1039
1040        /**
1041         * Control whether the process CPU usage meter should be shown.
1042         */
1043        public static final String SHOW_PROCESSES = "show_processes";
1044
1045        /**
1046         * If 1, the activity manager will aggressively finish activities and
1047         * processes as soon as they are no longer needed.  If 0, the normal
1048         * extended lifetime is used.
1049         */
1050        public static final String ALWAYS_FINISH_ACTIVITIES =
1051                "always_finish_activities";
1052
1053
1054        /**
1055         * Ringer mode. This is used internally, changing this value will not
1056         * change the ringer mode. See AudioManager.
1057         */
1058        public static final String MODE_RINGER = "mode_ringer";
1059
1060        /**
1061         * Determines which streams are affected by ringer mode changes. The
1062         * stream type's bit should be set to 1 if it should be muted when going
1063         * into an inaudible ringer mode.
1064         */
1065        public static final String MODE_RINGER_STREAMS_AFFECTED = "mode_ringer_streams_affected";
1066
1067         /**
1068          * Determines which streams are affected by mute. The
1069          * stream type's bit should be set to 1 if it should be muted when a mute request
1070          * is received.
1071          */
1072         public static final String MUTE_STREAMS_AFFECTED = "mute_streams_affected";
1073
1074        /**
1075         * Whether vibrate is on for different events. This is used internally,
1076         * changing this value will not change the vibrate. See AudioManager.
1077         */
1078        public static final String VIBRATE_ON = "vibrate_on";
1079
1080        /**
1081         * Ringer volume. This is used internally, changing this value will not
1082         * change the volume. See AudioManager.
1083         */
1084        public static final String VOLUME_RING = "volume_ring";
1085
1086        /**
1087         * System/notifications volume. This is used internally, changing this
1088         * value will not change the volume. See AudioManager.
1089         */
1090        public static final String VOLUME_SYSTEM = "volume_system";
1091
1092        /**
1093         * Voice call volume. This is used internally, changing this value will
1094         * not change the volume. See AudioManager.
1095         */
1096        public static final String VOLUME_VOICE = "volume_voice";
1097
1098        /**
1099         * Music/media/gaming volume. This is used internally, changing this
1100         * value will not change the volume. See AudioManager.
1101         */
1102        public static final String VOLUME_MUSIC = "volume_music";
1103
1104        /**
1105         * Alarm volume. This is used internally, changing this
1106         * value will not change the volume. See AudioManager.
1107         */
1108        public static final String VOLUME_ALARM = "volume_alarm";
1109
1110        /**
1111         * Notification volume. This is used internally, changing this
1112         * value will not change the volume. See AudioManager.
1113         */
1114        public static final String VOLUME_NOTIFICATION = "volume_notification";
1115
1116        /**
1117         * Whether the notifications should use the ring volume (value of 1) or
1118         * a separate notification volume (value of 0). In most cases, users
1119         * will have this enabled so the notification and ringer volumes will be
1120         * the same. However, power users can disable this and use the separate
1121         * notification volume control.
1122         * <p>
1123         * Note: This is a one-off setting that will be removed in the future
1124         * when there is profile support. For this reason, it is kept hidden
1125         * from the public APIs.
1126         *
1127         * @hide
1128         */
1129        public static final String NOTIFICATIONS_USE_RING_VOLUME =
1130            "notifications_use_ring_volume";
1131
1132        /**
1133         * The mapping of stream type (integer) to its setting.
1134         */
1135        public static final String[] VOLUME_SETTINGS = {
1136            VOLUME_VOICE, VOLUME_SYSTEM, VOLUME_RING, VOLUME_MUSIC,
1137            VOLUME_ALARM, VOLUME_NOTIFICATION
1138        };
1139
1140        /**
1141         * Appended to various volume related settings to record the previous
1142         * values before they the settings were affected by a silent/vibrate
1143         * ringer mode change.
1144         */
1145        public static final String APPEND_FOR_LAST_AUDIBLE = "_last_audible";
1146
1147        /**
1148         * Persistent store for the system-wide default ringtone URI.
1149         * <p>
1150         * If you need to play the default ringtone at any given time, it is recommended
1151         * you give {@link #DEFAULT_RINGTONE_URI} to the media player.  It will resolve
1152         * to the set default ringtone at the time of playing.
1153         *
1154         * @see #DEFAULT_RINGTONE_URI
1155         */
1156        public static final String RINGTONE = "ringtone";
1157
1158        /**
1159         * A {@link Uri} that will point to the current default ringtone at any
1160         * given time.
1161         * <p>
1162         * If the current default ringtone is in the DRM provider and the caller
1163         * does not have permission, the exception will be a
1164         * FileNotFoundException.
1165         */
1166        public static final Uri DEFAULT_RINGTONE_URI = getUriFor(RINGTONE);
1167
1168        /**
1169         * Persistent store for the system-wide default notification sound.
1170         *
1171         * @see #RINGTONE
1172         * @see #DEFAULT_NOTIFICATION_URI
1173         */
1174        public static final String NOTIFICATION_SOUND = "notification_sound";
1175
1176        /**
1177         * A {@link Uri} that will point to the current default notification
1178         * sound at any given time.
1179         *
1180         * @see #DEFAULT_RINGTONE_URI
1181         */
1182        public static final Uri DEFAULT_NOTIFICATION_URI = getUriFor(NOTIFICATION_SOUND);
1183
1184        /**
1185         * Persistent store for the system-wide default alarm alert.
1186         *
1187         * @see #RINGTONE
1188         * @see #DEFAULT_ALARM_ALERT_URI
1189         */
1190        public static final String ALARM_ALERT = "alarm_alert";
1191
1192        /**
1193         * A {@link Uri} that will point to the current default alarm alert at
1194         * any given time.
1195         *
1196         * @see #DEFAULT_ALARM_ALERT_URI
1197         */
1198        public static final Uri DEFAULT_ALARM_ALERT_URI = getUriFor(ALARM_ALERT);
1199
1200        /**
1201         * Setting to enable Auto Replace (AutoText) in text editors. 1 = On, 0 = Off
1202         */
1203        public static final String TEXT_AUTO_REPLACE = "auto_replace";
1204
1205        /**
1206         * Setting to enable Auto Caps in text editors. 1 = On, 0 = Off
1207         */
1208        public static final String TEXT_AUTO_CAPS = "auto_caps";
1209
1210        /**
1211         * Setting to enable Auto Punctuate in text editors. 1 = On, 0 = Off. This
1212         * feature converts two spaces to a "." and space.
1213         */
1214        public static final String TEXT_AUTO_PUNCTUATE = "auto_punctuate";
1215
1216        /**
1217         * Setting to showing password characters in text editors. 1 = On, 0 = Off
1218         */
1219        public static final String TEXT_SHOW_PASSWORD = "show_password";
1220
1221        public static final String SHOW_GTALK_SERVICE_STATUS =
1222                "SHOW_GTALK_SERVICE_STATUS";
1223
1224        /**
1225         * Name of activity to use for wallpaper on the home screen.
1226         */
1227        public static final String WALLPAPER_ACTIVITY = "wallpaper_activity";
1228
1229        /**
1230         * Value to specify if the user prefers the date, time and time zone
1231         * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1232         */
1233        public static final String AUTO_TIME = "auto_time";
1234
1235        /**
1236         * Display times as 12 or 24 hours
1237         *   12
1238         *   24
1239         */
1240        public static final String TIME_12_24 = "time_12_24";
1241
1242        /**
1243         * Date format string
1244         *   mm/dd/yyyy
1245         *   dd/mm/yyyy
1246         *   yyyy/mm/dd
1247         */
1248        public static final String DATE_FORMAT = "date_format";
1249
1250        /**
1251         * Whether the setup wizard has been run before (on first boot), or if
1252         * it still needs to be run.
1253         *
1254         * nonzero = it has been run in the past
1255         * 0 = it has not been run in the past
1256         */
1257        public static final String SETUP_WIZARD_HAS_RUN = "setup_wizard_has_run";
1258
1259        /**
1260         * Scaling factor for normal window animations. Setting to 0 will disable window
1261         * animations.
1262         */
1263        public static final String WINDOW_ANIMATION_SCALE = "window_animation_scale";
1264
1265        /**
1266         * Scaling factor for activity transition animations. Setting to 0 will disable window
1267         * animations.
1268         */
1269        public static final String TRANSITION_ANIMATION_SCALE = "transition_animation_scale";
1270
1271        /**
1272         * Scaling factor for normal window animations. Setting to 0 will disable window
1273         * animations.
1274         * @hide
1275         */
1276        public static final String FANCY_IME_ANIMATIONS = "fancy_ime_animations";
1277
1278        /**
1279         * Control whether the accelerometer will be used to change screen
1280         * orientation.  If 0, it will not be used unless explicitly requested
1281         * by the application; if 1, it will be used by default unless explicitly
1282         * disabled by the application.
1283         */
1284        public static final String ACCELEROMETER_ROTATION = "accelerometer_rotation";
1285
1286        /**
1287         * Whether the audible DTMF tones are played by the dialer when dialing. The value is
1288         * boolean (1 or 0).
1289         */
1290        public static final String DTMF_TONE_WHEN_DIALING = "dtmf_tone";
1291
1292        /**
1293         * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1294         * boolean (1 or 0).
1295         */
1296        public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
1297
1298        /**
1299         * Whether the haptic feedback (long presses, ...) are enabled. The value is
1300         * boolean (1 or 0).
1301         */
1302        public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
1303
1304        // Settings moved to Settings.Secure
1305
1306        /**
1307         * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
1308         * instead
1309         */
1310        @Deprecated
1311        public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1312
1313        /**
1314         * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1315         */
1316        @Deprecated
1317        public static final String ANDROID_ID = Secure.ANDROID_ID;
1318
1319        /**
1320         * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1321         */
1322        @Deprecated
1323        public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1324
1325        /**
1326         * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1327         */
1328        @Deprecated
1329        public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1330
1331        /**
1332         * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1333         */
1334        @Deprecated
1335        public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1336
1337        /**
1338         * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1339         */
1340        @Deprecated
1341        public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1342
1343        /**
1344         * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1345         */
1346        @Deprecated
1347        public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
1348
1349        /**
1350         * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1351         * instead
1352         */
1353        @Deprecated
1354        public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1355
1356        /**
1357         * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1358         */
1359        @Deprecated
1360        public static final String LOGGING_ID = Secure.LOGGING_ID;
1361
1362        /**
1363         * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1364         */
1365        @Deprecated
1366        public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1367
1368        /**
1369         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1370         * instead
1371         */
1372        @Deprecated
1373        public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1374
1375        /**
1376         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1377         * instead
1378         */
1379        @Deprecated
1380        public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1381
1382        /**
1383         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1384         * instead
1385         */
1386        @Deprecated
1387        public static final String PARENTAL_CONTROL_REDIRECT_URL =
1388            Secure.PARENTAL_CONTROL_REDIRECT_URL;
1389
1390        /**
1391         * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1392         */
1393        @Deprecated
1394        public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1395
1396        /**
1397         * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1398         */
1399        @Deprecated
1400        public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
1401
1402        /**
1403         * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1404         */
1405        @Deprecated
1406        public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1407
1408//       /**
1409//         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT}
1410//         * instead
1411//         */
1412        @Deprecated
1413        public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1414
1415//        /**
1416//         * @deprecated Use
1417//         * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS}
1418//         * instead
1419//         */
1420        @Deprecated
1421        public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1422                Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1423
1424        /**
1425         * @deprecated Use
1426         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1427         */
1428        @Deprecated
1429        public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1430            Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1431
1432        /**
1433         * @deprecated Use
1434         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
1435         */
1436        @Deprecated
1437        public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1438            Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
1439
1440        /**
1441         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
1442         * instead
1443         */
1444        @Deprecated
1445        public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
1446
1447        /**
1448         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
1449         */
1450        @Deprecated
1451        public static final String WIFI_ON = Secure.WIFI_ON;
1452
1453        /**
1454         * @deprecated Use
1455         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
1456         * instead
1457         */
1458        @Deprecated
1459        public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1460                Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
1461
1462        /**
1463         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
1464         */
1465        @Deprecated
1466        public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
1467
1468        /**
1469         * @deprecated Use
1470         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
1471         */
1472        @Deprecated
1473        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1474                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
1475
1476        /**
1477         * @deprecated Use
1478         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
1479         */
1480        @Deprecated
1481        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1482                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
1483
1484        /**
1485         * @deprecated Use
1486         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
1487         * instead
1488         */
1489        @Deprecated
1490        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1491                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
1492
1493        /**
1494         * @deprecated Use
1495         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
1496         */
1497        @Deprecated
1498        public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1499            Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
1500
1501        /**
1502         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
1503         * instead
1504         */
1505        @Deprecated
1506        public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
1507
1508        /**
1509         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
1510         */
1511        @Deprecated
1512        public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
1513
1514        /**
1515         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
1516         */
1517        @Deprecated
1518        public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
1519
1520        /**
1521         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
1522         * instead
1523         */
1524        @Deprecated
1525        public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
1526
1527        /**
1528         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
1529         * instead
1530         */
1531        @Deprecated
1532        public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
1533            Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
1534    }
1535
1536    /**
1537     * Secure system settings, containing system preferences that applications
1538     * can read but are not allowed to write.  These are for preferences that
1539     * the user must explicitly modify through the system UI or specialized
1540     * APIs for those values, not modified directly by applications.
1541     */
1542    public static final class Secure extends NameValueTable {
1543        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
1544
1545        private static volatile NameValueCache mNameValueCache = null;
1546
1547        /**
1548         * Look up a name in the database.
1549         * @param resolver to access the database with
1550         * @param name to look up in the table
1551         * @return the corresponding value, or null if not present
1552         */
1553        public synchronized static String getString(ContentResolver resolver, String name) {
1554            if (mNameValueCache == null) {
1555                mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
1556            }
1557            return mNameValueCache.getString(resolver, name);
1558        }
1559
1560        /**
1561         * Store a name/value pair into the database.
1562         * @param resolver to access the database with
1563         * @param name to store
1564         * @param value to associate with the name
1565         * @return true if the value was set, false on database errors
1566         */
1567        public static boolean putString(ContentResolver resolver,
1568                String name, String value) {
1569            return putString(resolver, CONTENT_URI, name, value);
1570        }
1571
1572        /**
1573         * Construct the content URI for a particular name/value pair,
1574         * useful for monitoring changes with a ContentObserver.
1575         * @param name to look up in the table
1576         * @return the corresponding content URI, or null if not present
1577         */
1578        public static Uri getUriFor(String name) {
1579            return getUriFor(CONTENT_URI, name);
1580        }
1581
1582        /**
1583         * Convenience function for retrieving a single secure settings value
1584         * as an integer.  Note that internally setting values are always
1585         * stored as strings; this function converts the string to an integer
1586         * for you.  The default value will be returned if the setting is
1587         * not defined or not an integer.
1588         *
1589         * @param cr The ContentResolver to access.
1590         * @param name The name of the setting to retrieve.
1591         * @param def Value to return if the setting is not defined.
1592         *
1593         * @return The setting's current value, or 'def' if it is not defined
1594         * or not a valid integer.
1595         */
1596        public static int getInt(ContentResolver cr, String name, int def) {
1597            String v = getString(cr, name);
1598            try {
1599                return v != null ? Integer.parseInt(v) : def;
1600            } catch (NumberFormatException e) {
1601                return def;
1602            }
1603        }
1604
1605        /**
1606         * Convenience function for retrieving a single secure settings value
1607         * as an integer.  Note that internally setting values are always
1608         * stored as strings; this function converts the string to an integer
1609         * for you.
1610         * <p>
1611         * This version does not take a default value.  If the setting has not
1612         * been set, or the string value is not a number,
1613         * it throws {@link SettingNotFoundException}.
1614         *
1615         * @param cr The ContentResolver to access.
1616         * @param name The name of the setting to retrieve.
1617         *
1618         * @throws SettingNotFoundException Thrown if a setting by the given
1619         * name can't be found or the setting value is not an integer.
1620         *
1621         * @return The setting's current value.
1622         */
1623        public static int getInt(ContentResolver cr, String name)
1624                throws SettingNotFoundException {
1625            String v = getString(cr, name);
1626            try {
1627                return Integer.parseInt(v);
1628            } catch (NumberFormatException e) {
1629                throw new SettingNotFoundException(name);
1630            }
1631        }
1632
1633        /**
1634         * Convenience function for updating a single settings value as an
1635         * integer. This will either create a new entry in the table if the
1636         * given name does not exist, or modify the value of the existing row
1637         * with that name.  Note that internally setting values are always
1638         * stored as strings, so this function converts the given value to a
1639         * string before storing it.
1640         *
1641         * @param cr The ContentResolver to access.
1642         * @param name The name of the setting to modify.
1643         * @param value The new value for the setting.
1644         * @return true if the value was set, false on database errors
1645         */
1646        public static boolean putInt(ContentResolver cr, String name, int value) {
1647            return putString(cr, name, Integer.toString(value));
1648        }
1649
1650        /**
1651         * Convenience function for retrieving a single secure settings value
1652         * as a {@code long}.  Note that internally setting values are always
1653         * stored as strings; this function converts the string to a {@code long}
1654         * for you.  The default value will be returned if the setting is
1655         * not defined or not a {@code long}.
1656         *
1657         * @param cr The ContentResolver to access.
1658         * @param name The name of the setting to retrieve.
1659         * @param def Value to return if the setting is not defined.
1660         *
1661         * @return The setting's current value, or 'def' if it is not defined
1662         * or not a valid {@code long}.
1663         */
1664        public static long getLong(ContentResolver cr, String name, long def) {
1665            String valString = getString(cr, name);
1666            long value;
1667            try {
1668                value = valString != null ? Long.parseLong(valString) : def;
1669            } catch (NumberFormatException e) {
1670                value = def;
1671            }
1672            return value;
1673        }
1674
1675        /**
1676         * Convenience function for retrieving a single secure settings value
1677         * as a {@code long}.  Note that internally setting values are always
1678         * stored as strings; this function converts the string to a {@code long}
1679         * for you.
1680         * <p>
1681         * This version does not take a default value.  If the setting has not
1682         * been set, or the string value is not a number,
1683         * it throws {@link SettingNotFoundException}.
1684         *
1685         * @param cr The ContentResolver to access.
1686         * @param name The name of the setting to retrieve.
1687         *
1688         * @return The setting's current value.
1689         * @throws SettingNotFoundException Thrown if a setting by the given
1690         * name can't be found or the setting value is not an integer.
1691         */
1692        public static long getLong(ContentResolver cr, String name)
1693                throws SettingNotFoundException {
1694            String valString = getString(cr, name);
1695            try {
1696                return Long.parseLong(valString);
1697            } catch (NumberFormatException e) {
1698                throw new SettingNotFoundException(name);
1699            }
1700        }
1701
1702        /**
1703         * Convenience function for updating a secure settings value as a long
1704         * integer. This will either create a new entry in the table if the
1705         * given name does not exist, or modify the value of the existing row
1706         * with that name.  Note that internally setting values are always
1707         * stored as strings, so this function converts the given value to a
1708         * string before storing it.
1709         *
1710         * @param cr The ContentResolver to access.
1711         * @param name The name of the setting to modify.
1712         * @param value The new value for the setting.
1713         * @return true if the value was set, false on database errors
1714         */
1715        public static boolean putLong(ContentResolver cr, String name, long value) {
1716            return putString(cr, name, Long.toString(value));
1717        }
1718
1719        /**
1720         * Convenience function for retrieving a single secure settings value
1721         * as a floating point number.  Note that internally setting values are
1722         * always stored as strings; this function converts the string to an
1723         * float for you. The default value will be returned if the setting
1724         * is not defined or not a valid float.
1725         *
1726         * @param cr The ContentResolver to access.
1727         * @param name The name of the setting to retrieve.
1728         * @param def Value to return if the setting is not defined.
1729         *
1730         * @return The setting's current value, or 'def' if it is not defined
1731         * or not a valid float.
1732         */
1733        public static float getFloat(ContentResolver cr, String name, float def) {
1734            String v = getString(cr, name);
1735            try {
1736                return v != null ? Float.parseFloat(v) : def;
1737            } catch (NumberFormatException e) {
1738                return def;
1739            }
1740        }
1741
1742        /**
1743         * Convenience function for retrieving a single secure settings value
1744         * as a float.  Note that internally setting values are always
1745         * stored as strings; this function converts the string to a float
1746         * for you.
1747         * <p>
1748         * This version does not take a default value.  If the setting has not
1749         * been set, or the string value is not a number,
1750         * it throws {@link SettingNotFoundException}.
1751         *
1752         * @param cr The ContentResolver to access.
1753         * @param name The name of the setting to retrieve.
1754         *
1755         * @throws SettingNotFoundException Thrown if a setting by the given
1756         * name can't be found or the setting value is not a float.
1757         *
1758         * @return The setting's current value.
1759         */
1760        public static float getFloat(ContentResolver cr, String name)
1761                throws SettingNotFoundException {
1762            String v = getString(cr, name);
1763            try {
1764                return Float.parseFloat(v);
1765            } catch (NumberFormatException e) {
1766                throw new SettingNotFoundException(name);
1767            }
1768        }
1769
1770        /**
1771         * Convenience function for updating a single settings value as a
1772         * floating point number. This will either create a new entry in the
1773         * table if the given name does not exist, or modify the value of the
1774         * existing row with that name.  Note that internally setting values
1775         * are always stored as strings, so this function converts the given
1776         * value to a string before storing it.
1777         *
1778         * @param cr The ContentResolver to access.
1779         * @param name The name of the setting to modify.
1780         * @param value The new value for the setting.
1781         * @return true if the value was set, false on database errors
1782         */
1783        public static boolean putFloat(ContentResolver cr, String name, float value) {
1784            return putString(cr, name, Float.toString(value));
1785        }
1786
1787        /**
1788         * The content:// style URL for this table
1789         */
1790        public static final Uri CONTENT_URI =
1791            Uri.parse("content://" + AUTHORITY + "/secure");
1792
1793        /**
1794         * Whether ADB is enabled.
1795         */
1796        public static final String ADB_ENABLED = "adb_enabled";
1797
1798        /**
1799         * Setting to allow mock locations and location provider status to be injected into the
1800         * LocationManager service for testing purposes during application development.  These
1801         * locations and status values  override actual location and status information generated
1802         * by network, gps, or other location providers.
1803         */
1804        public static final String ALLOW_MOCK_LOCATION = "mock_location";
1805
1806        /**
1807         * The Android ID (a unique 64-bit value) as a hex string.
1808         * Identical to that obtained by calling
1809         * GoogleLoginService.getAndroidId(); it is also placed here
1810         * so you can get it without binding to a service.
1811         */
1812        public static final String ANDROID_ID = "android_id";
1813
1814        /**
1815         * Whether bluetooth is enabled/disabled
1816         * 0=disabled. 1=enabled.
1817         */
1818        public static final String BLUETOOTH_ON = "bluetooth_on";
1819
1820        /**
1821         * Get the key that retrieves a bluetooth headset's priority.
1822         * @hide
1823         */
1824        public static final String getBluetoothHeadsetPriorityKey(String address) {
1825            return ("bluetooth_headset_priority_" + address.toUpperCase());
1826        }
1827
1828        /**
1829         * Get the key that retrieves a bluetooth a2dp sink's priority.
1830         * @hide
1831         */
1832        public static final String getBluetoothA2dpSinkPriorityKey(String address) {
1833            return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
1834        }
1835
1836        /**
1837         * Whether or not data roaming is enabled. (0 = false, 1 = true)
1838         */
1839        public static final String DATA_ROAMING = "data_roaming";
1840
1841        /**
1842         * Setting to record the input method used by default, holding the ID
1843         * of the desired method.
1844         */
1845        public static final String DEFAULT_INPUT_METHOD = "default_input_method";
1846
1847        /**
1848         * Whether the device has been provisioned (0 = false, 1 = true)
1849         */
1850        public static final String DEVICE_PROVISIONED = "device_provisioned";
1851
1852        /**
1853         * List of input methods that are currently enabled.  This is a string
1854         * containing the IDs of all enabled input methods, each ID separated
1855         * by ':'.
1856         */
1857        public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
1858
1859        /**
1860         * Host name and port for a user-selected proxy.
1861         */
1862        public static final String HTTP_PROXY = "http_proxy";
1863
1864        /**
1865         * Whether the package installer should allow installation of apps downloaded from
1866         * sources other than the Android Market (vending machine).
1867         *
1868         * 1 = allow installing from other sources
1869         * 0 = only allow installing from the Android Market
1870         */
1871        public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
1872
1873        /**
1874         * Comma-separated list of location providers that activities may access.
1875         */
1876        public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
1877
1878        /**
1879         * The Logging ID (a unique 64-bit value) as a hex string.
1880         * Used as a pseudonymous identifier for logging.
1881         * @deprecated This identifier is poorly initialized and has
1882         * many collisions.  It should not be used.
1883         */
1884        @Deprecated
1885        public static final String LOGGING_ID = "logging_id";
1886
1887        /**
1888         * The Logging ID (a unique 64-bit value) as a hex string.
1889         * Used as a pseudonymous identifier for logging.
1890         * @hide
1891         */
1892        public static final String LOGGING_ID2 = "logging_id2";
1893
1894        /**
1895         * User preference for which network(s) should be used. Only the
1896         * connectivity service should touch this.
1897         */
1898        public static final String NETWORK_PREFERENCE = "network_preference";
1899
1900        /**
1901         */
1902        public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
1903
1904        /**
1905         */
1906        public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
1907
1908        /**
1909         */
1910        public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
1911
1912        /**
1913         * Settings classname to launch when Settings is clicked from All
1914         * Applications.  Needed because of user testing between the old
1915         * and new Settings apps.
1916         */
1917        // TODO: 881807
1918        public static final String SETTINGS_CLASSNAME = "settings_classname";
1919
1920        /**
1921         * USB Mass Storage Enabled
1922         */
1923        public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
1924
1925        /**
1926         * If this setting is set (to anything), then all references
1927         * to Gmail on the device must change to Google Mail.
1928         */
1929        public static final String USE_GOOGLE_MAIL = "use_google_mail";
1930
1931        /**
1932         * Whether to notify the user of open networks.
1933         * <p>
1934         * If not connected and the scan results have an open network, we will
1935         * put this notification up. If we attempt to connect to a network or
1936         * the open network(s) disappear, we remove the notification. When we
1937         * show the notification, we will not show it again for
1938         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
1939         */
1940        public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1941                "wifi_networks_available_notification_on";
1942
1943        /**
1944         * Delay (in seconds) before repeating the Wi-Fi networks available notification.
1945         * Connecting to a network will reset the timer.
1946         */
1947        public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1948                "wifi_networks_available_repeat_delay";
1949
1950        /**
1951         * The number of radio channels that are allowed in the local
1952         * 802.11 regulatory domain.
1953         * @hide
1954         */
1955        public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
1956
1957        /**
1958         * When the number of open networks exceeds this number, the
1959         * least-recently-used excess networks will be removed.
1960         */
1961        public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
1962
1963        /**
1964         * Whether the Wi-Fi should be on.  Only the Wi-Fi service should touch this.
1965         */
1966        public static final String WIFI_ON = "wifi_on";
1967
1968        /**
1969         * The acceptable packet loss percentage (range 0 - 100) before trying
1970         * another AP on the same network.
1971         */
1972        public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1973                "wifi_watchdog_acceptable_packet_loss_percentage";
1974
1975        /**
1976         * The number of access points required for a network in order for the
1977         * watchdog to monitor it.
1978         */
1979        public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
1980
1981        /**
1982         * The delay between background checks.
1983         */
1984        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1985                "wifi_watchdog_background_check_delay_ms";
1986
1987        /**
1988         * Whether the Wi-Fi watchdog is enabled for background checking even
1989         * after it thinks the user has connected to a good access point.
1990         */
1991        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1992                "wifi_watchdog_background_check_enabled";
1993
1994        /**
1995         * The timeout for a background ping
1996         */
1997        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1998                "wifi_watchdog_background_check_timeout_ms";
1999
2000        /**
2001         * The number of initial pings to perform that *may* be ignored if they
2002         * fail. Again, if these fail, they will *not* be used in packet loss
2003         * calculation. For example, one network always seemed to time out for
2004         * the first couple pings, so this is set to 3 by default.
2005         */
2006        public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2007            "wifi_watchdog_initial_ignored_ping_count";
2008
2009        /**
2010         * The maximum number of access points (per network) to attempt to test.
2011         * If this number is reached, the watchdog will no longer monitor the
2012         * initial connection state for the network. This is a safeguard for
2013         * networks containing multiple APs whose DNS does not respond to pings.
2014         */
2015        public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
2016
2017        /**
2018         * Whether the Wi-Fi watchdog is enabled.
2019         */
2020        public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2021
2022        /**
2023         * A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.
2024         * @hide pending API council
2025         */
2026        public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2027
2028        /**
2029         * The number of pings to test if an access point is a good connection.
2030         */
2031        public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
2032
2033        /**
2034         * The delay between pings.
2035         */
2036        public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
2037
2038        /**
2039         * The timeout per ping.
2040         */
2041        public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
2042
2043        /**
2044         * The maximum number of times we will retry a connection to an access
2045         * point for which we have failed in acquiring an IP address from DHCP.
2046         * A value of N means that we will make N+1 connection attempts in all.
2047         *
2048         * @hide pending API Council approval
2049         */
2050        public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
2051
2052        /**
2053         * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2054         * data connectivity to be established after a disconnect from Wi-Fi.
2055         *
2056         * @hide pending API Council approval
2057         */
2058        public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2059            "wifi_mobile_data_transition_wakelock_timeout_ms";
2060
2061        /**
2062         * Whether background data usage is allowed by the user. See
2063         * ConnectivityManager for more info.
2064         *
2065         * @hide pending API council
2066         */
2067        public static final String BACKGROUND_DATA = "background_data";
2068
2069        /**
2070         * The CDMA roaming mode 0 = Home Networks, CDMA default
2071         *                       1 = Roaming on Affiliated networks
2072         *                       2 = Roaming on any networks
2073         * @hide
2074         */
2075        public static final String CDMA_ROAMING_MODE = "roaming_settings";
2076
2077        /**
2078         * The CDMA subscription mode 0 = RUIM/SIM (default)
2079         *                                1 = NV
2080         * @hide
2081         */
2082        public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2083
2084        /**
2085         * represents current active phone class
2086         * 1 = GSM-Phone, 0 = CDMA-Phone
2087         * @hide
2088         */
2089        public static final String CURRENT_ACTIVE_PHONE = "current_active_phone";
2090
2091        /**
2092         * The preferred network mode 7 = Global, CDMA default
2093         *                            4 = CDMA only
2094         *                            3 = GSM/UMTS only
2095         * @hide
2096         */
2097        public static final String PREFERRED_NETWORK_MODE =
2098                "preferred_network_mode";
2099
2100        /**
2101         * CDMA Cell Broadcast SMS
2102         *                            0 = CDMA Cell Broadcast SMS disabled
2103         *                            1 = CDMA Cell Broadcast SMS enabled
2104         * @hide
2105         */
2106        public static final String CDMA_CELL_BROADCAST_SMS =
2107                "cdma_cell_broadcast_sms";
2108
2109        /**
2110         * The cdma subscription 0 = Subscription from RUIM, when available
2111         *                       1 = Subscription from NV
2112         * @hide
2113         */
2114        public static final String PREFERRED_CDMA_SUBSCRIPTION =
2115                "preferred_cdma_subscription";
2116
2117        /**
2118         * Whether the enhanced voice privacy mode is enabled.
2119         * 0 = normal voice privacy
2120         * 1 = enhanced voice privacy
2121         * @hide
2122         */
2123        public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
2124
2125        /**
2126         * Whether the TTY mode mode is enabled.
2127         * 0 = disabled
2128         * 1 = enabled
2129         * @hide
2130         */
2131        public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
2132
2133        /**
2134         * Helper method for determining if a location provider is enabled.
2135         * @param cr the content resolver to use
2136         * @param provider the location provider to query
2137         * @return true if the provider is enabled
2138         *
2139         * @hide
2140         */
2141        public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
2142            String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
2143            if (allowedProviders != null) {
2144                return (allowedProviders.equals(provider) ||
2145                        allowedProviders.contains("," + provider + ",") ||
2146                        allowedProviders.startsWith(provider + ",") ||
2147                        allowedProviders.endsWith("," + provider));
2148            }
2149            return false;
2150        }
2151
2152        /**
2153         * Thread-safe method for enabling or disabling a single location provider.
2154         * @param cr the content resolver to use
2155         * @param provider the location provider to enable or disable
2156         * @param enabled true if the provider should be enabled
2157         *
2158         * @hide
2159         */
2160        public static final void setLocationProviderEnabled(ContentResolver cr,
2161                String provider, boolean enabled) {
2162            // to ensure thread safety, we write the provider name with a '+' or '-'
2163            // and let the SettingsProvider handle it rather than reading and modifying
2164            // the list of enabled providers.
2165            if (enabled) {
2166                provider = "+" + provider;
2167            } else {
2168                provider = "-" + provider;
2169            }
2170            putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
2171        }
2172    }
2173
2174    /**
2175     * Gservices settings, containing the network names for Google's
2176     * various services. This table holds simple name/addr pairs.
2177     * Addresses can be accessed through the getString() method.
2178     *
2179     * TODO: This should move to partner/google/... somewhere.
2180     *
2181     * @hide
2182     */
2183    public static final class Gservices extends NameValueTable {
2184        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_gservices_version";
2185
2186        /**
2187         * Intent action broadcast when the Gservices table is updated by the server.
2188         * This is broadcast once after settings change (so many values may have been updated).
2189         */
2190        @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191        public static final String CHANGED_ACTION =
2192            "com.google.gservices.intent.action.GSERVICES_CHANGED";
2193
2194        private static volatile NameValueCache mNameValueCache = null;
2195        private static final Object mNameValueCacheLock = new Object();
2196
2197        /**
2198         * Look up a name in the database.
2199         * @param resolver to access the database with
2200         * @param name to look up in the table
2201         * @return the corresponding value, or null if not present
2202         */
2203        public static String getString(ContentResolver resolver, String name) {
2204            synchronized (mNameValueCacheLock) {
2205                if (mNameValueCache == null) {
2206                    mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
2207                }
2208                return mNameValueCache.getString(resolver, name);
2209            }
2210        }
2211
2212        /**
2213         * Store a name/value pair into the database.
2214         * @param resolver to access the database with
2215         * @param name to store
2216         * @param value to associate with the name
2217         * @return true if the value was set, false on database errors
2218         */
2219        public static boolean putString(ContentResolver resolver,
2220                String name, String value) {
2221            return putString(resolver, CONTENT_URI, name, value);
2222        }
2223
2224        /**
2225         * Look up the value for name in the database, convert it to an int using Integer.parseInt
2226         * and return it. If it is null or if a NumberFormatException is caught during the
2227         * conversion then return defValue.
2228         */
2229        public static int getInt(ContentResolver resolver, String name, int defValue) {
2230            String valString = getString(resolver, name);
2231            int value;
2232            try {
2233                value = valString != null ? Integer.parseInt(valString) : defValue;
2234            } catch (NumberFormatException e) {
2235                value = defValue;
2236            }
2237            return value;
2238        }
2239
2240        /**
2241         * Look up the value for name in the database, convert it to a long using Long.parseLong
2242         * and return it. If it is null or if a NumberFormatException is caught during the
2243         * conversion then return defValue.
2244         */
2245        public static long getLong(ContentResolver resolver, String name, long defValue) {
2246            String valString = getString(resolver, name);
2247            long value;
2248            try {
2249                value = valString != null ? Long.parseLong(valString) : defValue;
2250            } catch (NumberFormatException e) {
2251                value = defValue;
2252            }
2253            return value;
2254        }
2255
2256        /**
2257         * Construct the content URI for a particular name/value pair,
2258         * useful for monitoring changes with a ContentObserver.
2259         * @param name to look up in the table
2260         * @return the corresponding content URI, or null if not present
2261         */
2262        public static Uri getUriFor(String name) {
2263            return getUriFor(CONTENT_URI, name);
2264        }
2265
2266        /**
2267         * The content:// style URL for this table
2268         */
2269        public static final Uri CONTENT_URI =
2270                Uri.parse("content://" + AUTHORITY + "/gservices");
2271
2272        /**
2273         * MMS - URL to use for HTTP "x-wap-profile" header
2274         */
2275        public static final String MMS_X_WAP_PROFILE_URL
2276                = "mms_x_wap_profile_url";
2277
2278        /**
2279         * YouTube - the flag to indicate whether to use proxy
2280         */
2281        public static final String YOUTUBE_USE_PROXY
2282                = "youtube_use_proxy";
2283
2284        /**
2285         * MMS - maximum message size in bytes for a MMS message.
2286         */
2287        public static final String MMS_MAXIMUM_MESSAGE_SIZE
2288                = "mms_maximum_message_size";
2289
2290        /**
2291         * Event tags from the kernel event log to upload during checkin.
2292         */
2293        public static final String CHECKIN_EVENTS = "checkin_events";
2294
2295        /**
2296         * Event tags for list of services to upload during checkin.
2297         */
2298        public static final String CHECKIN_DUMPSYS_LIST = "checkin_dumpsys_list";
2299
2300        /**
2301         * The interval (in seconds) between periodic checkin attempts.
2302         */
2303        public static final String CHECKIN_INTERVAL = "checkin_interval";
2304
2305        /**
2306         * Boolean indicating if the market app should force market only checkins on
2307         * install/uninstall. Any non-0 value is considered true.
2308         */
2309        public static final String MARKET_FORCE_CHECKIN = "market_force_checkin";
2310
2311        /**
2312         * How frequently (in seconds) to check the memory status of the
2313         * device.
2314         */
2315        public static final String MEMCHECK_INTERVAL = "memcheck_interval";
2316
2317        /**
2318         * Max frequency (in seconds) to log memory check stats, in realtime
2319         * seconds.  This allows for throttling of logs when the device is
2320         * running for large amounts of time.
2321         */
2322        public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
2323                "memcheck_log_realtime_interval";
2324
2325        /**
2326         * Boolean indicating whether rebooting due to system memory checks
2327         * is enabled.
2328         */
2329        public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
2330
2331        /**
2332         * How many bytes the system process must be below to avoid scheduling
2333         * a soft reboot.  This reboot will happen when it is next determined
2334         * to be a good time.
2335         */
2336        public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
2337
2338        /**
2339         * How many bytes the system process must be below to avoid scheduling
2340         * a hard reboot.  This reboot will happen immediately.
2341         */
2342        public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
2343
2344        /**
2345         * How many bytes the phone process must be below to avoid scheduling
2346         * a soft restart.  This restart will happen when it is next determined
2347         * to be a good time.
2348         */
2349        public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
2350
2351        /**
2352         * How many bytes the phone process must be below to avoid scheduling
2353         * a hard restart.  This restart will happen immediately.
2354         */
2355        public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
2356
2357        /**
2358         * Boolean indicating whether restarting the phone process due to
2359         * memory checks is enabled.
2360         */
2361        public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
2362
2363        /**
2364         * First time during the day it is okay to kill processes
2365         * or reboot the device due to low memory situations.  This number is
2366         * in seconds since midnight.
2367         */
2368        public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
2369
2370        /**
2371         * Last time during the day it is okay to kill processes
2372         * or reboot the device due to low memory situations.  This number is
2373         * in seconds since midnight.
2374         */
2375        public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
2376
2377        /**
2378         * How long the screen must have been off in order to kill processes
2379         * or reboot.  This number is in seconds.  A value of -1 means to
2380         * entirely disregard whether the screen is on.
2381         */
2382        public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
2383
2384        /**
2385         * How much time there must be until the next alarm in order to kill processes
2386         * or reboot.  This number is in seconds.  Note: this value must be
2387         * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
2388         * always see an alarm scheduled within its time.
2389         */
2390        public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
2391
2392        /**
2393         * How frequently to check whether it is a good time to restart things,
2394         * if the device is in a bad state.  This number is in seconds.  Note:
2395         * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
2396         * the alarm to schedule the recheck will always appear within the
2397         * minimum "do not execute now" time.
2398         */
2399        public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
2400
2401        /**
2402         * How frequently (in DAYS) to reboot the device.  If 0, no reboots
2403         * will occur.
2404         */
2405        public static final String REBOOT_INTERVAL = "reboot_interval";
2406
2407        /**
2408         * First time during the day it is okay to force a reboot of the
2409         * device (if REBOOT_INTERVAL is set).  This number is
2410         * in seconds since midnight.
2411         */
2412        public static final String REBOOT_START_TIME = "reboot_start_time";
2413
2414        /**
2415         * The window of time (in seconds) after each REBOOT_INTERVAL in which
2416         * a reboot can be executed.  If 0, a reboot will always be executed at
2417         * exactly the given time.  Otherwise, it will only be executed if
2418         * the device is idle within the window.
2419         */
2420        public static final String REBOOT_WINDOW = "reboot_window";
2421
2422        /**
2423         * The minimum version of the server that is required in order for the device to accept
2424         * the server's recommendations about the initial sync settings to use. When this is unset,
2425         * blank or can't be interpreted as an integer then we will not ask the server for a
2426         * recommendation.
2427         */
2428        public static final String GMAIL_CONFIG_INFO_MIN_SERVER_VERSION =
2429                "gmail_config_info_min_server_version";
2430
2431        /**
2432         * Controls whether Gmail offers a preview button for images.
2433         */
2434        public static final String GMAIL_DISALLOW_IMAGE_PREVIEWS = "gmail_disallow_image_previews";
2435
2436        /**
2437         * The maximal size in bytes allowed for attachments when composing messages in Gmail
2438         */
2439        public static final String GMAIL_MAX_ATTACHMENT_SIZE = "gmail_max_attachment_size_bytes";
2440
2441        /**
2442         * The timeout in milliseconds that Gmail uses when opening a connection and reading
2443         * from it. A missing value or a value of -1 instructs Gmail to use the defaults provided
2444         * by GoogleHttpClient.
2445         */
2446        public static final String GMAIL_TIMEOUT_MS = "gmail_timeout_ms";
2447
2448        /**
2449         * Controls whether Gmail will request an expedited sync when a message is sent. Value must
2450         * be an integer where non-zero means true. Defaults to 1.
2451         */
2452        public static final String GMAIL_SEND_IMMEDIATELY = "gmail_send_immediately";
2453
2454        /**
2455         * Controls whether gmail buffers server responses.  Possible values are "memory", for a
2456         * memory-based buffer, or "file", for a temp-file-based buffer.  All other values
2457         * (including not set) disable buffering.
2458         */
2459        public static final String GMAIL_BUFFER_SERVER_RESPONSE = "gmail_buffer_server_response";
2460
2461        /**
2462         * Controls whether Gmail will discard uphill operations that repeatedly fail. Value must be
2463         * an integer where non-zero means true. Defaults to 1.
2464         */
2465        public static final String GMAIL_DISCARD_ERROR_UPHILL_OP = "gmail_discard_error_uphill_op";
2466
2467        /**
2468         * Hostname of the GTalk server.
2469         */
2470        public static final String GTALK_SERVICE_HOSTNAME = "gtalk_hostname";
2471
2472        /**
2473         * Secure port of the GTalk server.
2474         */
2475        public static final String GTALK_SERVICE_SECURE_PORT = "gtalk_secure_port";
2476
2477        /**
2478         * The server configurable RMQ acking interval
2479         */
2480        public static final String GTALK_SERVICE_RMQ_ACK_INTERVAL = "gtalk_rmq_ack_interval";
2481
2482        /**
2483         * The minimum reconnect delay for short network outages or when the network is suspended
2484         * due to phone use.
2485         */
2486        public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT =
2487                "gtalk_min_reconnect_delay_short";
2488
2489        /**
2490         * The reconnect variant range for short network outages or when the network is suspended
2491         * due to phone use. A random number between 0 and this constant is computed and
2492         * added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT} to form the initial reconnect
2493         * delay.
2494         */
2495        public static final String GTALK_SERVICE_RECONNECT_VARIANT_SHORT =
2496                "gtalk_reconnect_variant_short";
2497
2498        /**
2499         * The minimum reconnect delay for long network outages
2500         */
2501        public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG =
2502                "gtalk_min_reconnect_delay_long";
2503
2504        /**
2505         * The reconnect variant range for long network outages.  A random number between 0 and this
2506         * constant is computed and added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG} to
2507         * form the initial reconnect delay.
2508         */
2509        public static final String GTALK_SERVICE_RECONNECT_VARIANT_LONG =
2510                "gtalk_reconnect_variant_long";
2511
2512        /**
2513         * The maximum reconnect delay time, in milliseconds.
2514         */
2515        public static final String GTALK_SERVICE_MAX_RECONNECT_DELAY =
2516                "gtalk_max_reconnect_delay";
2517
2518        /**
2519         * The network downtime that is considered "short" for the above calculations,
2520         * in milliseconds.
2521         */
2522        public static final String GTALK_SERVICE_SHORT_NETWORK_DOWNTIME =
2523                "gtalk_short_network_downtime";
2524
2525        /**
2526         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2527         * will reset the heartbeat timer. The away heartbeat should be used when the user is
2528         * logged into the GTalk app, but not actively using it.
2529         */
2530        public static final String GTALK_SERVICE_AWAY_HEARTBEAT_INTERVAL_MS =
2531                "gtalk_heartbeat_ping_interval_ms";  // keep the string backward compatible
2532
2533        /**
2534         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2535         * will reset the heartbeat timer. The active heartbeat should be used when the user is
2536         * actively using the GTalk app.
2537         */
2538        public static final String GTALK_SERVICE_ACTIVE_HEARTBEAT_INTERVAL_MS =
2539                "gtalk_active_heartbeat_ping_interval_ms";
2540
2541        /**
2542         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2543         * will reset the heartbeat timer. The sync heartbeat should be used when the user isn't
2544         * logged into the GTalk app, but auto-sync is enabled.
2545         */
2546        public static final String GTALK_SERVICE_SYNC_HEARTBEAT_INTERVAL_MS =
2547                "gtalk_sync_heartbeat_ping_interval_ms";
2548
2549        /**
2550         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2551         * will reset the heartbeat timer. The no sync heartbeat should be used when the user isn't
2552         * logged into the GTalk app, and auto-sync is not enabled.
2553         */
2554        public static final String GTALK_SERVICE_NOSYNC_HEARTBEAT_INTERVAL_MS =
2555                "gtalk_nosync_heartbeat_ping_interval_ms";
2556
2557        /**
2558         * How long we wait to receive a heartbeat ping acknowledgement (or another packet)
2559         * from the GTalk server, before deeming the connection dead.
2560         */
2561        public static final String GTALK_SERVICE_HEARTBEAT_ACK_TIMEOUT_MS =
2562                "gtalk_heartbeat_ack_timeout_ms";
2563
2564        /**
2565         * How long after screen is turned off before we consider the user to be idle.
2566         */
2567        public static final String GTALK_SERVICE_IDLE_TIMEOUT_MS =
2568                "gtalk_idle_timeout_ms";
2569
2570        /**
2571         * By default, GTalkService will always connect to the server regardless of the auto-sync
2572         * setting. However, if this parameter is true, then GTalkService will only connect
2573         * if auto-sync is enabled. Using the GTalk app will trigger the connection too.
2574         */
2575        public static final String GTALK_SERVICE_CONNECT_ON_AUTO_SYNC =
2576                "gtalk_connect_on_auto_sync";
2577
2578        /**
2579         * GTalkService holds a wakelock while broadcasting the intent for data message received.
2580         * It then automatically release the wakelock after a timeout. This setting controls what
2581         * the timeout should be.
2582         */
2583        public static final String GTALK_DATA_MESSAGE_WAKELOCK_MS =
2584                "gtalk_data_message_wakelock_ms";
2585
2586        /**
2587         * The socket read timeout used to control how long ssl handshake wait for reads before
2588         * timing out. This is needed so the ssl handshake doesn't hang for a long time in some
2589         * circumstances.
2590         */
2591        public static final String GTALK_SSL_HANDSHAKE_TIMEOUT_MS =
2592                "gtalk_ssl_handshake_timeout_ms";
2593
2594        /**
2595         * Enable use of ssl session caching.
2596         * 'db' - save each session in a (per process) database
2597         * 'file' - save each session in a (per process) file
2598         * not set or any other value - normal java in-memory caching
2599         */
2600        public static final String SSL_SESSION_CACHE = "ssl_session_cache";
2601
2602        /**
2603         * How many bytes long a message has to be, in order to be gzipped.
2604         */
2605        public static final String SYNC_MIN_GZIP_BYTES =
2606                "sync_min_gzip_bytes";
2607
2608        /**
2609         * The hash value of the current provisioning settings
2610         */
2611        public static final String PROVISIONING_DIGEST = "digest";
2612
2613        /**
2614         * Provisioning keys to block from server update
2615         */
2616        public static final String PROVISIONING_OVERRIDE = "override";
2617
2618        /**
2619         * "Generic" service name for  authentication requests.
2620         */
2621        public static final String GOOGLE_LOGIN_GENERIC_AUTH_SERVICE
2622                = "google_login_generic_auth_service";
2623
2624        /**
2625         * Frequency in milliseconds at which we should sync the locally installed Vending Machine
2626         * content with the server.
2627         */
2628        public static final String VENDING_SYNC_FREQUENCY_MS = "vending_sync_frequency_ms";
2629
2630        /**
2631         * Support URL that is opened in a browser when user clicks on 'Help and Info' in Vending
2632         * Machine.
2633         */
2634        public static final String VENDING_SUPPORT_URL = "vending_support_url";
2635
2636        /**
2637         * Indicates if Vending Machine requires a SIM to be in the phone to allow a purchase.
2638         *
2639         * true = SIM is required
2640         * false = SIM is not required
2641         */
2642        public static final String VENDING_REQUIRE_SIM_FOR_PURCHASE =
2643                "vending_require_sim_for_purchase";
2644
2645        /**
2646         * The current version id of the Vending Machine terms of service.
2647         */
2648        public static final String VENDING_TOS_VERSION = "vending_tos_version";
2649
2650        /**
2651         * URL that points to the terms of service for Vending Machine.
2652         */
2653        public static final String VENDING_TOS_URL = "vending_tos_url";
2654
2655        /**
2656         * Whether to use sierraqa instead of sierra tokens for the purchase flow in
2657         * Vending Machine.
2658         *
2659         * true = use sierraqa
2660         * false = use sierra (default)
2661         */
2662        public static final String VENDING_USE_CHECKOUT_QA_SERVICE =
2663                "vending_use_checkout_qa_service";
2664
2665        /**
2666         * Default value to use for all/free/priced filter in Market.
2667         * Valid values: ALL, FREE, PAID (case insensitive)
2668         */
2669        public static final String VENDING_DEFAULT_FILTER = "vending_default_filter";
2670        /**
2671         * Ranking type value to use for the first category tab (currently popular)
2672         */
2673        public static final String VENDING_TAB_1_RANKING_TYPE = "vending_tab_1_ranking_type";
2674
2675        /**
2676         * Title string to use for first category tab.
2677         */
2678        public static final String VENDING_TAB_1_TITLE = "vending_tab_1_title";
2679
2680        /**
2681         * Ranking type value to use for the second category tab (currently newest)
2682         */
2683        public static final String VENDING_TAB_2_RANKING_TYPE = "vending_tab_2_ranking_type";
2684
2685        /**
2686         * Title string to use for second category tab.
2687         */
2688        public static final String VENDING_TAB_2_TITLE = "vending_tab_2_title";
2689
2690        /**
2691         * URL that points to the legal terms of service to display in Settings.
2692         * <p>
2693         * This should be a https URL. For a pretty user-friendly URL, use
2694         * {@link #SETTINGS_TOS_PRETTY_URL}.
2695         */
2696        public static final String SETTINGS_TOS_URL = "settings_tos_url";
2697
2698        /**
2699         * URL that points to the legal terms of service to display in Settings.
2700         * <p>
2701         * This should be a pretty http URL. For the URL the device will access
2702         * via Settings, use {@link #SETTINGS_TOS_URL}.
2703         */
2704        public static final String SETTINGS_TOS_PRETTY_URL = "settings_tos_pretty_url";
2705
2706        /**
2707         * URL that points to the contributors to display in Settings.
2708         * <p>
2709         * This should be a https URL. For a pretty user-friendly URL, use
2710         * {@link #SETTINGS_CONTRIBUTORS_PRETTY_URL}.
2711         */
2712        public static final String SETTINGS_CONTRIBUTORS_URL = "settings_contributors_url";
2713
2714        /**
2715         * URL that points to the contributors to display in Settings.
2716         * <p>
2717         * This should be a pretty http URL. For the URL the device will access
2718         * via Settings, use {@link #SETTINGS_CONTRIBUTORS_URL}.
2719         */
2720        public static final String SETTINGS_CONTRIBUTORS_PRETTY_URL =
2721                "settings_contributors_pretty_url";
2722
2723        /**
2724         * URL that points to the Terms Of Service for the device.
2725         * <p>
2726         * This should be a pretty http URL.
2727         */
2728        public static final String SETUP_GOOGLE_TOS_URL = "setup_google_tos_url";
2729
2730        /**
2731         * URL that points to the Android privacy policy for the device.
2732         * <p>
2733         * This should be a pretty http URL.
2734         */
2735        public static final String SETUP_ANDROID_PRIVACY_URL = "setup_android_privacy_url";
2736
2737        /**
2738         * URL that points to the Google privacy policy for the device.
2739         * <p>
2740         * This should be a pretty http URL.
2741         */
2742        public static final String SETUP_GOOGLE_PRIVACY_URL = "setup_google_privacy_url";
2743
2744        /**
2745         * Request an MSISDN token for various Google services.
2746         */
2747        public static final String USE_MSISDN_TOKEN = "use_msisdn_token";
2748
2749        /**
2750         * RSA public key used to encrypt passwords stored in the database.
2751         */
2752        public static final String GLS_PUBLIC_KEY = "google_login_public_key";
2753
2754        /**
2755         * Only check parental control status if this is set to "true".
2756         */
2757        public static final String PARENTAL_CONTROL_CHECK_ENABLED =
2758                "parental_control_check_enabled";
2759
2760        /**
2761         * The list of applications we need to block if parental control is
2762         * enabled.
2763         */
2764        public static final String PARENTAL_CONTROL_APPS_LIST =
2765                "parental_control_apps_list";
2766
2767        /**
2768         * Duration in which parental control status is valid.
2769         */
2770        public static final String PARENTAL_CONTROL_TIMEOUT_IN_MS =
2771                "parental_control_timeout_in_ms";
2772
2773        /**
2774         * When parental control is off, we expect to get this string from the
2775         * litmus url.
2776         */
2777        public static final String PARENTAL_CONTROL_EXPECTED_RESPONSE =
2778                "parental_control_expected_response";
2779
2780        /**
2781         * When the litmus url returns a 302, declare parental control to be on
2782         * only if the redirect url matches this regular expression.
2783         */
2784        public static final String PARENTAL_CONTROL_REDIRECT_REGEX =
2785                "parental_control_redirect_regex";
2786
2787        /**
2788         * Threshold for the amount of change in disk free space required to report the amount of
2789         * free space. Used to prevent spamming the logs when the disk free space isn't changing
2790         * frequently.
2791         */
2792        public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
2793                "disk_free_change_reporting_threshold";
2794
2795        /**
2796         * Prefix for new Google services published by the checkin
2797         * server.
2798         */
2799        public static final String GOOGLE_SERVICES_PREFIX
2800                = "google_services:";
2801
2802        /**
2803         * The maximum reconnect delay for short network outages or when the network is suspended
2804         * due to phone use.
2805         */
2806        public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
2807                "sync_max_retry_delay_in_seconds";
2808
2809        /**
2810         * Minimum percentage of free storage on the device that is used to determine if
2811         * the device is running low on storage.
2812         * Say this value is set to 10, the device is considered running low on storage
2813         * if 90% or more of the device storage is filled up.
2814         */
2815        public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
2816                "sys_storage_threshold_percentage";
2817
2818        /**
2819         * The interval in minutes after which the amount of free storage left on the
2820         * device is logged to the event log
2821         */
2822        public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
2823                "sys_free_storage_log_interval";
2824
2825        /**
2826         * The interval in milliseconds at which to check the number of SMS sent
2827         * out without asking for use permit, to limit the un-authorized SMS
2828         * usage.
2829         */
2830        public static final String SMS_OUTGOING_CEHCK_INTERVAL_MS =
2831                "sms_outgoing_check_interval_ms";
2832
2833        /**
2834         * The number of outgoing SMS sent without asking for user permit
2835         * (of {@link #SMS_OUTGOING_CEHCK_INTERVAL_MS}
2836         */
2837        public static final String SMS_OUTGOING_CEHCK_MAX_COUNT =
2838                "sms_outgoing_check_max_count";
2839
2840        /**
2841         * The interval in milliseconds at which to check packet counts on the
2842         * mobile data interface when screen is on, to detect possible data
2843         * connection problems.
2844         */
2845        public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
2846                "pdp_watchdog_poll_interval_ms";
2847
2848        /**
2849         * The interval in milliseconds at which to check packet counts on the
2850         * mobile data interface when screen is off, to detect possible data
2851         * connection problems.
2852         */
2853        public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
2854                "pdp_watchdog_long_poll_interval_ms";
2855
2856        /**
2857         * The interval in milliseconds at which to check packet counts on the
2858         * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
2859         * outgoing packets has been reached without incoming packets.
2860         */
2861        public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
2862                "pdp_watchdog_error_poll_interval_ms";
2863
2864        /**
2865         * The number of outgoing packets sent without seeing an incoming packet
2866         * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
2867         * device is logged to the event log
2868         */
2869        public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
2870                "pdp_watchdog_trigger_packet_count";
2871
2872        /**
2873         * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
2874         * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
2875         * attempting data connection recovery.
2876         */
2877        public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
2878                "pdp_watchdog_error_poll_count";
2879
2880        /**
2881         * The number of failed PDP reset attempts before moving to something more
2882         * drastic: re-registering to the network.
2883         */
2884        public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
2885                "pdp_watchdog_max_pdp_reset_fail_count";
2886
2887        /**
2888         * Address to ping as a last sanity check before attempting any recovery.
2889         * Unset or set to "0.0.0.0" to skip this check.
2890         */
2891        public static final String PDP_WATCHDOG_PING_ADDRESS = "pdp_watchdog_ping_address";
2892
2893        /**
2894         * The "-w deadline" parameter for the ping, ie, the max time in
2895         * seconds to spend pinging.
2896         */
2897        public static final String PDP_WATCHDOG_PING_DEADLINE = "pdp_watchdog_ping_deadline";
2898
2899        /**
2900         * The interval in milliseconds at which to check gprs registration
2901         * after the first registration mismatch of gprs and voice service,
2902         * to detect possible data network registration problems.
2903         *
2904         */
2905        public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
2906                "gprs_register_check_period_ms";
2907
2908        /**
2909         * The interval in milliseconds after which Wi-Fi is considered idle.
2910         * When idle, it is possible for the device to be switched from Wi-Fi to
2911         * the mobile data network.
2912         */
2913        public static final String WIFI_IDLE_MS = "wifi_idle_ms";
2914
2915        /**
2916         * Screen timeout in milliseconds corresponding to the
2917         * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
2918         * possible screen timeout behavior.)
2919         */
2920        public static final String SHORT_KEYLIGHT_DELAY_MS =
2921                "short_keylight_delay_ms";
2922
2923        /**
2924         * URL that points to the voice search servers. To be factored out of this class.
2925         */
2926        public static final String VOICE_SEARCH_URL = "voice_search_url";
2927
2928        /**
2929         * Speech encoding used with voice search on 3G networks. To be factored out of this class.
2930         */
2931        public static final String VOICE_SEARCH_ENCODING_THREE_G = "voice_search_encoding_three_g";
2932
2933        /**
2934         * Speech encoding used with voice search on WIFI networks. To be factored out of this class.
2935         */
2936        public static final String VOICE_SEARCH_ENCODING_WIFI = "voice_search_encoding_wifi";
2937
2938        /**
2939         * Whether to use automatic gain control in voice search (0 = disable, 1 = enable).
2940         * To be factored out of this class.
2941         */
2942        public static final String VOICE_SEARCH_ENABLE_AGC = "voice_search_enable_agc";
2943
2944        /**
2945         * Whether to use noise suppression in voice search (0 = disable, 1 = enable).
2946         * To be factored out of this class.
2947         */
2948        public static final String VOICE_SEARCH_ENABLE_NS = "voice_search_enable_ns";
2949
2950        /**
2951         * Whether to use the IIR filter in voice search (0 = disable, 1 = enable).
2952         * To be factored out of this class.
2953         */
2954        public static final String VOICE_SEARCH_ENABLE_IIR = "voice_search_enable_iir";
2955
2956        /**
2957         * List of test suites (local disk filename) for the automatic instrumentation test runner.
2958         * The file format is similar to automated_suites.xml, see AutoTesterService.
2959         * If this setting is missing or empty, the automatic test runner will not start.
2960         */
2961        public static final String AUTOTEST_SUITES_FILE = "autotest_suites_file";
2962
2963        /**
2964         * Interval between synchronous checkins forced by the automatic test runner.
2965         * If you set this to a value smaller than CHECKIN_INTERVAL, then the test runner's
2966         * frequent checkins will prevent asynchronous background checkins from interfering
2967         * with any performance measurements.
2968         */
2969        public static final String AUTOTEST_CHECKIN_SECONDS = "autotest_checkin_seconds";
2970
2971        /**
2972         * Interval between reboots forced by the automatic test runner.
2973         */
2974        public static final String AUTOTEST_REBOOT_SECONDS = "autotest_reboot_seconds";
2975
2976
2977        /**
2978         * Threshold values for the duration and level of a discharge cycle, under
2979         * which we log discharge cycle info.
2980         */
2981        public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
2982                "battery_discharge_duration_threshold";
2983        public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
2984
2985        /**
2986         * An email address that anr bugreports should be sent to.
2987         */
2988        public static final String ANR_BUGREPORT_RECIPIENT = "anr_bugreport_recipient";
2989
2990        /**
2991         * @deprecated
2992         * @hide
2993         */
2994        @Deprecated  // Obviated by NameValueCache: just fetch the value directly.
2995        public static class QueryMap extends ContentQueryMap {
2996
2997            public QueryMap(ContentResolver contentResolver, Cursor cursor, boolean keepUpdated,
2998                    Handler handlerForUpdateNotifications) {
2999                super(cursor, NAME, keepUpdated, handlerForUpdateNotifications);
3000            }
3001
3002            public QueryMap(ContentResolver contentResolver, boolean keepUpdated,
3003                    Handler handlerForUpdateNotifications) {
3004                this(contentResolver,
3005                        contentResolver.query(CONTENT_URI, null, null, null, null),
3006                        keepUpdated, handlerForUpdateNotifications);
3007            }
3008
3009            public String getString(String name) {
3010                ContentValues cv = getValues(name);
3011                if (cv == null) return null;
3012                return cv.getAsString(VALUE);
3013            }
3014        }
3015
3016    }
3017
3018    /**
3019     * User-defined bookmarks and shortcuts.  The target of each bookmark is an
3020     * Intent URL, allowing it to be either a web page or a particular
3021     * application activity.
3022     *
3023     * @hide
3024     */
3025    public static final class Bookmarks implements BaseColumns
3026    {
3027        private static final String TAG = "Bookmarks";
3028
3029        /**
3030         * The content:// style URL for this table
3031         */
3032        public static final Uri CONTENT_URI =
3033            Uri.parse("content://" + AUTHORITY + "/bookmarks");
3034
3035        /**
3036         * The row ID.
3037         * <p>Type: INTEGER</p>
3038         */
3039        public static final String ID = "_id";
3040
3041        /**
3042         * Descriptive name of the bookmark that can be displayed to the user.
3043         * If this is empty, the title should be resolved at display time (use
3044         * {@link #getTitle(Context, Cursor)} any time you want to display the
3045         * title of a bookmark.)
3046         * <P>
3047         * Type: TEXT
3048         * </P>
3049         */
3050        public static final String TITLE = "title";
3051
3052        /**
3053         * Arbitrary string (displayed to the user) that allows bookmarks to be
3054         * organized into categories.  There are some special names for
3055         * standard folders, which all start with '@'.  The label displayed for
3056         * the folder changes with the locale (via {@link #getLabelForFolder}) but
3057         * the folder name does not change so you can consistently query for
3058         * the folder regardless of the current locale.
3059         *
3060         * <P>Type: TEXT</P>
3061         *
3062         */
3063        public static final String FOLDER = "folder";
3064
3065        /**
3066         * The Intent URL of the bookmark, describing what it points to.  This
3067         * value is given to {@link android.content.Intent#getIntent} to create
3068         * an Intent that can be launched.
3069         * <P>Type: TEXT</P>
3070         */
3071        public static final String INTENT = "intent";
3072
3073        /**
3074         * Optional shortcut character associated with this bookmark.
3075         * <P>Type: INTEGER</P>
3076         */
3077        public static final String SHORTCUT = "shortcut";
3078
3079        /**
3080         * The order in which the bookmark should be displayed
3081         * <P>Type: INTEGER</P>
3082         */
3083        public static final String ORDERING = "ordering";
3084
3085        private static final String[] sIntentProjection = { INTENT };
3086        private static final String[] sShortcutProjection = { ID, SHORTCUT };
3087        private static final String sShortcutSelection = SHORTCUT + "=?";
3088
3089        /**
3090         * Convenience function to retrieve the bookmarked Intent for a
3091         * particular shortcut key.
3092         *
3093         * @param cr The ContentResolver to query.
3094         * @param shortcut The shortcut key.
3095         *
3096         * @return Intent The bookmarked URL, or null if there is no bookmark
3097         *         matching the given shortcut.
3098         */
3099        public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3100        {
3101            Intent intent = null;
3102
3103            Cursor c = cr.query(CONTENT_URI,
3104                    sIntentProjection, sShortcutSelection,
3105                    new String[] { String.valueOf((int) shortcut) }, ORDERING);
3106            // Keep trying until we find a valid shortcut
3107            try {
3108                while (intent == null && c.moveToNext()) {
3109                    try {
3110                        String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
3111                        intent = Intent.getIntent(intentURI);
3112                    } catch (java.net.URISyntaxException e) {
3113                        // The stored URL is bad...  ignore it.
3114                    } catch (IllegalArgumentException e) {
3115                        // Column not found
3116                        Log.e(TAG, "Intent column not found", e);
3117                    }
3118                }
3119            } finally {
3120                if (c != null) c.close();
3121            }
3122
3123            return intent;
3124        }
3125
3126        /**
3127         * Add a new bookmark to the system.
3128         *
3129         * @param cr The ContentResolver to query.
3130         * @param intent The desired target of the bookmark.
3131         * @param title Bookmark title that is shown to the user; null if none
3132         *            or it should be resolved to the intent's title.
3133         * @param folder Folder in which to place the bookmark; null if none.
3134         * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3135         *            this is non-zero and there is an existing bookmark entry
3136         *            with this same shortcut, then that existing shortcut is
3137         *            cleared (the bookmark is not removed).
3138         * @return The unique content URL for the new bookmark entry.
3139         */
3140        public static Uri add(ContentResolver cr,
3141                                           Intent intent,
3142                                           String title,
3143                                           String folder,
3144                                           char shortcut,
3145                                           int ordering)
3146        {
3147            // If a shortcut is supplied, and it is already defined for
3148            // another bookmark, then remove the old definition.
3149            if (shortcut != 0) {
3150                Cursor c = cr.query(CONTENT_URI,
3151                        sShortcutProjection, sShortcutSelection,
3152                        new String[] { String.valueOf((int) shortcut) }, null);
3153                try {
3154                    if (c.moveToFirst()) {
3155                        while (c.getCount() > 0) {
3156                            if (!c.deleteRow()) {
3157                                Log.w(TAG, "Could not delete existing shortcut row");
3158                            }
3159                        }
3160                    }
3161                } finally {
3162                    if (c != null) c.close();
3163                }
3164            }
3165
3166            ContentValues values = new ContentValues();
3167            if (title != null) values.put(TITLE, title);
3168            if (folder != null) values.put(FOLDER, folder);
3169            values.put(INTENT, intent.toURI());
3170            if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3171            values.put(ORDERING, ordering);
3172            return cr.insert(CONTENT_URI, values);
3173        }
3174
3175        /**
3176         * Return the folder name as it should be displayed to the user.  This
3177         * takes care of localizing special folders.
3178         *
3179         * @param r Resources object for current locale; only need access to
3180         *          system resources.
3181         * @param folder The value found in the {@link #FOLDER} column.
3182         *
3183         * @return CharSequence The label for this folder that should be shown
3184         *         to the user.
3185         */
3186        public static CharSequence getLabelForFolder(Resources r, String folder) {
3187            return folder;
3188        }
3189
3190        /**
3191         * Return the title as it should be displayed to the user. This takes
3192         * care of localizing bookmarks that point to activities.
3193         *
3194         * @param context A context.
3195         * @param cursor A cursor pointing to the row whose title should be
3196         *        returned. The cursor must contain at least the {@link #TITLE}
3197         *        and {@link #INTENT} columns.
3198         * @return A title that is localized and can be displayed to the user,
3199         *         or the empty string if one could not be found.
3200         */
3201        public static CharSequence getTitle(Context context, Cursor cursor) {
3202            int titleColumn = cursor.getColumnIndex(TITLE);
3203            int intentColumn = cursor.getColumnIndex(INTENT);
3204            if (titleColumn == -1 || intentColumn == -1) {
3205                throw new IllegalArgumentException(
3206                        "The cursor must contain the TITLE and INTENT columns.");
3207            }
3208
3209            String title = cursor.getString(titleColumn);
3210            if (!TextUtils.isEmpty(title)) {
3211                return title;
3212            }
3213
3214            String intentUri = cursor.getString(intentColumn);
3215            if (TextUtils.isEmpty(intentUri)) {
3216                return "";
3217            }
3218
3219            Intent intent;
3220            try {
3221                intent = Intent.getIntent(intentUri);
3222            } catch (URISyntaxException e) {
3223                return "";
3224            }
3225
3226            PackageManager packageManager = context.getPackageManager();
3227            ResolveInfo info = packageManager.resolveActivity(intent, 0);
3228            return info != null ? info.loadLabel(packageManager) : "";
3229        }
3230    }
3231
3232    /**
3233     * Returns the GTalk JID resource associated with this device.
3234     *
3235     * @return  String  the JID resource of the device. It uses the device IMEI in the computation
3236     * of the JID resource. If IMEI is not ready (i.e. telephony module not ready), we'll return
3237     * an empty string.
3238     * @hide
3239     */
3240    // TODO: we shouldn't not have a permenant Jid resource, as that's an easy target for
3241    // spams. We should change it once a while, like when we resubscribe to the subscription feeds
3242    // server.
3243    // (also, should this live in GTalkService?)
3244    public static synchronized String getJidResource() {
3245        if (sJidResource != null) {
3246            return sJidResource;
3247        }
3248
3249        MessageDigest digest;
3250        try {
3251            digest = MessageDigest.getInstance("SHA-1");
3252        } catch (NoSuchAlgorithmException e) {
3253            throw new RuntimeException("this should never happen");
3254        }
3255
3256        String deviceId = TelephonyManager.getDefault().getDeviceId();
3257        if (TextUtils.isEmpty(deviceId)) {
3258            return "";
3259        }
3260
3261        byte[] hashedDeviceId = digest.digest(deviceId.getBytes());
3262        String id = new String(Base64.encodeBase64(hashedDeviceId), 0, 12);
3263        id = id.replaceAll("/", "_");
3264        sJidResource = JID_RESOURCE_PREFIX + id;
3265        return sJidResource;
3266    }
3267
3268    /**
3269     * Returns the device ID that we should use when connecting to the mobile gtalk server.
3270     * This is a string like "android-0x1242", where the hex string is the Android ID obtained
3271     * from the GoogleLoginService.
3272     *
3273     * @param androidId The Android ID for this device.
3274     * @return The device ID that should be used when connecting to the mobile gtalk server.
3275     * @hide
3276     */
3277    public static String getGTalkDeviceId(long androidId) {
3278        return "android-" + Long.toHexString(androidId);
3279    }
3280}
3281
3282