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