diff options
Diffstat (limited to 'wifi/java/android/net/wifi/EasyConnectStatusCallback.java')
| -rw-r--r-- | wifi/java/android/net/wifi/EasyConnectStatusCallback.java | 286 |
1 files changed, 0 insertions, 286 deletions
diff --git a/wifi/java/android/net/wifi/EasyConnectStatusCallback.java b/wifi/java/android/net/wifi/EasyConnectStatusCallback.java deleted file mode 100644 index ee7025594bc6..000000000000 --- a/wifi/java/android/net/wifi/EasyConnectStatusCallback.java +++ /dev/null @@ -1,286 +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.wifi; - -import android.annotation.IntDef; -import android.annotation.NonNull; -import android.annotation.Nullable; -import android.annotation.SystemApi; -import android.util.SparseArray; - -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.util.concurrent.Executor; - -/** - * Easy Connect (DPP) Status Callback. Use this callback to get status updates (success, failure, - * progress) from the Easy Connect operations. - */ -public abstract class EasyConnectStatusCallback { - /** - * Easy Connect R1 Success event: Configuration sent (Configurator mode). This is the last - * and final Easy Connect event when either the local device or remote device implement R1. - * If both devices implement R2, this event will never be received, and the - * {@link #EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_APPLIED} will be received. - * @hide - */ - @SystemApi - public static final int EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT = 0; - - /** - * Easy Connect R2 Success event: Configuration applied by Enrollee (Configurator mode). - * This is the last and final Easy Connect event when both the local device and remote device - * implement R2. If either the local device or remote device implement R1, this event will never - * be received, and the {@link #EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT} will be received. - * @hide - */ - @SystemApi - public static final int EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_APPLIED = 1; - - /** @hide */ - @IntDef(prefix = {"EASY_CONNECT_EVENT_SUCCESS_"}, value = { - EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT, - EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_APPLIED, - }) - @Retention(RetentionPolicy.SOURCE) - public @interface EasyConnectSuccessStatusCode { - } - - /** - * Easy Connect Progress event: Initial authentication with peer succeeded. - * @hide - */ - @SystemApi - public static final int EASY_CONNECT_EVENT_PROGRESS_AUTHENTICATION_SUCCESS = 0; - - /** - * Easy Connect Progress event: Peer requires more time to process bootstrapping. - * @hide - */ - @SystemApi - public static final int EASY_CONNECT_EVENT_PROGRESS_RESPONSE_PENDING = 1; - - /** - * Easy Connect R2 Progress event: Configuration sent to Enrollee, waiting for response - * @hide - */ - @SystemApi - public static final int EASY_CONNECT_EVENT_PROGRESS_CONFIGURATION_SENT_WAITING_RESPONSE = 2; - - /** - * Easy Connect R2 Progress event: Configuration accepted by Enrollee, waiting for response - * @hide - */ - @SystemApi - public static final int EASY_CONNECT_EVENT_PROGRESS_CONFIGURATION_ACCEPTED = 3; - - /** @hide */ - @IntDef(prefix = {"EASY_CONNECT_EVENT_PROGRESS_"}, value = { - EASY_CONNECT_EVENT_PROGRESS_AUTHENTICATION_SUCCESS, - EASY_CONNECT_EVENT_PROGRESS_RESPONSE_PENDING, - EASY_CONNECT_EVENT_PROGRESS_CONFIGURATION_SENT_WAITING_RESPONSE, - EASY_CONNECT_EVENT_PROGRESS_CONFIGURATION_ACCEPTED, - }) - @Retention(RetentionPolicy.SOURCE) - public @interface EasyConnectProgressStatusCode { - } - - /** - * Easy Connect Failure event: Scanned QR code is either not a Easy Connect URI, or the Easy - * Connect URI has errors. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_INVALID_URI = -1; - - /** - * Easy Connect Failure event: Bootstrapping/Authentication initialization process failure. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_AUTHENTICATION = -2; - - /** - * Easy Connect Failure event: Both devices are implementing the same role and are incompatible. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_NOT_COMPATIBLE = -3; - - /** - * Easy Connect Failure event: Configuration process has failed due to malformed message. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_CONFIGURATION = -4; - - /** - * Easy Connect Failure event: Easy Connect request while in another Easy Connect exchange. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_BUSY = -5; - - /** - * Easy Connect Failure event: No response from the peer. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_TIMEOUT = -6; - - /** - * Easy Connect Failure event: General protocol failure. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_GENERIC = -7; - - /** - * Easy Connect Failure event: Feature or option is not supported. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_NOT_SUPPORTED = -8; - - /** - * Easy Connect Failure event: Invalid network provided to Easy Connect configurator. - * Network must either be WPA3-Personal (SAE) or WPA2-Personal (PSK). - */ - public static final int EASY_CONNECT_EVENT_FAILURE_INVALID_NETWORK = -9; - - /** - * Easy Connect R2 Failure event: Enrollee cannot find the network. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_CANNOT_FIND_NETWORK = -10; - - /** - * Easy Connect R2 Failure event: Enrollee failed to authenticate with the network. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_ENROLLEE_AUTHENTICATION = -11; - - /** - * Easy Connect R2 Failure event: Enrollee rejected the configuration. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_ENROLLEE_REJECTED_CONFIGURATION = -12; - - /** - * Easy Connect Failure event: System failed to generate DPP URI. - */ - public static final int EASY_CONNECT_EVENT_FAILURE_URI_GENERATION = -13; - - /** @hide */ - @IntDef(prefix = {"EASY_CONNECT_EVENT_FAILURE_"}, value = { - EASY_CONNECT_EVENT_FAILURE_INVALID_URI, - EASY_CONNECT_EVENT_FAILURE_AUTHENTICATION, - EASY_CONNECT_EVENT_FAILURE_NOT_COMPATIBLE, - EASY_CONNECT_EVENT_FAILURE_CONFIGURATION, - EASY_CONNECT_EVENT_FAILURE_BUSY, - EASY_CONNECT_EVENT_FAILURE_TIMEOUT, - EASY_CONNECT_EVENT_FAILURE_GENERIC, - EASY_CONNECT_EVENT_FAILURE_NOT_SUPPORTED, - EASY_CONNECT_EVENT_FAILURE_INVALID_NETWORK, - EASY_CONNECT_EVENT_FAILURE_CANNOT_FIND_NETWORK, - EASY_CONNECT_EVENT_FAILURE_ENROLLEE_AUTHENTICATION, - EASY_CONNECT_EVENT_FAILURE_ENROLLEE_REJECTED_CONFIGURATION, - EASY_CONNECT_EVENT_FAILURE_URI_GENERATION, - }) - @Retention(RetentionPolicy.SOURCE) - public @interface EasyConnectFailureStatusCode { - } - - /** @hide */ - @SystemApi - public EasyConnectStatusCallback() { - // Fully-static utility classes must not have constructor - } - - /** - * Called when local Easy Connect Enrollee successfully receives a new Wi-Fi configuration from - * the - * peer Easy Connect configurator. This callback marks the successful end of the Easy Connect - * current Easy Connect - * session, and no further callbacks will be called. This callback is the successful outcome - * of a Easy Connect flow starting with - * {@link WifiManager#startEasyConnectAsEnrolleeInitiator(String, Executor, - * EasyConnectStatusCallback)} . - * - * @param newNetworkId New Wi-Fi configuration with a network ID received from the configurator - * @hide - */ - @SystemApi - public abstract void onEnrolleeSuccess(int newNetworkId); - - /** - * Called when a Easy Connect success event takes place, except for when configuration is - * received from an external Configurator. The callback onSuccessConfigReceived will be used in - * this case. This callback marks the successful end of the current Easy Connect session, and no - * further callbacks will be called. This callback is the successful outcome of a Easy Connect - * flow starting with {@link WifiManager#startEasyConnectAsConfiguratorInitiator(String, int, - * int, Executor,EasyConnectStatusCallback)}. - * - * @param code Easy Connect success status code. - * @hide - */ - @SystemApi - public abstract void onConfiguratorSuccess(@EasyConnectSuccessStatusCode int code); - - /** - * Called when a Easy Connect Failure event takes place. This callback marks the unsuccessful - * end of the current Easy Connect session, and no further callbacks will be called. - * - * @param code Easy Connect failure status code. - * @hide - */ - @SystemApi - public void onFailure(@EasyConnectFailureStatusCode int code) {} - - /** - * Called when a Easy Connect Failure event takes place. This callback marks the unsuccessful - * end of the current Easy Connect session, and no further callbacks will be called. - * - * Note: Easy Connect (DPP) R2, provides additional details for the Configurator when the - * remote Enrollee is unable to connect to a network. The ssid, channelList and bandList - * inputs are initialized only for the EASY_CONNECT_EVENT_FAILURE_CANNOT_FIND_NETWORK failure - * code, and the ssid and bandList are initialized for the - * EASY_CONNECT_EVENT_FAILURE_ENROLLEE_AUTHENTICATION failure code. - * - * @param code Easy Connect failure status code. - * @param ssid SSID of the network the Enrollee tried to connect to. - * @param channelListArray List of Global Operating classes and channel sets the Enrollee used - * to scan to find the network, see the "DPP Connection Status Object" - * section in the specification for the format, and Table E-4 in - * IEEE Std 802.11-2016 - Global operating classes for more details. - * The sparse array key is the Global Operating class, and the value - * is an integer array of Wi-Fi channels. - * @param operatingClassArray Array of bands the Enrollee supports as expressed as the Global - * Operating Class, see Table E-4 in IEEE Std 802.11-2016 - Global - * operating classes. - * @hide - */ - @SystemApi - public void onFailure(@EasyConnectFailureStatusCode int code, @Nullable String ssid, - @NonNull SparseArray<int[]> channelListArray, @NonNull int[] operatingClassArray) { - onFailure(code); - } - - /** - * Called when Easy Connect events that indicate progress take place. Can be used by UI elements - * to show progress. - * - * @param code Easy Connect progress status code. - * @hide - */ - @SystemApi - public abstract void onProgress(@EasyConnectProgressStatusCode int code); - - /** - * Called when local Easy Connect Responder successfully generates a DPP URI from - * the supplicant. This callback is the first successful outcome - * of a Easy Connect Responder flow starting with - * {@link WifiManager#startEasyConnectAsEnrolleeResponder(String, int, Executor, - * EasyConnectStatusCallback)} . - * - * @param uri DPP URI from the supplicant. - * @hide - */ - @SystemApi - public void onBootstrapUriGenerated(@NonNull String uri) {}; -} |