2 * Copyright (C) 2014 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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
19 import android.Manifest;
20 import android.annotation.SdkConstant;
21 import android.annotation.SdkConstant.SdkConstantType;
22 import android.annotation.SystemApi;
23 import android.content.Context;
24 import android.content.Intent;
25 import android.net.NetworkScorerAppManager.NetworkScorerAppData;
26 import android.os.IBinder;
27 import android.os.RemoteException;
28 import android.os.ServiceManager;
29 import android.os.UserHandle;
32 * Class that manages communication between network subsystems and a network scorer.
34 * <p>You can get an instance of this class by calling
35 * {@link android.content.Context#getSystemService(String)}:
37 * <pre>NetworkScoreManager manager =
38 * (NetworkScoreManager) getSystemService(Context.NETWORK_SCORE_SERVICE)</pre>
40 * <p>A network scorer is any application which:
42 * <li>Declares the {@link android.Manifest.permission#SCORE_NETWORKS} permission.
43 * <li>Includes a receiver for {@link #ACTION_SCORE_NETWORKS} guarded by the
44 * {@link android.Manifest.permission#BROADCAST_NETWORK_PRIVILEGED} permission which scores
45 * networks and (eventually) calls {@link #updateScores} with the results. If this receiver
46 * specifies an android:label attribute, this label will be used when referring to the
47 * application throughout system settings; otherwise, the application label will be used.
50 * <p>The system keeps track of an active scorer application; at any time, only this application
51 * will receive {@link #ACTION_SCORE_NETWORKS} broadcasts and will be permitted to call
52 * {@link #updateScores}. Applications may determine the current active scorer with
53 * {@link #getActiveScorerPackage()} and request to change the active scorer by sending an
54 * {@link #ACTION_CHANGE_ACTIVE} broadcast with another scorer.
59 public class NetworkScoreManager {
61 * Activity action: ask the user to change the active network scorer. This will show a dialog
62 * that asks the user whether they want to replace the current active scorer with the one
63 * specified in {@link #EXTRA_PACKAGE_NAME}. The activity will finish with RESULT_OK if the
64 * active scorer was changed or RESULT_CANCELED if it failed for any reason.
66 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
67 public static final String ACTION_CHANGE_ACTIVE = "android.net.scoring.CHANGE_ACTIVE";
70 * Extra used with {@link #ACTION_CHANGE_ACTIVE} to specify the new scorer package. Set with
71 * {@link android.content.Intent#putExtra(String, String)}.
73 public static final String EXTRA_PACKAGE_NAME = "packageName";
76 * Broadcast action: new network scores are being requested. This intent will only be delivered
77 * to the current active scorer app. That app is responsible for scoring the networks and
78 * calling {@link #updateScores} when complete. The networks to score are specified in
79 * {@link #EXTRA_NETWORKS_TO_SCORE}, and will generally consist of all networks which have been
80 * configured by the user as well as any open networks.
82 * <p class="note">This is a protected intent that can only be sent by the system.
84 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
85 public static final String ACTION_SCORE_NETWORKS = "android.net.scoring.SCORE_NETWORKS";
88 * Extra used with {@link #ACTION_SCORE_NETWORKS} to specify the networks to be scored, as an
89 * array of {@link NetworkKey}s. Can be obtained with
90 * {@link android.content.Intent#getParcelableArrayExtra(String)}}.
92 public static final String EXTRA_NETWORKS_TO_SCORE = "networksToScore";
95 * Activity action: launch a custom activity for configuring a scorer before enabling it.
96 * Scorer applications may choose to specify an activity for this action, in which case the
97 * framework will launch that activity which should return RESULT_OK if scoring was enabled.
99 * <p>If no activity is included in a scorer which implements this action, the system dialog for
100 * selecting a scorer will be shown instead.
102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
103 public static final String ACTION_CUSTOM_ENABLE = "android.net.scoring.CUSTOM_ENABLE";
106 * Broadcast action: the active scorer has been changed. Scorer apps may listen to this to
107 * perform initialization once selected as the active scorer, or clean up unneeded resources
108 * if another scorer has been selected. This is an explicit broadcast only sent to the
109 * previous scorer and new scorer. Note that it is unnecessary to clear existing scores as
110 * this is handled by the system.
112 * <p>The new scorer will be specified in {@link #EXTRA_NEW_SCORER}.
114 * <p class="note">This is a protected intent that can only be sent by the system.
116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
117 public static final String ACTION_SCORER_CHANGED = "android.net.scoring.SCORER_CHANGED";
120 * Extra used with {@link #ACTION_SCORER_CHANGED} to specify the newly selected scorer's package
121 * name. Will be null if scoring was disabled. Can be obtained with
122 * {@link android.content.Intent#getStringExtra(String)}.
124 public static final String EXTRA_NEW_SCORER = "newScorer";
126 private final Context mContext;
127 private final INetworkScoreService mService;
130 public NetworkScoreManager(Context context) {
132 IBinder iBinder = ServiceManager.getService(Context.NETWORK_SCORE_SERVICE);
133 mService = INetworkScoreService.Stub.asInterface(iBinder);
137 * Obtain the package name of the current active network scorer.
139 * <p>At any time, only one scorer application will receive {@link #ACTION_SCORE_NETWORKS}
140 * broadcasts and be allowed to call {@link #updateScores}. Applications may use this method to
141 * determine the current scorer and offer the user the ability to select a different scorer via
142 * the {@link #ACTION_CHANGE_ACTIVE} intent.
143 * @return the full package name of the current active scorer, or null if there is no active
146 public String getActiveScorerPackage() {
147 NetworkScorerAppData app = NetworkScorerAppManager.getActiveScorer(mContext);
151 return app.mPackageName;
155 * Update network scores.
157 * <p>This may be called at any time to re-score active networks. Scores will generally be
158 * updated quickly, but if this method is called too frequently, the scores may be held and
159 * applied at a later time.
161 * @param networks the networks which have been scored by the scorer.
162 * @return whether the update was successful.
163 * @throws SecurityException if the caller is not the active scorer.
165 public boolean updateScores(ScoredNetwork[] networks) throws SecurityException {
167 return mService.updateScores(networks);
168 } catch (RemoteException e) {
169 throw e.rethrowFromSystemServer();
174 * Clear network scores.
176 * <p>Should be called when all scores need to be invalidated, i.e. because the scoring
177 * algorithm has changed and old scores can no longer be compared to future scores.
179 * <p>Note that scores will be cleared automatically when the active scorer changes, as scores
180 * from one scorer cannot be compared to those from another scorer.
182 * @return whether the clear was successful.
183 * @throws SecurityException if the caller is not the active scorer or privileged.
185 public boolean clearScores() throws SecurityException {
187 return mService.clearScores();
188 } catch (RemoteException e) {
189 throw e.rethrowFromSystemServer();
194 * Set the active scorer to a new package and clear existing scores.
196 * <p>Should never be called directly without obtaining user consent. This can be done by using
197 * the {@link #ACTION_CHANGE_ACTIVE} broadcast, or using a custom configuration activity.
199 * @return true if the operation succeeded, or false if the new package is not a valid scorer.
200 * @throws SecurityException if the caller does not hold the
201 * {@link android.Manifest.permission#SCORE_NETWORKS} permission.
205 public boolean setActiveScorer(String packageName) throws SecurityException {
207 return mService.setActiveScorer(packageName);
208 } catch (RemoteException e) {
209 throw e.rethrowFromSystemServer();
214 * Turn off network scoring.
216 * <p>May only be called by the current scorer app, or the system.
218 * @throws SecurityException if the caller is neither the active scorer nor the system.
220 public void disableScoring() throws SecurityException {
222 mService.disableScoring();
223 } catch (RemoteException e) {
224 throw e.rethrowFromSystemServer();
229 * Request scoring for networks.
231 * <p>Note that this is just a helper method to assemble the broadcast, and will run in the
234 * @return true if the broadcast was sent, or false if there is no active scorer.
235 * @throws SecurityException if the caller does not hold the
236 * {@link android.Manifest.permission#BROADCAST_NETWORK_PRIVILEGED} permission.
239 public boolean requestScores(NetworkKey[] networks) throws SecurityException {
240 String activeScorer = getActiveScorerPackage();
241 if (activeScorer == null) {
244 Intent intent = new Intent(ACTION_SCORE_NETWORKS);
245 intent.setPackage(activeScorer);
246 intent.setFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT);
247 intent.putExtra(EXTRA_NETWORKS_TO_SCORE, networks);
248 // A scorer should never become active if its package doesn't hold SCORE_NETWORKS, but
249 // ensure the package still holds it to be extra safe.
250 // TODO: http://b/23422763
251 mContext.sendBroadcastAsUser(intent, UserHandle.SYSTEM, Manifest.permission.SCORE_NETWORKS);
256 * Register a network score cache.
258 * @param networkType the type of network this cache can handle. See {@link NetworkKey#type}.
259 * @param scoreCache implementation of {@link INetworkScoreCache} to store the scores.
260 * @throws SecurityException if the caller does not hold the
261 * {@link android.Manifest.permission#BROADCAST_NETWORK_PRIVILEGED} permission.
262 * @throws IllegalArgumentException if a score cache is already registered for this type.
265 public void registerNetworkScoreCache(int networkType, INetworkScoreCache scoreCache) {
267 mService.registerNetworkScoreCache(networkType, scoreCache);
268 } catch (RemoteException e) {
269 throw e.rethrowFromSystemServer();