Skip to content

Most visited

Recently visited

navigation

StrictMode.VmPolicy.Builder

public static final class StrictMode.VmPolicy.Builder
extends Object

java.lang.Object
   ↳ android.os.StrictMode.VmPolicy.Builder


Creates StrictMode.VmPolicy instances. Methods whose names start with detect specify what problems we should look for. Methods whose names start with penalty specify what we should do when we detect a problem.

You can call as many detect and penalty methods as you like. Currently order is insignificant: all penalties apply to all detected problems.

For example, detect everything and log anything that's found:

 StrictMode.VmPolicy policy = new StrictMode.VmPolicy.Builder()
     .detectAll()
     .penaltyLog()
     .build();
 StrictMode.setVmPolicy(policy);
 

Summary

Public constructors

StrictMode.VmPolicy.Builder()
StrictMode.VmPolicy.Builder(StrictMode.VmPolicy base)

Build upon an existing VmPolicy.

Public methods

StrictMode.VmPolicy build()

Construct the VmPolicy instance.

StrictMode.VmPolicy.Builder detectActivityLeaks()

Detect leaks of Activity subclasses.

StrictMode.VmPolicy.Builder detectAll()

Detect everything that's potentially suspect.

StrictMode.VmPolicy.Builder detectCleartextNetwork()

Detect any network traffic from the calling app which is not wrapped in SSL/TLS.

StrictMode.VmPolicy.Builder detectFileUriExposure()

Detect when this application exposes a file:// Uri to another app.

StrictMode.VmPolicy.Builder detectLeakedClosableObjects()

Detect when an Closeable or other object with a explict termination method is finalized without having been closed.

StrictMode.VmPolicy.Builder detectLeakedRegistrationObjects()

Detect when a BroadcastReceiver or ServiceConnection is leaked during Context teardown.

StrictMode.VmPolicy.Builder detectLeakedSqlLiteObjects()

Detect when an SQLiteCursor or other SQLite object is finalized without having been closed.

StrictMode.VmPolicy.Builder penaltyDeath()

Crashes the whole process on violation.

StrictMode.VmPolicy.Builder penaltyDeathOnCleartextNetwork()

Crashes the whole process when cleartext network traffic is detected.

StrictMode.VmPolicy.Builder penaltyDeathOnFileUriExposure()

Crashes the whole process when a file:// Uri is exposed beyond this app.

StrictMode.VmPolicy.Builder penaltyDropBox()

Enable detected violations log a stacktrace and timing data to the DropBox on policy violation.

StrictMode.VmPolicy.Builder penaltyLog()

Log detected violations to the system log.

StrictMode.VmPolicy.Builder setClassInstanceLimit(Class klass, int instanceLimit)

Set an upper bound on how many instances of a class can be in memory at once.

Inherited methods

From class java.lang.Object

Public constructors

StrictMode.VmPolicy.Builder

Added in API level 9
StrictMode.VmPolicy.Builder ()

StrictMode.VmPolicy.Builder

Added in API level 11
StrictMode.VmPolicy.Builder (StrictMode.VmPolicy base)

Build upon an existing VmPolicy.

Parameters
base StrictMode.VmPolicy

Public methods

build

Added in API level 9
StrictMode.VmPolicy build ()

Construct the VmPolicy instance.

Note: if no penalties are enabled before calling build, penaltyLog() is implicitly set.

Returns
StrictMode.VmPolicy

detectActivityLeaks

Added in API level 11
StrictMode.VmPolicy.Builder detectActivityLeaks ()

Detect leaks of Activity subclasses.

Returns
StrictMode.VmPolicy.Builder

detectAll

Added in API level 9
StrictMode.VmPolicy.Builder detectAll ()

Detect everything that's potentially suspect.

In the Honeycomb release this includes leaks of SQLite cursors, Activities, and other closable objects but will likely expand in future releases.

Returns
StrictMode.VmPolicy.Builder

