Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bc81782b authored by David Su's avatar David Su
Browse files

NetworkScoreManager: Expose SCORE_FILTER_* consts 

Rename CACHE_FILTER_* constants to SCORE_FILTER_*
and expose them as @SystemApi so they can be used
by the Wifi module.

Bug: 135998869
Test: compiles
Change-Id: I9eab2e84d0b00fada7629a104566c1099f8b1288
parent 65aea378

api/system-current.txt

+3 −0
Original line number Diff line number Diff line
@@ -4971,6 +4971,9 @@ package android.net { 
    field @Deprecated public static final String EXTRA_NETWORKS_TO_SCORE = "networksToScore";

    field public static final String EXTRA_NEW_SCORER = "newScorer";

    field @Deprecated public static final String EXTRA_PACKAGE_NAME = "packageName";

    field public static final int SCORE_FILTER_CURRENT_NETWORK = 1; // 0x1

    field public static final int SCORE_FILTER_NONE = 0; // 0x0

    field public static final int SCORE_FILTER_SCAN_RESULTS = 2; // 0x2

  }















  public static interface NetworkScoreManager.NetworkScoreCallback {

































core/java/android/net/NetworkScoreManager.java



+15
−16




























Original line number
Diff line number
Diff line








@@ -163,27 +163,26 @@ public class NetworkScoreManager {













    public static final String EXTRA_NEW_SCORER = "newScorer";































    /** @hide */













    @IntDef({CACHE_FILTER_NONE, CACHE_FILTER_CURRENT_NETWORK, CACHE_FILTER_SCAN_RESULTS})













    @IntDef({SCORE_FILTER_NONE, SCORE_FILTER_CURRENT_NETWORK, SCORE_FILTER_SCAN_RESULTS})















    @Retention(RetentionPolicy.SOURCE)













    public @interface CacheUpdateFilter {}













    public @interface ScoreUpdateFilter {}































    /**













     * Do not filter updates sent to the cache.













     * @hide













     * Do not filter updates sent to the {@link NetworkScoreCallback}].















     */













    public static final int CACHE_FILTER_NONE = 0;













    public static final int SCORE_FILTER_NONE = 0;































    /**













     * Only send cache updates when the network matches the connected network.













     * @hide













     * Only send updates to the {@link NetworkScoreCallback} when the network matches the connected













     * network.















     */













    public static final int CACHE_FILTER_CURRENT_NETWORK = 1;













    public static final int SCORE_FILTER_CURRENT_NETWORK = 1;































    /**













     * Only send cache updates when the network is part of the current scan result set.













     * @hide













     * Only send updates to the {@link NetworkScoreCallback} when the network is part of the













     * current scan result set.















     */













    public static final int CACHE_FILTER_SCAN_RESULTS = 2;













    public static final int SCORE_FILTER_SCAN_RESULTS = 2;































    /** @hide */















    @IntDef({RECOMMENDATIONS_ENABLED_FORCED_OFF, RECOMMENDATIONS_ENABLED_OFF,










@@ -410,7 +409,7 @@ public class NetworkScoreManager {













    @RequiresPermission(android.Manifest.permission.REQUEST_NETWORK_SCORES)















    @Deprecated // migrate to registerNetworkScoreCache(int, INetworkScoreCache, int)















    public void registerNetworkScoreCache(int networkType, INetworkScoreCache scoreCache) {













        registerNetworkScoreCache(networkType, scoreCache, CACHE_FILTER_NONE);













        registerNetworkScoreCache(networkType, scoreCache, SCORE_FILTER_NONE);















    }































    /**









@@ -418,7 +417,7 @@ public class NetworkScoreManager {













     *















     * @param networkType the type of network this cache can handle. See {@link NetworkKey#type}















     * @param scoreCache implementation of {@link INetworkScoreCache} to store the scores













     * @param filterType the {@link CacheUpdateFilter} to apply













     * @param filterType the {@link ScoreUpdateFilter} to apply















     * @throws SecurityException if the caller does not hold the















     *         {@link permission#REQUEST_NETWORK_SCORES} permission.















     * @throws IllegalArgumentException if a score cache is already registered for this type.









@@ -426,7 +425,7 @@ public class NetworkScoreManager {













     */















    @RequiresPermission(android.Manifest.permission.REQUEST_NETWORK_SCORES)















    public void registerNetworkScoreCache(int networkType, INetworkScoreCache scoreCache,













            @CacheUpdateFilter int filterType) {













            @ScoreUpdateFilter int filterType) {















        try {















            mService.registerNetworkScoreCache(networkType, scoreCache, filterType);















        } catch (RemoteException e) {










@@ -510,7 +509,7 @@ public class NetworkScoreManager {













     * Register a network score callback.















     *















     * @param networkType the type of network this cache can handle. See {@link NetworkKey#type}













     * @param filterType the {@link CacheUpdateFilter} to apply













     * @param filterType the {@link ScoreUpdateFilter} to apply















     * @param callback implementation of {@link NetworkScoreCallback} that will be invoked when the















     *                 scores change.















     * @param executor The executor on which to execute the callbacks.









@@ -522,7 +521,7 @@ public class NetworkScoreManager {













    @SystemApi















    @RequiresPermission(android.Manifest.permission.REQUEST_NETWORK_SCORES)















    public void registerNetworkScoreCallback(@NetworkKey.NetworkType int networkType,













            @CacheUpdateFilter int filterType,













            @ScoreUpdateFilter int filterType,















            @NonNull @CallbackExecutor Executor executor,















            @NonNull NetworkScoreCallback callback) throws SecurityException {















        if (callback == null || executor == null) {

































services/core/java/com/android/server/NetworkScoreService.java



+4
−4




























Original line number
Diff line number
Diff line








@@ -523,7 +523,7 @@ public class NetworkScoreService extends INetworkScoreService.Stub {





























        @Override















        public void accept(INetworkScoreCache networkScoreCache, Object cookie) {













            int filterType = NetworkScoreManager.CACHE_FILTER_NONE;













            int filterType = NetworkScoreManager.SCORE_FILTER_NONE;















            if (cookie instanceof Integer) {















                filterType = (Integer) cookie;















            }









@@ -547,17 +547,17 @@ public class NetworkScoreService extends INetworkScoreService.Stub {













        private List<ScoredNetwork> filterScores(List<ScoredNetwork> scoredNetworkList,















                int filterType) {















            switch (filterType) {













                case NetworkScoreManager.CACHE_FILTER_NONE:













                case NetworkScoreManager.SCORE_FILTER_NONE:















                    return scoredNetworkList;





























                case NetworkScoreManager.CACHE_FILTER_CURRENT_NETWORK:













                case NetworkScoreManager.SCORE_FILTER_CURRENT_NETWORK:















                    if (mCurrentNetworkFilter == null) {















                        mCurrentNetworkFilter =















                                new CurrentNetworkScoreCacheFilter(new WifiInfoSupplier(mContext));















                    }















                    return mCurrentNetworkFilter.apply(scoredNetworkList);





























                case NetworkScoreManager.CACHE_FILTER_SCAN_RESULTS:













                case NetworkScoreManager.SCORE_FILTER_SCAN_RESULTS:















                    if (mScanResultsFilter == null) {















                        mScanResultsFilter = new ScanResultsScoreCacheFilter(















                                new ScanResultsSupplier(mContext));

































services/tests/servicestests/src/com/android/server/NetworkScoreServiceTest.java



+11
−11




























Original line number
Diff line number
Diff line








@@ -16,7 +16,7 @@





























package com.android.server;





























import static android.net.NetworkScoreManager.CACHE_FILTER_NONE;













import static android.net.NetworkScoreManager.SCORE_FILTER_NONE;































import static junit.framework.Assert.assertEquals;















import static junit.framework.Assert.assertFalse;










@@ -306,7 +306,7 @@ public class NetworkScoreServiceTest {













        bindToScorer(true /*callerIsScorer*/);































        mNetworkScoreService.registerNetworkScoreCache(NetworkKey.TYPE_WIFI,













                mNetworkScoreCache, CACHE_FILTER_NONE);













                mNetworkScoreCache, SCORE_FILTER_NONE);































        mNetworkScoreService.updateScores(new ScoredNetwork[]{SCORED_NETWORK});

























@@ -321,9 +321,9 @@ public class NetworkScoreServiceTest {













        bindToScorer(true /*callerIsScorer*/);































        mNetworkScoreService.registerNetworkScoreCache(NetworkKey.TYPE_WIFI,













                mNetworkScoreCache, CACHE_FILTER_NONE);













                mNetworkScoreCache, SCORE_FILTER_NONE);















        mNetworkScoreService.registerNetworkScoreCache(













                NetworkKey.TYPE_WIFI, mNetworkScoreCache2, CACHE_FILTER_NONE);













                NetworkKey.TYPE_WIFI, mNetworkScoreCache2, SCORE_FILTER_NONE);































        // updateScores should update both caches















        mNetworkScoreService.updateScores(new ScoredNetwork[]{SCORED_NETWORK});










@@ -378,7 +378,7 @@ public class NetworkScoreServiceTest {













        bindToScorer(true /*callerIsScorer*/);































        mNetworkScoreService.registerNetworkScoreCache(NetworkKey.TYPE_WIFI, mNetworkScoreCache,













                CACHE_FILTER_NONE);













                SCORE_FILTER_NONE);















        mNetworkScoreService.clearScores();































        verify(mNetworkScoreCache).clearScores();









@@ -392,7 +392,7 @@ public class NetworkScoreServiceTest {













                .thenReturn(PackageManager.PERMISSION_GRANTED);































        mNetworkScoreService.registerNetworkScoreCache(NetworkKey.TYPE_WIFI, mNetworkScoreCache,













                CACHE_FILTER_NONE);













                SCORE_FILTER_NONE);















        mNetworkScoreService.clearScores();































        verify(mNetworkScoreCache).clearScores();










@@ -472,7 +472,7 @@ public class NetworkScoreServiceTest {





























        try {















            mNetworkScoreService.registerNetworkScoreCache(













                NetworkKey.TYPE_WIFI, mNetworkScoreCache, CACHE_FILTER_NONE);













                    NetworkKey.TYPE_WIFI, mNetworkScoreCache, SCORE_FILTER_NONE);















            fail("SecurityException expected");















        } catch (SecurityException e) {















            // expected










@@ -615,7 +615,7 @@ public class NetworkScoreServiceTest {













                new ArrayList<>(scoredNetworkList),















                NetworkKey.TYPE_WIFI, mCurrentNetworkFilter, mScanResultsFilter);





























        consumer.accept(mNetworkScoreCache, NetworkScoreManager.CACHE_FILTER_NONE);













        consumer.accept(mNetworkScoreCache, NetworkScoreManager.SCORE_FILTER_NONE);































        verify(mNetworkScoreCache).updateScores(scoredNetworkList);















        verifyZeroInteractions(mCurrentNetworkFilter, mScanResultsFilter);










@@ -656,7 +656,7 @@ public class NetworkScoreServiceTest {













                Collections.emptyList(),















                NetworkKey.TYPE_WIFI, mCurrentNetworkFilter, mScanResultsFilter);





























        consumer.accept(mNetworkScoreCache, NetworkScoreManager.CACHE_FILTER_NONE);













        consumer.accept(mNetworkScoreCache, NetworkScoreManager.SCORE_FILTER_NONE);































        verifyZeroInteractions(mNetworkScoreCache, mCurrentNetworkFilter, mScanResultsFilter);















    }









@@ -673,7 +673,7 @@ public class NetworkScoreServiceTest {













        List<ScoredNetwork> filteredList = new ArrayList<>(scoredNetworkList);















        filteredList.remove(SCORED_NETWORK);















        when(mCurrentNetworkFilter.apply(scoredNetworkList)).thenReturn(filteredList);













        consumer.accept(mNetworkScoreCache, NetworkScoreManager.CACHE_FILTER_CURRENT_NETWORK);













        consumer.accept(mNetworkScoreCache, NetworkScoreManager.SCORE_FILTER_CURRENT_NETWORK);































        verify(mNetworkScoreCache).updateScores(filteredList);















        verifyZeroInteractions(mScanResultsFilter);









@@ -691,7 +691,7 @@ public class NetworkScoreServiceTest {













        List<ScoredNetwork> filteredList = new ArrayList<>(scoredNetworkList);















        filteredList.remove(SCORED_NETWORK);















        when(mScanResultsFilter.apply(scoredNetworkList)).thenReturn(filteredList);













        consumer.accept(mNetworkScoreCache, NetworkScoreManager.CACHE_FILTER_SCAN_RESULTS);













        consumer.accept(mNetworkScoreCache, NetworkScoreManager.SCORE_FILTER_SCAN_RESULTS);































        verify(mNetworkScoreCache).updateScores(filteredList);















        verifyZeroInteractions(mCurrentNetworkFilter);