allow run-time verbose debugging option on downloadmanager code.
[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.Log;
20
21 /**
22  * Contains the internal constants that are used in the download manager.
23  * As a general rule, modifying these constants should be done with care.
24  */
25 public class Constants {
26
27     /** Tag used for debugging/logging */
28     public static final String TAG = "DownloadManager";
29
30     /** The column that used to be used for the HTTP method of the request */
31     public static final String RETRY_AFTER_X_REDIRECT_COUNT = "method";
32
33     /** The column that used to be used for the magic OTA update filename */
34     public static final String OTA_UPDATE = "otaupdate";
35
36     /** The column that used to be used to reject system filetypes */
37     public static final String NO_SYSTEM_FILES = "no_system";
38
39     /** The column that is used for the downloads's ETag */
40     public static final String ETAG = "etag";
41
42     /** The column that is used for the initiating app's UID */
43     public static final String UID = "uid";
44
45     /** The column that is used to remember whether the media scanner was invoked */
46     public static final String MEDIA_SCANNED = "scanned";
47
48     /** The column that is used to count retries */
49     public static final String FAILED_CONNECTIONS = "numfailed";
50
51     /** The intent that gets sent when the service must wake up for a retry */
52     public static final String ACTION_RETRY = "android.intent.action.DOWNLOAD_WAKEUP";
53
54     /** the intent that gets sent when clicking a successful download */
55     public static final String ACTION_OPEN = "android.intent.action.DOWNLOAD_OPEN";
56
57     /** the intent that gets sent when clicking an incomplete/failed download  */
58     public static final String ACTION_LIST = "android.intent.action.DOWNLOAD_LIST";
59
60     /** the intent that gets sent when deleting the notification of a completed download */
61     public static final String ACTION_HIDE = "android.intent.action.DOWNLOAD_HIDE";
62
63     /** The default base name for downloaded files if we can't get one at the HTTP level */
64     public static final String DEFAULT_DL_FILENAME = "downloadfile";
65
66     /** The default extension for html files if we can't get one at the HTTP level */
67     public static final String DEFAULT_DL_HTML_EXTENSION = ".html";
68
69     /** The default extension for text files if we can't get one at the HTTP level */
70     public static final String DEFAULT_DL_TEXT_EXTENSION = ".txt";
71
72     /** The default extension for binary files if we can't get one at the HTTP level */
73     public static final String DEFAULT_DL_BINARY_EXTENSION = ".bin";
74
75     /**
76      * When a number has to be appended to the filename, this string is used to separate the
77      * base filename from the sequence number
78      */
79     public static final String FILENAME_SEQUENCE_SEPARATOR = "-";
80
81     /** Where we store downloaded files on the external storage */
82     public static final String DEFAULT_DL_SUBDIR = "/download";
83
84     /** A magic filename that is allowed to exist within the system cache */
85     public static final String KNOWN_SPURIOUS_FILENAME = "lost+found";
86
87     /** A magic filename that is allowed to exist within the system cache */
88     public static final String RECOVERY_DIRECTORY = "recovery";
89
90     /** The default user agent used for downloads */
91     public static final String DEFAULT_USER_AGENT = "AndroidDownloadManager";
92
93     /** The MIME type of special DRM files */
94     public static final String MIMETYPE_DRM_MESSAGE =
95             android.drm.mobile1.DrmRawContent.DRM_MIMETYPE_MESSAGE_STRING;
96
97     /** The MIME type of APKs */
98     public static final String MIMETYPE_APK = "application/vnd.android.package";
99
100     /** The buffer size used to stream the data */
101     public static final int BUFFER_SIZE = 4096;
102
103     /** The minimum amount of progress that has to be done before the progress bar gets updated */
104     public static final int MIN_PROGRESS_STEP = 4096;
105
106     /** The minimum amount of time that has to elapse before the progress bar gets updated, in ms */
107     public static final long MIN_PROGRESS_TIME = 1500;
108
109     /** The maximum number of rows in the database (FIFO) */
110     public static final int MAX_DOWNLOADS = 1000;
111
112     /**
113      * The number of times that the download manager will retry its network
114      * operations when no progress is happening before it gives up.
115      */
116     public static final int MAX_RETRIES = 5;
117
118     /**
119      * The minimum amount of time that the download manager accepts for
120      * a Retry-After response header with a parameter in delta-seconds.
121      */
122     public static final int MIN_RETRY_AFTER = 30; // 30s
123
124     /**
125      * The maximum amount of time that the download manager accepts for
126      * a Retry-After response header with a parameter in delta-seconds.
127      */
128     public static final int MAX_RETRY_AFTER = 24 * 60 * 60; // 24h
129
130     /**
131      * The maximum number of redirects.
132      */
133     public static final int MAX_REDIRECTS = 5; // can't be more than 7.
134
135     /**
136      * The time between a failure and the first retry after an IOException.
137      * Each subsequent retry grows exponentially, doubling each time.
138      * The time is in seconds.
139      */
140     public static final int RETRY_FIRST_DELAY = 30;
141
142     /** Enable separate connectivity logging */
143     static final boolean LOGX = false;
144
145     /** Enable verbose logging - use with "setprop log.tag.DownloadManager VERBOSE" */
146     private static final boolean LOCAL_LOGV = true; // STOPSHIP change this to false before shipping
147     public static final boolean LOGV = LOCAL_LOGV && Log.isLoggable(TAG, Log.VERBOSE);
148
149     /** Enable super-verbose logging */
150     private static final boolean LOCAL_LOGVV = true; // STOPSHIP change this to false before shipping
151     public static final boolean LOGVV = LOCAL_LOGVV && LOGV;
152 }