detectCleartextNetwork

Added in API level 23
StrictMode.VmPolicy.Builder detectCleartextNetwork ()

Detect any network traffic from the calling app which is not wrapped in SSL/TLS. This can help you detect places that your app is inadvertently sending cleartext data across the network.

Using penaltyDeath() or penaltyDeathOnCleartextNetwork() will block further traffic on that socket to prevent accidental data leakage, in addition to crashing your process.

Using penaltyDropBox() will log the raw contents of the packet that triggered the violation.

This inspects both IPv4/IPv6 and TCP/UDP network traffic, but it may be subject to false positives, such as when STARTTLS protocols or HTTP proxies are used.

Returns
StrictMode.VmPolicy.Builder

detectFileUriExposure

Added in API level 18
StrictMode.VmPolicy.Builder detectFileUriExposure ()

Detect when this application exposes a file:// Uri to another app.

This exposure is discouraged since the receiving app may not have access to the shared path. For example, the receiving app may not have requested the READ_EXTERNAL_STORAGE runtime permission, or the platform may be sharing the Uri across user profile boundaries.

Instead, apps should use content:// Uris so the platform can extend temporary permission for the receiving app to access the resource.

Returns
StrictMode.VmPolicy.Builder

See also:

detectLeakedClosableObjects

Added in API level 11
StrictMode.VmPolicy.Builder detectLeakedClosableObjects ()

Detect when an Closeable or other object with a explict termination method is finalized without having been closed.

You always want to explicitly close such objects to avoid unnecessary resources leaks.

Returns
StrictMode.VmPolicy.Builder

detectLeakedRegistrationObjects

Added in API level 16
StrictMode.VmPolicy.Builder detectLeakedRegistrationObjects ()

Detect when a BroadcastReceiver or ServiceConnection is leaked during Context teardown.

Returns
StrictMode.VmPolicy.Builder

detectLeakedSqlLiteObjects

Added in API level 9
StrictMode.VmPolicy.Builder detectLeakedSqlLiteObjects ()

Detect when an SQLiteCursor or other SQLite object is finalized without having been closed.

You always want to explicitly close your SQLite cursors to avoid unnecessary database contention and temporary memory leaks.

Returns
StrictMode.VmPolicy.Builder

penaltyDeath

Added in API level 9
StrictMode.VmPolicy.Builder penaltyDeath ()

Crashes the whole process on violation. This penalty runs at the end of all enabled penalties so you'll still get your logging or other violations before the process dies.

Returns
StrictMode.VmPolicy.Builder

penaltyDeathOnCleartextNetwork

Added in API level 23
StrictMode.VmPolicy.Builder penaltyDeathOnCleartextNetwork ()

Crashes the whole process when cleartext network traffic is detected.

Returns
StrictMode.VmPolicy.Builder

See also:

penaltyDeathOnFileUriExposure

Added in API level 24
StrictMode.VmPolicy.Builder penaltyDeathOnFileUriExposure ()

Crashes the whole process when a file:// Uri is exposed beyond this app.

Returns
StrictMode.VmPolicy.Builder

See also:

penaltyDropBox

Added in API level 9
StrictMode.VmPolicy.Builder penaltyDropBox ()

Enable detected violations log a stacktrace and timing data to the DropBox on policy violation. Intended mostly for platform integrators doing beta user field data collection.

Returns
StrictMode.VmPolicy.Builder

penaltyLog

Added in API level 9
StrictMode.VmPolicy.Builder penaltyLog ()

Log detected violations to the system log.

Returns
StrictMode.VmPolicy.Builder

setClassInstanceLimit

Added in API level 11
StrictMode.VmPolicy.Builder setClassInstanceLimit (Class klass, 
                int instanceLimit)

Set an upper bound on how many instances of a class can be in memory at once. Helps to prevent object leaks.

Parameters
klass Class
instanceLimit int
Returns
StrictMode.VmPolicy.Builder
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.