diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/html/guide/topics/admin/device-admin.jd | 124 |
1 files changed, 81 insertions, 43 deletions
diff --git a/docs/html/guide/topics/admin/device-admin.jd b/docs/html/guide/topics/admin/device-admin.jd index 4d9a14f..fda716a 100644 --- a/docs/html/guide/topics/admin/device-admin.jd +++ b/docs/html/guide/topics/admin/device-admin.jd @@ -1,24 +1,33 @@ -page.title=Android Device Administration API +page.title=Device Administration @jd:body + <div id="qv-wrapper"> <div id="qv"> <h2>In this document</h2> <ol> <li><a href="#overview">Device Administration API Overview</a> <ol> + <li><a href="#how">How does it work?</a></li> <li><a href="#policies">Policies</a></li> </ol> </li> - <li><a href="#how">How Does It Work?</a></li> <li><a href="#sample">Sample Application</a></li> <li><a href="#developing">Developing a Device Administration Application</a> <ol> - <li><a href="#manifest">Creating the Manifest</a></li> - <li><a href="#code">Implementing the Code</a> - </li> + <li><a href="#manifest">Creating the manifest</a></li> + <li><a href="#code">Implementing the code</a></li> </ol> + </li> + + </ol> + + <h2>Key classes</h2> + <ol> + <li>{@link android.app.admin.DeviceAdminReceiver}</li> + <li>{@link android.app.admin.DevicePolicyManager}</li> + <li>{@link android.app.admin.DeviceAdminInfo}</li> </ol> - </div> +</div> </div> <p>Android 2.2 introduces support for enterprise applications by offering the @@ -37,7 +46,10 @@ their email and calendar data.</p> solutions for Android-powered devices. It discusses the various features provided by the Device Administration API to provide stronger security for employee devices that are powered by Android.</p> + + <h2 id="overview">Device Administration API Overview</h2> + <p>Here are examples of the types of applications that might use the Device Administration API:</p> <ul> <li>Email clients.</li> @@ -45,14 +57,14 @@ employee devices that are powered by Android.</p> <li>Device management services and applications.</li> </ul> -<h3 id="how">How Does it Work?</h3> +<h3 id="how">How does it work?</h3> <p>You use the Device Administration API to write device admin applications that users install on their devices. The device admin application enforces the desired policies. Here's how it works:</p> <ul> <li>A system administrator writes a device admin application that enforces remote/local device security policies. These policies could be hard-coded into the app, or the application could dynamically fetch policies from a third-party -server. </li> +server. </li> <li>The application is installed on users' devices. Android does not currently have an automated provisioning solution. Some of the ways a sysadmin might distribute the application to users are as follows: @@ -68,7 +80,7 @@ distribute the application to users are as follows: <li>The system prompts the user to enable the device admin application. How and when this happens depends on how the application is implemented.</li> <li>Once users enable the device admin application, they are subject to -its policies. Complying with those policies typically confers benefits, such as +its policies. Complying with those policies typically confers benefits, such as access to sensitive systems and data.</li> </ul> <p>If users do not enable the device admin app, it remains on the device, but in an inactive state. Users will not be subject to its policies, and they will conversely not get any of the application's benefits—for example, they may not be able to sync data.</p> @@ -88,12 +100,14 @@ application.</p> <p>To uninstall an existing device admin application, users need to first unregister the application as an administrator. </p> -<h3 id ="policies">Policies</h3> + +<h3 id="policies">Policies</h3> + <p>In an enterprise setting, it's often the case that employee devices must adhere to a strict set of policies that govern the use of the device. The Device Administration API supports the policies listed in Table 1. Note that the Device Administration API currently only supports passwords for screen -lock:</p> +lock:</p> <p class="table-caption"><strong>Table 1.</strong> Policies supported by the Device Administration API.</p> <table border="1"> <tr> @@ -109,7 +123,7 @@ lock:</p> <td>Set the required number of characters for the password. For example, you can require PIN or passwords to have at least six characters. </td> </tr> <tr> - <td>Alphanumeric password required</td> + <td>Alphanumeric password required</td> <td>Requires that passwords have a combination of letters and numbers. They may include symbolic characters. </td> @@ -128,7 +142,9 @@ pressed a button before the device locks the screen. When this happens, users need to enter their PIN or passwords again before they can use their devices and access data. The value can be between 1 and 60 minutes.</td> </tr> </table> -<h4>Other Features</h4> + +<h4>Other features</h4> + <p>In addition to supporting the policies listed in the above table, the Device Administration API lets you do the following:</p> <ul> <li>Prompt user to set a new password.</li> @@ -138,6 +154,7 @@ Administration API lets you do the following:</p> <ul> <h2 id="sample">Sample Application</h2> + <p>The examples used in this document are based on the <a href="{@docRoot}resources/samples/ApiDemos/src/com/example/ android/apis/app/DeviceAdminSample.html">Device Administration API @@ -147,7 +164,7 @@ href="{@docRoot}resources/samples/get.html"> Getting the Samples</a>. Here is the <a href="{@docRoot}resources/samples/ApiDemos/src/com/example/ android/apis/app/DeviceAdminSample.html">complete code</a> for -the sample. </p> +the sample. </p> <p>The sample application offers a demo of device admin features. It presents users with a user interface that lets them enable the device admin application. Once @@ -169,13 +186,17 @@ locks.</li> <img src="{@docRoot}images/admin/device-admin-app.png"/> <p class="img-caption"><strong>Figure 1.</strong> Screenshot of the Sample Application</p> + + <h2 id="developing">Developing a Device Administration Application</h2> <p>System administrators can use the Device Administration API to write an application that enforces remote/local device security policy enforcement. This section summarizes the steps involved in creating a device administration application.</p> -<h3 id="manifest">Creating the Manifest</h3> + +<h3 id="manifest">Creating the manifest</h3> + <p>To use the Device Administration API, the application's manifest must include the following:</p> <ul> @@ -207,7 +228,7 @@ intent, expressed in the manifest as an intent filter.</li> <action android:name="android.app.action.DEVICE_ADMIN_ENABLED" /> </intent-filter> </receiver></pre> - + <p>Note that:</p> <ul> <li>The activity in the sample application is an {@link android.app.Activity} @@ -218,7 +239,7 @@ subclass called <code>Controller</code>. The syntax an inner class; it just is in this example.</li> <li>The following attributes refer to string resources that for the sample application reside in -<code>ApiDemos/res/values/strings.xml</code>. For more information about resources, see +<code>ApiDemos/res/values/strings.xml</code>. For more information about resources, see <a href="{@docRoot}guide/topics/resources/index.html">Application Resources</a>. <ul> @@ -234,8 +255,8 @@ informative than a label.</li> </ul> - -<li><code>android:permission="android.permission.BIND_DEVICE_ADMIN" + +<li><code>android:permission="android.permission.BIND_DEVICE_ADMIN" </code> is a permission that a {@link android.app.admin.DeviceAdminReceiver} subclass must have, to ensure that only the system can interact with the receiver (no application can be granted this permission). This prevents other applications from abusing your device admin app.</li> @@ -273,11 +294,15 @@ android.app.admin.DeviceAdminInfo} class. Here are the contents of include all of the policies, just the ones that are relevant for your app. </p> For more discussion of the manifest file, see the <a -href="{@docRoot}guide/topics/manifest/manifest-intro.html">Android Developers Guide</a>. -<h2 id="code">Implementing the Code</h2> +href="{@docRoot}guide/topics/manifest/manifest-intro.html">Android Developers Guide</a>. + + + +<h3 id="code">Implementing the code</h3> + <p>The Device Administration API includes the following classes:</p> <dl> - <dt>{@link android.app.admin.DeviceAdminReceiver}</dt> + <dt>{@link android.app.admin.DeviceAdminReceiver}</dt> <dd>Base class for implementing a device administration component. This class provides a convenience for interpreting the raw intent actions that are sent by the system. Your Device Administration application must include a @@ -287,7 +312,7 @@ system. Your Device Administration application must include a this class must have published a {@link android.app.admin.DeviceAdminReceiver} that the user has currently enabled. The {@link android.app.admin.DevicePolicyManager} manages policies for one or more {@link android.app.admin.DeviceAdminReceiver} instances</dd> - <dt>{@link android.app.admin.DeviceAdminInfo}</dt> + <dt>{@link android.app.admin.DeviceAdminInfo}</dt> <dd>This class is used to specify metadata for a device administrator component.</dd> </dl> @@ -295,6 +320,7 @@ for a device administrator component.</dd> The rest of this section describes how you use the {@link android.app.admin.DeviceAdminReceiver} and {@link android.app.admin.DevicePolicyManager} APIs to write a device admin application.</p> + <h4 id="receiver">Subclassing DeviceAdminReceiver</h4> <p>To create a device admin application, you must subclass {@link android.app.admin.DeviceAdminReceiver}. The {@link android.app.admin.DeviceAdminReceiver} class @@ -305,7 +331,7 @@ simply displays a {@link android.widget.Toast} notification in response to parti events. For example:</p> <pre>public class DeviceAdminSample extends DeviceAdminReceiver { -... +... @Override public void onEnabled(Context context, Intent intent) { showToast(context, "Sample Device Admin: enabled"); @@ -331,30 +357,32 @@ events. For example:</p> } ... }</pre> -<h4 id="enabling">Enabling the Application</h4> + +<h4 id="enabling">Enabling the application</h4> <p>One of the major events a device admin application has to handle is the user enabling the application. The user must explicitly enable the application for the policies to be enforced. If the user chooses not to enable the application it will still be present on the device, but its policies will not be enforced, and the user will not get any of the application's benefits.</p> <p>The process of enabling the application begins when the user performs an -action that triggers the {@link android.app.admin.DevicePolicyManager#ACTION_ADD_DEVICE_ADMIN} +action that triggers the {@link android.app.admin.DevicePolicyManager#ACTION_ADD_DEVICE_ADMIN} intent. In the sample application, this happens when the user clicks the <strong>Enable Admin</strong> button. </p> <p>When the user clicks the <strong>Enable Admin</strong> button, the display -changes to prompt the user to enable the device admin application, as shown in <strong>Figure 2</strong>.</p> +changes to prompt the user to enable the device admin application, as shown in figure +2.</p> <img src="{@docRoot}images/admin/device-admin-activate-prompt.png"/> <p class="img-caption"><strong>Figure 2.</strong> Sample Application: Activating the Application</p> <p>Below is the code that gets executed when the user clicks the <strong>Enable -Admin</strong> button shown in <strong>Figure 1</strong>. </p> +Admin</strong> button shown in figure 1. </p> <pre> private OnClickListener mEnableListener = new OnClickListener() { public void onClick(View v) { // Launch the activity to have the user enable our admin. Intent intent = new Intent(DevicePolicyManager.ACTION_ADD_DEVICE_ADMIN); - intent.putExtra(DevicePolicyManager.EXTRA_DEVICE_ADMIN, + intent.putExtra(DevicePolicyManager.EXTRA_DEVICE_ADMIN, mDeviceAdminSample); intent.putExtra(DevicePolicyManager.EXTRA_ADD_EXPLANATION, "Additional text explaining why this needs to be added."); @@ -379,10 +407,10 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) { }</pre> <p>The line -<code>intent.putExtra(DevicePolicyManager.EXTRA_DEVICE_ADMIN, +<code>intent.putExtra(DevicePolicyManager.EXTRA_DEVICE_ADMIN, mDeviceAdminSample)</code> states that <code>mDeviceAdminSample</code> (which is a {@link android.app.admin.DeviceAdminReceiver} component) is the target policy. -This line invokes the user interface shown in <strong>Figure 2</strong>, which guides users through +This line invokes the user interface shown in figure 2, which guides users through adding the device administrator to the system (or allows them to reject it).</p> <p>When the application needs to perform an operation that is contingent on the @@ -402,14 +430,16 @@ if (active) { // do something else } </pre> -<h3 id="admin_ops">Managing Policies</h3> + +<h3 id="admin_ops">Managing policies</h3> <p>{@link android.app.admin.DevicePolicyManager} is a public class for managing policies enforced on a device. {@link android.app.admin.DevicePolicyManager} manages policies for one or more {@link android.app.admin.DeviceAdminReceiver} instances. </p> <p>You get a handle to the {@link android.app.admin.DevicePolicyManager} as follows: </p> -<pre>DevicePolicyManager mDPM = -(DevicePolicyManager)getSystemService(Context.DEVICE_POLICY_SERVICE);<br -/></pre> +<pre> +DevicePolicyManager mDPM = + (DevicePolicyManager)getSystemService(Context.DEVICE_POLICY_SERVICE); +</pre> <p>This section describes how to use {@link android.app.admin.DevicePolicyManager} to perform administrative tasks:</p> <ul> @@ -417,26 +447,29 @@ or more {@link android.app.admin.DeviceAdminReceiver} instances. </p> <li><a href="#lock">Set device lock</a></li> <li><a href="#wipe">Perform data wipe</a></li> </ul> + <h4 id="pwd">Set password policies</h4> <p>{@link android.app.admin.DevicePolicyManager} includes APIs for setting and enforcing the device password policy. In the Device Administration API, the password only applies to screen lock. This section describes common password-related tasks.</p> + <h5>Set a password for the device</h5> <p>This code displays a user interface prompting the user to set a password:</p> <pre>Intent intent = new Intent(DevicePolicyManager.ACTION_SET_NEW_PASSWORD); startActivity(intent); </pre> + <h5>Set the password quality</h5> <p>The password quality can be one of the following {@link android.app.admin.DevicePolicyManager} constants: </p> <dl> - <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_ALPHABETIC}</dt><dd>The user must enter a + <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_ALPHABETIC}</dt><dd>The user must enter a password containing at least alphabetic (or other symbol) characters.</dd> - <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_ALPHANUMERIC}</dt><dd>The user must enter a + <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_ALPHANUMERIC}</dt><dd>The user must enter a password containing at least <em>both</em> numeric <em>and</em> alphabetic (or other symbol) characters.</dd> <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_NUMERIC}</dt><dd>The user must enter a password containing at least numeric characters.</dd> - <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_SOMETHING}</dt><dd>The policy requires some kind + <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_SOMETHING}</dt><dd>The policy requires some kind of password, but doesn't care what it is.</dd> <dt>{@link android.app.admin.DevicePolicyManager#PASSWORD_QUALITY_UNSPECIFIED}</dt><dd> The policy has no requirements for the password. </dd> @@ -448,6 +481,7 @@ ComponentName mDeviceAdminSample; ... mDPM.setPasswordQuality(mDeviceAdminSample, DevicePolicyManager.PASSWORD_QUALITY_ALPHANUMERIC); </pre> + <h5>Set the minimum password length</h5> <p>You can specify that a password must be at least the specified minimum length. For example:</p> @@ -457,19 +491,21 @@ int pwLength; ... mDPM.setPasswordMinimumLength(mDeviceAdminSample, pwLength); </pre> + <h5>Set maximum failed password attempts</h5> <p>You can set the maximum number of allowed failed password attempts before the device is wiped (that is, reset to factory settings). For example:</p> -<pre>DevicePolicyManager mDPM; -ComponentName mDeviceAdminSample; +<pre>DevicePolicyManager mDPM; +ComponentName mDeviceAdminSample; int maxFailedPw; ... mDPM.setMaximumFailedPasswordsForWipe(mDeviceAdminSample, maxFailedPw);</pre> + <h4 id="lock">Set device lock</h4> <p>You can set the maximum period of user inactivity that can occur before the device locks. For example:</p> <pre> -DevicePolicyManager mDPM; +DevicePolicyManager mDPM; ComponentName mDeviceAdminSample; ... long timeMs = 1000L*Long.parseLong(mTimeout.getText().toString()); @@ -477,9 +513,11 @@ mDPM.setMaximumTimeToLock(mDeviceAdminSample, timeMs); </pre> <p>You can also programmatically tell the device to lock immediately:</p> <pre> -DevicePolicyManager mDPM; +DevicePolicyManager mDPM; mDPM.lockNow();</pre> + <h4 id="wipe">Perform data wipe</h4> + <p>You can use the {@link android.app.admin.DevicePolicyManager} method {@link android.app.admin.DevicePolicyManager#wipeData wipeData()} to reset the device to factory settings. This is useful if the device is lost or stolen. Often the decision to wipe the device is the @@ -488,7 +526,7 @@ result of certain conditions being met. For example, you can use wiped after a specific number of failed password attempts.</p> <p>You wipe data as follows:</p> <pre> -DevicePolicyManager mDPM; +DevicePolicyManager mDPM; mDPM.wipeData(0);</pre> <p>The {@link android.app.admin.DevicePolicyManager#wipeData wipeData()} method takes as its parameter a bit mask of additional options. Currently the value must be 0. </p> |