1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
|
/*
* Copyright (C) 2014 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.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.Objects;
import java.util.regex.Pattern;
/**
* Information identifying a Wi-Fi network.
* @see NetworkKey
*
* @deprecated as part of the {@link NetworkScoreManager} deprecation.
* @hide
*/
@Deprecated
@SystemApi
public class WifiKey implements Parcelable {
// Patterns used for validation.
private static final Pattern SSID_PATTERN = Pattern.compile("(\".*\")|(0x[\\p{XDigit}]+)",
Pattern.DOTALL);
private static final Pattern BSSID_PATTERN =
Pattern.compile("([\\p{XDigit}]{2}:){5}[\\p{XDigit}]{2}");
/**
* The service set identifier (SSID) of an 802.11 network. If the SSID can be decoded as
* UTF-8, it will be surrounded by double quotation marks. Otherwise, it will be a string of
* hex digits starting with 0x.
*/
public final String ssid;
/**
* The basic service set identifier (BSSID) of an access point for this network. This will
* be in the form of a six-byte MAC address: {@code XX:XX:XX:XX:XX:XX}, where each X is a
* hexadecimal digit.
*/
public final String bssid;
/**
* Construct a new {@link WifiKey} for the given Wi-Fi SSID/BSSID pair.
*
* @param ssid the service set identifier (SSID) of an 802.11 network. If the SSID can be
* decoded as UTF-8, it should be surrounded by double quotation marks. Otherwise,
* it should be a string of hex digits starting with 0x.
* @param bssid the basic service set identifier (BSSID) of this network's access point.
* This should be in the form of a six-byte MAC address: {@code XX:XX:XX:XX:XX:XX},
* where each X is a hexadecimal digit.
* @throws IllegalArgumentException if either the SSID or BSSID is invalid.
*/
public WifiKey(String ssid, String bssid) {
if (ssid == null || !SSID_PATTERN.matcher(ssid).matches()) {
throw new IllegalArgumentException("Invalid ssid: " + ssid);
}
if (bssid == null || !BSSID_PATTERN.matcher(bssid).matches()) {
throw new IllegalArgumentException("Invalid bssid: " + bssid);
}
this.ssid = ssid;
this.bssid = bssid;
}
private WifiKey(Parcel in) {
ssid = in.readString();
bssid = in.readString();
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel out, int flags) {
out.writeString(ssid);
out.writeString(bssid);
}
@Override
public boolean equals(@Nullable Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
WifiKey wifiKey = (WifiKey) o;
return Objects.equals(ssid, wifiKey.ssid) && Objects.equals(bssid, wifiKey.bssid);
}
@Override
public int hashCode() {
return Objects.hash(ssid, bssid);
}
@NonNull
@Override
public String toString() {
return "WifiKey[SSID=" + ssid + ",BSSID=" + bssid + "]";
}
public static final @android.annotation.NonNull Creator<WifiKey> CREATOR =
new Creator<WifiKey>() {
@Override
public WifiKey createFromParcel(Parcel in) {
return new WifiKey(in);
}
@Override
public WifiKey[] newArray(int size) {
return new WifiKey[size];
}
};
}
|