Downloads.java revision 54781207d31fd0fb33c6038b6999ba649fc488b2
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
17package android.provider;
18
19import android.app.DownloadManager;
20import android.content.Context;
21import android.net.NetworkPolicyManager;
22import android.net.Uri;
23
24/**
25 * The Download Manager
26 *
27 * @pending
28 */
29public final class Downloads {
30    private Downloads() {}
31
32    /**
33     * Implementation details
34     *
35     * Exposes constants used to interact with the download manager's
36     * content provider.
37     * The constants URI ... STATUS are the names of columns in the downloads table.
38     *
39     * @hide
40     */
41    public static final class Impl implements BaseColumns {
42        private Impl() {}
43
44        /**
45         * The permission to access the download manager
46         */
47        public static final String PERMISSION_ACCESS = "android.permission.ACCESS_DOWNLOAD_MANAGER";
48
49        /**
50         * The permission to access the download manager's advanced functions
51         */
52        public static final String PERMISSION_ACCESS_ADVANCED =
53                "android.permission.ACCESS_DOWNLOAD_MANAGER_ADVANCED";
54
55        /**
56         * The permission to access the all the downloads in the manager.
57         */
58        public static final String PERMISSION_ACCESS_ALL =
59                "android.permission.ACCESS_ALL_DOWNLOADS";
60
61        /**
62         * The permission to directly access the download manager's cache
63         * directory
64         */
65        public static final String PERMISSION_CACHE = "android.permission.ACCESS_CACHE_FILESYSTEM";
66
67        /**
68         * The permission to send broadcasts on download completion
69         */
70        public static final String PERMISSION_SEND_INTENTS =
71                "android.permission.SEND_DOWNLOAD_COMPLETED_INTENTS";
72
73        /**
74         * The permission to download files to the cache partition that won't be automatically
75         * purged when space is needed.
76         */
77        public static final String PERMISSION_CACHE_NON_PURGEABLE =
78                "android.permission.DOWNLOAD_CACHE_NON_PURGEABLE";
79
80        /**
81         * The permission to download files without any system notification being shown.
82         */
83        public static final String PERMISSION_NO_NOTIFICATION =
84                "android.permission.DOWNLOAD_WITHOUT_NOTIFICATION";
85
86        /**
87         * The content:// URI to access downloads owned by the caller's UID.
88         */
89        public static final Uri CONTENT_URI =
90                Uri.parse("content://downloads/my_downloads");
91
92        /**
93         * The content URI for accessing all downloads across all UIDs (requires the
94         * ACCESS_ALL_DOWNLOADS permission).
95         */
96        public static final Uri ALL_DOWNLOADS_CONTENT_URI =
97                Uri.parse("content://downloads/all_downloads");
98
99        /** URI segment to access a publicly accessible downloaded file */
100        public static final String PUBLICLY_ACCESSIBLE_DOWNLOADS_URI_SEGMENT = "public_downloads";
101
102        /**
103         * The content URI for accessing publicly accessible downloads (i.e., it requires no
104         * permissions to access this downloaded file)
105         */
106        public static final Uri PUBLICLY_ACCESSIBLE_DOWNLOADS_URI =
107                Uri.parse("content://downloads/" + PUBLICLY_ACCESSIBLE_DOWNLOADS_URI_SEGMENT);
108
109        /**
110         * Broadcast Action: this is sent by the download manager to the app
111         * that had initiated a download when that download completes. The
112         * download's content: uri is specified in the intent's data.
113         */
114        public static final String ACTION_DOWNLOAD_COMPLETED =
115                "android.intent.action.DOWNLOAD_COMPLETED";
116
117        /**
118         * Broadcast Action: this is sent by the download manager to the app
119         * that had initiated a download when the user selects the notification
120         * associated with that download. The download's content: uri is specified
121         * in the intent's data if the click is associated with a single download,
122         * or Downloads.CONTENT_URI if the notification is associated with
123         * multiple downloads.
124         * Note: this is not currently sent for downloads that have completed
125         * successfully.
126         */
127        public static final String ACTION_NOTIFICATION_CLICKED =
128                "android.intent.action.DOWNLOAD_NOTIFICATION_CLICKED";
129
130        /**
131         * The name of the column containing the URI of the data being downloaded.
132         * <P>Type: TEXT</P>
133         * <P>Owner can Init/Read</P>
134         */
135        public static final String COLUMN_URI = "uri";
136
137        /**
138         * The name of the column containing application-specific data.
139         * <P>Type: TEXT</P>
140         * <P>Owner can Init/Read/Write</P>
141         */
142        public static final String COLUMN_APP_DATA = "entity";
143
144        /**
145         * The name of the column containing the flags that indicates whether
146         * the initiating application is capable of verifying the integrity of
147         * the downloaded file. When this flag is set, the download manager
148         * performs downloads and reports success even in some situations where
149         * it can't guarantee that the download has completed (e.g. when doing
150         * a byte-range request without an ETag, or when it can't determine
151         * whether a download fully completed).
152         * <P>Type: BOOLEAN</P>
153         * <P>Owner can Init</P>
154         */
155        public static final String COLUMN_NO_INTEGRITY = "no_integrity";
156
157        /**
158         * The name of the column containing the filename that the initiating
159         * application recommends. When possible, the download manager will attempt
160         * to use this filename, or a variation, as the actual name for the file.
161         * <P>Type: TEXT</P>
162         * <P>Owner can Init</P>
163         */
164        public static final String COLUMN_FILE_NAME_HINT = "hint";
165
166        /**
167         * The name of the column containing the filename where the downloaded data
168         * was actually stored.
169         * <P>Type: TEXT</P>
170         * <P>Owner can Read</P>
171         */
172        public static final String _DATA = "_data";
173
174        /**
175         * The name of the column containing the MIME type of the downloaded data.
176         * <P>Type: TEXT</P>
177         * <P>Owner can Init/Read</P>
178         */
179        public static final String COLUMN_MIME_TYPE = "mimetype";
180
181        /**
182         * The name of the column containing the flag that controls the destination
183         * of the download. See the DESTINATION_* constants for a list of legal values.
184         * <P>Type: INTEGER</P>
185         * <P>Owner can Init</P>
186         */
187        public static final String COLUMN_DESTINATION = "destination";
188
189        /**
190         * The name of the column containing the flags that controls whether the
191         * download is displayed by the UI. See the VISIBILITY_* constants for
192         * a list of legal values.
193         * <P>Type: INTEGER</P>
194         * <P>Owner can Init/Read/Write</P>
195         */
196        public static final String COLUMN_VISIBILITY = "visibility";
197
198        /**
199         * The name of the column containing the current control state  of the download.
200         * Applications can write to this to control (pause/resume) the download.
201         * the CONTROL_* constants for a list of legal values.
202         * <P>Type: INTEGER</P>
203         * <P>Owner can Read</P>
204         */
205        public static final String COLUMN_CONTROL = "control";
206
207        /**
208         * The name of the column containing the current status of the download.
209         * Applications can read this to follow the progress of each download. See
210         * the STATUS_* constants for a list of legal values.
211         * <P>Type: INTEGER</P>
212         * <P>Owner can Read</P>
213         */
214        public static final String COLUMN_STATUS = "status";
215
216        /**
217         * The name of the column containing the date at which some interesting
218         * status changed in the download. Stored as a System.currentTimeMillis()
219         * value.
220         * <P>Type: BIGINT</P>
221         * <P>Owner can Read</P>
222         */
223        public static final String COLUMN_LAST_MODIFICATION = "lastmod";
224
225        /**
226         * The name of the column containing the package name of the application
227         * that initiating the download. The download manager will send
228         * notifications to a component in this package when the download completes.
229         * <P>Type: TEXT</P>
230         * <P>Owner can Init/Read</P>
231         */
232        public static final String COLUMN_NOTIFICATION_PACKAGE = "notificationpackage";
233
234        /**
235         * The name of the column containing the component name of the class that
236         * will receive notifications associated with the download. The
237         * package/class combination is passed to
238         * Intent.setClassName(String,String).
239         * <P>Type: TEXT</P>
240         * <P>Owner can Init/Read</P>
241         */
242        public static final String COLUMN_NOTIFICATION_CLASS = "notificationclass";
243
244        /**
245         * If extras are specified when requesting a download they will be provided in the intent that
246         * is sent to the specified class and package when a download has finished.
247         * <P>Type: TEXT</P>
248         * <P>Owner can Init</P>
249         */
250        public static final String COLUMN_NOTIFICATION_EXTRAS = "notificationextras";
251
252        /**
253         * The name of the column contain the values of the cookie to be used for
254         * the download. This is used directly as the value for the Cookie: HTTP
255         * header that gets sent with the request.
256         * <P>Type: TEXT</P>
257         * <P>Owner can Init</P>
258         */
259        public static final String COLUMN_COOKIE_DATA = "cookiedata";
260
261        /**
262         * The name of the column containing the user agent that the initiating
263         * application wants the download manager to use for this download.
264         * <P>Type: TEXT</P>
265         * <P>Owner can Init</P>
266         */
267        public static final String COLUMN_USER_AGENT = "useragent";
268
269        /**
270         * The name of the column containing the referer (sic) that the initiating
271         * application wants the download manager to use for this download.
272         * <P>Type: TEXT</P>
273         * <P>Owner can Init</P>
274         */
275        public static final String COLUMN_REFERER = "referer";
276
277        /**
278         * The name of the column containing the total size of the file being
279         * downloaded.
280         * <P>Type: INTEGER</P>
281         * <P>Owner can Read</P>
282         */
283        public static final String COLUMN_TOTAL_BYTES = "total_bytes";
284
285        /**
286         * The name of the column containing the size of the part of the file that
287         * has been downloaded so far.
288         * <P>Type: INTEGER</P>
289         * <P>Owner can Read</P>
290         */
291        public static final String COLUMN_CURRENT_BYTES = "current_bytes";
292
293        /**
294         * The name of the column where the initiating application can provide the
295         * UID of another application that is allowed to access this download. If
296         * multiple applications share the same UID, all those applications will be
297         * allowed to access this download. This column can be updated after the
298         * download is initiated. This requires the permission
299         * android.permission.ACCESS_DOWNLOAD_MANAGER_ADVANCED.
300         * <P>Type: INTEGER</P>
301         * <P>Owner can Init</P>
302         */
303        public static final String COLUMN_OTHER_UID = "otheruid";
304
305        /**
306         * The name of the column where the initiating application can provided the
307         * title of this download. The title will be displayed ito the user in the
308         * list of downloads.
309         * <P>Type: TEXT</P>
310         * <P>Owner can Init/Read/Write</P>
311         */
312        public static final String COLUMN_TITLE = "title";
313
314        /**
315         * The name of the column where the initiating application can provide the
316         * description of this download. The description will be displayed to the
317         * user in the list of downloads.
318         * <P>Type: TEXT</P>
319         * <P>Owner can Init/Read/Write</P>
320         */
321        public static final String COLUMN_DESCRIPTION = "description";
322
323        /**
324         * The name of the column indicating whether the download was requesting through the public
325         * API.  This controls some differences in behavior.
326         * <P>Type: BOOLEAN</P>
327         * <P>Owner can Init/Read</P>
328         */
329        public static final String COLUMN_IS_PUBLIC_API = "is_public_api";
330
331        /**
332         * The name of the column holding a bitmask of allowed network types.  This is only used for
333         * public API downloads.
334         * <P>Type: INTEGER</P>
335         * <P>Owner can Init/Read</P>
336         */
337        public static final String COLUMN_ALLOWED_NETWORK_TYPES = "allowed_network_types";
338
339        /**
340         * The name of the column indicating whether roaming connections can be used.  This is only
341         * used for public API downloads.
342         * <P>Type: BOOLEAN</P>
343         * <P>Owner can Init/Read</P>
344         */
345        public static final String COLUMN_ALLOW_ROAMING = "allow_roaming";
346
347        /**
348         * The name of the column indicating whether metered connections can be used.  This is only
349         * used for public API downloads.
350         * <P>Type: BOOLEAN</P>
351         * <P>Owner can Init/Read</P>
352         */
353        public static final String COLUMN_ALLOW_METERED = "allow_metered";
354
355        /**
356         * Whether or not this download should be displayed in the system's Downloads UI.  Defaults
357         * to true.
358         * <P>Type: INTEGER</P>
359         * <P>Owner can Init/Read</P>
360         */
361        public static final String COLUMN_IS_VISIBLE_IN_DOWNLOADS_UI = "is_visible_in_downloads_ui";
362
363        /**
364         * If true, the user has confirmed that this download can proceed over the mobile network
365         * even though it exceeds the recommended maximum size.
366         * <P>Type: BOOLEAN</P>
367         */
368        public static final String COLUMN_BYPASS_RECOMMENDED_SIZE_LIMIT =
369            "bypass_recommended_size_limit";
370
371        /**
372         * Set to true if this download is deleted. It is completely removed from the database
373         * when MediaProvider database also deletes the metadata asociated with this downloaded file.
374         * <P>Type: BOOLEAN</P>
375         * <P>Owner can Read</P>
376         */
377        public static final String COLUMN_DELETED = "deleted";
378
379        /**
380         * The URI to the corresponding entry in MediaProvider for this downloaded entry. It is
381         * used to delete the entries from MediaProvider database when it is deleted from the
382         * downloaded list.
383         * <P>Type: TEXT</P>
384         * <P>Owner can Read</P>
385         */
386        public static final String COLUMN_MEDIAPROVIDER_URI = "mediaprovider_uri";
387
388        /**
389         * The column that is used to remember whether the media scanner was invoked.
390         * It can take the values: null or 0(not scanned), 1(scanned), 2 (not scannable).
391         * <P>Type: TEXT</P>
392         */
393        public static final String COLUMN_MEDIA_SCANNED = "scanned";
394
395        /**
396         * The column with errorMsg for a failed downloaded.
397         * Used only for debugging purposes.
398         * <P>Type: TEXT</P>
399         */
400        public static final String COLUMN_ERROR_MSG = "errorMsg";
401
402        /**
403         *  This column stores the source of the last update to this row.
404         *  This column is only for internal use.
405         *  Valid values are indicated by LAST_UPDATESRC_* constants.
406         * <P>Type: INT</P>
407         */
408        public static final String COLUMN_LAST_UPDATESRC = "lastUpdateSrc";
409
410        /** The column that is used to count retries */
411        public static final String COLUMN_FAILED_CONNECTIONS = "numfailed";
412
413        /**
414         * default value for {@link #COLUMN_LAST_UPDATESRC}.
415         * This value is used when this column's value is not relevant.
416         */
417        public static final int LAST_UPDATESRC_NOT_RELEVANT = 0;
418
419        /**
420         * One of the values taken by {@link #COLUMN_LAST_UPDATESRC}.
421         * This value is used when the update is NOT to be relayed to the DownloadService
422         * (and thus spare DownloadService from scanning the database when this change occurs)
423         */
424        public static final int LAST_UPDATESRC_DONT_NOTIFY_DOWNLOADSVC = 1;
425
426        /*
427         * Lists the destinations that an application can specify for a download.
428         */
429
430        /**
431         * This download will be saved to the external storage. This is the
432         * default behavior, and should be used for any file that the user
433         * can freely access, copy, delete. Even with that destination,
434         * unencrypted DRM files are saved in secure internal storage.
435         * Downloads to the external destination only write files for which
436         * there is a registered handler. The resulting files are accessible
437         * by filename to all applications.
438         */
439        public static final int DESTINATION_EXTERNAL = 0;
440
441        /**
442         * This download will be saved to the download manager's private
443         * partition. This is the behavior used by applications that want to
444         * download private files that are used and deleted soon after they
445         * get downloaded. All file types are allowed, and only the initiating
446         * application can access the file (indirectly through a content
447         * provider). This requires the
448         * android.permission.ACCESS_DOWNLOAD_MANAGER_ADVANCED permission.
449         */
450        public static final int DESTINATION_CACHE_PARTITION = 1;
451
452        /**
453         * This download will be saved to the download manager's private
454         * partition and will be purged as necessary to make space. This is
455         * for private files (similar to CACHE_PARTITION) that aren't deleted
456         * immediately after they are used, and are kept around by the download
457         * manager as long as space is available.
458         */
459        public static final int DESTINATION_CACHE_PARTITION_PURGEABLE = 2;
460
461        /**
462         * This download will be saved to the download manager's private
463         * partition, as with DESTINATION_CACHE_PARTITION, but the download
464         * will not proceed if the user is on a roaming data connection.
465         */
466        public static final int DESTINATION_CACHE_PARTITION_NOROAMING = 3;
467
468        /**
469         * This download will be saved to the location given by the file URI in
470         * {@link #COLUMN_FILE_NAME_HINT}.
471         */
472        public static final int DESTINATION_FILE_URI = 4;
473
474        /**
475         * This download will be saved to the system cache ("/cache")
476         * partition. This option is only used by system apps and so it requires
477         * android.permission.ACCESS_CACHE_FILESYSTEM permission.
478         */
479        public static final int DESTINATION_SYSTEMCACHE_PARTITION = 5;
480
481        /**
482         * This download was completed by the caller (i.e., NOT downloadmanager)
483         * and caller wants to have this download displayed in Downloads App.
484         */
485        public static final int DESTINATION_NON_DOWNLOADMANAGER_DOWNLOAD = 6;
486
487        /**
488         * This download is allowed to run.
489         */
490        public static final int CONTROL_RUN = 0;
491
492        /**
493         * This download must pause at the first opportunity.
494         */
495        public static final int CONTROL_PAUSED = 1;
496
497        /*
498         * Lists the states that the download manager can set on a download
499         * to notify applications of the download progress.
500         * The codes follow the HTTP families:<br>
501         * 1xx: informational<br>
502         * 2xx: success<br>
503         * 3xx: redirects (not used by the download manager)<br>
504         * 4xx: client errors<br>
505         * 5xx: server errors
506         */
507
508        /**
509         * Returns whether the status is informational (i.e. 1xx).
510         */
511        public static boolean isStatusInformational(int status) {
512            return (status >= 100 && status < 200);
513        }
514
515        /**
516         * Returns whether the status is a success (i.e. 2xx).
517         */
518        public static boolean isStatusSuccess(int status) {
519            return (status >= 200 && status < 300);
520        }
521
522        /**
523         * Returns whether the status is an error (i.e. 4xx or 5xx).
524         */
525        public static boolean isStatusError(int status) {
526            return (status >= 400 && status < 600);
527        }
528
529        /**
530         * Returns whether the status is a client error (i.e. 4xx).
531         */
532        public static boolean isStatusClientError(int status) {
533            return (status >= 400 && status < 500);
534        }
535
536        /**
537         * Returns whether the status is a server error (i.e. 5xx).
538         */
539        public static boolean isStatusServerError(int status) {
540            return (status >= 500 && status < 600);
541        }
542
543        /**
544         * this method determines if a notification should be displayed for a
545         * given {@link #COLUMN_VISIBILITY} value
546         * @param visibility the value of {@link #COLUMN_VISIBILITY}.
547         * @return true if the notification should be displayed. false otherwise.
548         */
549        public static boolean isNotificationToBeDisplayed(int visibility) {
550            return visibility == DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED ||
551                    visibility == DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_ONLY_COMPLETION;
552        }
553
554        /**
555         * Returns whether the download has completed (either with success or
556         * error).
557         */
558        public static boolean isStatusCompleted(int status) {
559            return (status >= 200 && status < 300) || (status >= 400 && status < 600);
560        }
561
562        /**
563         * This download hasn't stated yet
564         */
565        public static final int STATUS_PENDING = 190;
566
567        /**
568         * This download has started
569         */
570        public static final int STATUS_RUNNING = 192;
571
572        /**
573         * This download has been paused by the owning app.
574         */
575        public static final int STATUS_PAUSED_BY_APP = 193;
576
577        /**
578         * This download encountered some network error and is waiting before retrying the request.
579         */
580        public static final int STATUS_WAITING_TO_RETRY = 194;
581
582        /**
583         * This download is waiting for network connectivity to proceed.
584         */
585        public static final int STATUS_WAITING_FOR_NETWORK = 195;
586
587        /**
588         * This download exceeded a size limit for mobile networks and is waiting for a Wi-Fi
589         * connection to proceed.
590         */
591        public static final int STATUS_QUEUED_FOR_WIFI = 196;
592
593        /**
594         * This download couldn't be completed due to insufficient storage
595         * space.  Typically, this is because the SD card is full.
596         */
597        public static final int STATUS_INSUFFICIENT_SPACE_ERROR = 198;
598
599        /**
600         * This download couldn't be completed because no external storage
601         * device was found.  Typically, this is because the SD card is not
602         * mounted.
603         */
604        public static final int STATUS_DEVICE_NOT_FOUND_ERROR = 199;
605
606        /**
607         * This download has successfully completed.
608         * Warning: there might be other status values that indicate success
609         * in the future.
610         * Use isSucccess() to capture the entire category.
611         */
612        public static final int STATUS_SUCCESS = 200;
613
614        /**
615         * This request couldn't be parsed. This is also used when processing
616         * requests with unknown/unsupported URI schemes.
617         */
618        public static final int STATUS_BAD_REQUEST = 400;
619
620        /**
621         * This download can't be performed because the content type cannot be
622         * handled.
623         */
624        public static final int STATUS_NOT_ACCEPTABLE = 406;
625
626        /**
627         * This download cannot be performed because the length cannot be
628         * determined accurately. This is the code for the HTTP error "Length
629         * Required", which is typically used when making requests that require
630         * a content length but don't have one, and it is also used in the
631         * client when a response is received whose length cannot be determined
632         * accurately (therefore making it impossible to know when a download
633         * completes).
634         */
635        public static final int STATUS_LENGTH_REQUIRED = 411;
636
637        /**
638         * This download was interrupted and cannot be resumed.
639         * This is the code for the HTTP error "Precondition Failed", and it is
640         * also used in situations where the client doesn't have an ETag at all.
641         */
642        public static final int STATUS_PRECONDITION_FAILED = 412;
643
644        /**
645         * The lowest-valued error status that is not an actual HTTP status code.
646         */
647        public static final int MIN_ARTIFICIAL_ERROR_STATUS = 488;
648
649        /**
650         * The requested destination file already exists.
651         */
652        public static final int STATUS_FILE_ALREADY_EXISTS_ERROR = 488;
653
654        /**
655         * Some possibly transient error occurred, but we can't resume the download.
656         */
657        public static final int STATUS_CANNOT_RESUME = 489;
658
659        /**
660         * This download was canceled
661         */
662        public static final int STATUS_CANCELED = 490;
663
664        /**
665         * This download has completed with an error.
666         * Warning: there will be other status values that indicate errors in
667         * the future. Use isStatusError() to capture the entire category.
668         */
669        public static final int STATUS_UNKNOWN_ERROR = 491;
670
671        /**
672         * This download couldn't be completed because of a storage issue.
673         * Typically, that's because the filesystem is missing or full.
674         * Use the more specific {@link #STATUS_INSUFFICIENT_SPACE_ERROR}
675         * and {@link #STATUS_DEVICE_NOT_FOUND_ERROR} when appropriate.
676         */
677        public static final int STATUS_FILE_ERROR = 492;
678
679        /**
680         * This download couldn't be completed because of an HTTP
681         * redirect response that the download manager couldn't
682         * handle.
683         */
684        public static final int STATUS_UNHANDLED_REDIRECT = 493;
685
686        /**
687         * This download couldn't be completed because of an
688         * unspecified unhandled HTTP code.
689         */
690        public static final int STATUS_UNHANDLED_HTTP_CODE = 494;
691
692        /**
693         * This download couldn't be completed because of an
694         * error receiving or processing data at the HTTP level.
695         */
696        public static final int STATUS_HTTP_DATA_ERROR = 495;
697
698        /**
699         * This download couldn't be completed because of an
700         * HttpException while setting up the request.
701         */
702        public static final int STATUS_HTTP_EXCEPTION = 496;
703
704        /**
705         * This download couldn't be completed because there were
706         * too many redirects.
707         */
708        public static final int STATUS_TOO_MANY_REDIRECTS = 497;
709
710        /**
711         * This download has failed because requesting application has been
712         * blocked by {@link NetworkPolicyManager}.
713         *
714         * @hide
715         * @deprecated since behavior now uses
716         *             {@link #STATUS_WAITING_FOR_NETWORK}
717         */
718        @Deprecated
719        public static final int STATUS_BLOCKED = 498;
720
721        /** {@hide} */
722        public static String statusToString(int status) {
723            switch (status) {
724                case STATUS_PENDING: return "PENDING";
725                case STATUS_RUNNING: return "RUNNING";
726                case STATUS_PAUSED_BY_APP: return "PAUSED_BY_APP";
727                case STATUS_WAITING_TO_RETRY: return "WAITING_TO_RETRY";
728                case STATUS_WAITING_FOR_NETWORK: return "WAITING_FOR_NETWORK";
729                case STATUS_QUEUED_FOR_WIFI: return "QUEUED_FOR_WIFI";
730                case STATUS_INSUFFICIENT_SPACE_ERROR: return "INSUFFICIENT_SPACE_ERROR";
731                case STATUS_DEVICE_NOT_FOUND_ERROR: return "DEVICE_NOT_FOUND_ERROR";
732                case STATUS_SUCCESS: return "SUCCESS";
733                case STATUS_BAD_REQUEST: return "BAD_REQUEST";
734                case STATUS_NOT_ACCEPTABLE: return "NOT_ACCEPTABLE";
735                case STATUS_LENGTH_REQUIRED: return "LENGTH_REQUIRED";
736                case STATUS_PRECONDITION_FAILED: return "PRECONDITION_FAILED";
737                case STATUS_FILE_ALREADY_EXISTS_ERROR: return "FILE_ALREADY_EXISTS_ERROR";
738                case STATUS_CANNOT_RESUME: return "CANNOT_RESUME";
739                case STATUS_CANCELED: return "CANCELED";
740                case STATUS_UNKNOWN_ERROR: return "UNKNOWN_ERROR";
741                case STATUS_FILE_ERROR: return "FILE_ERROR";
742                case STATUS_UNHANDLED_REDIRECT: return "UNHANDLED_REDIRECT";
743                case STATUS_UNHANDLED_HTTP_CODE: return "UNHANDLED_HTTP_CODE";
744                case STATUS_HTTP_DATA_ERROR: return "HTTP_DATA_ERROR";
745                case STATUS_HTTP_EXCEPTION: return "HTTP_EXCEPTION";
746                case STATUS_TOO_MANY_REDIRECTS: return "TOO_MANY_REDIRECTS";
747                case STATUS_BLOCKED: return "BLOCKED";
748                default: return Integer.toString(status);
749            }
750        }
751
752        /**
753         * This download is visible but only shows in the notifications
754         * while it's in progress.
755         */
756        public static final int VISIBILITY_VISIBLE = DownloadManager.Request.VISIBILITY_VISIBLE;
757
758        /**
759         * This download is visible and shows in the notifications while
760         * in progress and after completion.
761         */
762        public static final int VISIBILITY_VISIBLE_NOTIFY_COMPLETED =
763                DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED;
764
765        /**
766         * This download doesn't show in the UI or in the notifications.
767         */
768        public static final int VISIBILITY_HIDDEN = DownloadManager.Request.VISIBILITY_HIDDEN;
769
770        /**
771         * Constants related to HTTP request headers associated with each download.
772         */
773        public static class RequestHeaders {
774            public static final String HEADERS_DB_TABLE = "request_headers";
775            public static final String COLUMN_DOWNLOAD_ID = "download_id";
776            public static final String COLUMN_HEADER = "header";
777            public static final String COLUMN_VALUE = "value";
778
779            /**
780             * Path segment to add to a download URI to retrieve request headers
781             */
782            public static final String URI_SEGMENT = "headers";
783
784            /**
785             * Prefix for ContentValues keys that contain HTTP header lines, to be passed to
786             * DownloadProvider.insert().
787             */
788            public static final String INSERT_KEY_PREFIX = "http_header_";
789        }
790    }
791
792    /**
793     * Query where clause for general querying.
794     */
795    private static final String QUERY_WHERE_CLAUSE = Impl.COLUMN_NOTIFICATION_PACKAGE + "=? AND "
796            + Impl.COLUMN_NOTIFICATION_CLASS + "=?";
797
798    /**
799     * Delete all the downloads for a package/class pair.
800     */
801    public static final void removeAllDownloadsByPackage(
802            Context context, String notification_package, String notification_class) {
803        context.getContentResolver().delete(Impl.CONTENT_URI, QUERY_WHERE_CLAUSE,
804                new String[] { notification_package, notification_class });
805    }
806}
807