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