Marking SoftApCallback methods as SystemAPI

Making SoftApCallback methods available to @SystemAPI including
the API for registration of a SoftApCallback. This includes updating
registration to use an executor now vs a handler.

Bug: 143564153
Test: atest FrameworksWifiApiTests:android.net.wifi.WifiManagerTest
Also tested manually on a Hawk.

Change-Id: I22b5029a8dbd7a50ad6faf0bb3b15269af839956
This commit is contained in:
James Mattis
2019-10-31 14:11:40 -07:00
parent 2685fcfc6d
commit 80c86d5c08
5 changed files with 42 additions and 25 deletions

View File

@@ -4838,6 +4838,7 @@ package android.net.wifi {
method public boolean isPortableHotspotSupported();
method @RequiresPermission(android.Manifest.permission.ACCESS_WIFI_STATE) public boolean isWifiApEnabled();
method public boolean isWifiScannerSupported();
method @RequiresPermission("android.permission.NETWORK_SETTINGS") public void registerSoftApCallback(@NonNull android.net.wifi.WifiManager.SoftApCallback, @Nullable java.util.concurrent.Executor);
method @RequiresPermission("android.permission.WIFI_UPDATE_USABILITY_STATS_SCORE") public void removeOnWifiUsabilityStatsListener(@NonNull android.net.wifi.WifiManager.OnWifiUsabilityStatsListener);
method @RequiresPermission(anyOf={"android.permission.NETWORK_SETTINGS", android.Manifest.permission.NETWORK_SETUP_WIZARD, "android.permission.NETWORK_STACK"}) public void save(@NonNull android.net.wifi.WifiConfiguration, @Nullable android.net.wifi.WifiManager.ActionListener);
method @RequiresPermission("android.permission.WIFI_SET_DEVICE_MOBILITY_STATE") public void setDeviceMobilityState(int);
@@ -4897,6 +4898,12 @@ package android.net.wifi {
method public void onWifiUsabilityStats(int, boolean, @NonNull android.net.wifi.WifiUsabilityStatsEntry);
}
public static interface WifiManager.SoftApCallback {
method public void onConnectedClientsChanged(@NonNull java.util.List<android.net.wifi.WifiClient>);
method public default void onInfoChanged(@NonNull android.net.wifi.SoftApInfo);
method public void onStateChanged(int, int);
}
public class WifiNetworkConnectionStatistics implements android.os.Parcelable {
ctor public WifiNetworkConnectionStatistics(int, int);
ctor public WifiNetworkConnectionStatistics();

View File

@@ -22,6 +22,7 @@ import android.net.ConnectivityManager;
import android.net.wifi.WifiClient;
import android.net.wifi.WifiManager;
import android.os.Handler;
import android.os.HandlerExecutor;
import android.os.UserManager;
import android.util.Log;
@@ -110,7 +111,8 @@ public class HotspotControllerImpl implements HotspotController, WifiManager.Sof
if (mWifiManager != null) {
if (mListening) {
if (mCallbacks.size() == 1) {
mWifiManager.registerSoftApCallback(this, mMainHandler);
mWifiManager.registerSoftApCallback(this,
new HandlerExecutor(mMainHandler));
} else {
// mWifiManager#registerSoftApCallback triggers a call to
// onConnectedClientsChanged on the Main Handler. In order to always update
@@ -144,7 +146,7 @@ public class HotspotControllerImpl implements HotspotController, WifiManager.Sof
if (mListening || !listening) return;
mListening = true;
if (mCallbacks.size() >= 1) {
mWifiManager.registerSoftApCallback(this, mMainHandler);
mWifiManager.registerSoftApCallback(this, new HandlerExecutor(mMainHandler));
}
}

View File

@@ -43,6 +43,7 @@ import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import java.util.ArrayList;
import java.util.concurrent.Executor;
@SmallTest
@RunWith(AndroidTestingRunner.class)
@@ -73,7 +74,7 @@ public class HotspotControllerImplTest extends SysuiTestCase {
.onConnectedClientsChanged(new ArrayList<>());
return null;
}).when(mWifiManager).registerSoftApCallback(any(WifiManager.SoftApCallback.class),
any(Handler.class));
any(Executor.class));
mController = new HotspotControllerImpl(mContext, new Handler(mLooper.getLooper()));
mController.handleSetListening(true);

View File

@@ -3344,6 +3344,7 @@ public class WifiManager {
*
* @hide
*/
@SystemApi
public interface SoftApCallback {
/**
* Called when soft AP state changes.
@@ -3381,11 +3382,11 @@ public class WifiManager {
* @hide
*/
private class SoftApCallbackProxy extends ISoftApCallback.Stub {
private final Handler mHandler;
private final Executor mExecutor;
private final SoftApCallback mCallback;
SoftApCallbackProxy(Looper looper, SoftApCallback callback) {
mHandler = new Handler(looper);
SoftApCallbackProxy(Executor executor, SoftApCallback callback) {
mExecutor = executor;
mCallback = callback;
}
@@ -3396,7 +3397,8 @@ public class WifiManager {
+ ", failureReason=" + failureReason);
}
mHandler.post(() -> {
Binder.clearCallingIdentity();
mExecutor.execute(() -> {
mCallback.onStateChanged(state, failureReason);
});
}
@@ -3408,7 +3410,8 @@ public class WifiManager {
+ clients.size() + " clients");
}
mHandler.post(() -> {
Binder.clearCallingIdentity();
mExecutor.execute(() -> {
mCallback.onConnectedClientsChanged(clients);
});
}
@@ -3418,7 +3421,9 @@ public class WifiManager {
if (mVerboseLoggingEnabled) {
Log.v(TAG, "SoftApCallbackProxy: onInfoChange: softApInfo=" + softApInfo);
}
mHandler.post(() -> {
Binder.clearCallingIdentity();
mExecutor.execute(() -> {
mCallback.onInfoChanged(softApInfo);
});
}
@@ -3437,18 +3442,19 @@ public class WifiManager {
* <p>
*
* @param callback Callback for soft AP events
* @param handler The Handler on whose thread to execute the callbacks of the {@code callback}
* object. If null, then the application's main thread will be used.
* @param executor The executor to execute the callbacks of the {@code executor}
* object. If null, then the application's main executor will be used.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
public void registerSoftApCallback(@NonNull SoftApCallback callback,
@Nullable Handler handler) {
@Nullable @CallbackExecutor Executor executor) {
if (callback == null) throw new IllegalArgumentException("callback cannot be null");
Log.v(TAG, "registerSoftApCallback: callback=" + callback + ", handler=" + handler);
Log.v(TAG, "registerSoftApCallback: callback=" + callback + ", executor=" + executor);
Looper looper = (handler == null) ? mContext.getMainLooper() : handler.getLooper();
executor = (executor == null) ? mContext.getMainExecutor() : executor;
Binder binder = new Binder();
try {
IWifiManager iWifiManager = getIWifiManager();
@@ -3456,7 +3462,7 @@ public class WifiManager {
throw new RemoteException("Wifi service is not running");
}
iWifiManager.registerSoftApCallback(
binder, new SoftApCallbackProxy(looper, callback), callback.hashCode());
binder, new SoftApCallbackProxy(executor, callback), callback.hashCode());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}

View File

@@ -66,6 +66,7 @@ import android.net.wifi.WifiManager.TrafficStateCallback;
import android.os.Binder;
import android.os.Build;
import android.os.Handler;
import android.os.HandlerExecutor;
import android.os.IBinder;
import android.os.RemoteException;
import android.os.test.TestLooper;
@@ -696,7 +697,7 @@ public class WifiManagerTest {
@Test
public void registerSoftApCallbackThrowsIllegalArgumentExceptionOnNullArgumentForCallback() {
try {
mWifiManager.registerSoftApCallback(null, mHandler);
mWifiManager.registerSoftApCallback(null, new HandlerExecutor(mHandler));
fail("expected IllegalArgumentException");
} catch (IllegalArgumentException expected) {
}
@@ -721,7 +722,7 @@ public class WifiManagerTest {
public void registerSoftApCallbackUsesMainLooperOnNullArgumentForHandler() {
when(mContext.getMainLooper()).thenReturn(mLooper.getLooper());
mWifiManager.registerSoftApCallback(mSoftApCallback, null);
verify(mContext).getMainLooper();
verify(mContext).getMainExecutor();
}
/**
@@ -729,7 +730,7 @@ public class WifiManagerTest {
*/
@Test
public void registerSoftApCallbackCallGoesToWifiServiceImpl() throws Exception {
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class),
any(ISoftApCallback.Stub.class), anyInt());
}
@@ -740,7 +741,7 @@ public class WifiManagerTest {
@Test
public void unregisterSoftApCallbackCallGoesToWifiServiceImpl() throws Exception {
ArgumentCaptor<Integer> callbackIdentifier = ArgumentCaptor.forClass(Integer.class);
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class),
any(ISoftApCallback.Stub.class), callbackIdentifier.capture());
@@ -755,7 +756,7 @@ public class WifiManagerTest {
public void softApCallbackProxyCallsOnStateChanged() throws Exception {
ArgumentCaptor<ISoftApCallback.Stub> callbackCaptor =
ArgumentCaptor.forClass(ISoftApCallback.Stub.class);
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class), callbackCaptor.capture(),
anyInt());
@@ -771,7 +772,7 @@ public class WifiManagerTest {
public void softApCallbackProxyCallsOnConnectedClientsChanged() throws Exception {
ArgumentCaptor<ISoftApCallback.Stub> callbackCaptor =
ArgumentCaptor.forClass(ISoftApCallback.Stub.class);
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class), callbackCaptor.capture(),
anyInt());
@@ -792,7 +793,7 @@ public class WifiManagerTest {
testSoftApInfo.setBandwidth(TEST_AP_BANDWIDTH);
ArgumentCaptor<ISoftApCallback.Stub> callbackCaptor =
ArgumentCaptor.forClass(ISoftApCallback.Stub.class);
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class), callbackCaptor.capture(),
anyInt());
@@ -811,7 +812,7 @@ public class WifiManagerTest {
testSoftApInfo.setBandwidth(TEST_AP_BANDWIDTH);
ArgumentCaptor<ISoftApCallback.Stub> callbackCaptor =
ArgumentCaptor.forClass(ISoftApCallback.Stub.class);
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class), callbackCaptor.capture(),
anyInt());
@@ -837,7 +838,7 @@ public class WifiManagerTest {
ArgumentCaptor.forClass(ISoftApCallback.Stub.class);
TestLooper altLooper = new TestLooper();
Handler altHandler = new Handler(altLooper.getLooper());
mWifiManager.registerSoftApCallback(mSoftApCallback, altHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(altHandler));
verify(mWifiService).registerSoftApCallback(any(IBinder.class), callbackCaptor.capture(),
anyInt());
@@ -851,7 +852,7 @@ public class WifiManagerTest {
*/
@Test
public void testCorrectLooperIsUsedForSoftApCallbackHandler() throws Exception {
mWifiManager.registerSoftApCallback(mSoftApCallback, mHandler);
mWifiManager.registerSoftApCallback(mSoftApCallback, new HandlerExecutor(mHandler));
mLooper.dispatchAll();
verify(mWifiService).registerSoftApCallback(any(IBinder.class),
any(ISoftApCallback.Stub.class), anyInt());