Context.java revision 9189cabb0b6c6c28232fe6f412b7ba7a37352a6a
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.PackageManager; 20import android.content.res.AssetManager; 21import android.content.res.Resources; 22import android.content.res.TypedArray; 23import android.database.sqlite.SQLiteDatabase; 24import android.database.sqlite.SQLiteDatabase.CursorFactory; 25import android.graphics.Bitmap; 26import android.graphics.drawable.Drawable; 27import android.net.Uri; 28import android.os.Bundle; 29import android.os.Handler; 30import android.os.Looper; 31import android.util.AttributeSet; 32 33import java.io.File; 34import java.io.FileInputStream; 35import java.io.FileNotFoundException; 36import java.io.FileOutputStream; 37import java.io.IOException; 38import java.io.InputStream; 39 40/** 41 * Interface to global information about an application environment. This is 42 * an abstract class whose implementation is provided by 43 * the Android system. It 44 * allows access to application-specific resources and classes, as well as 45 * up-calls for application-level operations such as launching activities, 46 * broadcasting and receiving intents, etc. 47 */ 48public abstract class Context { 49 /** 50 * File creation mode: the default mode, where the created file can only 51 * be accessed by the calling application (or all applications sharing the 52 * same user ID). 53 * @see #MODE_WORLD_READABLE 54 * @see #MODE_WORLD_WRITEABLE 55 */ 56 public static final int MODE_PRIVATE = 0x0000; 57 /** 58 * File creation mode: allow all other applications to have read access 59 * to the created file. 60 * @see #MODE_PRIVATE 61 * @see #MODE_WORLD_WRITEABLE 62 */ 63 public static final int MODE_WORLD_READABLE = 0x0001; 64 /** 65 * File creation mode: allow all other applications to have write access 66 * to the created file. 67 * @see #MODE_PRIVATE 68 * @see #MODE_WORLD_READABLE 69 */ 70 public static final int MODE_WORLD_WRITEABLE = 0x0002; 71 /** 72 * File creation mode: for use with {@link #openFileOutput}, if the file 73 * already exists then write data to the end of the existing file 74 * instead of erasing it. 75 * @see #openFileOutput 76 */ 77 public static final int MODE_APPEND = 0x8000; 78 79 /** 80 * Flag for {@link #bindService}: automatically create the service as long 81 * as the binding exists. Note that while this will create the service, 82 * its {@link android.app.Service#onStart} method will still only be called due to an 83 * explicit call to {@link #startService}. Even without that, though, 84 * this still provides you with access to the service object while the 85 * service is created. 86 * 87 * <p>Specifying this flag also tells the system to treat the service 88 * as being as important as your own process -- that is, when deciding 89 * which process should be killed to free memory, the service will only 90 * be considered a candidate as long as the processes of any such bindings 91 * is also a candidate to be killed. This is to avoid situations where 92 * the service is being continually created and killed due to low memory. 93 */ 94 public static final int BIND_AUTO_CREATE = 0x0001; 95 96 /** 97 * Flag for {@link #bindService}: include debugging help for mismatched 98 * calls to unbind. When this flag is set, the callstack of the following 99 * {@link #unbindService} call is retained, to be printed if a later 100 * incorrect unbind call is made. Note that doing this requires retaining 101 * information about the binding that was made for the lifetime of the app, 102 * resulting in a leak -- this should only be used for debugging. 103 */ 104 public static final int BIND_DEBUG_UNBIND = 0x0002; 105 106 /** Return an AssetManager instance for your application's package. */ 107 public abstract AssetManager getAssets(); 108 109 /** Return a Resources instance for your application's package. */ 110 public abstract Resources getResources(); 111 112 /** Return PackageManager instance to find global package information. */ 113 public abstract PackageManager getPackageManager(); 114 115 /** Return a ContentResolver instance for your application's package. */ 116 public abstract ContentResolver getContentResolver(); 117 118 /** 119 * Return the Looper for the main thread of the current process. This is 120 * the thread used to dispatch calls to application components (activities, 121 * services, etc). 122 */ 123 public abstract Looper getMainLooper(); 124 125 /** 126 * Return the context of the single, global Application object of the 127 * current process. 128 */ 129 public abstract Context getApplicationContext(); 130 131 /** 132 * Return a localized, styled CharSequence from the application's package's 133 * default string table. 134 * 135 * @param resId Resource id for the CharSequence text 136 */ 137 public final CharSequence getText(int resId) { 138 return getResources().getText(resId); 139 } 140 141 /** 142 * Return a localized string from the application's package's 143 * default string table. 144 * 145 * @param resId Resource id for the string 146 */ 147 public final String getString(int resId) { 148 return getResources().getString(resId); 149 } 150 151 /** 152 * Return a localized formatted string from the application's package's 153 * default string table, substituting the format arguments as defined in 154 * {@link java.util.Formatter} and {@link java.lang.String#format}. 155 * 156 * @param resId Resource id for the format string 157 * @param formatArgs The format arguments that will be used for substitution. 158 */ 159 160 public final String getString(int resId, Object... formatArgs) { 161 return getResources().getString(resId, formatArgs); 162 } 163 164 /** 165 * Set the base theme for this context. Note that this should be called 166 * before any views are instantiated in the Context (for example before 167 * calling {@link android.app.Activity#setContentView} or 168 * {@link android.view.LayoutInflater#inflate}). 169 * 170 * @param resid The style resource describing the theme. 171 */ 172 public abstract void setTheme(int resid); 173 174 /** 175 * Return the Theme object associated with this Context. 176 */ 177 public abstract Resources.Theme getTheme(); 178 179 /** 180 * Retrieve styled attribute information in this Context's theme. See 181 * {@link Resources.Theme#obtainStyledAttributes(int[])} 182 * for more information. 183 * 184 * @see Resources.Theme#obtainStyledAttributes(int[]) 185 */ 186 public final TypedArray obtainStyledAttributes( 187 int[] attrs) { 188 return getTheme().obtainStyledAttributes(attrs); 189 } 190 191 /** 192 * Retrieve styled attribute information in this Context's theme. See 193 * {@link Resources.Theme#obtainStyledAttributes(int, int[])} 194 * for more information. 195 * 196 * @see Resources.Theme#obtainStyledAttributes(int, int[]) 197 */ 198 public final TypedArray obtainStyledAttributes( 199 int resid, int[] attrs) throws Resources.NotFoundException { 200 return getTheme().obtainStyledAttributes(resid, attrs); 201 } 202 203 /** 204 * Retrieve styled attribute information in this Context's theme. See 205 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} 206 * for more information. 207 * 208 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) 209 */ 210 public final TypedArray obtainStyledAttributes( 211 AttributeSet set, int[] attrs) { 212 return getTheme().obtainStyledAttributes(set, attrs, 0, 0); 213 } 214 215 /** 216 * Retrieve styled attribute information in this Context's theme. See 217 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} 218 * for more information. 219 * 220 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) 221 */ 222 public final TypedArray obtainStyledAttributes( 223 AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) { 224 return getTheme().obtainStyledAttributes( 225 set, attrs, defStyleAttr, defStyleRes); 226 } 227 228 /** 229 * Return a class loader you can use to retrieve classes in this package. 230 */ 231 public abstract ClassLoader getClassLoader(); 232 233 /** Return the name of this application's package. */ 234 public abstract String getPackageName(); 235 236 /** 237 * {@hide} 238 * Return the full path to this context's resource files. This is the ZIP files 239 * containing the application's resources. 240 * 241 * <p>Note: this is not generally useful for applications, since they should 242 * not be directly accessing the file system. 243 * 244 * 245 * @return String Path to the resources. 246 */ 247 public abstract String getPackageResourcePath(); 248 249 /** 250 * {@hide} 251 * Return the full path to this context's code and asset files. This is the ZIP files 252 * containing the application's code and assets. 253 * 254 * <p>Note: this is not generally useful for applications, since they should 255 * not be directly accessing the file system. 256 * 257 * 258 * @return String Path to the code and assets. 259 */ 260 public abstract String getPackageCodePath(); 261 262 /** 263 * Retrieve and hold the contents of the preferences file 'name', returning 264 * a SharedPreferences through which you can retrieve and modify its 265 * values. Only one instance of the SharedPreferences object is returned 266 * to any callers for the same name, meaning they will see each other's 267 * edits as soon as they are made. 268 * 269 * @param name Desired preferences file. If a preferences file by this name 270 * does not exist, it will be created when you retrieve an 271 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()). 272 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 273 * default operation, {@link #MODE_WORLD_READABLE} 274 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. 275 * 276 * @return Returns the single SharedPreferences instance that can be used 277 * to retrieve and modify the preference values. 278 * 279 * @see #MODE_PRIVATE 280 * @see #MODE_WORLD_READABLE 281 * @see #MODE_WORLD_WRITEABLE 282 */ 283 public abstract SharedPreferences getSharedPreferences(String name, 284 int mode); 285 286 /** 287 * Open a private file associated with this Context's application package 288 * for reading. 289 * 290 * @param name The name of the file to open; can not contain path 291 * separators. 292 * 293 * @return FileInputStream Resulting input stream. 294 * 295 * @see #openFileOutput 296 * @see #fileList 297 * @see #deleteFile 298 * @see java.io.FileInputStream#FileInputStream(String) 299 */ 300 public abstract FileInputStream openFileInput(String name) 301 throws FileNotFoundException; 302 303 /** 304 * Open a private file associated with this Context's application package 305 * for writing. Creates the file if it doesn't already exist. 306 * 307 * @param name The name of the file to open; can not contain path 308 * separators. 309 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 310 * default operation, {@link #MODE_APPEND} to append to an existing file, 311 * {@link #MODE_WORLD_READABLE} and {@link #MODE_WORLD_WRITEABLE} to control 312 * permissions. 313 * 314 * @return FileOutputStream Resulting output stream. 315 * 316 * @see #MODE_APPEND 317 * @see #MODE_PRIVATE 318 * @see #MODE_WORLD_READABLE 319 * @see #MODE_WORLD_WRITEABLE 320 * @see #openFileInput 321 * @see #fileList 322 * @see #deleteFile 323 * @see java.io.FileOutputStream#FileOutputStream(String) 324 */ 325 public abstract FileOutputStream openFileOutput(String name, int mode) 326 throws FileNotFoundException; 327 328 /** 329 * Delete the given private file associated with this Context's 330 * application package. 331 * 332 * @param name The name of the file to delete; can not contain path 333 * separators. 334 * 335 * @return True if the file was successfully deleted; else 336 * false. 337 * 338 * @see #openFileInput 339 * @see #openFileOutput 340 * @see #fileList 341 * @see java.io.File#delete() 342 */ 343 public abstract boolean deleteFile(String name); 344 345 /** 346 * Returns the absolute path on the filesystem where a file created with 347 * {@link #openFileOutput} is stored. 348 * 349 * @param name The name of the file for which you would like to get 350 * its path. 351 * 352 * @return Returns an absolute path to the given file. 353 * 354 * @see #openFileOutput 355 * @see #getFilesDir 356 * @see #getDir 357 */ 358 public abstract File getFileStreamPath(String name); 359 360 /** 361 * Returns the absolute path to the directory on the filesystem where 362 * files created with {@link #openFileOutput} are stored. 363 * 364 * @return Returns the path of the directory holding application files. 365 * 366 * @see #openFileOutput 367 * @see #getFileStreamPath 368 * @see #getDir 369 */ 370 public abstract File getFilesDir(); 371 372 /** 373 * Returns the absolute path to the application specific cache directory 374 * on the filesystem. These files will be ones that get deleted first when the 375 * device runs low on storage 376 * There is no guarantee when these files will be deleted. 377 * 378 * @return Returns the path of the directory holding application cache files. 379 * 380 * @see #openFileOutput 381 * @see #getFileStreamPath 382 * @see #getDir 383 */ 384 public abstract File getCacheDir(); 385 386 /** 387 * Returns an array of strings naming the private files associated with 388 * this Context's application package. 389 * 390 * @return Array of strings naming the private files. 391 * 392 * @see #openFileInput 393 * @see #openFileOutput 394 * @see #deleteFile 395 */ 396 public abstract String[] fileList(); 397 398 /** 399 * Retrieve, creating if needed, a new directory in which the application 400 * can place its own custom data files. You can use the returned File 401 * object to create and access files in this directory. Note that files 402 * created through a File object will only be accessible by your own 403 * application; you can only set the mode of the entire directory, not 404 * of individual files. 405 * 406 * @param name Name of the directory to retrieve. This is a directory 407 * that is created as part of your application data. 408 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 409 * default operation, {@link #MODE_WORLD_READABLE} and 410 * {@link #MODE_WORLD_WRITEABLE} to control permissions. 411 * 412 * @return Returns a File object for the requested directory. The directory 413 * will have been created if it does not already exist. 414 * 415 * @see #openFileOutput(String, int) 416 */ 417 public abstract File getDir(String name, int mode); 418 419 /** 420 * Open a new private SQLiteDatabase associated with this Context's 421 * application package. Create the database file if it doesn't exist. 422 * 423 * @param name The name (unique in the application package) of the database. 424 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 425 * default operation, {@link #MODE_WORLD_READABLE} 426 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. 427 * @param factory An optional factory class that is called to instantiate a 428 * cursor when query is called. 429 * 430 * @return The contents of a newly created database with the given name. 431 * @throws android.database.sqlite.SQLiteException if the database file could not be opened. 432 * 433 * @see #MODE_PRIVATE 434 * @see #MODE_WORLD_READABLE 435 * @see #MODE_WORLD_WRITEABLE 436 * @see #deleteDatabase 437 */ 438 public abstract SQLiteDatabase openOrCreateDatabase(String name, 439 int mode, CursorFactory factory); 440 441 /** 442 * Delete an existing private SQLiteDatabase associated with this Context's 443 * application package. 444 * 445 * @param name The name (unique in the application package) of the 446 * database. 447 * 448 * @return True if the database was successfully deleted; else false. 449 * 450 * @see #openOrCreateDatabase 451 */ 452 public abstract boolean deleteDatabase(String name); 453 454 /** 455 * Returns the absolute path on the filesystem where a database created with 456 * {@link #openOrCreateDatabase} is stored. 457 * 458 * @param name The name of the database for which you would like to get 459 * its path. 460 * 461 * @return Returns an absolute path to the given database. 462 * 463 * @see #openOrCreateDatabase 464 */ 465 public abstract File getDatabasePath(String name); 466 467 /** 468 * Returns an array of strings naming the private databases associated with 469 * this Context's application package. 470 * 471 * @return Array of strings naming the private databases. 472 * 473 * @see #openOrCreateDatabase 474 * @see #deleteDatabase 475 */ 476 public abstract String[] databaseList(); 477 478 /** 479 * Like {@link #peekWallpaper}, but always returns a valid Drawable. If 480 * no wallpaper is set, the system default wallpaper is returned. 481 * 482 * @return Returns a Drawable object that will draw the wallpaper. 483 */ 484 public abstract Drawable getWallpaper(); 485 486 /** 487 * Retrieve the current system wallpaper. This is returned as an 488 * abstract Drawable that you can install in a View to display whatever 489 * wallpaper the user has currently set. If there is no wallpaper set, 490 * a null pointer is returned. 491 * 492 * @return Returns a Drawable object that will draw the wallpaper or a 493 * null pointer if these is none. 494 */ 495 public abstract Drawable peekWallpaper(); 496 497 /** 498 * Returns the desired minimum width for the wallpaper. Callers of 499 * {@link #setWallpaper(android.graphics.Bitmap)} or 500 * {@link #setWallpaper(java.io.InputStream)} should check this value 501 * beforehand to make sure the supplied wallpaper respects the desired 502 * minimum width. 503 * 504 * If the returned value is <= 0, the caller should use the width of 505 * the default display instead. 506 * 507 * @return The desired minimum width for the wallpaper. This value should 508 * be honored by applications that set the wallpaper but it is not 509 * mandatory. 510 */ 511 public abstract int getWallpaperDesiredMinimumWidth(); 512 513 /** 514 * Returns the desired minimum height for the wallpaper. Callers of 515 * {@link #setWallpaper(android.graphics.Bitmap)} or 516 * {@link #setWallpaper(java.io.InputStream)} should check this value 517 * beforehand to make sure the supplied wallpaper respects the desired 518 * minimum height. 519 * 520 * If the returned value is <= 0, the caller should use the height of 521 * the default display instead. 522 * 523 * @return The desired minimum height for the wallpaper. This value should 524 * be honored by applications that set the wallpaper but it is not 525 * mandatory. 526 */ 527 public abstract int getWallpaperDesiredMinimumHeight(); 528 529 /** 530 * Change the current system wallpaper to a bitmap. The given bitmap is 531 * converted to a PNG and stored as the wallpaper. On success, the intent 532 * {@link Intent#ACTION_WALLPAPER_CHANGED} is broadcast. 533 * 534 * @param bitmap The bitmap to save. 535 * 536 * @throws IOException If an error occurs reverting to the default 537 * wallpaper. 538 */ 539 public abstract void setWallpaper(Bitmap bitmap) throws IOException; 540 541 /** 542 * Change the current system wallpaper to a specific byte stream. The 543 * give InputStream is copied into persistent storage and will now be 544 * used as the wallpaper. Currently it must be either a JPEG or PNG 545 * image. On success, the intent {@link Intent#ACTION_WALLPAPER_CHANGED} 546 * is broadcast. 547 * 548 * @param data A stream containing the raw data to install as a wallpaper. 549 * 550 * @throws IOException If an error occurs reverting to the default 551 * wallpaper. 552 */ 553 public abstract void setWallpaper(InputStream data) throws IOException; 554 555 /** 556 * Remove any currently set wallpaper, reverting to the system's default 557 * wallpaper. On success, the intent {@link Intent#ACTION_WALLPAPER_CHANGED} 558 * is broadcast. 559 * 560 * @throws IOException If an error occurs reverting to the default 561 * wallpaper. 562 */ 563 public abstract void clearWallpaper() throws IOException; 564 565 /** 566 * Launch a new activity. You will not receive any information about when 567 * the activity exits. 568 * 569 * <p>Note that if this method is being called from outside of an 570 * {@link android.app.Activity} Context, then the Intent must include 571 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because, 572 * without being started from an existing Activity, there is no existing 573 * task in which to place the new activity and thus it needs to be placed 574 * in its own separate task. 575 * 576 * <p>This method throws {@link ActivityNotFoundException} 577 * if there was no Activity found to run the given Intent. 578 * 579 * @param intent The description of the activity to start. 580 * 581 * @throws ActivityNotFoundException 582 * 583 * @see PackageManager#resolveActivity 584 */ 585 public abstract void startActivity(Intent intent); 586 587 /** 588 * Broadcast the given intent to all interested BroadcastReceivers. This 589 * call is asynchronous; it returns immediately, and you will continue 590 * executing while the receivers are run. No results are propagated from 591 * receivers and receivers can not abort the broadcast. If you want 592 * to allow receivers to propagate results or abort the broadcast, you must 593 * send an ordered broadcast using 594 * {@link #sendOrderedBroadcast(Intent, String)}. 595 * 596 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 597 * 598 * @param intent The Intent to broadcast; all receivers matching this 599 * Intent will receive the broadcast. 600 * 601 * @see android.content.BroadcastReceiver 602 * @see #registerReceiver 603 * @see #sendBroadcast(Intent, String) 604 * @see #sendOrderedBroadcast(Intent, String) 605 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 606 */ 607 public abstract void sendBroadcast(Intent intent); 608 609 /** 610 * Broadcast the given intent to all interested BroadcastReceivers, allowing 611 * an optional required permission to be enforced. This 612 * call is asynchronous; it returns immediately, and you will continue 613 * executing while the receivers are run. No results are propagated from 614 * receivers and receivers can not abort the broadcast. If you want 615 * to allow receivers to propagate results or abort the broadcast, you must 616 * send an ordered broadcast using 617 * {@link #sendOrderedBroadcast(Intent, String)}. 618 * 619 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 620 * 621 * @param intent The Intent to broadcast; all receivers matching this 622 * Intent will receive the broadcast. 623 * @param receiverPermission (optional) String naming a permissions that 624 * a receiver must hold in order to receive your broadcast. 625 * If null, no permission is required. 626 * 627 * @see android.content.BroadcastReceiver 628 * @see #registerReceiver 629 * @see #sendBroadcast(Intent) 630 * @see #sendOrderedBroadcast(Intent, String) 631 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 632 */ 633 public abstract void sendBroadcast(Intent intent, 634 String receiverPermission); 635 636 /** 637 * Broadcast the given intent to all interested BroadcastReceivers, delivering 638 * them one at a time to allow more preferred receivers to consume the 639 * broadcast before it is delivered to less preferred receivers. This 640 * call is asynchronous; it returns immediately, and you will continue 641 * executing while the receivers are run. 642 * 643 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 644 * 645 * @param intent The Intent to broadcast; all receivers matching this 646 * Intent will receive the broadcast. 647 * @param receiverPermission (optional) String naming a permissions that 648 * a receiver must hold in order to receive your broadcast. 649 * If null, no permission is required. 650 * 651 * @see android.content.BroadcastReceiver 652 * @see #registerReceiver 653 * @see #sendBroadcast(Intent) 654 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 655 */ 656 public abstract void sendOrderedBroadcast(Intent intent, 657 String receiverPermission); 658 659 /** 660 * Version of {@link #sendBroadcast(Intent)} that allows you to 661 * receive data back from the broadcast. This is accomplished by 662 * supplying your own BroadcastReceiver when calling, which will be 663 * treated as a final receiver at the end of the broadcast -- its 664 * {@link BroadcastReceiver#onReceive} method will be called with 665 * the result values collected from the other receivers. If you use 666 * an <var>resultReceiver</var> with this method, then the broadcast will 667 * be serialized in the same way as calling 668 * {@link #sendOrderedBroadcast(Intent, String)}. 669 * 670 * <p>Like {@link #sendBroadcast(Intent)}, this method is 671 * asynchronous; it will return before 672 * resultReceiver.onReceive() is called. 673 * 674 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 675 * 676 * @param intent The Intent to broadcast; all receivers matching this 677 * Intent will receive the broadcast. 678 * @param receiverPermission String naming a permissions that 679 * a receiver must hold in order to receive your broadcast. 680 * If null, no permission is required. 681 * @param resultReceiver Your own BroadcastReceiver to treat as the final 682 * receiver of the broadcast. 683 * @param scheduler A custom Handler with which to schedule the 684 * resultReceiver callback; if null it will be 685 * scheduled in the Context's main thread. 686 * @param initialCode An initial value for the result code. Often 687 * Activity.RESULT_OK. 688 * @param initialData An initial value for the result data. Often 689 * null. 690 * @param initialExtras An initial value for the result extras. Often 691 * null. 692 * 693 * @see #sendBroadcast(Intent) 694 * @see #sendBroadcast(Intent, String) 695 * @see #sendOrderedBroadcast(Intent, String) 696 * @see #sendStickyBroadcast(Intent) 697 * @see android.content.BroadcastReceiver 698 * @see #registerReceiver 699 * @see android.app.Activity#RESULT_OK 700 */ 701 public abstract void sendOrderedBroadcast(Intent intent, 702 String receiverPermission, BroadcastReceiver resultReceiver, 703 Handler scheduler, int initialCode, String initialData, 704 Bundle initialExtras); 705 706 /** 707 * Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the 708 * Intent you are sending stays around after the broadcast is complete, 709 * so that others can quickly retrieve that data through the return 710 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In 711 * all other ways, this behaves the same as 712 * {@link #sendBroadcast(Intent)}. 713 * 714 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 715 * permission in order to use this API. If you do not hold that 716 * permission, {@link SecurityException} will be thrown. 717 * 718 * @param intent The Intent to broadcast; all receivers matching this 719 * Intent will receive the broadcast, and the Intent will be held to 720 * be re-broadcast to future receivers. 721 * 722 * @see #sendBroadcast(Intent) 723 */ 724 public abstract void sendStickyBroadcast(Intent intent); 725 726 /** 727 * Remove the data previously sent with {@link #sendStickyBroadcast}, 728 * so that it is as if the sticky broadcast had never happened. 729 * 730 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 731 * permission in order to use this API. If you do not hold that 732 * permission, {@link SecurityException} will be thrown. 733 * 734 * @param intent The Intent that was previously broadcast. 735 * 736 * @see #sendStickyBroadcast 737 */ 738 public abstract void removeStickyBroadcast(Intent intent); 739 740 /** 741 * Register a BroadcastReceiver to be run in the main activity thread. The 742 * <var>receiver</var> will be called with any broadcast Intent that 743 * matches <var>filter</var>, in the main application thread. 744 * 745 * <p>The system may broadcast Intents that are "sticky" -- these stay 746 * around after the broadcast as finished, to be sent to any later 747 * registrations. If your IntentFilter matches one of these sticky 748 * Intents, that Intent will be returned by this function 749 * <strong>and</strong> sent to your <var>receiver</var> as if it had just 750 * been broadcast. 751 * 752 * <p>There may be multiple sticky Intents that match <var>filter</var>, 753 * in which case each of these will be sent to <var>receiver</var>. In 754 * this case, only one of these can be returned directly by the function; 755 * which of these that is returned is arbitrarily decided by the system. 756 * 757 * <p>If you know the Intent your are registering for is sticky, you can 758 * supply null for your <var>receiver</var>. In this case, no receiver is 759 * registered -- the function simply returns the sticky Intent that 760 * matches <var>filter</var>. In the case of multiple matches, the same 761 * rules as described above apply. 762 * 763 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 764 * 765 * <p class="note">Note: this method <em>cannot be called from a 766 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver 767 * that is declared in an application's manifest. It is okay, however, to call 768 * this method from another BroadcastReceiver that has itself been registered 769 * at run time with {@link #registerReceiver}, since the lifetime of such a 770 * registered BroadcastReceiver is tied to the object that registered it.</p> 771 * 772 * @param receiver The BroadcastReceiver to handle the broadcast. 773 * @param filter Selects the Intent broadcasts to be received. 774 * 775 * @return The first sticky intent found that matches <var>filter</var>, 776 * or null if there are none. 777 * 778 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) 779 * @see #sendBroadcast 780 * @see #unregisterReceiver 781 */ 782 public abstract Intent registerReceiver(BroadcastReceiver receiver, 783 IntentFilter filter); 784 785 /** 786 * Register to receive intent broadcasts, to run in the context of 787 * <var>scheduler</var>. See 788 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more 789 * information. This allows you to enforce permissions on who can 790 * broadcast intents to your receiver, or have the receiver run in 791 * a different thread than the main application thread. 792 * 793 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 794 * 795 * @param receiver The BroadcastReceiver to handle the broadcast. 796 * @param filter Selects the Intent broadcasts to be received. 797 * @param broadcastPermission String naming a permissions that a 798 * broadcaster must hold in order to send an Intent to you. If null, 799 * no permission is required. 800 * @param scheduler Handler identifying the thread that will receive 801 * the Intent. If null, the main thread of the process will be used. 802 * 803 * @return The first sticky intent found that matches <var>filter</var>, 804 * or null if there are none. 805 * 806 * @see #registerReceiver(BroadcastReceiver, IntentFilter) 807 * @see #sendBroadcast 808 * @see #unregisterReceiver 809 */ 810 public abstract Intent registerReceiver(BroadcastReceiver receiver, 811 IntentFilter filter, 812 String broadcastPermission, 813 Handler scheduler); 814 815 /** 816 * Unregister a previously registered BroadcastReceiver. <em>All</em> 817 * filters that have been registered for this BroadcastReceiver will be 818 * removed. 819 * 820 * @param receiver The BroadcastReceiver to unregister. 821 * 822 * @see #registerReceiver 823 */ 824 public abstract void unregisterReceiver(BroadcastReceiver receiver); 825 826 /** 827 * Request that a given application service be started. The Intent 828 * can either contain the complete class name of a specific service 829 * implementation to start, or an abstract definition through the 830 * action and other fields of the kind of service to start. If this service 831 * is not already running, it will be instantiated and started (creating a 832 * process for it if needed); if it is running then it remains running. 833 * 834 * <p>Every call to this method will result in a corresponding call to 835 * the target service's {@link android.app.Service#onStart} method, 836 * with the <var>intent</var> given here. This provides a convenient way 837 * to submit jobs to a service without having to bind and call on to its 838 * interface. 839 * 840 * <p>Using startService() overrides the default service lifetime that is 841 * managed by {@link #bindService}: it requires the service to remain 842 * running until {@link #stopService} is called, regardless of whether 843 * any clients are connected to it. Note that calls to startService() 844 * are not nesting: no matter how many times you call startService(), 845 * a single call to {@link #stopService} will stop it. 846 * 847 * <p>The system attempts to keep running services around as much as 848 * possible. The only time they should be stopped is if the current 849 * foreground application is using so many resources that the service needs 850 * to be killed. If any errors happen in the service's process, it will 851 * automatically be restarted. 852 * 853 * <p>This function will throw {@link SecurityException} if you do not 854 * have permission to start the given service. 855 * 856 * @param service Identifies the service to be started. The Intent may 857 * specify either an explicit component name to start, or a logical 858 * description (action, category, etc) to match an 859 * {@link IntentFilter} published by a service. Additional values 860 * may be included in the Intent extras to supply arguments along with 861 * this specific start call. 862 * 863 * @return If the service is being started or is already running, the 864 * {@link ComponentName} of the actual service that was started is 865 * returned; else if the service does not exist null is returned. 866 * 867 * @throws SecurityException 868 * 869 * @see #stopService 870 * @see #bindService 871 */ 872 public abstract ComponentName startService(Intent service); 873 874 /** 875 * Request that a given application service be stopped. If the service is 876 * not running, nothing happens. Otherwise it is stopped. Note that calls 877 * to startService() are not counted -- this stops the service no matter 878 * how many times it was started. 879 * 880 * <p>Note that if a stopped service still has {@link ServiceConnection} 881 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will 882 * not be destroyed until all of these bindings are removed. See 883 * the {@link android.app.Service} documentation for more details on a 884 * service's lifecycle. 885 * 886 * <p>This function will throw {@link SecurityException} if you do not 887 * have permission to stop the given service. 888 * 889 * @param service Description of the service to be stopped. The Intent may 890 * specify either an explicit component name to start, or a logical 891 * description (action, category, etc) to match an 892 * {@link IntentFilter} published by a service. 893 * 894 * @return If there is a service matching the given Intent that is already 895 * running, then it is stopped and true is returned; else false is returned. 896 * 897 * @throws SecurityException 898 * 899 * @see #startService 900 */ 901 public abstract boolean stopService(Intent service); 902 903 /** 904 * Connect to an application service, creating it if needed. This defines 905 * a dependency between your application and the service. The given 906 * <var>conn</var> will receive the service object when its created and be 907 * told if it dies and restarts. The service will be considered required 908 * by the system only for as long as the calling context exists. For 909 * example, if this Context is an Activity that is stopped, the service will 910 * not be required to continue running until the Activity is resumed. 911 * 912 * <p>This function will throw {@link SecurityException} if you do not 913 * have permission to bind to the given service. 914 * 915 * <p class="note">Note: this method <em>can not be called from an 916 * {@link BroadcastReceiver} component</em>. A pattern you can use to 917 * communicate from an BroadcastReceiver to a Service is to call 918 * {@link #startService} with the arguments containing the command to be 919 * sent, with the service calling its 920 * {@link android.app.Service#stopSelf(int)} method when done executing 921 * that command. See the API demo App/Service/Service Start Arguments 922 * Controller for an illustration of this. It is okay, however, to use 923 * this method from an BroadcastReceiver that has been registered with 924 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver 925 * is tied to another object (the one that registered it).</p> 926 * 927 * @param service Identifies the service to connect to. The Intent may 928 * specify either an explicit component name, or a logical 929 * description (action, category, etc) to match an 930 * {@link IntentFilter} published by a service. 931 * @param conn Receives information as the service is started and stopped. 932 * @param flags Operation options for the binding. May be 0 or 933 * {@link #BIND_AUTO_CREATE}. 934 * @return If you have successfully bound to the service, true is returned; 935 * false is returned if the connection is not made so you will not 936 * receive the service object. 937 * 938 * @throws SecurityException 939 * 940 * @see #unbindService 941 * @see #startService 942 * @see #BIND_AUTO_CREATE 943 */ 944 public abstract boolean bindService(Intent service, ServiceConnection conn, 945 int flags); 946 947 /** 948 * Disconnect from an application service. You will no longer receive 949 * calls as the service is restarted, and the service is now allowed to 950 * stop at any time. 951 * 952 * @param conn The connection interface previously supplied to 953 * bindService(). 954 * 955 * @see #bindService 956 */ 957 public abstract void unbindService(ServiceConnection conn); 958 959 /** 960 * Start executing an {@link android.app.Instrumentation} class. The given 961 * Instrumentation component will be run by killing its target application 962 * (if currently running), starting the target process, instantiating the 963 * instrumentation component, and then letting it drive the application. 964 * 965 * <p>This function is not synchronous -- it returns as soon as the 966 * instrumentation has started and while it is running. 967 * 968 * <p>Instrumentation is normally only allowed to run against a package 969 * that is either unsigned or signed with a signature that the 970 * the instrumentation package is also signed with (ensuring the target 971 * trusts the instrumentation). 972 * 973 * @param className Name of the Instrumentation component to be run. 974 * @param profileFile Optional path to write profiling data as the 975 * instrumentation runs, or null for no profiling. 976 * @param arguments Additional optional arguments to pass to the 977 * instrumentation, or null. 978 * 979 * @return Returns true if the instrumentation was successfully started, 980 * else false if it could not be found. 981 */ 982 public abstract boolean startInstrumentation(ComponentName className, 983 String profileFile, Bundle arguments); 984 985 /** 986 * Return the handle to a system-level service by name. The class of the 987 * returned object varies by the requested name. Currently available names 988 * are: 989 * 990 * <dl> 991 * <dt> {@link #WINDOW_SERVICE} ("window") 992 * <dd> The top-level window manager in which you can place custom 993 * windows. The returned object is a {@link android.view.WindowManager}. 994 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater") 995 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources 996 * in this context. 997 * <dt> {@link #ACTIVITY_SERVICE} ("activity") 998 * <dd> A {@link android.app.ActivityManager} for interacting with the 999 * global activity state of the system. 1000 * <dt> {@link #POWER_SERVICE} ("power") 1001 * <dd> A {@link android.os.PowerManager} for controlling power 1002 * management. 1003 * <dt> {@link #ALARM_SERVICE} ("alarm") 1004 * <dd> A {@link android.app.AlarmManager} for receiving intents at the 1005 * time of your choosing. 1006 * <dt> {@link #NOTIFICATION_SERVICE} ("notification") 1007 * <dd> A {@link android.app.NotificationManager} for informing the user 1008 * of background events. 1009 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard") 1010 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard. 1011 * <dt> {@link #LOCATION_SERVICE} ("location") 1012 * <dd> A {@link android.location.LocationManager} for controlling location 1013 * (e.g., GPS) updates. 1014 * <dt> {@link #SEARCH_SERVICE} ("search") 1015 * <dd> A {@link android.app.SearchManager} for handling search. 1016 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator") 1017 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator 1018 * hardware. 1019 * <dt> {@link #CONNECTIVITY_SERVICE} ("connection") 1020 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for 1021 * handling management of network connections. 1022 * <dt> {@link #WIFI_SERVICE} ("wifi") 1023 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of 1024 * Wi-Fi connectivity. 1025 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method") 1026 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager} 1027 * for management of input methods. 1028 * </dl> 1029 * 1030 * <p>Note: System services obtained via this API may be closely associated with 1031 * the Context in which they are obtained from. In general, do not share the 1032 * service objects between various different contexts (Activities, Applications, 1033 * Services, Providers, etc.) 1034 * 1035 * @param name The name of the desired service. 1036 * 1037 * @return The service or null if the name does not exist. 1038 * 1039 * @see #WINDOW_SERVICE 1040 * @see android.view.WindowManager 1041 * @see #LAYOUT_INFLATER_SERVICE 1042 * @see android.view.LayoutInflater 1043 * @see #ACTIVITY_SERVICE 1044 * @see android.app.ActivityManager 1045 * @see #POWER_SERVICE 1046 * @see android.os.PowerManager 1047 * @see #ALARM_SERVICE 1048 * @see android.app.AlarmManager 1049 * @see #NOTIFICATION_SERVICE 1050 * @see android.app.NotificationManager 1051 * @see #KEYGUARD_SERVICE 1052 * @see android.app.KeyguardManager 1053 * @see #LOCATION_SERVICE 1054 * @see android.location.LocationManager 1055 * @see #SEARCH_SERVICE 1056 * @see android.app.SearchManager 1057 * @see #SENSOR_SERVICE 1058 * @see android.hardware.SensorManager 1059 * @see #VIBRATOR_SERVICE 1060 * @see android.os.Vibrator 1061 * @see #CONNECTIVITY_SERVICE 1062 * @see android.net.ConnectivityManager 1063 * @see #WIFI_SERVICE 1064 * @see android.net.wifi.WifiManager 1065 * @see #AUDIO_SERVICE 1066 * @see android.media.AudioManager 1067 * @see #TELEPHONY_SERVICE 1068 * @see android.telephony.TelephonyManager 1069 * @see #INPUT_METHOD_SERVICE 1070 * @see android.view.inputmethod.InputMethodManager 1071 */ 1072 public abstract Object getSystemService(String name); 1073 1074 /** 1075 * Use with {@link #getSystemService} to retrieve a 1076 * {@link android.os.PowerManager} for controlling power management, 1077 * including "wake locks," which let you keep the device on while 1078 * you're running long tasks. 1079 */ 1080 public static final String POWER_SERVICE = "power"; 1081 /** 1082 * Use with {@link #getSystemService} to retrieve a 1083 * {@link android.view.WindowManager} for accessing the system's window 1084 * manager. 1085 * 1086 * @see #getSystemService 1087 * @see android.view.WindowManager 1088 */ 1089 public static final String WINDOW_SERVICE = "window"; 1090 /** 1091 * Use with {@link #getSystemService} to retrieve a 1092 * {@link android.view.LayoutInflater} for inflating layout resources in this 1093 * context. 1094 * 1095 * @see #getSystemService 1096 * @see android.view.LayoutInflater 1097 */ 1098 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater"; 1099 /** 1100 * Use with {@link #getSystemService} to retrieve a 1101 * {@link android.app.ActivityManager} for interacting with the global 1102 * system state. 1103 * 1104 * @see #getSystemService 1105 * @see android.app.ActivityManager 1106 */ 1107 public static final String ACTIVITY_SERVICE = "activity"; 1108 /** 1109 * Use with {@link #getSystemService} to retrieve a 1110 * {@link android.app.AlarmManager} for receiving intents at a 1111 * time of your choosing. 1112 * 1113 * @see #getSystemService 1114 * @see android.app.AlarmManager 1115 */ 1116 public static final String ALARM_SERVICE = "alarm"; 1117 /** 1118 * Use with {@link #getSystemService} to retrieve a 1119 * {@link android.app.NotificationManager} for informing the user of 1120 * background events. 1121 * 1122 * @see #getSystemService 1123 * @see android.app.NotificationManager 1124 */ 1125 public static final String NOTIFICATION_SERVICE = "notification"; 1126 /** 1127 * Use with {@link #getSystemService} to retrieve a 1128 * {@link android.view.accessibility.AccessibilityManager} for giving the user 1129 * feedback for UI events through the registered event listeners. 1130 * 1131 * @see #getSystemService 1132 * @see android.view.accessibility.AccessibilityManager 1133 */ 1134 public static final String ACCESSIBILITY_SERVICE = "accessibility"; 1135 /** 1136 * Use with {@link #getSystemService} to retrieve a 1137 * {@link android.app.NotificationManager} for controlling keyguard. 1138 * 1139 * @see #getSystemService 1140 * @see android.app.KeyguardManager 1141 */ 1142 public static final String KEYGUARD_SERVICE = "keyguard"; 1143 /** 1144 * Use with {@link #getSystemService} to retrieve a {@link 1145 * android.location.LocationManager} for controlling location 1146 * updates. 1147 * 1148 * @see #getSystemService 1149 * @see android.location.LocationManager 1150 */ 1151 public static final String LOCATION_SERVICE = "location"; 1152 /** 1153 * Use with {@link #getSystemService} to retrieve a {@link 1154 * android.app.SearchManager} for handling searches. 1155 * 1156 * @see #getSystemService 1157 * @see android.app.SearchManager 1158 */ 1159 public static final String SEARCH_SERVICE = "search"; 1160 /** 1161 * Use with {@link #getSystemService} to retrieve a {@link 1162 * android.hardware.SensorManager} for accessing sensors. 1163 * 1164 * @see #getSystemService 1165 * @see android.hardware.SensorManager 1166 */ 1167 public static final String SENSOR_SERVICE = "sensor"; 1168 /** 1169 * Use with {@link #getSystemService} to retrieve a {@link 1170 * android.bluetooth.BluetoothDevice} for interacting with Bluetooth. 1171 * 1172 * @see #getSystemService 1173 * @see android.bluetooth.BluetoothDevice 1174 * @hide 1175 */ 1176 public static final String BLUETOOTH_SERVICE = "bluetooth"; 1177 /** 1178 * Use with {@link #getSystemService} to retrieve a 1179 * com.android.server.WallpaperService for accessing wallpapers. 1180 * 1181 * @see #getSystemService 1182 */ 1183 public static final String WALLPAPER_SERVICE = "wallpaper"; 1184 /** 1185 * Use with {@link #getSystemService} to retrieve a {@link 1186 * android.os.Vibrator} for interacting with the vibration hardware. 1187 * 1188 * @see #getSystemService 1189 * @see android.os.Vibrator 1190 */ 1191 public static final String VIBRATOR_SERVICE = "vibrator"; 1192 /** 1193 * Use with {@link #getSystemService} to retrieve a {@link 1194 * android.app.StatusBarManager} for interacting with the status bar. 1195 * 1196 * @see #getSystemService 1197 * @see android.app.StatusBarManager 1198 * @hide 1199 */ 1200 public static final String STATUS_BAR_SERVICE = "statusbar"; 1201 1202 /** 1203 * Use with {@link #getSystemService} to retrieve a {@link 1204 * android.net.ConnectivityManager} for handling management of 1205 * network connections. 1206 * 1207 * @see #getSystemService 1208 * @see android.net.ConnectivityManager 1209 */ 1210 public static final String CONNECTIVITY_SERVICE = "connectivity"; 1211 1212 /** 1213 * Use with {@link #getSystemService} to retrieve a {@link 1214 * android.net.wifi.WifiManager} for handling management of 1215 * Wi-Fi access. 1216 * 1217 * @see #getSystemService 1218 * @see android.net.wifi.WifiManager 1219 */ 1220 public static final String WIFI_SERVICE = "wifi"; 1221 1222 /** 1223 * Use with {@link #getSystemService} to retrieve a 1224 * {@link android.media.AudioManager} for handling management of volume, 1225 * ringer modes and audio routing. 1226 * 1227 * @see #getSystemService 1228 * @see android.media.AudioManager 1229 */ 1230 public static final String AUDIO_SERVICE = "audio"; 1231 1232 /** 1233 * Use with {@link #getSystemService} to retrieve a 1234 * {@link android.telephony.TelephonyManager} for handling management the 1235 * telephony features of the device. 1236 * 1237 * @see #getSystemService 1238 * @see android.telephony.TelephonyManager 1239 */ 1240 public static final String TELEPHONY_SERVICE = "phone"; 1241 1242 /** 1243 * Use with {@link #getSystemService} to retrieve a 1244 * {@link android.text.ClipboardManager} for accessing and modifying 1245 * the contents of the global clipboard. 1246 * 1247 * @see #getSystemService 1248 * @see android.text.ClipboardManager 1249 */ 1250 public static final String CLIPBOARD_SERVICE = "clipboard"; 1251 1252 /** 1253 * Use with {@link #getSystemService} to retrieve a 1254 * {@link android.view.inputmethod.InputMethodManager} for accessing input 1255 * methods. 1256 * 1257 * @see #getSystemService 1258 */ 1259 public static final String INPUT_METHOD_SERVICE = "input_method"; 1260 1261 /** 1262 * Use with {@link #getSystemService} to retrieve a 1263 * {@blink android.appwidget.AppWidgetManager} for accessing AppWidgets. 1264 * 1265 * @hide 1266 * @see #getSystemService 1267 */ 1268 public static final String APPWIDGET_SERVICE = "appwidget"; 1269 1270 /** 1271 * Use with {@link #getSystemService} to retrieve an 1272 * {@blink android.backup.IBackupManager IBackupManager} for communicating 1273 * with the backup mechanism. 1274 * 1275 * @see #getSystemService 1276 */ 1277 public static final String BACKUP_SERVICE = "backup"; 1278 1279 /** 1280 * Determine whether the given permission is allowed for a particular 1281 * process and user ID running in the system. 1282 * 1283 * @param permission The name of the permission being checked. 1284 * @param pid The process ID being checked against. Must be > 0. 1285 * @param uid The user ID being checked against. A uid of 0 is the root 1286 * user, which will pass every permission check. 1287 * 1288 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the given 1289 * pid/uid is allowed that permission, or 1290 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1291 * 1292 * @see PackageManager#checkPermission(String, String) 1293 * @see #checkCallingPermission 1294 */ 1295 public abstract int checkPermission(String permission, int pid, int uid); 1296 1297 /** 1298 * Determine whether the calling process of an IPC you are handling has been 1299 * granted a particular permission. This is basically the same as calling 1300 * {@link #checkPermission(String, int, int)} with the pid and uid returned 1301 * by {@link android.os.Binder#getCallingPid} and 1302 * {@link android.os.Binder#getCallingUid}. One important difference 1303 * is that if you are not currently processing an IPC, this function 1304 * will always fail. This is done to protect against accidentally 1305 * leaking permissions; you can use {@link #checkCallingOrSelfPermission} 1306 * to avoid this protection. 1307 * 1308 * @param permission The name of the permission being checked. 1309 * 1310 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the calling 1311 * pid/uid is allowed that permission, or 1312 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1313 * 1314 * @see PackageManager#checkPermission(String, String) 1315 * @see #checkPermission 1316 * @see #checkCallingOrSelfPermission 1317 */ 1318 public abstract int checkCallingPermission(String permission); 1319 1320 /** 1321 * Determine whether the calling process of an IPC <em>or you</em> have been 1322 * granted a particular permission. This is the same as 1323 * {@link #checkCallingPermission}, except it grants your own permissions 1324 * if you are not currently processing an IPC. Use with care! 1325 * 1326 * @param permission The name of the permission being checked. 1327 * 1328 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the calling 1329 * pid/uid is allowed that permission, or 1330 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1331 * 1332 * @see PackageManager#checkPermission(String, String) 1333 * @see #checkPermission 1334 * @see #checkCallingPermission 1335 */ 1336 public abstract int checkCallingOrSelfPermission(String permission); 1337 1338 /** 1339 * If the given permission is not allowed for a particular process 1340 * and user ID running in the system, throw a {@link SecurityException}. 1341 * 1342 * @param permission The name of the permission being checked. 1343 * @param pid The process ID being checked against. Must be > 0. 1344 * @param uid The user ID being checked against. A uid of 0 is the root 1345 * user, which will pass every permission check. 1346 * @param message A message to include in the exception if it is thrown. 1347 * 1348 * @see #checkPermission(String, int, int) 1349 */ 1350 public abstract void enforcePermission( 1351 String permission, int pid, int uid, String message); 1352 1353 /** 1354 * If the calling process of an IPC you are handling has not been 1355 * granted a particular permission, throw a {@link 1356 * SecurityException}. This is basically the same as calling 1357 * {@link #enforcePermission(String, int, int, String)} with the 1358 * pid and uid returned by {@link android.os.Binder#getCallingPid} 1359 * and {@link android.os.Binder#getCallingUid}. One important 1360 * difference is that if you are not currently processing an IPC, 1361 * this function will always throw the SecurityException. This is 1362 * done to protect against accidentally leaking permissions; you 1363 * can use {@link #enforceCallingOrSelfPermission} to avoid this 1364 * protection. 1365 * 1366 * @param permission The name of the permission being checked. 1367 * @param message A message to include in the exception if it is thrown. 1368 * 1369 * @see #checkCallingPermission(String) 1370 */ 1371 public abstract void enforceCallingPermission( 1372 String permission, String message); 1373 1374 /** 1375 * If neither you nor the calling process of an IPC you are 1376 * handling has been granted a particular permission, throw a 1377 * {@link SecurityException}. This is the same as {@link 1378 * #enforceCallingPermission}, except it grants your own 1379 * permissions if you are not currently processing an IPC. Use 1380 * with care! 1381 * 1382 * @param permission The name of the permission being checked. 1383 * @param message A message to include in the exception if it is thrown. 1384 * 1385 * @see #checkCallingOrSelfPermission(String) 1386 */ 1387 public abstract void enforceCallingOrSelfPermission( 1388 String permission, String message); 1389 1390 /** 1391 * Grant permission to access a specific Uri to another package, regardless 1392 * of whether that package has general permission to access the Uri's 1393 * content provider. This can be used to grant specific, temporary 1394 * permissions, typically in response to user interaction (such as the 1395 * user opening an attachment that you would like someone else to 1396 * display). 1397 * 1398 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 1399 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1400 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 1401 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to 1402 * start an activity instead of this function directly. If you use this 1403 * function directly, you should be sure to call 1404 * {@link #revokeUriPermission} when the target should no longer be allowed 1405 * to access it. 1406 * 1407 * <p>To succeed, the content provider owning the Uri must have set the 1408 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions 1409 * grantUriPermissions} attribute in its manifest or included the 1410 * {@link android.R.styleable#AndroidManifestGrantUriPermission 1411 * <grant-uri-permissions>} tag. 1412 * 1413 * @param toPackage The package you would like to allow to access the Uri. 1414 * @param uri The Uri you would like to grant access to. 1415 * @param modeFlags The desired access modes. Any combination of 1416 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 1417 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1418 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 1419 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1420 * 1421 * @see #revokeUriPermission 1422 */ 1423 public abstract void grantUriPermission(String toPackage, Uri uri, 1424 int modeFlags); 1425 1426 /** 1427 * Remove all permissions to access a particular content provider Uri 1428 * that were previously added with {@link #grantUriPermission}. The given 1429 * Uri will match all previously granted Uris that are the same or a 1430 * sub-path of the given Uri. That is, revoking "content://foo/one" will 1431 * revoke both "content://foo/target" and "content://foo/target/sub", but not 1432 * "content://foo". 1433 * 1434 * @param uri The Uri you would like to revoke access to. 1435 * @param modeFlags The desired access modes. Any combination of 1436 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 1437 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1438 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 1439 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1440 * 1441 * @see #grantUriPermission 1442 */ 1443 public abstract void revokeUriPermission(Uri uri, int modeFlags); 1444 1445 /** 1446 * Determine whether a particular process and user ID has been granted 1447 * permission to access a specific URI. This only checks for permissions 1448 * that have been explicitly granted -- if the given process/uid has 1449 * more general access to the URI's content provider then this check will 1450 * always fail. 1451 * 1452 * @param uri The uri that is being checked. 1453 * @param pid The process ID being checked against. Must be > 0. 1454 * @param uid The user ID being checked against. A uid of 0 is the root 1455 * user, which will pass every permission check. 1456 * @param modeFlags The type of access to grant. May be one or both of 1457 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1458 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1459 * 1460 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the given 1461 * pid/uid is allowed to access that uri, or 1462 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1463 * 1464 * @see #checkCallingUriPermission 1465 */ 1466 public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags); 1467 1468 /** 1469 * Determine whether the calling process and user ID has been 1470 * granted permission to access a specific URI. This is basically 1471 * the same as calling {@link #checkUriPermission(Uri, int, int, 1472 * int)} with the pid and uid returned by {@link 1473 * android.os.Binder#getCallingPid} and {@link 1474 * android.os.Binder#getCallingUid}. One important difference is 1475 * that if you are not currently processing an IPC, this function 1476 * will always fail. 1477 * 1478 * @param uri The uri that is being checked. 1479 * @param modeFlags The type of access to grant. May be one or both of 1480 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1481 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1482 * 1483 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller 1484 * is allowed to access that uri, or 1485 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1486 * 1487 * @see #checkUriPermission(Uri, int, int, int) 1488 */ 1489 public abstract int checkCallingUriPermission(Uri uri, int modeFlags); 1490 1491 /** 1492 * Determine whether the calling process of an IPC <em>or you</em> has been granted 1493 * permission to access a specific URI. This is the same as 1494 * {@link #checkCallingUriPermission}, except it grants your own permissions 1495 * if you are not currently processing an IPC. Use with care! 1496 * 1497 * @param uri The uri that is being checked. 1498 * @param modeFlags The type of access to grant. May be one or both of 1499 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1500 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1501 * 1502 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller 1503 * is allowed to access that uri, or 1504 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1505 * 1506 * @see #checkCallingUriPermission 1507 */ 1508 public abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags); 1509 1510 /** 1511 * Check both a Uri and normal permission. This allows you to perform 1512 * both {@link #checkPermission} and {@link #checkUriPermission} in one 1513 * call. 1514 * 1515 * @param uri The Uri whose permission is to be checked, or null to not 1516 * do this check. 1517 * @param readPermission The permission that provides overall read access, 1518 * or null to not do this check. 1519 * @param writePermission The permission that provides overall write 1520 * acess, or null to not do this check. 1521 * @param pid The process ID being checked against. Must be > 0. 1522 * @param uid The user ID being checked against. A uid of 0 is the root 1523 * user, which will pass every permission check. 1524 * @param modeFlags The type of access to grant. May be one or both of 1525 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1526 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1527 * 1528 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller 1529 * is allowed to access that uri or holds one of the given permissions, or 1530 * {@link PackageManager#PERMISSION_DENIED} if it is not. 1531 */ 1532 public abstract int checkUriPermission(Uri uri, String readPermission, 1533 String writePermission, int pid, int uid, int modeFlags); 1534 1535 /** 1536 * If a particular process and user ID has not been granted 1537 * permission to access a specific URI, throw {@link 1538 * SecurityException}. This only checks for permissions that have 1539 * been explicitly granted -- if the given process/uid has more 1540 * general access to the URI's content provider then this check 1541 * will always fail. 1542 * 1543 * @param uri The uri that is being checked. 1544 * @param pid The process ID being checked against. Must be > 0. 1545 * @param uid The user ID being checked against. A uid of 0 is the root 1546 * user, which will pass every permission check. 1547 * @param modeFlags The type of access to grant. May be one or both of 1548 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1549 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1550 * @param message A message to include in the exception if it is thrown. 1551 * 1552 * @see #checkUriPermission(Uri, int, int, int) 1553 */ 1554 public abstract void enforceUriPermission( 1555 Uri uri, int pid, int uid, int modeFlags, String message); 1556 1557 /** 1558 * If the calling process and user ID has not been granted 1559 * permission to access a specific URI, throw {@link 1560 * SecurityException}. This is basically the same as calling 1561 * {@link #enforceUriPermission(Uri, int, int, int, String)} with 1562 * the pid and uid returned by {@link 1563 * android.os.Binder#getCallingPid} and {@link 1564 * android.os.Binder#getCallingUid}. One important difference is 1565 * that if you are not currently processing an IPC, this function 1566 * will always throw a SecurityException. 1567 * 1568 * @param uri The uri that is being checked. 1569 * @param modeFlags The type of access to grant. May be one or both of 1570 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1571 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1572 * @param message A message to include in the exception if it is thrown. 1573 * 1574 * @see #checkCallingUriPermission(Uri, int) 1575 */ 1576 public abstract void enforceCallingUriPermission( 1577 Uri uri, int modeFlags, String message); 1578 1579 /** 1580 * If the calling process of an IPC <em>or you</em> has not been 1581 * granted permission to access a specific URI, throw {@link 1582 * SecurityException}. This is the same as {@link 1583 * #enforceCallingUriPermission}, except it grants your own 1584 * permissions if you are not currently processing an IPC. Use 1585 * with care! 1586 * 1587 * @param uri The uri that is being checked. 1588 * @param modeFlags The type of access to grant. May be one or both of 1589 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1590 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1591 * @param message A message to include in the exception if it is thrown. 1592 * 1593 * @see #checkCallingOrSelfUriPermission(Uri, int) 1594 */ 1595 public abstract void enforceCallingOrSelfUriPermission( 1596 Uri uri, int modeFlags, String message); 1597 1598 /** 1599 * Enforce both a Uri and normal permission. This allows you to perform 1600 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one 1601 * call. 1602 * 1603 * @param uri The Uri whose permission is to be checked, or null to not 1604 * do this check. 1605 * @param readPermission The permission that provides overall read access, 1606 * or null to not do this check. 1607 * @param writePermission The permission that provides overall write 1608 * acess, or null to not do this check. 1609 * @param pid The process ID being checked against. Must be > 0. 1610 * @param uid The user ID being checked against. A uid of 0 is the root 1611 * user, which will pass every permission check. 1612 * @param modeFlags The type of access to grant. May be one or both of 1613 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 1614 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 1615 * @param message A message to include in the exception if it is thrown. 1616 * 1617 * @see #checkUriPermission(Uri, String, String, int, int, int) 1618 */ 1619 public abstract void enforceUriPermission( 1620 Uri uri, String readPermission, String writePermission, 1621 int pid, int uid, int modeFlags, String message); 1622 1623 /** 1624 * Flag for use with {@link #createPackageContext}: include the application 1625 * code with the context. This means loading code into the caller's 1626 * process, so that {@link #getClassLoader()} can be used to instantiate 1627 * the application's classes. Setting this flags imposes security 1628 * restrictions on what application context you can access; if the 1629 * requested application can not be safely loaded into your process, 1630 * java.lang.SecurityException will be thrown. If this flag is not set, 1631 * there will be no restrictions on the packages that can be loaded, 1632 * but {@link #getClassLoader} will always return the default system 1633 * class loader. 1634 */ 1635 public static final int CONTEXT_INCLUDE_CODE = 0x00000001; 1636 1637 /** 1638 * Flag for use with {@link #createPackageContext}: ignore any security 1639 * restrictions on the Context being requested, allowing it to always 1640 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code 1641 * to be loaded into a process even when it isn't safe to do so. Use 1642 * with extreme care! 1643 */ 1644 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002; 1645 1646 /** 1647 * Return a new Context object for the given application name. This 1648 * Context is the same as what the named application gets when it is 1649 * launched, containing the same resources and class loader. Each call to 1650 * this method returns a new instance of a Context object; Context objects 1651 * are not shared, however they share common state (Resources, ClassLoader, 1652 * etc) so the Context instance itself is fairly lightweight. 1653 * 1654 * <p>Throws {@link PackageManager.NameNotFoundException} if there is no 1655 * application with the given package name. 1656 * 1657 * <p>Throws {@link java.lang.SecurityException} if the Context requested 1658 * can not be loaded into the caller's process for security reasons (see 1659 * {@link #CONTEXT_INCLUDE_CODE} for more information}. 1660 * 1661 * @param packageName Name of the application's package. 1662 * @param flags Option flags, one of {@link #CONTEXT_INCLUDE_CODE} 1663 * or {@link #CONTEXT_IGNORE_SECURITY}. 1664 * 1665 * @return A Context for the application. 1666 * 1667 * @throws java.lang.SecurityException 1668 * @throws PackageManager.NameNotFoundException if there is no application with 1669 * the given package name 1670 */ 1671 public abstract Context createPackageContext(String packageName, 1672 int flags) throws PackageManager.NameNotFoundException; 1673} 1674