diff options
| author | Chalard Jean <jchalard@google.com> | 2019-01-30 21:04:58 +0900 |
|---|---|---|
| committer | Xiao Ma <xiaom@google.com> | 2019-03-18 11:33:17 +0900 |
| commit | 952135122d50bfc88825ed87ef03739a235a1921 (patch) | |
| tree | 754a1e5a37be47ab3ed572f877294604167bd22d /core/java | |
| parent | 205886d28f017195963d8922d7ec813309506179 (diff) | |
Move the IpMemoryStore to the network stack.
Test: atest FrameworksNetTests
Change-Id: Ic5bd6ff54b09a6fa92b6863f240a5b053011acb6
Diffstat (limited to 'core/java')
| -rw-r--r-- | core/java/android/app/SystemServiceRegistry.java | 13 | ||||
| -rw-r--r-- | core/java/android/content/Context.java | 8 | ||||
| -rw-r--r-- | core/java/android/net/IIpMemoryStoreCallbacks.aidl | 24 | ||||
| -rw-r--r-- | core/java/android/net/INetworkStackConnector.aidl | 4 | ||||
| -rw-r--r-- | core/java/android/net/IpMemoryStore.java | 179 | ||||
| -rw-r--r-- | core/java/android/net/ipmemorystore/NetworkAttributes.java | 323 | ||||
| -rw-r--r-- | core/java/android/net/ipmemorystore/SameL3NetworkResponse.java | 147 | ||||
| -rw-r--r-- | core/java/android/net/ipmemorystore/Status.java | 73 | ||||
| -rw-r--r-- | core/java/android/net/ipmemorystore/Utils.java | 51 |
9 files changed, 27 insertions, 795 deletions
diff --git a/core/java/android/app/SystemServiceRegistry.java b/core/java/android/app/SystemServiceRegistry.java index a3ee8491e6d1..b4330fb56af0 100644 --- a/core/java/android/app/SystemServiceRegistry.java +++ b/core/java/android/app/SystemServiceRegistry.java @@ -81,11 +81,9 @@ import android.net.ConnectivityThread; import android.net.EthernetManager; import android.net.IConnectivityManager; import android.net.IEthernetManager; -import android.net.IIpMemoryStore; import android.net.IIpSecService; import android.net.INetworkPolicyManager; import android.net.ITestNetworkManager; -import android.net.IpMemoryStore; import android.net.IpSecManager; import android.net.NetworkPolicyManager; import android.net.NetworkScoreManager; @@ -298,17 +296,6 @@ final class SystemServiceRegistry { } }); - registerService(Context.IP_MEMORY_STORE_SERVICE, IpMemoryStore.class, - new CachedServiceFetcher<IpMemoryStore>() { - @Override - public IpMemoryStore createService(final ContextImpl ctx) - throws ServiceNotFoundException { - IBinder b = ServiceManager.getServiceOrThrow( - Context.IP_MEMORY_STORE_SERVICE); - IIpMemoryStore service = IIpMemoryStore.Stub.asInterface(b); - return new IpMemoryStore(ctx, service); - }}); - registerService(Context.IPSEC_SERVICE, IpSecManager.class, new CachedServiceFetcher<IpSecManager>() { @Override diff --git a/core/java/android/content/Context.java b/core/java/android/content/Context.java index 5a75d5df554f..8625a04963a7 100644 --- a/core/java/android/content/Context.java +++ b/core/java/android/content/Context.java @@ -3523,14 +3523,6 @@ public abstract class Context { /** * Use with {@link #getSystemService(String)} to retrieve a - * {@link android.net.IpMemoryStore} to store and read information about - * known networks. - * @hide - */ - public static final String IP_MEMORY_STORE_SERVICE = "ipmemorystore"; - - /** - * Use with {@link #getSystemService(String)} to retrieve a * {@link android.net.IpSecManager} for encrypting Sockets or Networks with * IPSec. * diff --git a/core/java/android/net/IIpMemoryStoreCallbacks.aidl b/core/java/android/net/IIpMemoryStoreCallbacks.aidl new file mode 100644 index 000000000000..53108dbca097 --- /dev/null +++ b/core/java/android/net/IIpMemoryStoreCallbacks.aidl @@ -0,0 +1,24 @@ +/* + * Copyright (C) 2019 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package android.net; + +import android.net.IIpMemoryStore; + +/** {@hide} */ +oneway interface IIpMemoryStoreCallbacks { + void onIpMemoryStoreFetched(in IIpMemoryStore ipMemoryStore); +} diff --git a/core/java/android/net/INetworkStackConnector.aidl b/core/java/android/net/INetworkStackConnector.aidl index edb9df61044f..3751c36d6ee9 100644 --- a/core/java/android/net/INetworkStackConnector.aidl +++ b/core/java/android/net/INetworkStackConnector.aidl @@ -15,6 +15,7 @@ */ package android.net; +import android.net.IIpMemoryStoreCallbacks; import android.net.INetworkMonitorCallbacks; import android.net.Network; import android.net.dhcp.DhcpServingParamsParcel; @@ -27,4 +28,5 @@ oneway interface INetworkStackConnector { in IDhcpServerCallbacks cb); void makeNetworkMonitor(in Network network, String name, in INetworkMonitorCallbacks cb); void makeIpClient(in String ifName, in IIpClientCallbacks callbacks); -}
\ No newline at end of file + void fetchIpMemoryStore(in IIpMemoryStoreCallbacks cb); +} diff --git a/core/java/android/net/IpMemoryStore.java b/core/java/android/net/IpMemoryStore.java deleted file mode 100644 index 2f4d9bc6a89a..000000000000 --- a/core/java/android/net/IpMemoryStore.java +++ /dev/null @@ -1,179 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package android.net; - -import android.annotation.NonNull; -import android.annotation.Nullable; -import android.annotation.SystemService; -import android.content.Context; -import android.net.ipmemorystore.Blob; -import android.net.ipmemorystore.IOnBlobRetrievedListener; -import android.net.ipmemorystore.IOnL2KeyResponseListener; -import android.net.ipmemorystore.IOnNetworkAttributesRetrieved; -import android.net.ipmemorystore.IOnSameNetworkResponseListener; -import android.net.ipmemorystore.IOnStatusListener; -import android.net.ipmemorystore.NetworkAttributes; -import android.os.RemoteException; - -import com.android.internal.util.Preconditions; - -/** - * The interface for system components to access the IP memory store. - * @see com.android.server.net.ipmemorystore.IpMemoryStoreService - * @hide - */ -@SystemService(Context.IP_MEMORY_STORE_SERVICE) -public class IpMemoryStore { - @NonNull final Context mContext; - @NonNull final IIpMemoryStore mService; - - public IpMemoryStore(@NonNull final Context context, @NonNull final IIpMemoryStore service) { - mContext = Preconditions.checkNotNull(context, "missing context"); - mService = Preconditions.checkNotNull(service, "missing IIpMemoryStore"); - } - - /** - * Store network attributes for a given L2 key. - * If L2Key is null, choose automatically from the attributes ; passing null is equivalent to - * calling findL2Key with the attributes and storing in the returned value. - * - * @param l2Key The L2 key for the L2 network. Clients that don't know or care about the L2 - * key and only care about grouping can pass a unique ID here like the ones - * generated by {@code java.util.UUID.randomUUID()}, but keep in mind the low - * relevance of such a network will lead to it being evicted soon if it's not - * refreshed. Use findL2Key to try and find a similar L2Key to these attributes. - * @param attributes The attributes for this network. - * @param listener A listener that will be invoked to inform of the completion of this call, - * or null if the client is not interested in learning about success/failure. - * Through the listener, returns the L2 key. This is useful if the L2 key was not specified. - * If the call failed, the L2 key will be null. - */ - public void storeNetworkAttributes(@NonNull final String l2Key, - @NonNull final NetworkAttributes attributes, - @Nullable final IOnStatusListener listener) { - try { - mService.storeNetworkAttributes(l2Key, attributes.toParcelable(), listener); - } catch (RemoteException e) { - throw e.rethrowFromSystemServer(); - } - } - - /** - * Store a binary blob associated with an L2 key and a name. - * - * @param l2Key The L2 key for this network. - * @param clientId The ID of the client. - * @param name The name of this data. - * @param data The data to store. - * @param listener A listener to inform of the completion of this call, or null if the client - * is not interested in learning about success/failure. - * Through the listener, returns a status to indicate success or failure. - */ - public void storeBlob(@NonNull final String l2Key, @NonNull final String clientId, - @NonNull final String name, @NonNull final Blob data, - @Nullable final IOnStatusListener listener) { - try { - mService.storeBlob(l2Key, clientId, name, data, listener); - } catch (RemoteException e) { - throw e.rethrowFromSystemServer(); - } - } - - /** - * Returns the best L2 key associated with the attributes. - * - * This will find a record that would be in the same group as the passed attributes. This is - * useful to choose the key for storing a sample or private data when the L2 key is not known. - * If multiple records are group-close to these attributes, the closest match is returned. - * If multiple records have the same closeness, the one with the smaller (unicode codepoint - * order) L2 key is returned. - * If no record matches these attributes, null is returned. - * - * @param attributes The attributes of the network to find. - * @param listener The listener that will be invoked to return the answer. - * Through the listener, returns the L2 key if one matched, or null. - */ - public void findL2Key(@NonNull final NetworkAttributes attributes, - @NonNull final IOnL2KeyResponseListener listener) { - try { - mService.findL2Key(attributes.toParcelable(), listener); - } catch (RemoteException e) { - throw e.rethrowFromSystemServer(); - } - } - - /** - * Returns whether, to the best of the store's ability to tell, the two specified L2 keys point - * to the same L3 network. Group-closeness is used to determine this. - * - * @param l2Key1 The key for the first network. - * @param l2Key2 The key for the second network. - * @param listener The listener that will be invoked to return the answer. - * Through the listener, a SameL3NetworkResponse containing the answer and confidence. - */ - public void isSameNetwork(@NonNull final String l2Key1, @NonNull final String l2Key2, - @NonNull final IOnSameNetworkResponseListener listener) { - try { - mService.isSameNetwork(l2Key1, l2Key2, listener); - } catch (RemoteException e) { - throw e.rethrowFromSystemServer(); - } - } - - /** - * Retrieve the network attributes for a key. - * If no record is present for this key, this will return null attributes. - * - * @param l2Key The key of the network to query. - * @param listener The listener that will be invoked to return the answer. - * Through the listener, returns the network attributes and the L2 key associated with - * the query. - */ - public void retrieveNetworkAttributes(@NonNull final String l2Key, - @NonNull final IOnNetworkAttributesRetrieved listener) { - try { - mService.retrieveNetworkAttributes(l2Key, listener); - } catch (RemoteException e) { - throw e.rethrowFromSystemServer(); - } - } - - /** - * Retrieve previously stored private data. - * If no data was stored for this L2 key and name this will return null. - * - * @param l2Key The L2 key. - * @param clientId The id of the client that stored this data. - * @param name The name of the data. - * @param listener The listener that will be invoked to return the answer. - * Through the listener, returns the private data (or null), with the L2 key - * and the name of the data associated with the query. - */ - public void retrieveBlob(@NonNull final String l2Key, @NonNull final String clientId, - @NonNull final String name, @NonNull final IOnBlobRetrievedListener listener) { - try { - mService.retrieveBlob(l2Key, clientId, name, listener); - } catch (RemoteException e) { - throw e.rethrowFromSystemServer(); - } - } - - /** Gets an instance of the memory store */ - public static IpMemoryStore getMemoryStore(final Context context) { - return (IpMemoryStore) context.getSystemService(Context.IP_MEMORY_STORE_SERVICE); - } -} diff --git a/core/java/android/net/ipmemorystore/NetworkAttributes.java b/core/java/android/net/ipmemorystore/NetworkAttributes.java deleted file mode 100644 index 6a9eae00e3ff..000000000000 --- a/core/java/android/net/ipmemorystore/NetworkAttributes.java +++ /dev/null @@ -1,323 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package android.net.ipmemorystore; - -import android.annotation.NonNull; -import android.annotation.Nullable; - -import com.android.internal.annotations.VisibleForTesting; - -import java.net.Inet4Address; -import java.net.InetAddress; -import java.net.UnknownHostException; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; -import java.util.Objects; -import java.util.StringJoiner; - -/** - * A POD object to represent attributes of a single L2 network entry. - * @hide - */ -public class NetworkAttributes { - private static final boolean DBG = true; - - // Weight cutoff for grouping. To group, a similarity score is computed with the following - // algorithm : if both fields are non-null and equals() then add their assigned weight, else if - // both are null then add a portion of their assigned weight (see NULL_MATCH_WEIGHT), - // otherwise add nothing. - // As a guideline, this should be something like 60~75% of the total weights in this class. The - // design states "in essence a reader should imagine that if two important columns don't match, - // or one important and several unimportant columns don't match then the two records are - // considered a different group". - private static final float TOTAL_WEIGHT_CUTOFF = 520.0f; - // The portion of the weight that is earned when scoring group-sameness by having both columns - // being null. This is because some networks rightfully don't have some attributes (e.g. a - // V6-only network won't have an assigned V4 address) and both being null should count for - // something, but attributes may also be null just because data is unavailable. - private static final float NULL_MATCH_WEIGHT = 0.25f; - - // The v4 address that was assigned to this device the last time it joined this network. - // This typically comes from DHCP but could be something else like static configuration. - // This does not apply to IPv6. - // TODO : add a list of v6 prefixes for the v6 case. - @Nullable - public final Inet4Address assignedV4Address; - private static final float WEIGHT_ASSIGNEDV4ADDR = 300.0f; - - // Optionally supplied by the client if it has an opinion on L3 network. For example, this - // could be a hash of the SSID + security type on WiFi. - @Nullable - public final String groupHint; - private static final float WEIGHT_GROUPHINT = 300.0f; - - // The list of DNS server addresses. - @Nullable - public final List<InetAddress> dnsAddresses; - private static final float WEIGHT_DNSADDRESSES = 200.0f; - - // The mtu on this network. - @Nullable - public final Integer mtu; - private static final float WEIGHT_MTU = 50.0f; - - // The sum of all weights in this class. Tests ensure that this stays equal to the total of - // all weights. - /** @hide */ - @VisibleForTesting - public static final float TOTAL_WEIGHT = WEIGHT_ASSIGNEDV4ADDR - + WEIGHT_GROUPHINT - + WEIGHT_DNSADDRESSES - + WEIGHT_MTU; - - /** @hide */ - @VisibleForTesting - public NetworkAttributes( - @Nullable final Inet4Address assignedV4Address, - @Nullable final String groupHint, - @Nullable final List<InetAddress> dnsAddresses, - @Nullable final Integer mtu) { - if (mtu != null && mtu < 0) throw new IllegalArgumentException("MTU can't be negative"); - this.assignedV4Address = assignedV4Address; - this.groupHint = groupHint; - this.dnsAddresses = null == dnsAddresses ? null : - Collections.unmodifiableList(new ArrayList<>(dnsAddresses)); - this.mtu = mtu; - } - - @VisibleForTesting - public NetworkAttributes(@NonNull final NetworkAttributesParcelable parcelable) { - // The call to the other constructor must be the first statement of this constructor, - // so everything has to be inline - this((Inet4Address) getByAddressOrNull(parcelable.assignedV4Address), - parcelable.groupHint, - blobArrayToInetAddressList(parcelable.dnsAddresses), - parcelable.mtu >= 0 ? parcelable.mtu : null); - } - - @Nullable - private static InetAddress getByAddressOrNull(@Nullable final byte[] address) { - try { - return InetAddress.getByAddress(address); - } catch (UnknownHostException e) { - return null; - } - } - - @Nullable - private static List<InetAddress> blobArrayToInetAddressList(@Nullable final Blob[] blobs) { - if (null == blobs) return null; - final ArrayList<InetAddress> list = new ArrayList<>(blobs.length); - for (final Blob b : blobs) { - final InetAddress addr = getByAddressOrNull(b.data); - if (null != addr) list.add(addr); - } - return list; - } - - @Nullable - private static Blob[] inetAddressListToBlobArray(@Nullable final List<InetAddress> addresses) { - if (null == addresses) return null; - final ArrayList<Blob> blobs = new ArrayList<>(); - for (int i = 0; i < addresses.size(); ++i) { - final InetAddress addr = addresses.get(i); - if (null == addr) continue; - final Blob b = new Blob(); - b.data = addr.getAddress(); - blobs.add(b); - } - return blobs.toArray(new Blob[0]); - } - - /** Converts this NetworkAttributes to a parcelable object */ - @NonNull - public NetworkAttributesParcelable toParcelable() { - final NetworkAttributesParcelable parcelable = new NetworkAttributesParcelable(); - parcelable.assignedV4Address = - (null == assignedV4Address) ? null : assignedV4Address.getAddress(); - parcelable.groupHint = groupHint; - parcelable.dnsAddresses = inetAddressListToBlobArray(dnsAddresses); - parcelable.mtu = (null == mtu) ? -1 : mtu; - return parcelable; - } - - private float samenessContribution(final float weight, - @Nullable final Object o1, @Nullable final Object o2) { - if (null == o1) { - return (null == o2) ? weight * NULL_MATCH_WEIGHT : 0f; - } - return Objects.equals(o1, o2) ? weight : 0f; - } - - /** @hide */ - public float getNetworkGroupSamenessConfidence(@NonNull final NetworkAttributes o) { - final float samenessScore = - samenessContribution(WEIGHT_ASSIGNEDV4ADDR, assignedV4Address, o.assignedV4Address) - + samenessContribution(WEIGHT_GROUPHINT, groupHint, o.groupHint) - + samenessContribution(WEIGHT_DNSADDRESSES, dnsAddresses, o.dnsAddresses) - + samenessContribution(WEIGHT_MTU, mtu, o.mtu); - // The minimum is 0, the max is TOTAL_WEIGHT and should be represented by 1.0, and - // TOTAL_WEIGHT_CUTOFF should represent 0.5, but there is no requirement that - // TOTAL_WEIGHT_CUTOFF would be half of TOTAL_WEIGHT (indeed, it should not be). - // So scale scores under the cutoff between 0 and 0.5, and the scores over the cutoff - // between 0.5 and 1.0. - if (samenessScore < TOTAL_WEIGHT_CUTOFF) { - return samenessScore / (TOTAL_WEIGHT_CUTOFF * 2); - } else { - return (samenessScore - TOTAL_WEIGHT_CUTOFF) / (TOTAL_WEIGHT - TOTAL_WEIGHT_CUTOFF) / 2 - + 0.5f; - } - } - - /** @hide */ - public static class Builder { - @Nullable - private Inet4Address mAssignedAddress; - @Nullable - private String mGroupHint; - @Nullable - private List<InetAddress> mDnsAddresses; - @Nullable - private Integer mMtu; - - /** - * Set the assigned address. - * @param assignedV4Address The assigned address. - * @return This builder. - */ - public Builder setAssignedV4Address(@Nullable final Inet4Address assignedV4Address) { - mAssignedAddress = assignedV4Address; - return this; - } - - /** - * Set the group hint. - * @param groupHint The group hint. - * @return This builder. - */ - public Builder setGroupHint(@Nullable final String groupHint) { - mGroupHint = groupHint; - return this; - } - - /** - * Set the DNS addresses. - * @param dnsAddresses The DNS addresses. - * @return This builder. - */ - public Builder setDnsAddresses(@Nullable final List<InetAddress> dnsAddresses) { - if (DBG && null != dnsAddresses) { - // Parceling code crashes if one of the addresses is null, therefore validate - // them when running in debug. - for (final InetAddress address : dnsAddresses) { - if (null == address) throw new IllegalArgumentException("Null DNS address"); - } - } - this.mDnsAddresses = dnsAddresses; - return this; - } - - /** - * Set the MTU. - * @param mtu The MTU. - * @return This builder. - */ - public Builder setMtu(@Nullable final Integer mtu) { - if (null != mtu && mtu < 0) throw new IllegalArgumentException("MTU can't be negative"); - mMtu = mtu; - return this; - } - - /** - * Return the built NetworkAttributes object. - * @return The built NetworkAttributes object. - */ - public NetworkAttributes build() { - return new NetworkAttributes(mAssignedAddress, mGroupHint, mDnsAddresses, mMtu); - } - } - - /** @hide */ - public boolean isEmpty() { - return (null == assignedV4Address) && (null == groupHint) - && (null == dnsAddresses) && (null == mtu); - } - - @Override - public boolean equals(@Nullable final Object o) { - if (!(o instanceof NetworkAttributes)) return false; - final NetworkAttributes other = (NetworkAttributes) o; - return Objects.equals(assignedV4Address, other.assignedV4Address) - && Objects.equals(groupHint, other.groupHint) - && Objects.equals(dnsAddresses, other.dnsAddresses) - && Objects.equals(mtu, other.mtu); - } - - @Override - public int hashCode() { - return Objects.hash(assignedV4Address, groupHint, dnsAddresses, mtu); - } - - /** Pretty print */ - @Override - public String toString() { - final StringJoiner resultJoiner = new StringJoiner(" ", "{", "}"); - final ArrayList<String> nullFields = new ArrayList<>(); - - if (null != assignedV4Address) { - resultJoiner.add("assignedV4Addr :"); - resultJoiner.add(assignedV4Address.toString()); - } else { - nullFields.add("assignedV4Addr"); - } - - if (null != groupHint) { - resultJoiner.add("groupHint :"); - resultJoiner.add(groupHint); - } else { - nullFields.add("groupHint"); - } - - if (null != dnsAddresses) { - resultJoiner.add("dnsAddr : ["); - for (final InetAddress addr : dnsAddresses) { - resultJoiner.add(addr.getHostAddress()); - } - resultJoiner.add("]"); - } else { - nullFields.add("dnsAddr"); - } - - if (null != mtu) { - resultJoiner.add("mtu :"); - resultJoiner.add(mtu.toString()); - } else { - nullFields.add("mtu"); - } - - if (!nullFields.isEmpty()) { - resultJoiner.add("; Null fields : ["); - for (final String field : nullFields) { - resultJoiner.add(field); - } - resultJoiner.add("]"); - } - - return resultJoiner.toString(); - } -} diff --git a/core/java/android/net/ipmemorystore/SameL3NetworkResponse.java b/core/java/android/net/ipmemorystore/SameL3NetworkResponse.java deleted file mode 100644 index 291aca8fc611..000000000000 --- a/core/java/android/net/ipmemorystore/SameL3NetworkResponse.java +++ /dev/null @@ -1,147 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package android.net.ipmemorystore; - -import android.annotation.IntDef; -import android.annotation.NonNull; -import android.annotation.Nullable; - -import com.android.internal.annotations.VisibleForTesting; - -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.util.Objects; - -/** - * An object representing the answer to a query whether two given L2 networks represent the - * same L3 network. Parcels as a SameL3NetworkResponseParceled object. - * @hide - */ -public class SameL3NetworkResponse { - @IntDef(prefix = "NETWORK_", - value = {NETWORK_SAME, NETWORK_DIFFERENT, NETWORK_NEVER_CONNECTED}) - @Retention(RetentionPolicy.SOURCE) - public @interface NetworkSameness {} - - /** - * Both L2 networks represent the same L3 network. - */ - public static final int NETWORK_SAME = 1; - - /** - * The two L2 networks represent a different L3 network. - */ - public static final int NETWORK_DIFFERENT = 2; - - /** - * The device has never connected to at least one of these two L2 networks, or data - * has been wiped. Therefore the device has never seen the L3 network behind at least - * one of these two L2 networks, and can't evaluate whether it's the same as the other. - */ - public static final int NETWORK_NEVER_CONNECTED = 3; - - /** - * The first L2 key specified in the query. - */ - @NonNull - public final String l2Key1; - - /** - * The second L2 key specified in the query. - */ - @NonNull - public final String l2Key2; - - /** - * A confidence value indicating whether the two L2 networks represent the same L3 network. - * - * If both L2 networks were known, this value will be between 0.0 and 1.0, with 0.0 - * representing complete confidence that the given L2 networks represent a different - * L3 network, and 1.0 representing complete confidence that the given L2 networks - * represent the same L3 network. - * If at least one of the L2 networks was not known, this value will be outside of the - * 0.0~1.0 range. - * - * Most apps should not be interested in this, and are encouraged to use the collapsing - * {@link #getNetworkSameness()} function below. - */ - public final float confidence; - - /** - * @return whether the two L2 networks represent the same L3 network. Either - * {@code NETWORK_SAME}, {@code NETWORK_DIFFERENT} or {@code NETWORK_NEVER_CONNECTED}. - */ - @NetworkSameness - public final int getNetworkSameness() { - if (confidence > 1.0 || confidence < 0.0) return NETWORK_NEVER_CONNECTED; - return confidence > 0.5 ? NETWORK_SAME : NETWORK_DIFFERENT; - } - - /** @hide */ - public SameL3NetworkResponse(@NonNull final String l2Key1, @NonNull final String l2Key2, - final float confidence) { - this.l2Key1 = l2Key1; - this.l2Key2 = l2Key2; - this.confidence = confidence; - } - - /** Builds a SameL3NetworkResponse from a parcelable object */ - @VisibleForTesting - public SameL3NetworkResponse(@NonNull final SameL3NetworkResponseParcelable parceled) { - this(parceled.l2Key1, parceled.l2Key2, parceled.confidence); - } - - /** Converts this SameL3NetworkResponse to a parcelable object */ - @NonNull - public SameL3NetworkResponseParcelable toParcelable() { - final SameL3NetworkResponseParcelable parcelable = new SameL3NetworkResponseParcelable(); - parcelable.l2Key1 = l2Key1; - parcelable.l2Key2 = l2Key2; - parcelable.confidence = confidence; - return parcelable; - } - - // Note key1 and key2 have to match each other for this to return true. If - // key1 matches o.key2 and the other way around this returns false. - @Override - public boolean equals(@Nullable final Object o) { - if (!(o instanceof SameL3NetworkResponse)) return false; - final SameL3NetworkResponse other = (SameL3NetworkResponse) o; - return l2Key1.equals(other.l2Key1) && l2Key2.equals(other.l2Key2) - && confidence == other.confidence; - } - - @Override - public int hashCode() { - return Objects.hash(l2Key1, l2Key2, confidence); - } - - @Override - /** Pretty print */ - public String toString() { - switch (getNetworkSameness()) { - case NETWORK_SAME: - return "\"" + l2Key1 + "\" same L3 network as \"" + l2Key2 + "\""; - case NETWORK_DIFFERENT: - return "\"" + l2Key1 + "\" different L3 network from \"" + l2Key2 + "\""; - case NETWORK_NEVER_CONNECTED: - return "\"" + l2Key1 + "\" can't be tested against \"" + l2Key2 + "\""; - default: - return "Buggy sameness value ? \"" + l2Key1 + "\", \"" + l2Key2 + "\""; - } - } -} diff --git a/core/java/android/net/ipmemorystore/Status.java b/core/java/android/net/ipmemorystore/Status.java deleted file mode 100644 index cacd42d713c2..000000000000 --- a/core/java/android/net/ipmemorystore/Status.java +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package android.net.ipmemorystore; - -import android.annotation.NonNull; - -import com.android.internal.annotations.VisibleForTesting; - -/** - * A parcelable status representing the result of an operation. - * Parcels as StatusParceled. - * @hide - */ -public class Status { - public static final int SUCCESS = 0; - - public static final int ERROR_GENERIC = -1; - public static final int ERROR_ILLEGAL_ARGUMENT = -2; - public static final int ERROR_DATABASE_CANNOT_BE_OPENED = -3; - public static final int ERROR_STORAGE = -4; - - public final int resultCode; - - public Status(final int resultCode) { - this.resultCode = resultCode; - } - - @VisibleForTesting - public Status(@NonNull final StatusParcelable parcelable) { - this(parcelable.resultCode); - } - - /** Converts this Status to a parcelable object */ - @NonNull - public StatusParcelable toParcelable() { - final StatusParcelable parcelable = new StatusParcelable(); - parcelable.resultCode = resultCode; - return parcelable; - } - - public boolean isSuccess() { - return SUCCESS == resultCode; - } - - /** Pretty print */ - @Override - public String toString() { - switch (resultCode) { - case SUCCESS: return "SUCCESS"; - case ERROR_GENERIC: return "GENERIC ERROR"; - case ERROR_ILLEGAL_ARGUMENT: return "ILLEGAL ARGUMENT"; - case ERROR_DATABASE_CANNOT_BE_OPENED: return "DATABASE CANNOT BE OPENED"; - // "DB storage error" is not very helpful but SQLite does not provide specific error - // codes upon store failure. Thus this indicates SQLite returned some error upon store - case ERROR_STORAGE: return "DATABASE STORAGE ERROR"; - default: return "Unknown value ?!"; - } - } -} diff --git a/core/java/android/net/ipmemorystore/Utils.java b/core/java/android/net/ipmemorystore/Utils.java deleted file mode 100644 index b361aca5a6f7..000000000000 --- a/core/java/android/net/ipmemorystore/Utils.java +++ /dev/null @@ -1,51 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package android.net.ipmemorystore; - -import android.annotation.NonNull; -import android.annotation.Nullable; - -/** {@hide} */ -public class Utils { - /** Pretty print */ - public static String blobToString(@Nullable final Blob blob) { - return "Blob : " + byteArrayToString(null == blob ? null : blob.data); - } - - /** Pretty print */ - public static String byteArrayToString(@Nullable final byte[] data) { - if (null == data) return "null"; - final StringBuilder sb = new StringBuilder("["); - if (data.length <= 24) { - appendByteArray(sb, data, 0, data.length); - } else { - appendByteArray(sb, data, 0, 16); - sb.append("..."); - appendByteArray(sb, data, data.length - 8, data.length); - } - sb.append("]"); - return sb.toString(); - } - - // Adds the hex representation of the array between the specified indices (inclusive, exclusive) - private static void appendByteArray(@NonNull final StringBuilder sb, @NonNull final byte[] ar, - final int from, final int to) { - for (int i = from; i < to; ++i) { - sb.append(String.format("%02X", ar[i])); - } - } -} |
