Initial Contribution
[android/platform/packages/providers/DownloadProvider.git] / src / com / android / providers / downloads / Constants.java
1 /*
2  * Copyright (C) 2008 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
17 package com.android.providers.downloads;
18
19 import android.util.Config;
20 import android.util.Log;
21
22 /**
23  * Contains the internal constants that are used in the download manager.
24  * As a general rule, modifying these constants should be done with care.
25  */
26 public class Constants {
27
28     /** Tag used for debugging/logging */
29     public static final String TAG = "DownloadManager";
30
31     /** The permission that allows to access data about all downloads */
32     public static final String UI_PERMISSION = "android.permission.ACCESS_DOWNLOAD_DATA";
33
34     /** The permission that allows to download a system image */
35     public static final String OTA_UPDATE_PERMISSION = "android.permission.DOWNLOAD_OTA_UPDATE";
36
37     /** The intent that gets sent when the service must wake up for a retry */
38     public static final String ACTION_RETRY = "android.intent.action.DOWNLOAD_WAKEUP";
39
40     /** the intent that gets sent when clicking a successful download */
41     public static final String ACTION_OPEN = "android.intent.action.DOWNLOAD_OPEN";
42
43     /** the intent that gets sent when clicking an incomplete/failed download  */
44     public static final String ACTION_LIST = "android.intent.action.DOWNLOAD_LIST";
45
46     /** the intent that gets sent when deleting the notification of a completed download */
47     public static final String ACTION_HIDE = "android.intent.action.DOWNLOAD_HIDE";
48
49     /** The default base name for downloaded files if we can't get one at the HTTP level */
50     public static final String DEFAULT_DL_FILENAME = "downloadfile";
51
52     /** The default extension for html files if we can't get one at the HTTP level */
53     public static final String DEFAULT_DL_HTML_EXTENSION = ".html";
54
55     /** The default extension for text files if we can't get one at the HTTP level */
56     public static final String DEFAULT_DL_TEXT_EXTENSION = ".txt";
57
58     /** The default extension for binary files if we can't get one at the HTTP level */
59     public static final String DEFAULT_DL_BINARY_EXTENSION = ".bin";
60
61     /**
62      * When a number has to be appended to the filename, this string is used to separate the
63      * base filename from the sequence number
64      */
65     public static final String FILENAME_SEQUENCE_SEPARATOR = "-";
66
67     /** Where we store downloaded files on the external storage */
68     public static final String DEFAULT_DL_SUBDIR = "/download";
69
70     /** A magic filename that is allowed to exist within the system cache */
71     public static final String KNOWN_SPURIOUS_FILENAME = "lost+found";
72
73     /** A magic filename that is allowed to exist within the system cache */
74     public static final String RECOVERY_DIRECTORY = "recovery";
75
76     /** The magic filename for OTA updates */
77     public static final String OTA_UPDATE_FILENAME = "update.install";
78
79     /** The default user agent used for downloads */
80     public static final String DEFAULT_USER_AGENT = "AndroidDownloadManager";
81
82     /** The MIME type of special DRM files */
83     public static final String MIMETYPE_DRM_MESSAGE =
84             android.drm.mobile1.DrmRawContent.DRM_MIMETYPE_MESSAGE_STRING;
85
86     /** The MIME type of APKs */
87     public static final String MIMETYPE_APK = "application/vnd.android.package";
88
89     /** The buffer size used to stream the data */
90     public static final int BUFFER_SIZE = 4096;
91
92     /** The minimum amount of progress that has to be done before the progress bar gets updated */
93     public static final int MIN_PROGRESS_STEP = 4096;
94
95     /** The minimum amount of time that has to elapse before the progress bar gets updated, in ms */
96     public static final long MIN_PROGRESS_TIME = 1500;
97
98     /** The maximum number of rows in the database (FIFO) */
99     public static final int MAX_DOWNLOADS = 1000;
100
101     /**
102      * The number of times that the download manager will retry its network
103      * operations when no progress is happening before it gives up.
104      */
105     public static final int MAX_RETRIES = 5;
106
107     /**
108      * The time between a failure and the first retry after an IOException.
109      * Each subsequent retry grows exponentially, doubling each time.
110      * The time is in seconds.
111      */
112     public static final int RETRY_FIRST_DELAY = 30;
113
114     /** Enable verbose logging - use with "setprop log.tag.DownloadManager VERBOSE" */
115     private static final boolean LOCAL_LOGV = false;
116     public static final boolean LOGV = Config.LOGV
117             || (Config.LOGD && LOCAL_LOGV && Log.isLoggable(TAG, Log.VERBOSE));
118
119     /** Enable super-verbose logging */
120     private static final boolean LOCAL_LOGVV = false;
121     public static final boolean LOGVV = LOCAL_LOGVV && LOGV;
122 }