Renaming Ethernet Network Management Classes

Renaming InternalNetwork* files and classes related to ethernet network
management to EthernetNetwork* as ethernet is the only trasnport these
particular files are used with.

Bug: 210485380
Test: atest EthernetServiceTests
Change-Id: I5be8543afd70f2edca76a9366cee4ccf61f0d0e7
This commit is contained in:
James Mattis
2022-01-28 13:39:04 -08:00
parent 9b9952ebe1
commit 5aa01c3196
6 changed files with 47 additions and 47 deletions

View File

@@ -21,8 +21,8 @@ import android.annotation.Nullable;
import android.content.Context; import android.content.Context;
import android.net.ConnectivityManager; import android.net.ConnectivityManager;
import android.net.EthernetNetworkSpecifier; import android.net.EthernetNetworkSpecifier;
import android.net.IInternalNetworkManagementListener; import android.net.IEthernetNetworkManagementListener;
import android.net.InternalNetworkManagementException; import android.net.EthernetNetworkManagementException;
import android.net.IpConfiguration; import android.net.IpConfiguration;
import android.net.IpConfiguration.IpAssignment; import android.net.IpConfiguration.IpAssignment;
import android.net.IpConfiguration.ProxySettings; import android.net.IpConfiguration.ProxySettings;
@@ -195,14 +195,14 @@ public class EthernetNetworkFactory extends NetworkFactory {
* {@code null} is passed, then the network's current * {@code null} is passed, then the network's current
* {@link NetworkCapabilities} will be used in support of existing APIs as * {@link NetworkCapabilities} will be used in support of existing APIs as
* the public API does not allow this. * the public API does not allow this.
* @param listener an optional {@link IInternalNetworkManagementListener} to notify callers of * @param listener an optional {@link IEthernetNetworkManagementListener} to notify callers of
* completion. * completion.
*/ */
@VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE) @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
protected void updateInterface(@NonNull final String ifaceName, protected void updateInterface(@NonNull final String ifaceName,
@NonNull final IpConfiguration ipConfig, @NonNull final IpConfiguration ipConfig,
@Nullable final NetworkCapabilities capabilities, @Nullable final NetworkCapabilities capabilities,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
enforceInterfaceIsTracked(ifaceName); enforceInterfaceIsTracked(ifaceName);
final NetworkInterfaceState iface = mTrackingInterfaces.get(ifaceName); final NetworkInterfaceState iface = mTrackingInterfaces.get(ifaceName);
iface.updateInterface(ipConfig, capabilities, listener); iface.updateInterface(ipConfig, capabilities, listener);
@@ -254,10 +254,10 @@ public class EthernetNetworkFactory extends NetworkFactory {
/** Returns true if state has been modified */ /** Returns true if state has been modified */
@VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE) @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
protected boolean updateInterfaceLinkState(@NonNull final String ifaceName, final boolean up, protected boolean updateInterfaceLinkState(@NonNull final String ifaceName, final boolean up,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
if (!mTrackingInterfaces.containsKey(ifaceName)) { if (!mTrackingInterfaces.containsKey(ifaceName)) {
maybeSendNetworkManagementCallback(listener, null, maybeSendNetworkManagementCallback(listener, null,
new InternalNetworkManagementException( new EthernetNetworkManagementException(
ifaceName + " can't be updated as it is not available.")); ifaceName + " can't be updated as it is not available."));
return false; return false;
} }
@@ -306,9 +306,9 @@ public class EthernetNetworkFactory extends NetworkFactory {
} }
private static void maybeSendNetworkManagementCallback( private static void maybeSendNetworkManagementCallback(
@Nullable final IInternalNetworkManagementListener listener, @Nullable final IEthernetNetworkManagementListener listener,
@Nullable final Network network, @Nullable final Network network,
@Nullable final InternalNetworkManagementException e) { @Nullable final EthernetNetworkManagementException e) {
if (null == listener) { if (null == listener) {
return; return;
} }
@@ -368,9 +368,9 @@ public class EthernetNetworkFactory extends NetworkFactory {
private class EthernetIpClientCallback extends IpClientCallbacks { private class EthernetIpClientCallback extends IpClientCallbacks {
private final ConditionVariable mIpClientStartCv = new ConditionVariable(false); private final ConditionVariable mIpClientStartCv = new ConditionVariable(false);
private final ConditionVariable mIpClientShutdownCv = new ConditionVariable(false); private final ConditionVariable mIpClientShutdownCv = new ConditionVariable(false);
@Nullable IInternalNetworkManagementListener mNetworkManagementListener; @Nullable IEthernetNetworkManagementListener mNetworkManagementListener;
EthernetIpClientCallback(@Nullable final IInternalNetworkManagementListener listener) { EthernetIpClientCallback(@Nullable final IEthernetNetworkManagementListener listener) {
mNetworkManagementListener = listener; mNetworkManagementListener = listener;
} }
@@ -455,7 +455,7 @@ public class EthernetNetworkFactory extends NetworkFactory {
void updateInterface(@NonNull final IpConfiguration ipConfig, void updateInterface(@NonNull final IpConfiguration ipConfig,
@Nullable final NetworkCapabilities capabilities, @Nullable final NetworkCapabilities capabilities,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
if (DBG) { if (DBG) {
Log.d(TAG, "updateInterface, iface: " + name Log.d(TAG, "updateInterface, iface: " + name
+ ", ipConfig: " + ipConfig + ", old ipConfig: " + mIpConfig + ", ipConfig: " + ipConfig + ", old ipConfig: " + mIpConfig
@@ -482,7 +482,7 @@ public class EthernetNetworkFactory extends NetworkFactory {
start(null); start(null);
} }
private void start(@Nullable final IInternalNetworkManagementListener listener) { private void start(@Nullable final IEthernetNetworkManagementListener listener) {
if (mIpClient != null) { if (mIpClient != null) {
if (DBG) Log.d(TAG, "IpClient already started"); if (DBG) Log.d(TAG, "IpClient already started");
return; return;
@@ -503,7 +503,7 @@ public class EthernetNetworkFactory extends NetworkFactory {
} }
void onIpLayerStarted(@NonNull final LinkProperties linkProperties, void onIpLayerStarted(@NonNull final LinkProperties linkProperties,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
if(mIpClient == null) { if(mIpClient == null) {
// This call comes from a message posted on the handler thread, but the IpClient has // This call comes from a message posted on the handler thread, but the IpClient has
// since been stopped such as may be the case if updateInterfaceLinkState() is // since been stopped such as may be the case if updateInterfaceLinkState() is
@@ -546,7 +546,7 @@ public class EthernetNetworkFactory extends NetworkFactory {
realizeNetworkManagementCallback(mNetworkAgent.getNetwork(), null); realizeNetworkManagementCallback(mNetworkAgent.getNetwork(), null);
} }
void onIpLayerStopped(@Nullable final IInternalNetworkManagementListener listener) { void onIpLayerStopped(@Nullable final IEthernetNetworkManagementListener listener) {
// This cannot happen due to provisioning timeout, because our timeout is 0. It can // This cannot happen due to provisioning timeout, because our timeout is 0. It can
// happen due to errors while provisioning or on provisioning loss. // happen due to errors while provisioning or on provisioning loss.
if(mIpClient == null) { if(mIpClient == null) {
@@ -567,13 +567,13 @@ public class EthernetNetworkFactory extends NetworkFactory {
private void maybeSendNetworkManagementCallbackForAbort() { private void maybeSendNetworkManagementCallbackForAbort() {
realizeNetworkManagementCallback(null, realizeNetworkManagementCallback(null,
new InternalNetworkManagementException( new EthernetNetworkManagementException(
"The IP provisioning request has been aborted.")); "The IP provisioning request has been aborted."));
} }
// Must be called on the handler thread // Must be called on the handler thread
private void realizeNetworkManagementCallback(@Nullable final Network network, private void realizeNetworkManagementCallback(@Nullable final Network network,
@Nullable final InternalNetworkManagementException e) { @Nullable final EthernetNetworkManagementException e) {
ensureRunningOnEthernetHandlerThread(); ensureRunningOnEthernetHandlerThread();
if (null == mIpClientCallback) { if (null == mIpClientCallback) {
return; return;
@@ -621,10 +621,10 @@ public class EthernetNetworkFactory extends NetworkFactory {
/** Returns true if state has been modified */ /** Returns true if state has been modified */
boolean updateLinkState(final boolean up, boolean updateLinkState(final boolean up,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
if (mLinkUp == up) { if (mLinkUp == up) {
EthernetNetworkFactory.maybeSendNetworkManagementCallback(listener, null, EthernetNetworkFactory.maybeSendNetworkManagementCallback(listener, null,
new InternalNetworkManagementException( new EthernetNetworkManagementException(
"No changes with requested link state " + up + " for " + name)); "No changes with requested link state " + up + " for " + name));
return false; return false;
} }
@@ -692,7 +692,7 @@ public class EthernetNetworkFactory extends NetworkFactory {
restart(null); restart(null);
} }
void restart(@Nullable final IInternalNetworkManagementListener listener){ void restart(@Nullable final IEthernetNetworkManagementListener listener){
if (DBG) Log.d(TAG, "reconnecting Ethernet"); if (DBG) Log.d(TAG, "reconnecting Ethernet");
stop(); stop();
start(listener); start(listener);

View File

@@ -22,9 +22,9 @@ import android.content.Context;
import android.content.pm.PackageManager; import android.content.pm.PackageManager;
import android.net.IEthernetManager; import android.net.IEthernetManager;
import android.net.IEthernetServiceListener; import android.net.IEthernetServiceListener;
import android.net.IInternalNetworkManagementListener; import android.net.IEthernetNetworkManagementListener;
import android.net.ITetheredInterfaceCallback; import android.net.ITetheredInterfaceCallback;
import android.net.InternalNetworkUpdateRequest; import android.net.EthernetNetworkUpdateRequest;
import android.net.IpConfiguration; import android.net.IpConfiguration;
import android.os.Binder; import android.os.Binder;
import android.os.Handler; import android.os.Handler;
@@ -227,8 +227,8 @@ public class EthernetServiceImpl extends IEthernetManager.Stub {
@Override @Override
public void updateConfiguration(@NonNull final String iface, public void updateConfiguration(@NonNull final String iface,
@NonNull final InternalNetworkUpdateRequest request, @NonNull final EthernetNetworkUpdateRequest request,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
Log.i(TAG, "updateConfiguration called with: iface=" + iface Log.i(TAG, "updateConfiguration called with: iface=" + iface
+ ", request=" + request + ", listener=" + listener); + ", request=" + request + ", listener=" + listener);
validateNetworkManagementState(iface, "updateConfiguration()"); validateNetworkManagementState(iface, "updateConfiguration()");
@@ -240,7 +240,7 @@ public class EthernetServiceImpl extends IEthernetManager.Stub {
@Override @Override
public void connectNetwork(@NonNull final String iface, public void connectNetwork(@NonNull final String iface,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
Log.i(TAG, "connectNetwork called with: iface=" + iface + ", listener=" + listener); Log.i(TAG, "connectNetwork called with: iface=" + iface + ", listener=" + listener);
validateNetworkManagementState(iface, "connectNetwork()"); validateNetworkManagementState(iface, "connectNetwork()");
mTracker.connectNetwork(iface, listener); mTracker.connectNetwork(iface, listener);
@@ -248,7 +248,7 @@ public class EthernetServiceImpl extends IEthernetManager.Stub {
@Override @Override
public void disconnectNetwork(@NonNull final String iface, public void disconnectNetwork(@NonNull final String iface,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
Log.i(TAG, "disconnectNetwork called with: iface=" + iface + ", listener=" + listener); Log.i(TAG, "disconnectNetwork called with: iface=" + iface + ", listener=" + listener);
validateNetworkManagementState(iface, "disconnectNetwork()"); validateNetworkManagementState(iface, "disconnectNetwork()");
mTracker.disconnectNetwork(iface, listener); mTracker.disconnectNetwork(iface, listener);

View File

@@ -24,7 +24,7 @@ import android.annotation.NonNull;
import android.annotation.Nullable; import android.annotation.Nullable;
import android.content.Context; import android.content.Context;
import android.net.IEthernetServiceListener; import android.net.IEthernetServiceListener;
import android.net.IInternalNetworkManagementListener; import android.net.IEthernetNetworkManagementListener;
import android.net.INetd; import android.net.INetd;
import android.net.ITetheredInterfaceCallback; import android.net.ITetheredInterfaceCallback;
import android.net.InterfaceConfigurationParcel; import android.net.InterfaceConfigurationParcel;
@@ -178,7 +178,7 @@ public class EthernetTracker {
protected void updateConfiguration(@NonNull final String iface, protected void updateConfiguration(@NonNull final String iface,
@NonNull final StaticIpConfiguration staticIpConfig, @NonNull final StaticIpConfiguration staticIpConfig,
@NonNull final NetworkCapabilities capabilities, @NonNull final NetworkCapabilities capabilities,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
if (DBG) { if (DBG) {
Log.i(TAG, "updateConfiguration, iface: " + iface + ", capabilities: " + capabilities Log.i(TAG, "updateConfiguration, iface: " + iface + ", capabilities: " + capabilities
+ ", staticIpConfig: " + staticIpConfig); + ", staticIpConfig: " + staticIpConfig);
@@ -192,13 +192,13 @@ public class EthernetTracker {
@VisibleForTesting(visibility = PACKAGE) @VisibleForTesting(visibility = PACKAGE)
protected void connectNetwork(@NonNull final String iface, protected void connectNetwork(@NonNull final String iface,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
mHandler.post(() -> updateInterfaceState(iface, true, listener)); mHandler.post(() -> updateInterfaceState(iface, true, listener));
} }
@VisibleForTesting(visibility = PACKAGE) @VisibleForTesting(visibility = PACKAGE)
protected void disconnectNetwork(@NonNull final String iface, protected void disconnectNetwork(@NonNull final String iface,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
mHandler.post(() -> updateInterfaceState(iface, false, listener)); mHandler.post(() -> updateInterfaceState(iface, false, listener));
} }
@@ -370,7 +370,7 @@ public class EthernetTracker {
} }
private void updateInterfaceState(@NonNull final String iface, final boolean up, private void updateInterfaceState(@NonNull final String iface, final boolean up,
@Nullable final IInternalNetworkManagementListener listener) { @Nullable final IEthernetNetworkManagementListener listener) {
final int mode = getInterfaceMode(iface); final int mode = getInterfaceMode(iface);
final boolean factoryLinkStateUpdated = (mode == INTERFACE_MODE_CLIENT) final boolean factoryLinkStateUpdated = (mode == INTERFACE_MODE_CLIENT)
&& mFactory.updateInterfaceLinkState(iface, up, listener); && mFactory.updateInterfaceLinkState(iface, up, listener);

View File

@@ -40,8 +40,8 @@ import android.content.Context;
import android.content.res.Resources; import android.content.res.Resources;
import android.net.ConnectivityManager; import android.net.ConnectivityManager;
import android.net.EthernetNetworkSpecifier; import android.net.EthernetNetworkSpecifier;
import android.net.IInternalNetworkManagementListener; import android.net.IEthernetNetworkManagementListener;
import android.net.InternalNetworkManagementException; import android.net.EthernetNetworkManagementException;
import android.net.IpConfiguration; import android.net.IpConfiguration;
import android.net.LinkAddress; import android.net.LinkAddress;
import android.net.LinkProperties; import android.net.LinkProperties;
@@ -83,7 +83,7 @@ import java.util.concurrent.TimeUnit;
public class EthernetNetworkFactoryTest { public class EthernetNetworkFactoryTest {
private static final int TIMEOUT_MS = 2_000; private static final int TIMEOUT_MS = 2_000;
private static final String TEST_IFACE = "test123"; private static final String TEST_IFACE = "test123";
private static final IInternalNetworkManagementListener NULL_LISTENER = null; private static final IEthernetNetworkManagementListener NULL_LISTENER = null;
private static final String IP_ADDR = "192.0.2.2/25"; private static final String IP_ADDR = "192.0.2.2/25";
private static final LinkAddress LINK_ADDR = new LinkAddress(IP_ADDR); private static final LinkAddress LINK_ADDR = new LinkAddress(IP_ADDR);
private static final String HW_ADDR = "01:02:03:04:05:06"; private static final String HW_ADDR = "01:02:03:04:05:06";
@@ -627,17 +627,17 @@ public class EthernetNetworkFactoryTest {
} }
private static final class TestNetworkManagementListener private static final class TestNetworkManagementListener
implements IInternalNetworkManagementListener { implements IEthernetNetworkManagementListener {
private final CompletableFuture<Pair<Network, InternalNetworkManagementException>> mDone private final CompletableFuture<Pair<Network, EthernetNetworkManagementException>> mDone
= new CompletableFuture<>(); = new CompletableFuture<>();
@Override @Override
public void onComplete(final Network network, public void onComplete(final Network network,
final InternalNetworkManagementException exception) { final EthernetNetworkManagementException exception) {
mDone.complete(new Pair<>(network, exception)); mDone.complete(new Pair<>(network, exception));
} }
Pair<Network, InternalNetworkManagementException> expectOnComplete() throws Exception { Pair<Network, EthernetNetworkManagementException> expectOnComplete() throws Exception {
return mDone.get(TIMEOUT_MS, TimeUnit.MILLISECONDS); return mDone.get(TIMEOUT_MS, TimeUnit.MILLISECONDS);
} }
@@ -704,7 +704,7 @@ public class EthernetNetworkFactoryTest {
private void assertSuccessfulListener( private void assertSuccessfulListener(
@NonNull final TestNetworkManagementListener successfulListener, @NonNull final TestNetworkManagementListener successfulListener,
@NonNull final Network expectedNetwork) throws Exception { @NonNull final Network expectedNetwork) throws Exception {
final Pair<Network, InternalNetworkManagementException> successfulResult = final Pair<Network, EthernetNetworkManagementException> successfulResult =
successfulListener.expectOnComplete(); successfulListener.expectOnComplete();
assertEquals(expectedNetwork, successfulResult.first); assertEquals(expectedNetwork, successfulResult.first);
assertNull(successfulResult.second); assertNull(successfulResult.second);
@@ -713,7 +713,7 @@ public class EthernetNetworkFactoryTest {
private void assertFailedListener(@NonNull final TestNetworkManagementListener failedListener, private void assertFailedListener(@NonNull final TestNetworkManagementListener failedListener,
@NonNull final String errMsg) @NonNull final String errMsg)
throws Exception { throws Exception {
final Pair<Network, InternalNetworkManagementException> failedResult = final Pair<Network, EthernetNetworkManagementException> failedResult =
failedListener.expectOnComplete(); failedListener.expectOnComplete();
assertNull(failedResult.first); assertNull(failedResult.first);
assertNotNull(failedResult.second); assertNotNull(failedResult.second);

View File

@@ -25,8 +25,8 @@ import static org.mockito.Mockito.verify;
import android.annotation.NonNull; import android.annotation.NonNull;
import android.content.Context; import android.content.Context;
import android.content.pm.PackageManager; import android.content.pm.PackageManager;
import android.net.IInternalNetworkManagementListener; import android.net.IEthernetNetworkManagementListener;
import android.net.InternalNetworkUpdateRequest; import android.net.EthernetNetworkUpdateRequest;
import android.net.IpConfiguration; import android.net.IpConfiguration;
import android.net.NetworkCapabilities; import android.net.NetworkCapabilities;
import android.net.StaticIpConfiguration; import android.net.StaticIpConfiguration;
@@ -45,10 +45,10 @@ import org.mockito.MockitoAnnotations;
@SmallTest @SmallTest
public class EthernetServiceImplTest { public class EthernetServiceImplTest {
private static final String TEST_IFACE = "test123"; private static final String TEST_IFACE = "test123";
private static final InternalNetworkUpdateRequest UPDATE_REQUEST = private static final EthernetNetworkUpdateRequest UPDATE_REQUEST =
new InternalNetworkUpdateRequest( new EthernetNetworkUpdateRequest(
new StaticIpConfiguration(), new NetworkCapabilities.Builder().build()); new StaticIpConfiguration(), new NetworkCapabilities.Builder().build());
private static final IInternalNetworkManagementListener NULL_LISTENER = null; private static final IEthernetNetworkManagementListener NULL_LISTENER = null;
private EthernetServiceImpl mEthernetServiceImpl; private EthernetServiceImpl mEthernetServiceImpl;
@Mock private Context mContext; @Mock private Context mContext;
@Mock private Handler mHandler; @Mock private Handler mHandler;

View File

@@ -30,7 +30,7 @@ import static org.mockito.Mockito.when;
import android.content.Context; import android.content.Context;
import android.content.res.Resources; import android.content.res.Resources;
import android.net.InetAddresses; import android.net.InetAddresses;
import android.net.IInternalNetworkManagementListener; import android.net.IEthernetNetworkManagementListener;
import android.net.INetd; import android.net.INetd;
import android.net.IpConfiguration; import android.net.IpConfiguration;
import android.net.IpConfiguration.IpAssignment; import android.net.IpConfiguration.IpAssignment;
@@ -62,7 +62,7 @@ public class EthernetTrackerTest {
private static final String TEST_IFACE = "test123"; private static final String TEST_IFACE = "test123";
private static final int TIMEOUT_MS = 1_000; private static final int TIMEOUT_MS = 1_000;
private static final String THREAD_NAME = "EthernetServiceThread"; private static final String THREAD_NAME = "EthernetServiceThread";
private static final IInternalNetworkManagementListener NULL_LISTENER = null; private static final IEthernetNetworkManagementListener NULL_LISTENER = null;
private EthernetTracker tracker; private EthernetTracker tracker;
private HandlerThread mHandlerThread; private HandlerThread mHandlerThread;
@Mock private Context mContext; @Mock private Context mContext;
@@ -325,7 +325,7 @@ public class EthernetTrackerTest {
public void testUpdateConfiguration() { public void testUpdateConfiguration() {
final NetworkCapabilities capabilities = new NetworkCapabilities.Builder().build(); final NetworkCapabilities capabilities = new NetworkCapabilities.Builder().build();
final StaticIpConfiguration staticIpConfig = new StaticIpConfiguration(); final StaticIpConfiguration staticIpConfig = new StaticIpConfiguration();
final IInternalNetworkManagementListener listener = null; final IEthernetNetworkManagementListener listener = null;
tracker.updateConfiguration(TEST_IFACE, staticIpConfig, capabilities, listener); tracker.updateConfiguration(TEST_IFACE, staticIpConfig, capabilities, listener);
waitForIdle(); waitForIdle();