Context.java revision b4163a6e12ee7100c758c6d3d062ade1f2843fce
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.content; 18 19import android.content.pm.ApplicationInfo; 20import android.content.pm.PackageManager; 21import android.content.res.AssetManager; 22import android.content.res.Resources; 23import android.content.res.TypedArray; 24import android.database.DatabaseErrorHandler; 25import android.database.sqlite.SQLiteDatabase; 26import android.database.sqlite.SQLiteDatabase.CursorFactory; 27import android.graphics.Bitmap; 28import android.graphics.drawable.Drawable; 29import android.media.MediaScannerConnection.OnScanCompletedListener; 30import android.net.Uri; 31import android.os.Bundle; 32import android.os.Handler; 33import android.os.Looper; 34import android.util.AttributeSet; 35 36import java.io.File; 37import java.io.FileInputStream; 38import java.io.FileNotFoundException; 39import java.io.FileOutputStream; 40import java.io.IOException; 41import java.io.InputStream; 42 43/** 44 * Interface to global information about an application environment. This is 45 * an abstract class whose implementation is provided by 46 * the Android system. It 47 * allows access to application-specific resources and classes, as well as 48 * up-calls for application-level operations such as launching activities, 49 * broadcasting and receiving intents, etc. 50 */ 51public abstract class Context { 52 /** 53 * File creation mode: the default mode, where the created file can only 54 * be accessed by the calling application (or all applications sharing the 55 * same user ID). 56 * @see #MODE_WORLD_READABLE 57 * @see #MODE_WORLD_WRITEABLE 58 */ 59 public static final int MODE_PRIVATE = 0x0000; 60 /** 61 * File creation mode: allow all other applications to have read access 62 * to the created file. 63 * @see #MODE_PRIVATE 64 * @see #MODE_WORLD_WRITEABLE 65 */ 66 public static final int MODE_WORLD_READABLE = 0x0001; 67 /** 68 * File creation mode: allow all other applications to have write access 69 * to the created file. 70 * @see #MODE_PRIVATE 71 * @see #MODE_WORLD_READABLE 72 */ 73 public static final int MODE_WORLD_WRITEABLE = 0x0002; 74 /** 75 * File creation mode: for use with {@link #openFileOutput}, if the file 76 * already exists then write data to the end of the existing file 77 * instead of erasing it. 78 * @see #openFileOutput 79 */ 80 public static final int MODE_APPEND = 0x8000; 81 82 /** 83 * SharedPreference loading flag: when set, the file on disk will 84 * be checked for modification even if the shared preferences 85 * instance is already loaded in this process. This behavior is 86 * sometimes desired in cases where the application has multiple 87 * processes, all writing to the same SharedPreferences file. 88 * Generally there are better forms of communication between 89 * processes, though. 90 * 91 * <p>This was the legacy (but undocumented) behavior in and 92 * before Gingerbread (Android 2.3) and this flag is implied when 93 * targetting such releases. For applications targetting SDK 94 * versions <em>greater than</em> Android 2.3, this flag must be 95 * explicitly set if desired. 96 * 97 * @see #getSharedPreferences 98 */ 99 public static final int MODE_MULTI_PROCESS = 0x0004; 100 101 /** 102 * Database open flag: when set, the database is opened with write-ahead 103 * logging enabled by default. 104 * 105 * @see #openOrCreateDatabase(String, int, CursorFactory) 106 * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler) 107 * @see SQLiteDatabase#enableWriteAheadLogging 108 */ 109 public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING = 0x0008; 110 111 /** 112 * Flag for {@link #bindService}: automatically create the service as long 113 * as the binding exists. Note that while this will create the service, 114 * its {@link android.app.Service#onStartCommand} 115 * method will still only be called due to an 116 * explicit call to {@link #startService}. Even without that, though, 117 * this still provides you with access to the service object while the 118 * service is created. 119 * 120 * <p>Note that prior to {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, 121 * not supplying this flag would also impact how important the system 122 * consider's the target service's process to be. When set, the only way 123 * for it to be raised was by binding from a service in which case it will 124 * only be important when that activity is in the foreground. Now to 125 * achieve this behavior you must explicitly supply the new flag 126 * {@link #BIND_ADJUST_WITH_ACTIVITY}. For compatibility, old applications 127 * that don't specify {@link #BIND_AUTO_CREATE} will automatically have 128 * the flags {@link #BIND_WAIVE_PRIORITY} and 129 * {@link #BIND_ADJUST_WITH_ACTIVITY} set for them in order to achieve 130 * the same result. 131 */ 132 public static final int BIND_AUTO_CREATE = 0x0001; 133 134 /** 135 * Flag for {@link #bindService}: include debugging help for mismatched 136 * calls to unbind. When this flag is set, the callstack of the following 137 * {@link #unbindService} call is retained, to be printed if a later 138 * incorrect unbind call is made. Note that doing this requires retaining 139 * information about the binding that was made for the lifetime of the app, 140 * resulting in a leak -- this should only be used for debugging. 141 */ 142 public static final int BIND_DEBUG_UNBIND = 0x0002; 143 144 /** 145 * Flag for {@link #bindService}: don't allow this binding to raise 146 * the target service's process to the foreground scheduling priority. 147 * It will still be raised to at least the same memory priority 148 * as the client (so that its process will not be killable in any 149 * situation where the client is not killable), but for CPU scheduling 150 * purposes it may be left in the background. This only has an impact 151 * in the situation where the binding client is a foreground process 152 * and the target service is in a background process. 153 */ 154 public static final int BIND_NOT_FOREGROUND = 0x0004; 155 156 /** 157 * Flag for {@link #bindService}: indicates that the client application 158 * binding to this service considers the service to be more important than 159 * the app itself. When set, the platform will try to have the out of 160 * memory kill the app before it kills the service it is bound to, though 161 * this is not guaranteed to be the case. 162 */ 163 public static final int BIND_ABOVE_CLIENT = 0x0008; 164 165 /** 166 * Flag for {@link #bindService}: allow the process hosting the bound 167 * service to go through its normal memory management. It will be 168 * treated more like a running service, allowing the system to 169 * (temporarily) expunge the process if low on memory or for some other 170 * whim it may have, and being more aggressive about making it a candidate 171 * to be killed (and restarted) if running for a long time. 172 */ 173 public static final int BIND_ALLOW_OOM_MANAGEMENT = 0x0010; 174 175 /** 176 * Flag for {@link #bindService}: don't impact the scheduling or 177 * memory management priority of the target service's hosting process. 178 * Allows the service's process to be managed on the background LRU list 179 * just like a regular application process in the background. 180 */ 181 public static final int BIND_WAIVE_PRIORITY = 0x0020; 182 183 /** 184 * Flag for {@link #bindService}: this service is very important to 185 * the client, so should be brought to the foreground process level 186 * when the client is. Normally a process can only be raised to the 187 * visibility level by a client, even if that client is in the foreground. 188 */ 189 public static final int BIND_IMPORTANT = 0x0040; 190 191 /** 192 * Flag for {@link #bindService}: If binding from an activity, allow the 193 * target service's process importance to be raised based on whether the 194 * activity is visible to the user, regardless whether another flag is 195 * used to reduce the amount that the client process's overall importance 196 * is used to impact it. 197 */ 198 public static final int BIND_ADJUST_WITH_ACTIVITY = 0x0080; 199 200 /** 201 * Flag for {@link #bindService}: Don't consider the bound service to be 202 * visible, even if the caller is visible. 203 * @hide 204 */ 205 public static final int BIND_NOT_VISIBLE = 0x40000000; 206 207 /** Return an AssetManager instance for your application's package. */ 208 public abstract AssetManager getAssets(); 209 210 /** Return a Resources instance for your application's package. */ 211 public abstract Resources getResources(); 212 213 /** Return PackageManager instance to find global package information. */ 214 public abstract PackageManager getPackageManager(); 215 216 /** Return a ContentResolver instance for your application's package. */ 217 public abstract ContentResolver getContentResolver(); 218 219 /** 220 * Return the Looper for the main thread of the current process. This is 221 * the thread used to dispatch calls to application components (activities, 222 * services, etc). 223 */ 224 public abstract Looper getMainLooper(); 225 226 /** 227 * Return the context of the single, global Application object of the 228 * current process. This generally should only be used if you need a 229 * Context whose lifecycle is separate from the current context, that is 230 * tied to the lifetime of the process rather than the current component. 231 * 232 * <p>Consider for example how this interacts with 233 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)}: 234 * <ul> 235 * <li> <p>If used from an Activity context, the receiver is being registered 236 * within that activity. This means that you are expected to unregister 237 * before the activity is done being destroyed; in fact if you do not do 238 * so, the framework will clean up your leaked registration as it removes 239 * the activity and log an error. Thus, if you use the Activity context 240 * to register a receiver that is static (global to the process, not 241 * associated with an Activity instance) then that registration will be 242 * removed on you at whatever point the activity you used is destroyed. 243 * <li> <p>If used from the Context returned here, the receiver is being 244 * registered with the global state associated with your application. Thus 245 * it will never be unregistered for you. This is necessary if the receiver 246 * is associated with static data, not a particular component. However 247 * using the ApplicationContext elsewhere can easily lead to serious leaks 248 * if you forget to unregister, unbind, etc. 249 * </ul> 250 */ 251 public abstract Context getApplicationContext(); 252 253 /** 254 * Add a new {@link ComponentCallbacks} to the base application of the 255 * Context, which will be called at the same times as the ComponentCallbacks 256 * methods of activities and other components are called. Note that you 257 * <em>must</em> be sure to use {@link #unregisterComponentCallbacks} when 258 * appropriate in the future; this will not be removed for you. 259 * 260 * @param callback The interface to call. This can be either a 261 * {@link ComponentCallbacks} or {@link ComponentCallbacks2} interface. 262 */ 263 public void registerComponentCallbacks(ComponentCallbacks callback) { 264 getApplicationContext().registerComponentCallbacks(callback); 265 } 266 267 /** 268 * Remove a {@link ComponentCallbacks} objec that was previously registered 269 * with {@link #registerComponentCallbacks(ComponentCallbacks)}. 270 */ 271 public void unregisterComponentCallbacks(ComponentCallbacks callback) { 272 getApplicationContext().unregisterComponentCallbacks(callback); 273 } 274 275 /** 276 * Return a localized, styled CharSequence from the application's package's 277 * default string table. 278 * 279 * @param resId Resource id for the CharSequence text 280 */ 281 public final CharSequence getText(int resId) { 282 return getResources().getText(resId); 283 } 284 285 /** 286 * Return a localized string from the application's package's 287 * default string table. 288 * 289 * @param resId Resource id for the string 290 */ 291 public final String getString(int resId) { 292 return getResources().getString(resId); 293 } 294 295 /** 296 * Return a localized formatted string from the application's package's 297 * default string table, substituting the format arguments as defined in 298 * {@link java.util.Formatter} and {@link java.lang.String#format}. 299 * 300 * @param resId Resource id for the format string 301 * @param formatArgs The format arguments that will be used for substitution. 302 */ 303 304 public final String getString(int resId, Object... formatArgs) { 305 return getResources().getString(resId, formatArgs); 306 } 307 308 /** 309 * Set the base theme for this context. Note that this should be called 310 * before any views are instantiated in the Context (for example before 311 * calling {@link android.app.Activity#setContentView} or 312 * {@link android.view.LayoutInflater#inflate}). 313 * 314 * @param resid The style resource describing the theme. 315 */ 316 public abstract void setTheme(int resid); 317 318 /** @hide Needed for some internal implementation... not public because 319 * you can't assume this actually means anything. */ 320 public int getThemeResId() { 321 return 0; 322 } 323 324 /** 325 * Return the Theme object associated with this Context. 326 */ 327 public abstract Resources.Theme getTheme(); 328 329 /** 330 * Retrieve styled attribute information in this Context's theme. See 331 * {@link Resources.Theme#obtainStyledAttributes(int[])} 332 * for more information. 333 * 334 * @see Resources.Theme#obtainStyledAttributes(int[]) 335 */ 336 public final TypedArray obtainStyledAttributes( 337 int[] attrs) { 338 return getTheme().obtainStyledAttributes(attrs); 339 } 340 341 /** 342 * Retrieve styled attribute information in this Context's theme. See 343 * {@link Resources.Theme#obtainStyledAttributes(int, int[])} 344 * for more information. 345 * 346 * @see Resources.Theme#obtainStyledAttributes(int, int[]) 347 */ 348 public final TypedArray obtainStyledAttributes( 349 int resid, int[] attrs) throws Resources.NotFoundException { 350 return getTheme().obtainStyledAttributes(resid, attrs); 351 } 352 353 /** 354 * Retrieve styled attribute information in this Context's theme. See 355 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} 356 * for more information. 357 * 358 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) 359 */ 360 public final TypedArray obtainStyledAttributes( 361 AttributeSet set, int[] attrs) { 362 return getTheme().obtainStyledAttributes(set, attrs, 0, 0); 363 } 364 365 /** 366 * Retrieve styled attribute information in this Context's theme. See 367 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} 368 * for more information. 369 * 370 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) 371 */ 372 public final TypedArray obtainStyledAttributes( 373 AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) { 374 return getTheme().obtainStyledAttributes( 375 set, attrs, defStyleAttr, defStyleRes); 376 } 377 378 /** 379 * Return a class loader you can use to retrieve classes in this package. 380 */ 381 public abstract ClassLoader getClassLoader(); 382 383 /** Return the name of this application's package. */ 384 public abstract String getPackageName(); 385 386 /** Return the full application info for this context's package. */ 387 public abstract ApplicationInfo getApplicationInfo(); 388 389 /** 390 * Return the full path to this context's primary Android package. 391 * The Android package is a ZIP file which contains the application's 392 * primary resources. 393 * 394 * <p>Note: this is not generally useful for applications, since they should 395 * not be directly accessing the file system. 396 * 397 * @return String Path to the resources. 398 */ 399 public abstract String getPackageResourcePath(); 400 401 /** 402 * Return the full path to this context's primary Android package. 403 * The Android package is a ZIP file which contains application's 404 * primary code and assets. 405 * 406 * <p>Note: this is not generally useful for applications, since they should 407 * not be directly accessing the file system. 408 * 409 * @return String Path to the code and assets. 410 */ 411 public abstract String getPackageCodePath(); 412 413 /** 414 * {@hide} 415 * Return the full path to the shared prefs file for the given prefs group name. 416 * 417 * <p>Note: this is not generally useful for applications, since they should 418 * not be directly accessing the file system. 419 */ 420 public abstract File getSharedPrefsFile(String name); 421 422 /** 423 * Retrieve and hold the contents of the preferences file 'name', returning 424 * a SharedPreferences through which you can retrieve and modify its 425 * values. Only one instance of the SharedPreferences object is returned 426 * to any callers for the same name, meaning they will see each other's 427 * edits as soon as they are made. 428 * 429 * @param name Desired preferences file. If a preferences file by this name 430 * does not exist, it will be created when you retrieve an 431 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()). 432 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 433 * default operation, {@link #MODE_WORLD_READABLE} 434 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. The bit 435 * {@link #MODE_MULTI_PROCESS} can also be used if multiple processes 436 * are mutating the same SharedPreferences file. {@link #MODE_MULTI_PROCESS} 437 * is always on in apps targetting Gingerbread (Android 2.3) and below, and 438 * off by default in later versions. 439 * 440 * @return Returns the single SharedPreferences instance that can be used 441 * to retrieve and modify the preference values. 442 * 443 * @see #MODE_PRIVATE 444 * @see #MODE_WORLD_READABLE 445 * @see #MODE_WORLD_WRITEABLE 446 * @see #MODE_MULTI_PROCESS 447 */ 448 public abstract SharedPreferences getSharedPreferences(String name, 449 int mode); 450 451 /** 452 * Open a private file associated with this Context's application package 453 * for reading. 454 * 455 * @param name The name of the file to open; can not contain path 456 * separators. 457 * 458 * @return FileInputStream Resulting input stream. 459 * 460 * @see #openFileOutput 461 * @see #fileList 462 * @see #deleteFile 463 * @see java.io.FileInputStream#FileInputStream(String) 464 */ 465 public abstract FileInputStream openFileInput(String name) 466 throws FileNotFoundException; 467 468 /** 469 * Open a private file associated with this Context's application package 470 * for writing. Creates the file if it doesn't already exist. 471 * 472 * @param name The name of the file to open; can not contain path 473 * separators. 474 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 475 * default operation, {@link #MODE_APPEND} to append to an existing file, 476 * {@link #MODE_WORLD_READABLE} and {@link #MODE_WORLD_WRITEABLE} to control 477 * permissions. 478 * 479 * @return FileOutputStream Resulting output stream. 480 * 481 * @see #MODE_APPEND 482 * @see #MODE_PRIVATE 483 * @see #MODE_WORLD_READABLE 484 * @see #MODE_WORLD_WRITEABLE 485 * @see #openFileInput 486 * @see #fileList 487 * @see #deleteFile 488 * @see java.io.FileOutputStream#FileOutputStream(String) 489 */ 490 public abstract FileOutputStream openFileOutput(String name, int mode) 491 throws FileNotFoundException; 492 493 /** 494 * Delete the given private file associated with this Context's 495 * application package. 496 * 497 * @param name The name of the file to delete; can not contain path 498 * separators. 499 * 500 * @return True if the file was successfully deleted; else 501 * false. 502 * 503 * @see #openFileInput 504 * @see #openFileOutput 505 * @see #fileList 506 * @see java.io.File#delete() 507 */ 508 public abstract boolean deleteFile(String name); 509 510 /** 511 * Returns the absolute path on the filesystem where a file created with 512 * {@link #openFileOutput} is stored. 513 * 514 * @param name The name of the file for which you would like to get 515 * its path. 516 * 517 * @return Returns an absolute path to the given file. 518 * 519 * @see #openFileOutput 520 * @see #getFilesDir 521 * @see #getDir 522 */ 523 public abstract File getFileStreamPath(String name); 524 525 /** 526 * Returns the absolute path to the directory on the filesystem where 527 * files created with {@link #openFileOutput} are stored. 528 * 529 * @return Returns the path of the directory holding application files. 530 * 531 * @see #openFileOutput 532 * @see #getFileStreamPath 533 * @see #getDir 534 */ 535 public abstract File getFilesDir(); 536 537 /** 538 * Returns the absolute path to the directory on the external filesystem 539 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory() 540 * Environment.getExternalStorageDirectory()}) where the application can 541 * place persistent files it owns. These files are private to the 542 * applications, and not typically visible to the user as media. 543 * 544 * <p>This is like {@link #getFilesDir()} in that these 545 * files will be deleted when the application is uninstalled, however there 546 * are some important differences: 547 * 548 * <ul> 549 * <li>External files are not always available: they will disappear if the 550 * user mounts the external storage on a computer or removes it. See the 551 * APIs on {@link android.os.Environment} for information in the storage state. 552 * <li>There is no security enforced with these files. All applications 553 * can read and write files placed here. 554 * </ul> 555 * 556 * <p>Here is an example of typical code to manipulate a file in 557 * an application's private storage:</p> 558 * 559 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java 560 * private_file} 561 * 562 * <p>If you supply a non-null <var>type</var> to this function, the returned 563 * file will be a path to a sub-directory of the given type. Though these files 564 * are not automatically scanned by the media scanner, you can explicitly 565 * add them to the media database with 566 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[], 567 * OnScanCompletedListener) MediaScannerConnection.scanFile}. 568 * Note that this is not the same as 569 * {@link android.os.Environment#getExternalStoragePublicDirectory 570 * Environment.getExternalStoragePublicDirectory()}, which provides 571 * directories of media shared by all applications. The 572 * directories returned here are 573 * owned by the application, and their contents will be removed when the 574 * application is uninstalled. Unlike 575 * {@link android.os.Environment#getExternalStoragePublicDirectory 576 * Environment.getExternalStoragePublicDirectory()}, the directory 577 * returned here will be automatically created for you. 578 * 579 * <p>Here is an example of typical code to manipulate a picture in 580 * an application's private storage and add it to the media database:</p> 581 * 582 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java 583 * private_picture} 584 * 585 * @param type The type of files directory to return. May be null for 586 * the root of the files directory or one of 587 * the following Environment constants for a subdirectory: 588 * {@link android.os.Environment#DIRECTORY_MUSIC}, 589 * {@link android.os.Environment#DIRECTORY_PODCASTS}, 590 * {@link android.os.Environment#DIRECTORY_RINGTONES}, 591 * {@link android.os.Environment#DIRECTORY_ALARMS}, 592 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS}, 593 * {@link android.os.Environment#DIRECTORY_PICTURES}, or 594 * {@link android.os.Environment#DIRECTORY_MOVIES}. 595 * 596 * @return Returns the path of the directory holding application files 597 * on external storage. Returns null if external storage is not currently 598 * mounted so it could not ensure the path exists; you will need to call 599 * this method again when it is available. 600 * 601 * @see #getFilesDir 602 * @see android.os.Environment#getExternalStoragePublicDirectory 603 */ 604 public abstract File getExternalFilesDir(String type); 605 606 /** 607 * Return the directory where this application's OBB files (if there 608 * are any) can be found. Note if the application does not have any OBB 609 * files, this directory may not exist. 610 */ 611 public abstract File getObbDir(); 612 613 /** 614 * Returns the absolute path to the application specific cache directory 615 * on the filesystem. These files will be ones that get deleted first when the 616 * device runs low on storage. 617 * There is no guarantee when these files will be deleted. 618 * 619 * <strong>Note: you should not <em>rely</em> on the system deleting these 620 * files for you; you should always have a reasonable maximum, such as 1 MB, 621 * for the amount of space you consume with cache files, and prune those 622 * files when exceeding that space.</strong> 623 * 624 * @return Returns the path of the directory holding application cache files. 625 * 626 * @see #openFileOutput 627 * @see #getFileStreamPath 628 * @see #getDir 629 */ 630 public abstract File getCacheDir(); 631 632 /** 633 * Returns the absolute path to the directory on the external filesystem 634 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory() 635 * Environment.getExternalStorageDirectory()} where the application can 636 * place cache files it owns. 637 * 638 * <p>This is like {@link #getCacheDir()} in that these 639 * files will be deleted when the application is uninstalled, however there 640 * are some important differences: 641 * 642 * <ul> 643 * <li>The platform does not monitor the space available in external storage, 644 * and thus will not automatically delete these files. Note that you should 645 * be managing the maximum space you will use for these anyway, just like 646 * with {@link #getCacheDir()}. 647 * <li>External files are not always available: they will disappear if the 648 * user mounts the external storage on a computer or removes it. See the 649 * APIs on {@link android.os.Environment} for information in the storage state. 650 * <li>There is no security enforced with these files. All applications 651 * can read and write files placed here. 652 * </ul> 653 * 654 * @return Returns the path of the directory holding application cache files 655 * on external storage. Returns null if external storage is not currently 656 * mounted so it could not ensure the path exists; you will need to call 657 * this method again when it is available. 658 * 659 * @see #getCacheDir 660 */ 661 public abstract File getExternalCacheDir(); 662 663 /** 664 * Returns an array of strings naming the private files associated with 665 * this Context's application package. 666 * 667 * @return Array of strings naming the private files. 668 * 669 * @see #openFileInput 670 * @see #openFileOutput 671 * @see #deleteFile 672 */ 673 public abstract String[] fileList(); 674 675 /** 676 * Retrieve, creating if needed, a new directory in which the application 677 * can place its own custom data files. You can use the returned File 678 * object to create and access files in this directory. Note that files 679 * created through a File object will only be accessible by your own 680 * application; you can only set the mode of the entire directory, not 681 * of individual files. 682 * 683 * @param name Name of the directory to retrieve. This is a directory 684 * that is created as part of your application data. 685 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 686 * default operation, {@link #MODE_WORLD_READABLE} and 687 * {@link #MODE_WORLD_WRITEABLE} to control permissions. 688 * 689 * @return Returns a File object for the requested directory. The directory 690 * will have been created if it does not already exist. 691 * 692 * @see #openFileOutput(String, int) 693 */ 694 public abstract File getDir(String name, int mode); 695 696 /** 697 * Open a new private SQLiteDatabase associated with this Context's 698 * application package. Create the database file if it doesn't exist. 699 * 700 * @param name The name (unique in the application package) of the database. 701 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 702 * default operation, {@link #MODE_WORLD_READABLE} 703 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. 704 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default. 705 * @param factory An optional factory class that is called to instantiate a 706 * cursor when query is called. 707 * 708 * @return The contents of a newly created database with the given name. 709 * @throws android.database.sqlite.SQLiteException if the database file could not be opened. 710 * 711 * @see #MODE_PRIVATE 712 * @see #MODE_WORLD_READABLE 713 * @see #MODE_WORLD_WRITEABLE 714 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING 715 * @see #deleteDatabase 716 */ 717 public abstract SQLiteDatabase openOrCreateDatabase(String name, 718 int mode, CursorFactory factory); 719 720 /** 721 * Open a new private SQLiteDatabase associated with this Context's 722 * application package. Creates the database file if it doesn't exist. 723 * 724 * <p>Accepts input param: a concrete instance of {@link DatabaseErrorHandler} to be 725 * used to handle corruption when sqlite reports database corruption.</p> 726 * 727 * @param name The name (unique in the application package) of the database. 728 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 729 * default operation, {@link #MODE_WORLD_READABLE} 730 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. 731 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default. 732 * @param factory An optional factory class that is called to instantiate a 733 * cursor when query is called. 734 * @param errorHandler the {@link DatabaseErrorHandler} to be used when sqlite reports database 735 * corruption. if null, {@link android.database.DefaultDatabaseErrorHandler} is assumed. 736 * @return The contents of a newly created database with the given name. 737 * @throws android.database.sqlite.SQLiteException if the database file could not be opened. 738 * 739 * @see #MODE_PRIVATE 740 * @see #MODE_WORLD_READABLE 741 * @see #MODE_WORLD_WRITEABLE 742 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING 743 * @see #deleteDatabase 744 */ 745 public abstract SQLiteDatabase openOrCreateDatabase(String name, 746 int mode, CursorFactory factory, DatabaseErrorHandler errorHandler); 747 748 /** 749 * Delete an existing private SQLiteDatabase associated with this Context's 750 * application package. 751 * 752 * @param name The name (unique in the application package) of the 753 * database. 754 * 755 * @return True if the database was successfully deleted; else false. 756 * 757 * @see #openOrCreateDatabase 758 */ 759 public abstract boolean deleteDatabase(String name); 760 761 /** 762 * Returns the absolute path on the filesystem where a database created with 763 * {@link #openOrCreateDatabase} is stored. 764 * 765 * @param name The name of the database for which you would like to get 766 * its path. 767 * 768 * @return Returns an absolute path to the given database. 769 * 770 * @see #openOrCreateDatabase 771 */ 772 public abstract File getDatabasePath(String name); 773 774 /** 775 * Returns an array of strings naming the private databases associated with 776 * this Context's application package. 777 * 778 * @return Array of strings naming the private databases. 779 * 780 * @see #openOrCreateDatabase 781 * @see #deleteDatabase 782 */ 783 public abstract String[] databaseList(); 784 785 /** 786 * @deprecated Use {@link android.app.WallpaperManager#getDrawable 787 * WallpaperManager.get()} instead. 788 */ 789 @Deprecated 790 public abstract Drawable getWallpaper(); 791 792 /** 793 * @deprecated Use {@link android.app.WallpaperManager#peekDrawable 794 * WallpaperManager.peek()} instead. 795 */ 796 @Deprecated 797 public abstract Drawable peekWallpaper(); 798 799 /** 800 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth() 801 * WallpaperManager.getDesiredMinimumWidth()} instead. 802 */ 803 @Deprecated 804 public abstract int getWallpaperDesiredMinimumWidth(); 805 806 /** 807 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight() 808 * WallpaperManager.getDesiredMinimumHeight()} instead. 809 */ 810 @Deprecated 811 public abstract int getWallpaperDesiredMinimumHeight(); 812 813 /** 814 * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap) 815 * WallpaperManager.set()} instead. 816 * <p>This method requires the caller to hold the permission 817 * {@link android.Manifest.permission#SET_WALLPAPER}. 818 */ 819 @Deprecated 820 public abstract void setWallpaper(Bitmap bitmap) throws IOException; 821 822 /** 823 * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream) 824 * WallpaperManager.set()} instead. 825 * <p>This method requires the caller to hold the permission 826 * {@link android.Manifest.permission#SET_WALLPAPER}. 827 */ 828 @Deprecated 829 public abstract void setWallpaper(InputStream data) throws IOException; 830 831 /** 832 * @deprecated Use {@link android.app.WallpaperManager#clear 833 * WallpaperManager.clear()} instead. 834 * <p>This method requires the caller to hold the permission 835 * {@link android.Manifest.permission#SET_WALLPAPER}. 836 */ 837 @Deprecated 838 public abstract void clearWallpaper() throws IOException; 839 840 /** 841 * Same as {@link #startActivity(Intent, Bundle)} with no options 842 * specified. 843 * 844 * @param intent The description of the activity to start. 845 * 846 * @throws ActivityNotFoundException 847 * 848 * @see {@link #startActivity(Intent, Bundle)} 849 * @see PackageManager#resolveActivity 850 */ 851 public abstract void startActivity(Intent intent); 852 853 /** 854 * Launch a new activity. You will not receive any information about when 855 * the activity exits. 856 * 857 * <p>Note that if this method is being called from outside of an 858 * {@link android.app.Activity} Context, then the Intent must include 859 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because, 860 * without being started from an existing Activity, there is no existing 861 * task in which to place the new activity and thus it needs to be placed 862 * in its own separate task. 863 * 864 * <p>This method throws {@link ActivityNotFoundException} 865 * if there was no Activity found to run the given Intent. 866 * 867 * @param intent The description of the activity to start. 868 * @param options Additional options for how the Activity should be started. 869 * May be null if there are no options. See {@link android.app.ActivityOptions} 870 * for how to build the Bundle supplied here; there are no supported definitions 871 * for building it manually. 872 * 873 * @throws ActivityNotFoundException 874 * 875 * @see #startActivity(Intent) 876 * @see PackageManager#resolveActivity 877 */ 878 public abstract void startActivity(Intent intent, Bundle options); 879 880 /** 881 * Same as {@link #startActivities(Intent[], Bundle)} with no options 882 * specified. 883 * 884 * @param intents An array of Intents to be started. 885 * 886 * @throws ActivityNotFoundException 887 * 888 * @see {@link #startActivities(Intent[], Bundle)} 889 * @see PackageManager#resolveActivity 890 */ 891 public abstract void startActivities(Intent[] intents); 892 893 /** 894 * Launch multiple new activities. This is generally the same as calling 895 * {@link #startActivity(Intent)} for the first Intent in the array, 896 * that activity during its creation calling {@link #startActivity(Intent)} 897 * for the second entry, etc. Note that unlike that approach, generally 898 * none of the activities except the last in the array will be created 899 * at this point, but rather will be created when the user first visits 900 * them (due to pressing back from the activity on top). 901 * 902 * <p>This method throws {@link ActivityNotFoundException} 903 * if there was no Activity found for <em>any</em> given Intent. In this 904 * case the state of the activity stack is undefined (some Intents in the 905 * list may be on it, some not), so you probably want to avoid such situations. 906 * 907 * @param intents An array of Intents to be started. 908 * @param options Additional options for how the Activity should be started. 909 * See {@link android.content.Context#startActivity(Intent, Bundle) 910 * Context.startActivity(Intent, Bundle)} for more details. 911 * 912 * @throws ActivityNotFoundException 913 * 914 * @see {@link #startActivities(Intent[])} 915 * @see PackageManager#resolveActivity 916 */ 917 public abstract void startActivities(Intent[] intents, Bundle options); 918 919 /** 920 * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)} 921 * with no options specified. 922 * 923 * @param intent The IntentSender to launch. 924 * @param fillInIntent If non-null, this will be provided as the 925 * intent parameter to {@link IntentSender#sendIntent}. 926 * @param flagsMask Intent flags in the original IntentSender that you 927 * would like to change. 928 * @param flagsValues Desired values for any bits set in 929 * <var>flagsMask</var> 930 * @param extraFlags Always set to 0. 931 * 932 * @see #startActivity(Intent) 933 * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle) 934 */ 935 public abstract void startIntentSender(IntentSender intent, 936 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) 937 throws IntentSender.SendIntentException; 938 939 /** 940 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender 941 * to start. If the IntentSender is for an activity, that activity will be started 942 * as if you had called the regular {@link #startActivity(Intent)} 943 * here; otherwise, its associated action will be executed (such as 944 * sending a broadcast) as if you had called 945 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it. 946 * 947 * @param intent The IntentSender to launch. 948 * @param fillInIntent If non-null, this will be provided as the 949 * intent parameter to {@link IntentSender#sendIntent}. 950 * @param flagsMask Intent flags in the original IntentSender that you 951 * would like to change. 952 * @param flagsValues Desired values for any bits set in 953 * <var>flagsMask</var> 954 * @param extraFlags Always set to 0. 955 * @param options Additional options for how the Activity should be started. 956 * See {@link android.content.Context#startActivity(Intent, Bundle) 957 * Context.startActivity(Intent, Bundle)} for more details. If options 958 * have also been supplied by the IntentSender, options given here will 959 * override any that conflict with those given by the IntentSender. 960 * 961 * @see #startActivity(Intent, Bundle) 962 * @see #startIntentSender(IntentSender, Intent, int, int, int) 963 */ 964 public abstract void startIntentSender(IntentSender intent, 965 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, 966 Bundle options) throws IntentSender.SendIntentException; 967 968 /** 969 * Broadcast the given intent to all interested BroadcastReceivers. This 970 * call is asynchronous; it returns immediately, and you will continue 971 * executing while the receivers are run. No results are propagated from 972 * receivers and receivers can not abort the broadcast. If you want 973 * to allow receivers to propagate results or abort the broadcast, you must 974 * send an ordered broadcast using 975 * {@link #sendOrderedBroadcast(Intent, String)}. 976 * 977 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 978 * 979 * @param intent The Intent to broadcast; all receivers matching this 980 * Intent will receive the broadcast. 981 * 982 * @see android.content.BroadcastReceiver 983 * @see #registerReceiver 984 * @see #sendBroadcast(Intent, String) 985 * @see #sendOrderedBroadcast(Intent, String) 986 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 987 */ 988 public abstract void sendBroadcast(Intent intent); 989 990 /** 991 * Same as #sendBroadcast(Intent intent), but for a specific user. This broadcast 992 * can only be sent to receivers that are part of the calling application. It 993 * requires holding the {@link android.Manifest.permission#INTERACT_ACROSS_USERS} 994 * permission. 995 * @param intent the intent to broadcast 996 * @param userId user to send the intent to 997 */ 998 public void sendBroadcastToUser(Intent intent, int userId) { 999 throw new RuntimeException("Not implemented. Must override in a subclass."); 1000 } 1001 1002 /** 1003 * Broadcast the given intent to all interested BroadcastReceivers, allowing 1004 * an optional required permission to be enforced. This 1005 * call is asynchronous; it returns immediately, and you will continue 1006 * executing while the receivers are run. No results are propagated from 1007 * receivers and receivers can not abort the broadcast. If you want 1008 * to allow receivers to propagate results or abort the broadcast, you must 1009 * send an ordered broadcast using 1010 * {@link #sendOrderedBroadcast(Intent, String)}. 1011 * 1012 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1013 * 1014 * @param intent The Intent to broadcast; all receivers matching this 1015 * Intent will receive the broadcast. 1016 * @param receiverPermission (optional) String naming a permission that 1017 * a receiver must hold in order to receive your broadcast. 1018 * If null, no permission is required. 1019 * 1020 * @see android.content.BroadcastReceiver 1021 * @see #registerReceiver 1022 * @see #sendBroadcast(Intent) 1023 * @see #sendOrderedBroadcast(Intent, String) 1024 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 1025 */ 1026 public abstract void sendBroadcast(Intent intent, 1027 String receiverPermission); 1028 1029 /** 1030 * Broadcast the given intent to all interested BroadcastReceivers, delivering 1031 * them one at a time to allow more preferred receivers to consume the 1032 * broadcast before it is delivered to less preferred receivers. This 1033 * call is asynchronous; it returns immediately, and you will continue 1034 * executing while the receivers are run. 1035 * 1036 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1037 * 1038 * @param intent The Intent to broadcast; all receivers matching this 1039 * Intent will receive the broadcast. 1040 * @param receiverPermission (optional) String naming a permissions that 1041 * a receiver must hold in order to receive your broadcast. 1042 * If null, no permission is required. 1043 * 1044 * @see android.content.BroadcastReceiver 1045 * @see #registerReceiver 1046 * @see #sendBroadcast(Intent) 1047 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 1048 */ 1049 public abstract void sendOrderedBroadcast(Intent intent, 1050 String receiverPermission); 1051 1052 /** 1053 * Version of {@link #sendBroadcast(Intent)} that allows you to 1054 * receive data back from the broadcast. This is accomplished by 1055 * supplying your own BroadcastReceiver when calling, which will be 1056 * treated as a final receiver at the end of the broadcast -- its 1057 * {@link BroadcastReceiver#onReceive} method will be called with 1058 * the result values collected from the other receivers. The broadcast will 1059 * be serialized in the same way as calling 1060 * {@link #sendOrderedBroadcast(Intent, String)}. 1061 * 1062 * <p>Like {@link #sendBroadcast(Intent)}, this method is 1063 * asynchronous; it will return before 1064 * resultReceiver.onReceive() is called. 1065 * 1066 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1067 * 1068 * @param intent The Intent to broadcast; all receivers matching this 1069 * Intent will receive the broadcast. 1070 * @param receiverPermission String naming a permissions that 1071 * a receiver must hold in order to receive your broadcast. 1072 * If null, no permission is required. 1073 * @param resultReceiver Your own BroadcastReceiver to treat as the final 1074 * receiver of the broadcast. 1075 * @param scheduler A custom Handler with which to schedule the 1076 * resultReceiver callback; if null it will be 1077 * scheduled in the Context's main thread. 1078 * @param initialCode An initial value for the result code. Often 1079 * Activity.RESULT_OK. 1080 * @param initialData An initial value for the result data. Often 1081 * null. 1082 * @param initialExtras An initial value for the result extras. Often 1083 * null. 1084 * 1085 * @see #sendBroadcast(Intent) 1086 * @see #sendBroadcast(Intent, String) 1087 * @see #sendOrderedBroadcast(Intent, String) 1088 * @see #sendStickyBroadcast(Intent) 1089 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) 1090 * @see android.content.BroadcastReceiver 1091 * @see #registerReceiver 1092 * @see android.app.Activity#RESULT_OK 1093 */ 1094 public abstract void sendOrderedBroadcast(Intent intent, 1095 String receiverPermission, BroadcastReceiver resultReceiver, 1096 Handler scheduler, int initialCode, String initialData, 1097 Bundle initialExtras); 1098 1099 /** 1100 * Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the 1101 * Intent you are sending stays around after the broadcast is complete, 1102 * so that others can quickly retrieve that data through the return 1103 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In 1104 * all other ways, this behaves the same as 1105 * {@link #sendBroadcast(Intent)}. 1106 * 1107 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 1108 * permission in order to use this API. If you do not hold that 1109 * permission, {@link SecurityException} will be thrown. 1110 * 1111 * @param intent The Intent to broadcast; all receivers matching this 1112 * Intent will receive the broadcast, and the Intent will be held to 1113 * be re-broadcast to future receivers. 1114 * 1115 * @see #sendBroadcast(Intent) 1116 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) 1117 */ 1118 public abstract void sendStickyBroadcast(Intent intent); 1119 1120 /** 1121 * Version of {@link #sendStickyBroadcast} that allows you to 1122 * receive data back from the broadcast. This is accomplished by 1123 * supplying your own BroadcastReceiver when calling, which will be 1124 * treated as a final receiver at the end of the broadcast -- its 1125 * {@link BroadcastReceiver#onReceive} method will be called with 1126 * the result values collected from the other receivers. The broadcast will 1127 * be serialized in the same way as calling 1128 * {@link #sendOrderedBroadcast(Intent, String)}. 1129 * 1130 * <p>Like {@link #sendBroadcast(Intent)}, this method is 1131 * asynchronous; it will return before 1132 * resultReceiver.onReceive() is called. Note that the sticky data 1133 * stored is only the data you initially supply to the broadcast, not 1134 * the result of any changes made by the receivers. 1135 * 1136 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1137 * 1138 * @param intent The Intent to broadcast; all receivers matching this 1139 * Intent will receive the broadcast. 1140 * @param resultReceiver Your own BroadcastReceiver to treat as the final 1141 * receiver of the broadcast. 1142 * @param scheduler A custom Handler with which to schedule the 1143 * resultReceiver callback; if null it will be 1144 * scheduled in the Context's main thread. 1145 * @param initialCode An initial value for the result code. Often 1146 * Activity.RESULT_OK. 1147 * @param initialData An initial value for the result data. Often 1148 * null. 1149 * @param initialExtras An initial value for the result extras. Often 1150 * null. 1151 * 1152 * @see #sendBroadcast(Intent) 1153 * @see #sendBroadcast(Intent, String) 1154 * @see #sendOrderedBroadcast(Intent, String) 1155 * @see #sendStickyBroadcast(Intent) 1156 * @see android.content.BroadcastReceiver 1157 * @see #registerReceiver 1158 * @see android.app.Activity#RESULT_OK 1159 */ 1160 public abstract void sendStickyOrderedBroadcast(Intent intent, 1161 BroadcastReceiver resultReceiver, 1162 Handler scheduler, int initialCode, String initialData, 1163 Bundle initialExtras); 1164 1165 1166 /** 1167 * Remove the data previously sent with {@link #sendStickyBroadcast}, 1168 * so that it is as if the sticky broadcast had never happened. 1169 * 1170 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 1171 * permission in order to use this API. If you do not hold that 1172 * permission, {@link SecurityException} will be thrown. 1173 * 1174 * @param intent The Intent that was previously broadcast. 1175 * 1176 * @see #sendStickyBroadcast 1177 */ 1178 public abstract void removeStickyBroadcast(Intent intent); 1179 1180 /** 1181 * Register a BroadcastReceiver to be run in the main activity thread. The 1182 * <var>receiver</var> will be called with any broadcast Intent that 1183 * matches <var>filter</var>, in the main application thread. 1184 * 1185 * <p>The system may broadcast Intents that are "sticky" -- these stay 1186 * around after the broadcast as finished, to be sent to any later 1187 * registrations. If your IntentFilter matches one of these sticky 1188 * Intents, that Intent will be returned by this function 1189 * <strong>and</strong> sent to your <var>receiver</var> as if it had just 1190 * been broadcast. 1191 * 1192 * <p>There may be multiple sticky Intents that match <var>filter</var>, 1193 * in which case each of these will be sent to <var>receiver</var>. In 1194 * this case, only one of these can be returned directly by the function; 1195 * which of these that is returned is arbitrarily decided by the system. 1196 * 1197 * <p>If you know the Intent your are registering for is sticky, you can 1198 * supply null for your <var>receiver</var>. In this case, no receiver is 1199 * registered -- the function simply returns the sticky Intent that 1200 * matches <var>filter</var>. In the case of multiple matches, the same 1201 * rules as described above apply. 1202 * 1203 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1204 * 1205 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers 1206 * registered with this method will correctly respect the 1207 * {@link Intent#setPackage(String)} specified for an Intent being broadcast. 1208 * Prior to that, it would be ignored and delivered to all matching registered 1209 * receivers. Be careful if using this for security.</p> 1210 * 1211 * <p class="note">Note: this method <em>cannot be called from a 1212 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver 1213 * that is declared in an application's manifest. It is okay, however, to call 1214 * this method from another BroadcastReceiver that has itself been registered 1215 * at run time with {@link #registerReceiver}, since the lifetime of such a 1216 * registered BroadcastReceiver is tied to the object that registered it.</p> 1217 * 1218 * @param receiver The BroadcastReceiver to handle the broadcast. 1219 * @param filter Selects the Intent broadcasts to be received. 1220 * 1221 * @return The first sticky intent found that matches <var>filter</var>, 1222 * or null if there are none. 1223 * 1224 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) 1225 * @see #sendBroadcast 1226 * @see #unregisterReceiver 1227 */ 1228 public abstract Intent registerReceiver(BroadcastReceiver receiver, 1229 IntentFilter filter); 1230 1231 /** 1232 * Register to receive intent broadcasts, to run in the context of 1233 * <var>scheduler</var>. See 1234 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more 1235 * information. This allows you to enforce permissions on who can 1236 * broadcast intents to your receiver, or have the receiver run in 1237 * a different thread than the main application thread. 1238 * 1239 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1240 * 1241 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers 1242 * registered with this method will correctly respect the 1243 * {@link Intent#setPackage(String)} specified for an Intent being broadcast. 1244 * Prior to that, it would be ignored and delivered to all matching registered 1245 * receivers. Be careful if using this for security.</p> 1246 * 1247 * @param receiver The BroadcastReceiver to handle the broadcast. 1248 * @param filter Selects the Intent broadcasts to be received. 1249 * @param broadcastPermission String naming a permissions that a 1250 * broadcaster must hold in order to send an Intent to you. If null, 1251 * no permission is required. 1252 * @param scheduler Handler identifying the thread that will receive 1253 * the Intent. If null, the main thread of the process will be used. 1254 * 1255 * @return The first sticky intent found that matches <var>filter</var>, 1256 * or null if there are none. 1257 * 1258 * @see #registerReceiver(BroadcastReceiver, IntentFilter) 1259 * @see #sendBroadcast 1260 * @see #unregisterReceiver 1261 */ 1262 public abstract Intent registerReceiver(BroadcastReceiver receiver, 1263 IntentFilter filter, 1264 String broadcastPermission, 1265 Handler scheduler); 1266 1267 /** 1268 * Unregister a previously registered BroadcastReceiver. <em>All</em> 1269 * filters that have been registered for this BroadcastReceiver will be 1270 * removed. 1271 * 1272 * @param receiver The BroadcastReceiver to unregister. 1273 * 1274 * @see #registerReceiver 1275 */ 1276 public abstract void unregisterReceiver(BroadcastReceiver receiver); 1277 1278 /** 1279 * Request that a given application service be started. The Intent 1280 * can either contain the complete class name of a specific service 1281 * implementation to start, or an abstract definition through the 1282 * action and other fields of the kind of service to start. If this service 1283 * is not already running, it will be instantiated and started (creating a 1284 * process for it if needed); if it is running then it remains running. 1285 * 1286 * <p>Every call to this method will result in a corresponding call to 1287 * the target service's {@link android.app.Service#onStartCommand} method, 1288 * with the <var>intent</var> given here. This provides a convenient way 1289 * to submit jobs to a service without having to bind and call on to its 1290 * interface. 1291 * 1292 * <p>Using startService() overrides the default service lifetime that is 1293 * managed by {@link #bindService}: it requires the service to remain 1294 * running until {@link #stopService} is called, regardless of whether 1295 * any clients are connected to it. Note that calls to startService() 1296 * are not nesting: no matter how many times you call startService(), 1297 * a single call to {@link #stopService} will stop it. 1298 * 1299 * <p>The system attempts to keep running services around as much as 1300 * possible. The only time they should be stopped is if the current 1301 * foreground application is using so many resources that the service needs 1302 * to be killed. If any errors happen in the service's process, it will 1303 * automatically be restarted. 1304 * 1305 * <p>This function will throw {@link SecurityException} if you do not 1306 * have permission to start the given service. 1307 * 1308 * @param service Identifies the service to be started. The Intent may 1309 * specify either an explicit component name to start, or a logical 1310 * description (action, category, etc) to match an 1311 * {@link IntentFilter} published by a service. Additional values 1312 * may be included in the Intent extras to supply arguments along with 1313 * this specific start call. 1314 * 1315 * @return If the service is being started or is already running, the 1316 * {@link ComponentName} of the actual service that was started is 1317 * returned; else if the service does not exist null is returned. 1318 * 1319 * @throws SecurityException 1320 * 1321 * @see #stopService 1322 * @see #bindService 1323 */ 1324 public abstract ComponentName startService(Intent service); 1325 1326 /** 1327 * Request that a given application service be stopped. If the service is 1328 * not running, nothing happens. Otherwise it is stopped. Note that calls 1329 * to startService() are not counted -- this stops the service no matter 1330 * how many times it was started. 1331 * 1332 * <p>Note that if a stopped service still has {@link ServiceConnection} 1333 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will 1334 * not be destroyed until all of these bindings are removed. See 1335 * the {@link android.app.Service} documentation for more details on a 1336 * service's lifecycle. 1337 * 1338 * <p>This function will throw {@link SecurityException} if you do not 1339 * have permission to stop the given service. 1340 * 1341 * @param service Description of the service to be stopped. The Intent may 1342 * specify either an explicit component name to start, or a logical 1343 * description (action, category, etc) to match an 1344 * {@link IntentFilter} published by a service. 1345 * 1346 * @return If there is a service matching the given Intent that is already 1347 * running, then it is stopped and true is returned; else false is returned. 1348 * 1349 * @throws SecurityException 1350 * 1351 * @see #startService 1352 */ 1353 public abstract boolean stopService(Intent service); 1354 1355 /** 1356 * Connect to an application service, creating it if needed. This defines 1357 * a dependency between your application and the service. The given 1358 * <var>conn</var> will receive the service object when it is created and be 1359 * told if it dies and restarts. The service will be considered required 1360 * by the system only for as long as the calling context exists. For 1361 * example, if this Context is an Activity that is stopped, the service will 1362 * not be required to continue running until the Activity is resumed. 1363 * 1364 * <p>This function will throw {@link SecurityException} if you do not 1365 * have permission to bind to the given service. 1366 * 1367 * <p class="note">Note: this method <em>can not be called from a 1368 * {@link BroadcastReceiver} component</em>. A pattern you can use to 1369 * communicate from a BroadcastReceiver to a Service is to call 1370 * {@link #startService} with the arguments containing the command to be 1371 * sent, with the service calling its 1372 * {@link android.app.Service#stopSelf(int)} method when done executing 1373 * that command. See the API demo App/Service/Service Start Arguments 1374 * Controller for an illustration of this. It is okay, however, to use 1375 * this method from a BroadcastReceiver that has been registered with 1376 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver 1377 * is tied to another object (the one that registered it).</p> 1378 * 1379 * @param service Identifies the service to connect to. The Intent may 1380 * specify either an explicit component name, or a logical 1381 * description (action, category, etc) to match an 1382 * {@link IntentFilter} published by a service. 1383 * @param conn Receives information as the service is started and stopped. 1384 * This must be a valid ServiceConnection object; it must not be null. 1385 * @param flags Operation options for the binding. May be 0, 1386 * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND}, 1387 * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT}, 1388 * {@link #BIND_ALLOW_OOM_MANAGEMENT}, or 1389 * {@link #BIND_WAIVE_PRIORITY}. 1390 * @return If you have successfully bound to the service, true is returned; 1391 * false is returned if the connection is not made so you will not 1392 * receive the service object. 1393 * 1394 * @throws SecurityException 1395 * 1396 * @see #unbindService 1397 * @see #startService 1398 * @see #BIND_AUTO_CREATE 1399 * @see #BIND_DEBUG_UNBIND 1400 * @see #BIND_NOT_FOREGROUND 1401 */ 1402 public abstract boolean bindService(Intent service, ServiceConnection conn, 1403 int flags); 1404 1405 /** 1406 * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userId 1407 * argument for use by system server and other multi-user aware code. 1408 * @hide 1409 */ 1410 public boolean bindService(Intent service, ServiceConnection conn, int flags, int userId) { 1411 throw new RuntimeException("Not implemented. Must override in a subclass."); 1412 } 1413 1414 /** 1415 * Disconnect from an application service. You will no longer receive 1416 * calls as the service is restarted, and the service is now allowed to 1417 * stop at any time. 1418 * 1419 * @param conn The connection interface previously supplied to 1420 * bindService(). This parameter must not be null. 1421 * 1422 * @see #bindService 1423 */ 1424 public abstract void unbindService(ServiceConnection conn); 1425 1426 /** 1427 * Start executing an {@link android.app.Instrumentation} class. The given 1428 * Instrumentation component will be run by killing its target application 1429 * (if currently running), starting the target process, instantiating the 1430 * instrumentation component, and then letting it drive the application. 1431 * 1432 * <p>This function is not synchronous -- it returns as soon as the 1433 * instrumentation has started and while it is running. 1434 * 1435 * <p>Instrumentation is normally only allowed to run against a package 1436 * that is either unsigned or signed with a signature that the 1437 * the instrumentation package is also signed with (ensuring the target 1438 * trusts the instrumentation). 1439 * 1440 * @param className Name of the Instrumentation component to be run. 1441 * @param profileFile Optional path to write profiling data as the 1442 * instrumentation runs, or null for no profiling. 1443 * @param arguments Additional optional arguments to pass to the 1444 * instrumentation, or null. 1445 * 1446 * @return Returns true if the instrumentation was successfully started, 1447 * else false if it could not be found. 1448 */ 1449 public abstract boolean startInstrumentation(ComponentName className, 1450 String profileFile, Bundle arguments); 1451 1452 /** 1453 * Return the handle to a system-level service by name. The class of the 1454 * returned object varies by the requested name. Currently available names 1455 * are: 1456 * 1457 * <dl> 1458 * <dt> {@link #WINDOW_SERVICE} ("window") 1459 * <dd> The top-level window manager in which you can place custom 1460 * windows. The returned object is a {@link android.view.WindowManager}. 1461 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater") 1462 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources 1463 * in this context. 1464 * <dt> {@link #ACTIVITY_SERVICE} ("activity") 1465 * <dd> A {@link android.app.ActivityManager} for interacting with the 1466 * global activity state of the system. 1467 * <dt> {@link #POWER_SERVICE} ("power") 1468 * <dd> A {@link android.os.PowerManager} for controlling power 1469 * management. 1470 * <dt> {@link #ALARM_SERVICE} ("alarm") 1471 * <dd> A {@link android.app.AlarmManager} for receiving intents at the 1472 * time of your choosing. 1473 * <dt> {@link #NOTIFICATION_SERVICE} ("notification") 1474 * <dd> A {@link android.app.NotificationManager} for informing the user 1475 * of background events. 1476 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard") 1477 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard. 1478 * <dt> {@link #LOCATION_SERVICE} ("location") 1479 * <dd> A {@link android.location.LocationManager} for controlling location 1480 * (e.g., GPS) updates. 1481 * <dt> {@link #SEARCH_SERVICE} ("search") 1482 * <dd> A {@link android.app.SearchManager} for handling search. 1483 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator") 1484 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator 1485 * hardware. 1486 * <dt> {@link #CONNECTIVITY_SERVICE} ("connection") 1487 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for 1488 * handling management of network connections. 1489 * <dt> {@link #WIFI_SERVICE} ("wifi") 1490 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of 1491 * Wi-Fi connectivity. 1492 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method") 1493 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager} 1494 * for management of input methods. 1495 * <dt> {@link #UI_MODE_SERVICE} ("uimode") 1496 * <dd> An {@link android.app.UiModeManager} for controlling UI modes. 1497 * <dt> {@link #DOWNLOAD_SERVICE} ("download") 1498 * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads 1499 * </dl> 1500 * 1501 * <p>Note: System services obtained via this API may be closely associated with 1502 * the Context in which they are obtained from. In general, do not share the 1503 * service objects between various different contexts (Activities, Applications, 1504 * Services, Providers, etc.) 1505 * 1506 * @param name The name of the desired service. 1507 * 1508 * @return The service or null if the name does not exist. 1509 * 1510 * @see #WINDOW_SERVICE 1511 * @see android.view.WindowManager 1512 * @see #LAYOUT_INFLATER_SERVICE 1513 * @see android.view.LayoutInflater 1514 * @see #ACTIVITY_SERVICE 1515 * @see android.app.ActivityManager 1516 * @see #POWER_SERVICE 1517 * @see android.os.PowerManager 1518 * @see #ALARM_SERVICE 1519 * @see android.app.AlarmManager 1520 * @see #NOTIFICATION_SERVICE 1521 * @see android.app.NotificationManager 1522 * @see #KEYGUARD_SERVICE 1523 * @see android.app.KeyguardManager 1524 * @see #LOCATION_SERVICE 1525 * @see android.location.LocationManager 1526 * @see #SEARCH_SERVICE 1527 * @see android.app.SearchManager 1528 * @see #SENSOR_SERVICE 1529 * @see android.hardware.SensorManager 1530 * @see #STORAGE_SERVICE 1531 * @see android.os.storage.StorageManager 1532 * @see #VIBRATOR_SERVICE 1533 * @see android.os.Vibrator 1534 * @see #CONNECTIVITY_SERVICE 1535 * @see android.net.ConnectivityManager 1536 * @see #WIFI_SERVICE 1537 * @see android.net.wifi.WifiManager 1538 * @see #AUDIO_SERVICE 1539 * @see android.media.AudioManager 1540 * @see #MEDIA_ROUTER_SERVICE 1541 * @see android.media.MediaRouter 1542 * @see #TELEPHONY_SERVICE 1543 * @see android.telephony.TelephonyManager 1544 * @see #INPUT_METHOD_SERVICE 1545 * @see android.view.inputmethod.InputMethodManager 1546 * @see #UI_MODE_SERVICE 1547 * @see android.app.UiModeManager 1548 * @see #DOWNLOAD_SERVICE 1549 * @see android.app.DownloadManager 1550 */ 1551 public abstract Object getSystemService(String name); 1552 1553 /** 1554 * Use with {@link #getSystemService} to retrieve a 1555 * {@link android.os.PowerManager} for controlling power management, 1556 * including "wake locks," which let you keep the device on while 1557 * you're running long tasks. 1558 */ 1559 public static final String POWER_SERVICE = "power"; 1560 1561 /** 1562 * Use with {@link #getSystemService} to retrieve a 1563 * {@link android.view.WindowManager} for accessing the system's window 1564 * manager. 1565 * 1566 * @see #getSystemService 1567 * @see android.view.WindowManager 1568 */ 1569 public static final String WINDOW_SERVICE = "window"; 1570 1571 /** 1572 * Use with {@link #getSystemService} to retrieve a 1573 * {@link android.view.LayoutInflater} for inflating layout resources in this 1574 * context. 1575 * 1576 * @see #getSystemService 1577 * @see android.view.LayoutInflater 1578 */ 1579 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater"; 1580 1581 /** 1582 * Use with {@link #getSystemService} to retrieve a 1583 * {@link android.accounts.AccountManager} for receiving intents at a 1584 * time of your choosing. 1585 * 1586 * @see #getSystemService 1587 * @see android.accounts.AccountManager 1588 */ 1589 public static final String ACCOUNT_SERVICE = "account"; 1590 1591 /** 1592 * Use with {@link #getSystemService} to retrieve a 1593 * {@link android.app.ActivityManager} for interacting with the global 1594 * system state. 1595 * 1596 * @see #getSystemService 1597 * @see android.app.ActivityManager 1598 */ 1599 public static final String ACTIVITY_SERVICE = "activity"; 1600 1601 /** 1602 * Use with {@link #getSystemService} to retrieve a 1603 * {@link android.app.AlarmManager} for receiving intents at a 1604 * time of your choosing. 1605 * 1606 * @see #getSystemService 1607 * @see android.app.AlarmManager 1608 */ 1609 public static final String ALARM_SERVICE = "alarm"; 1610 1611 /** 1612 * Use with {@link #getSystemService} to retrieve a 1613 * {@link android.app.NotificationManager} for informing the user of 1614 * background events. 1615 * 1616 * @see #getSystemService 1617 * @see android.app.NotificationManager 1618 */ 1619 public static final String NOTIFICATION_SERVICE = "notification"; 1620 1621 /** 1622 * Use with {@link #getSystemService} to retrieve a 1623 * {@link android.view.accessibility.AccessibilityManager} for giving the user 1624 * feedback for UI events through the registered event listeners. 1625 * 1626 * @see #getSystemService 1627 * @see android.view.accessibility.AccessibilityManager 1628 */ 1629 public static final String ACCESSIBILITY_SERVICE = "accessibility"; 1630 1631 /** 1632 * Use with {@link #getSystemService} to retrieve a 1633 * {@link android.app.NotificationManager} for controlling keyguard. 1634 * 1635 * @see #getSystemService 1636 * @see android.app.KeyguardManager 1637 */ 1638 public static final String KEYGUARD_SERVICE = "keyguard"; 1639 1640 /** 1641 * Use with {@link #getSystemService} to retrieve a {@link 1642 * android.location.LocationManager} for controlling location 1643 * updates. 1644 * 1645 * @see #getSystemService 1646 * @see android.location.LocationManager 1647 */ 1648 public static final String LOCATION_SERVICE = "location"; 1649 1650 /** 1651 * Use with {@link #getSystemService} to retrieve a 1652 * {@link android.location.CountryDetector} for detecting the country that 1653 * the user is in. 1654 * 1655 * @hide 1656 */ 1657 public static final String COUNTRY_DETECTOR = "country_detector"; 1658 1659 /** 1660 * Use with {@link #getSystemService} to retrieve a {@link 1661 * android.app.SearchManager} for handling searches. 1662 * 1663 * @see #getSystemService 1664 * @see android.app.SearchManager 1665 */ 1666 public static final String SEARCH_SERVICE = "search"; 1667 1668 /** 1669 * Use with {@link #getSystemService} to retrieve a {@link 1670 * android.hardware.SensorManager} for accessing sensors. 1671 * 1672 * @see #getSystemService 1673 * @see android.hardware.SensorManager 1674 */ 1675 public static final String SENSOR_SERVICE = "sensor"; 1676 1677 /** 1678 * Use with {@link #getSystemService} to retrieve a {@link 1679 * android.os.storage.StorageManager} for accessing system storage 1680 * functions. 1681 * 1682 * @see #getSystemService 1683 * @see android.os.storage.StorageManager 1684 */ 1685 public static final String STORAGE_SERVICE = "storage"; 1686 1687 /** 1688 * Use with {@link #getSystemService} to retrieve a 1689 * com.android.server.WallpaperService for accessing wallpapers. 1690 * 1691 * @see #getSystemService 1692 */ 1693 public static final String WALLPAPER_SERVICE = "wallpaper"; 1694 1695 /** 1696 * Use with {@link #getSystemService} to retrieve a {@link 1697 * android.os.Vibrator} for interacting with the vibration hardware. 1698 * 1699 * @see #getSystemService 1700 * @see android.os.Vibrator 1701 */ 1702 public static final String VIBRATOR_SERVICE = "vibrator"; 1703 1704 /** 1705 * Use with {@link #getSystemService} to retrieve a {@link 1706 * android.app.StatusBarManager} for interacting with the status bar. 1707 * 1708 * @see #getSystemService 1709 * @see android.app.StatusBarManager 1710 * @hide 1711 */ 1712 public static final String STATUS_BAR_SERVICE = "statusbar"; 1713 1714 /** 1715 * Use with {@link #getSystemService} to retrieve a {@link 1716 * android.net.ConnectivityManager} for handling management of 1717 * network connections. 1718 * 1719 * @see #getSystemService 1720 * @see android.net.ConnectivityManager 1721 */ 1722 public static final String CONNECTIVITY_SERVICE = "connectivity"; 1723 1724 /** 1725 * Use with {@link #getSystemService} to retrieve a {@link 1726 * android.net.ThrottleManager} for handling management of 1727 * throttling. 1728 * 1729 * @hide 1730 * @see #getSystemService 1731 * @see android.net.ThrottleManager 1732 */ 1733 public static final String THROTTLE_SERVICE = "throttle"; 1734 1735 /** 1736 * Use with {@link #getSystemService} to retrieve a {@link 1737 * android.os.IUpdateLock} for managing runtime sequences that 1738 * must not be interrupted by headless OTA application or similar. 1739 * 1740 * @hide 1741 * @see #getSystemService 1742 * @see android.os.UpdateLock 1743 */ 1744 public static final String UPDATE_LOCK_SERVICE = "updatelock"; 1745 1746 /** 1747 * Use with {@link #getSystemService} to retrieve a {@link 1748 * android.net.NetworkManagementService} for handling management of 1749 * system network services 1750 * 1751 * @hide 1752 * @see #getSystemService 1753 * @see android.net.NetworkManagementService 1754 */ 1755 public static final String NETWORKMANAGEMENT_SERVICE = "network_management"; 1756 1757 /** {@hide} */ 1758 public static final String NETWORK_STATS_SERVICE = "netstats"; 1759 /** {@hide} */ 1760 public static final String NETWORK_POLICY_SERVICE = "netpolicy"; 1761 1762 /** 1763 * Use with {@link #getSystemService} to retrieve a {@link 1764 * android.net.wifi.WifiManager} for handling management of 1765 * Wi-Fi access. 1766 * 1767 * @see #getSystemService 1768 * @see android.net.wifi.WifiManager 1769 */ 1770 public static final String WIFI_SERVICE = "wifi"; 1771 1772 /** 1773 * Use with {@link #getSystemService} to retrieve a {@link 1774 * android.net.wifi.p2p.WifiP2pManager} for handling management of 1775 * Wi-Fi peer-to-peer connections. 1776 * 1777 * @see #getSystemService 1778 * @see android.net.wifi.p2p.WifiP2pManager 1779 */ 1780 public static final String WIFI_P2P_SERVICE = "wifip2p"; 1781 1782 /** 1783 * Use with {@link #getSystemService} to retrieve a {@link 1784 * android.net.nsd.NsdManager} for handling management of network service 1785 * discovery 1786 * 1787 * @see #getSystemService 1788 * @see android.net.nsd.NsdManager 1789 */ 1790 public static final String NSD_SERVICE = "servicediscovery"; 1791 1792 /** 1793 * Use with {@link #getSystemService} to retrieve a 1794 * {@link android.media.AudioManager} for handling management of volume, 1795 * ringer modes and audio routing. 1796 * 1797 * @see #getSystemService 1798 * @see android.media.AudioManager 1799 */ 1800 public static final String AUDIO_SERVICE = "audio"; 1801 1802 /** 1803 * Use with {@link #getSystemService} to retrieve a 1804 * {@link android.media.MediaRouter} for controlling and managing 1805 * routing of media. 1806 * 1807 * @see #getSystemService 1808 * @see android.media.MediaRouter 1809 */ 1810 public static final String MEDIA_ROUTER_SERVICE = "media_router"; 1811 1812 /** 1813 * Use with {@link #getSystemService} to retrieve a 1814 * {@link android.telephony.TelephonyManager} for handling management the 1815 * telephony features of the device. 1816 * 1817 * @see #getSystemService 1818 * @see android.telephony.TelephonyManager 1819 */ 1820 public static final String TELEPHONY_SERVICE = "phone"; 1821 1822 /** 1823 * Use with {@link #getSystemService} to retrieve a 1824 * {@link android.text.ClipboardManager} for accessing and modifying 1825 * the contents of the global clipboard. 1826 * 1827 * @see #getSystemService 1828 * @see android.text.ClipboardManager 1829 */ 1830 public static final String CLIPBOARD_SERVICE = "clipboard"; 1831 1832 /** 1833 * Use with {@link #getSystemService} to retrieve a 1834 * {@link android.view.inputmethod.InputMethodManager} for accessing input 1835 * methods. 1836 * 1837 * @see #getSystemService 1838 */ 1839 public static final String INPUT_METHOD_SERVICE = "input_method"; 1840 1841 /** 1842 * Use with {@link #getSystemService} to retrieve a 1843 * {@link android.view.textservice.TextServicesManager} for accessing 1844 * text services. 1845 * 1846 * @see #getSystemService 1847 */ 1848 public static final String TEXT_SERVICES_MANAGER_SERVICE = "textservices"; 1849 1850 /** 1851 * Use with {@link #getSystemService} to retrieve a 1852 * {@link android.appwidget.AppWidgetManager} for accessing AppWidgets. 1853 * 1854 * @hide 1855 * @see #getSystemService 1856 */ 1857 public static final String APPWIDGET_SERVICE = "appwidget"; 1858 1859 /** 1860 * Use with {@link #getSystemService} to retrieve an 1861 * {@link android.app.backup.IBackupManager IBackupManager} for communicating 1862 * with the backup mechanism. 1863 * @hide 1864 * 1865 * @see #getSystemService 1866 */ 1867 public static final String BACKUP_SERVICE = "backup"; 1868 1869 /** 1870 * Use with {@link #getSystemService} to retrieve a 1871 * {@link android.os.DropBoxManager} instance for recording 1872 * diagnostic logs. 1873 * @see #getSystemService 1874 */ 1875 public static final String DROPBOX_SERVICE = "dropbox"; 1876 1877 /** 1878 * Use with {@link #getSystemService} to retrieve a 1879 * {@link android.app.admin.DevicePolicyManager} for working with global 1880 * device policy management. 1881 * 1882 * @see #getSystemService 1883 */ 1884 public static final String DEVICE_POLICY_SERVICE = "device_policy"; 1885 1886 /** 1887 * Use with {@link #getSystemService} to retrieve a 1888 * {@link android.app.UiModeManager} for controlling UI modes. 1889 * 1890 * @see #getSystemService 1891 */ 1892 public static final String UI_MODE_SERVICE = "uimode"; 1893 1894 /** 1895 * Use with {@link #getSystemService} to retrieve a 1896 * {@link android.app.DownloadManager} for requesting HTTP downloads. 1897 * 1898 * @see #getSystemService 1899 */ 1900 public static final String DOWNLOAD_SERVICE = "download"; 1901 1902 /** 1903 * Use with {@link #getSystemService} to retrieve a 1904 * {@link android.nfc.NfcManager} for using NFC. 1905 * 1906 * @see #getSystemService 1907 */ 1908 public static final String NFC_SERVICE = "nfc"; 1909 1910 /** 1911 * Use with {@link #getSystemService} to retrieve a 1912 * {@link android.bluetooth.BluetoothAdapter} for using Bluetooth. 1913 * 1914 * @see #getSystemService 1915 * @hide 1916 */ 1917 public static final String BLUETOOTH_SERVICE = "bluetooth"; 1918 1919 /** 1920 * Use with {@link #getSystemService} to retrieve a 1921 * {@link android.net.sip.SipManager} for accessing the SIP related service. 1922 * 1923 * @see #getSystemService 1924 */ 1925 /** @hide */ 1926 public static final String SIP_SERVICE = "sip"; 1927 1928 /** 1929 * Use with {@link #getSystemService} to retrieve a {@link 1930 * android.hardware.usb.UsbManager} for access to USB devices (as a USB host) 1931 * and for controlling this device's behavior as a USB device. 1932 * 1933 * @see #getSystemService 1934 * @see android.harware.usb.UsbManager 1935 */ 1936 public static final String USB_SERVICE = "usb"; 1937 1938 /** 1939 * Use with {@link #getSystemService} to retrieve a {@link 1940 * android.hardware.SerialManager} for access to serial ports. 1941 * 1942 * @see #getSystemService 1943 * @see android.harware.SerialManager 1944 * 1945 * @hide 1946 */ 1947 public static final String SERIAL_SERVICE = "serial"; 1948 1949 /** 1950 * Use with {@link #getSystemService} to retrieve a 1951 * {@link android.hardware.input.InputManager} for interacting with input devices. 1952 * 1953 * @see #getSystemService 1954 * @see android.hardware.input.InputManager 1955 */ 1956 public static final String INPUT_SERVICE = "input"; 1957 1958 /** 1959 * Use with {@link #getSystemService} to retrieve a 1960 * {@link android.hardware.display.DisplayManager} for interacting with display devices. 1961 * 1962 * @see #getSystemService 1963 * @see android.hardware.display.DisplayManager 1964 */ 1965 public static final String DISPLAY_SERVICE = "display"; 1966 1967 /** 1968 * Use with {@link #getSystemService} to retrieve a 1969 * {@link android.os.SchedulingPolicyService} for managing scheduling policy. 1970 * 1971 * @see #getSystemService 1972 * @see android.os.SchedulingPolicyService 1973 * 1974 * @hide 1975 */ 1976 public static final String SCHEDULING_POLICY_SERVICE = "scheduling_policy"; 1977 1978 /** 1979 * Determine whether the given permission is allowed for a particular 1980 * process and user ID running in the system. 1981 * 1982 * @param permission The name of the permission being checked. 1983 * @param pid The process ID being checked against. Must be > 0. 1984 * @param uid The user ID being checked against. A uid of 0 is the root 1985 * user, which will pass every permission check. 1986 * 1987 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the given 1988 * pid/uid is allowed that permission, or 1989 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1990 * 1991 * @see PackageManager#checkPermission(String, String) 1992 * @see #checkCallingPermission 1993 */ 1994 public abstract int checkPermission(String permission, int pid, int uid); 1995 1996 /** 1997 * Determine whether the calling process of an IPC you are handling has been 1998 * granted a particular permission. This is basically the same as calling 1999 * {@link #checkPermission(String, int, int)} with the pid and uid returned 2000 * by {@link android.os.Binder#getCallingPid} and 2001 * {@link android.os.Binder#getCallingUid}. One important difference 2002 * is that if you are not currently processing an IPC, this function 2003 * will always fail. This is done to protect against accidentally 2004 * leaking permissions; you can use {@link #checkCallingOrSelfPermission} 2005 * to avoid this protection. 2006 * 2007 * @param permission The name of the permission being checked. 2008 * 2009 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the calling 2010 * pid/uid is allowed that permission, or 2011 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2012 * 2013 * @see PackageManager#checkPermission(String, String) 2014 * @see #checkPermission 2015 * @see #checkCallingOrSelfPermission 2016 */ 2017 public abstract int checkCallingPermission(String permission); 2018 2019 /** 2020 * Determine whether the calling process of an IPC <em>or you</em> have been 2021 * granted a particular permission. This is the same as 2022 * {@link #checkCallingPermission}, except it grants your own permissions 2023 * if you are not currently processing an IPC. Use with care! 2024 * 2025 * @param permission The name of the permission being checked. 2026 * 2027 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the calling 2028 * pid/uid is allowed that permission, or 2029 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2030 * 2031 * @see PackageManager#checkPermission(String, String) 2032 * @see #checkPermission 2033 * @see #checkCallingPermission 2034 */ 2035 public abstract int checkCallingOrSelfPermission(String permission); 2036 2037 /** 2038 * If the given permission is not allowed for a particular process 2039 * and user ID running in the system, throw a {@link SecurityException}. 2040 * 2041 * @param permission The name of the permission being checked. 2042 * @param pid The process ID being checked against. Must be > 0. 2043 * @param uid The user ID being checked against. A uid of 0 is the root 2044 * user, which will pass every permission check. 2045 * @param message A message to include in the exception if it is thrown. 2046 * 2047 * @see #checkPermission(String, int, int) 2048 */ 2049 public abstract void enforcePermission( 2050 String permission, int pid, int uid, String message); 2051 2052 /** 2053 * If the calling process of an IPC you are handling has not been 2054 * granted a particular permission, throw a {@link 2055 * SecurityException}. This is basically the same as calling 2056 * {@link #enforcePermission(String, int, int, String)} with the 2057 * pid and uid returned by {@link android.os.Binder#getCallingPid} 2058 * and {@link android.os.Binder#getCallingUid}. One important 2059 * difference is that if you are not currently processing an IPC, 2060 * this function will always throw the SecurityException. This is 2061 * done to protect against accidentally leaking permissions; you 2062 * can use {@link #enforceCallingOrSelfPermission} to avoid this 2063 * protection. 2064 * 2065 * @param permission The name of the permission being checked. 2066 * @param message A message to include in the exception if it is thrown. 2067 * 2068 * @see #checkCallingPermission(String) 2069 */ 2070 public abstract void enforceCallingPermission( 2071 String permission, String message); 2072 2073 /** 2074 * If neither you nor the calling process of an IPC you are 2075 * handling has been granted a particular permission, throw a 2076 * {@link SecurityException}. This is the same as {@link 2077 * #enforceCallingPermission}, except it grants your own 2078 * permissions if you are not currently processing an IPC. Use 2079 * with care! 2080 * 2081 * @param permission The name of the permission being checked. 2082 * @param message A message to include in the exception if it is thrown. 2083 * 2084 * @see #checkCallingOrSelfPermission(String) 2085 */ 2086 public abstract void enforceCallingOrSelfPermission( 2087 String permission, String message); 2088 2089 /** 2090 * Grant permission to access a specific Uri to another package, regardless 2091 * of whether that package has general permission to access the Uri's 2092 * content provider. This can be used to grant specific, temporary 2093 * permissions, typically in response to user interaction (such as the 2094 * user opening an attachment that you would like someone else to 2095 * display). 2096 * 2097 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 2098 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2099 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 2100 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to 2101 * start an activity instead of this function directly. If you use this 2102 * function directly, you should be sure to call 2103 * {@link #revokeUriPermission} when the target should no longer be allowed 2104 * to access it. 2105 * 2106 * <p>To succeed, the content provider owning the Uri must have set the 2107 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions 2108 * grantUriPermissions} attribute in its manifest or included the 2109 * {@link android.R.styleable#AndroidManifestGrantUriPermission 2110 * <grant-uri-permissions>} tag. 2111 * 2112 * @param toPackage The package you would like to allow to access the Uri. 2113 * @param uri The Uri you would like to grant access to. 2114 * @param modeFlags The desired access modes. Any combination of 2115 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 2116 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2117 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 2118 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2119 * 2120 * @see #revokeUriPermission 2121 */ 2122 public abstract void grantUriPermission(String toPackage, Uri uri, 2123 int modeFlags); 2124 2125 /** 2126 * Remove all permissions to access a particular content provider Uri 2127 * that were previously added with {@link #grantUriPermission}. The given 2128 * Uri will match all previously granted Uris that are the same or a 2129 * sub-path of the given Uri. That is, revoking "content://foo/one" will 2130 * revoke both "content://foo/target" and "content://foo/target/sub", but not 2131 * "content://foo". 2132 * 2133 * @param uri The Uri you would like to revoke access to. 2134 * @param modeFlags The desired access modes. Any combination of 2135 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 2136 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2137 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 2138 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2139 * 2140 * @see #grantUriPermission 2141 */ 2142 public abstract void revokeUriPermission(Uri uri, int modeFlags); 2143 2144 /** 2145 * Determine whether a particular process and user ID has been granted 2146 * permission to access a specific URI. This only checks for permissions 2147 * that have been explicitly granted -- if the given process/uid has 2148 * more general access to the URI's content provider then this check will 2149 * always fail. 2150 * 2151 * @param uri The uri that is being checked. 2152 * @param pid The process ID being checked against. Must be > 0. 2153 * @param uid The user ID being checked against. A uid of 0 is the root 2154 * user, which will pass every permission check. 2155 * @param modeFlags The type of access to grant. May be one or both of 2156 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2157 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2158 * 2159 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the given 2160 * pid/uid is allowed to access that uri, or 2161 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2162 * 2163 * @see #checkCallingUriPermission 2164 */ 2165 public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags); 2166 2167 /** 2168 * Determine whether the calling process and user ID has been 2169 * granted permission to access a specific URI. This is basically 2170 * the same as calling {@link #checkUriPermission(Uri, int, int, 2171 * int)} with the pid and uid returned by {@link 2172 * android.os.Binder#getCallingPid} and {@link 2173 * android.os.Binder#getCallingUid}. One important difference is 2174 * that if you are not currently processing an IPC, this function 2175 * will always fail. 2176 * 2177 * @param uri The uri that is being checked. 2178 * @param modeFlags The type of access to grant. May be one or both of 2179 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2180 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2181 * 2182 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller 2183 * is allowed to access that uri, or 2184 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2185 * 2186 * @see #checkUriPermission(Uri, int, int, int) 2187 */ 2188 public abstract int checkCallingUriPermission(Uri uri, int modeFlags); 2189 2190 /** 2191 * Determine whether the calling process of an IPC <em>or you</em> has been granted 2192 * permission to access a specific URI. This is the same as 2193 * {@link #checkCallingUriPermission}, except it grants your own permissions 2194 * if you are not currently processing an IPC. Use with care! 2195 * 2196 * @param uri The uri that is being checked. 2197 * @param modeFlags The type of access to grant. May be one or both of 2198 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2199 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2200 * 2201 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller 2202 * is allowed to access that uri, or 2203 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2204 * 2205 * @see #checkCallingUriPermission 2206 */ 2207 public abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags); 2208 2209 /** 2210 * Check both a Uri and normal permission. This allows you to perform 2211 * both {@link #checkPermission} and {@link #checkUriPermission} in one 2212 * call. 2213 * 2214 * @param uri The Uri whose permission is to be checked, or null to not 2215 * do this check. 2216 * @param readPermission The permission that provides overall read access, 2217 * or null to not do this check. 2218 * @param writePermission The permission that provides overall write 2219 * acess, or null to not do this check. 2220 * @param pid The process ID being checked against. Must be > 0. 2221 * @param uid The user ID being checked against. A uid of 0 is the root 2222 * user, which will pass every permission check. 2223 * @param modeFlags The type of access to grant. May be one or both of 2224 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2225 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2226 * 2227 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller 2228 * is allowed to access that uri or holds one of the given permissions, or 2229 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2230 */ 2231 public abstract int checkUriPermission(Uri uri, String readPermission, 2232 String writePermission, int pid, int uid, int modeFlags); 2233 2234 /** 2235 * If a particular process and user ID has not been granted 2236 * permission to access a specific URI, throw {@link 2237 * SecurityException}. This only checks for permissions that have 2238 * been explicitly granted -- if the given process/uid has more 2239 * general access to the URI's content provider then this check 2240 * will always fail. 2241 * 2242 * @param uri The uri that is being checked. 2243 * @param pid The process ID being checked against. Must be > 0. 2244 * @param uid The user ID being checked against. A uid of 0 is the root 2245 * user, which will pass every permission check. 2246 * @param modeFlags The type of access to grant. May be one or both of 2247 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2248 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2249 * @param message A message to include in the exception if it is thrown. 2250 * 2251 * @see #checkUriPermission(Uri, int, int, int) 2252 */ 2253 public abstract void enforceUriPermission( 2254 Uri uri, int pid, int uid, int modeFlags, String message); 2255 2256 /** 2257 * If the calling process and user ID has not been granted 2258 * permission to access a specific URI, throw {@link 2259 * SecurityException}. This is basically the same as calling 2260 * {@link #enforceUriPermission(Uri, int, int, int, String)} with 2261 * the pid and uid returned by {@link 2262 * android.os.Binder#getCallingPid} and {@link 2263 * android.os.Binder#getCallingUid}. One important difference is 2264 * that if you are not currently processing an IPC, this function 2265 * will always throw a SecurityException. 2266 * 2267 * @param uri The uri that is being checked. 2268 * @param modeFlags The type of access to grant. May be one or both of 2269 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2270 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2271 * @param message A message to include in the exception if it is thrown. 2272 * 2273 * @see #checkCallingUriPermission(Uri, int) 2274 */ 2275 public abstract void enforceCallingUriPermission( 2276 Uri uri, int modeFlags, String message); 2277 2278 /** 2279 * If the calling process of an IPC <em>or you</em> has not been 2280 * granted permission to access a specific URI, throw {@link 2281 * SecurityException}. This is the same as {@link 2282 * #enforceCallingUriPermission}, except it grants your own 2283 * permissions if you are not currently processing an IPC. Use 2284 * with care! 2285 * 2286 * @param uri The uri that is being checked. 2287 * @param modeFlags The type of access to grant. May be one or both of 2288 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2289 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2290 * @param message A message to include in the exception if it is thrown. 2291 * 2292 * @see #checkCallingOrSelfUriPermission(Uri, int) 2293 */ 2294 public abstract void enforceCallingOrSelfUriPermission( 2295 Uri uri, int modeFlags, String message); 2296 2297 /** 2298 * Enforce both a Uri and normal permission. This allows you to perform 2299 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one 2300 * call. 2301 * 2302 * @param uri The Uri whose permission is to be checked, or null to not 2303 * do this check. 2304 * @param readPermission The permission that provides overall read access, 2305 * or null to not do this check. 2306 * @param writePermission The permission that provides overall write 2307 * acess, or null to not do this check. 2308 * @param pid The process ID being checked against. Must be > 0. 2309 * @param uid The user ID being checked against. A uid of 0 is the root 2310 * user, which will pass every permission check. 2311 * @param modeFlags The type of access to grant. May be one or both of 2312 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2313 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2314 * @param message A message to include in the exception if it is thrown. 2315 * 2316 * @see #checkUriPermission(Uri, String, String, int, int, int) 2317 */ 2318 public abstract void enforceUriPermission( 2319 Uri uri, String readPermission, String writePermission, 2320 int pid, int uid, int modeFlags, String message); 2321 2322 /** 2323 * Flag for use with {@link #createPackageContext}: include the application 2324 * code with the context. This means loading code into the caller's 2325 * process, so that {@link #getClassLoader()} can be used to instantiate 2326 * the application's classes. Setting this flags imposes security 2327 * restrictions on what application context you can access; if the 2328 * requested application can not be safely loaded into your process, 2329 * java.lang.SecurityException will be thrown. If this flag is not set, 2330 * there will be no restrictions on the packages that can be loaded, 2331 * but {@link #getClassLoader} will always return the default system 2332 * class loader. 2333 */ 2334 public static final int CONTEXT_INCLUDE_CODE = 0x00000001; 2335 2336 /** 2337 * Flag for use with {@link #createPackageContext}: ignore any security 2338 * restrictions on the Context being requested, allowing it to always 2339 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code 2340 * to be loaded into a process even when it isn't safe to do so. Use 2341 * with extreme care! 2342 */ 2343 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002; 2344 2345 /** 2346 * Flag for use with {@link #createPackageContext}: a restricted context may 2347 * disable specific features. For instance, a View associated with a restricted 2348 * context would ignore particular XML attributes. 2349 */ 2350 public static final int CONTEXT_RESTRICTED = 0x00000004; 2351 2352 /** 2353 * Return a new Context object for the given application name. This 2354 * Context is the same as what the named application gets when it is 2355 * launched, containing the same resources and class loader. Each call to 2356 * this method returns a new instance of a Context object; Context objects 2357 * are not shared, however they share common state (Resources, ClassLoader, 2358 * etc) so the Context instance itself is fairly lightweight. 2359 * 2360 * <p>Throws {@link PackageManager.NameNotFoundException} if there is no 2361 * application with the given package name. 2362 * 2363 * <p>Throws {@link java.lang.SecurityException} if the Context requested 2364 * can not be loaded into the caller's process for security reasons (see 2365 * {@link #CONTEXT_INCLUDE_CODE} for more information}. 2366 * 2367 * @param packageName Name of the application's package. 2368 * @param flags Option flags, one of {@link #CONTEXT_INCLUDE_CODE} 2369 * or {@link #CONTEXT_IGNORE_SECURITY}. 2370 * 2371 * @return A Context for the application. 2372 * 2373 * @throws java.lang.SecurityException 2374 * @throws PackageManager.NameNotFoundException if there is no application with 2375 * the given package name 2376 */ 2377 public abstract Context createPackageContext(String packageName, 2378 int flags) throws PackageManager.NameNotFoundException; 2379 2380 /** 2381 * Indicates whether this Context is restricted. 2382 * 2383 * @return True if this Context is restricted, false otherwise. 2384 * 2385 * @see #CONTEXT_RESTRICTED 2386 */ 2387 public boolean isRestricted() { 2388 return false; 2389 } 2390} 2391