Create a new BluetoothSocketException class which is a subclass of IOException. (0e03f15f) · Commits · e / os / android_packages_modules_Bluetooth

framework/api/current.txt

+27 −0

Original line number	Diff line number	Diff line
		@@ -1074,6 +1074,33 @@ package android.bluetooth {
		field public static final int TYPE_SCO = 2; // 0x2
		}

		public class BluetoothSocketException extends java.io.IOException {
		ctor public BluetoothSocketException(int, @NonNull String);
		ctor public BluetoothSocketException(int);
		method public int getErrorCode();
		field public static final int BLUETOOTH_OFF_FAILURE = 15; // 0xf
		field public static final int L2CAP_ACL_FAILURE = 2; // 0x2
		field public static final int L2CAP_CLIENT_SECURITY_FAILURE = 3; // 0x3
		field public static final int L2CAP_INSUFFICIENT_AUTHENTICATION = 4; // 0x4
		field public static final int L2CAP_INSUFFICIENT_AUTHORIZATION = 5; // 0x5
		field public static final int L2CAP_INSUFFICIENT_ENCRYPTION = 7; // 0x7
		field public static final int L2CAP_INSUFFICIENT_ENCRYPT_KEY_SIZE = 6; // 0x6
		field public static final int L2CAP_INVALID_PARAMETERS = 11; // 0xb
		field public static final int L2CAP_INVALID_SOURCE_CID = 8; // 0x8
		field public static final int L2CAP_NO_PSM_AVAILABLE = 13; // 0xd
		field public static final int L2CAP_NO_RESOURCES = 12; // 0xc
		field public static final int L2CAP_SOURCE_CID_ALREADY_ALLOCATED = 9; // 0x9
		field public static final int L2CAP_TIMEOUT = 14; // 0xe
		field public static final int L2CAP_UNACCEPTABLE_PARAMETERS = 10; // 0xa
		field public static final int L2CAP_UNKNOWN = 1; // 0x1
		field public static final int NULL_DEVICE = 19; // 0x13
		field public static final int RPC_FAILURE = 20; // 0x14
		field public static final int SOCKET_CLOSED = 17; // 0x11
		field public static final int SOCKET_CONNECTION_FAILURE = 18; // 0x12
		field public static final int SOCKET_MANAGER_FAILURE = 16; // 0x10
		field public static final int UNSPECIFIED = 0; // 0x0
		}

		public final class BluetoothStatusCodes {
		field public static final int ERROR_BLUETOOTH_NOT_ALLOWED = 2; // 0x2
		field public static final int ERROR_BLUETOOTH_NOT_ENABLED = 1; // 0x1

framework/java/android/bluetooth/BluetoothSocketException.java

0 → 100644

+279 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2023 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.bluetooth;

		import static java.lang.annotation.RetentionPolicy.SOURCE;

		import android.annotation.IntDef;
		import android.annotation.NonNull;

		import java.io.IOException;
		import java.lang.annotation.Retention;

		/**
		* Thrown when an error occurs during a Bluetooth Socket related exception.
		*
		* <p> This is currently only intended to be thrown for a failure during
		* {@link BluetoothSocket#connect()} operation.
		*/
		public class BluetoothSocketException extends IOException {

		@Retention(SOURCE)
		@IntDef({
		UNSPECIFIED,
		L2CAP_UNKNOWN,
		L2CAP_ACL_FAILURE,
		L2CAP_CLIENT_SECURITY_FAILURE,
		L2CAP_INSUFFICIENT_AUTHENTICATION,
		L2CAP_INSUFFICIENT_AUTHORIZATION,
		L2CAP_INSUFFICIENT_ENCRYPT_KEY_SIZE,
		L2CAP_INSUFFICIENT_ENCRYPTION,
		L2CAP_INVALID_SOURCE_CID,
		L2CAP_SOURCE_CID_ALREADY_ALLOCATED,
		L2CAP_UNACCEPTABLE_PARAMETERS,
		L2CAP_INVALID_PARAMETERS,
		L2CAP_NO_RESOURCES,
		L2CAP_NO_PSM_AVAILABLE,
		L2CAP_TIMEOUT,
		BLUETOOTH_OFF_FAILURE,
		SOCKET_MANAGER_FAILURE,
		SOCKET_CLOSED,
		SOCKET_CONNECTION_FAILURE,
		NULL_DEVICE,
		RPC_FAILURE})
		private @interface ErrorCode {}

		/**
		* Error code representing a failure during {@link BluetoothSocket}. The reason for failure
		* isn't specified.
		*/
		public static final int UNSPECIFIED = 0;

		/**
		* Error code during connect when socket connection fails for unknown reason
		* during L2CAP connection.
		*/
		public static final int L2CAP_UNKNOWN = 1;

		/**
		* Error code during connect when there is an ACL connection failure.
		*/
		public static final int L2CAP_ACL_FAILURE = 2;

		/**
		* Error code during connect when security clearance fails on the client during
		* L2CAP connection.
		*/
		public static final int L2CAP_CLIENT_SECURITY_FAILURE = 3;

		/**
		* Error code during connect when authentication fails on the peer device
		* during L2CAP connection.
		*/
		public static final int L2CAP_INSUFFICIENT_AUTHENTICATION = 4;

		/**
		* Error code during connect when authorization fails on the peer device during
		* L2CAP connection.
		*/
		public static final int L2CAP_INSUFFICIENT_AUTHORIZATION = 5;

		/**
		* Error code during connect indicating insufficient encryption key size on the
		* peer device during L2CAP connection.
		*/
		public static final int L2CAP_INSUFFICIENT_ENCRYPT_KEY_SIZE = 6;

		/**
		* Error code during connect for insufficient encryption from the peer device
		* during L2CAP connection.
		*/
		public static final int L2CAP_INSUFFICIENT_ENCRYPTION = 7;

		/**
		* Error code during connect for invalid Channel ID from the peer device during
		* L2CAP connection.
		*/
		public static final int L2CAP_INVALID_SOURCE_CID = 8;

		/**
		* Error code during connect for already allocated Channel ID from the peer
		* device during L2CAP connection.
		*/
		public static final int L2CAP_SOURCE_CID_ALREADY_ALLOCATED = 9;

		/**
		* Error code during connect for unacceptable Parameters from the peer device
		* during L2CAP connection.
		*/
		public static final int L2CAP_UNACCEPTABLE_PARAMETERS = 10;

		/**
		* Error code during connect for invalid parameters from the peer device during
		* L2CAP connection.
		*/
		public static final int L2CAP_INVALID_PARAMETERS = 11;

		/**
		* Error code during connect when no resources are available for L2CAP
		* connection.
		*/
		public static final int L2CAP_NO_RESOURCES = 12;

		/**
		* Error code during connect when no PSM is available for L2CAP connection.
		*/
		public static final int L2CAP_NO_PSM_AVAILABLE = 13;

		/**
		* Error code during connect when L2CAP connection timeout.
		*/
		public static final int L2CAP_TIMEOUT = 14;

		/**
		* Error code during connect when Bluetooth is off and socket connection is
		* triggered.
		*/
		public static final int BLUETOOTH_OFF_FAILURE = 15;

		/**
		* Error code during connect when socket manager is not available.
		*/
		public static final int SOCKET_MANAGER_FAILURE = 16;

		/**
		* Error code during connect when socket is closed.
		*/
		public static final int SOCKET_CLOSED = 17;

		/**
		* Error code during connect for generic socket connection failures.
		*/
		public static final int SOCKET_CONNECTION_FAILURE = 18;

		/**
		* Error code during connect when null device attempts to do socket connection.
		*/
		public static final int NULL_DEVICE = 19;

		/**
		* Error code during connect when a Runtime RPC exception occurs.
		*/
		public static final int RPC_FAILURE = 20;

		/* Corresponding messages for respective error codes. */
		private static final String UNSPECIFIED_MSG = "A Bluetooth Socket failure occurred";
		private static final String L2CAP_UNKNOWN_MSG = "Connection failed for unknown reason";
		private static final String L2CAP_ACL_FAILURE_MSG = "ACL connection failed";
		private static final String L2CAP_CLIENT_SECURITY_FAILURE_MSG =
		"Client security clearance failed";
		private static final String L2CAP_INSUFFICIENT_AUTHENTICATION_MSG =
		"Insufficient authentication";
		private static final String L2CAP_INSUFFICIENT_AUTHORIZATION_MSG = "Insufficient authorization";
		private static final String L2CAP_INSUFFICIENT_ENCRYPT_KEY_SIZE_MSG =
		"Insufficient encryption key size";
		private static final String L2CAP_INSUFFICIENT_ENCRYPTION_MSG = "Insufficient encryption";
		private static final String L2CAP_INVALID_SOURCE_CID_MSG = "Invalid source CID";
		private static final String L2CAP_SOURCE_CID_ALREADY_ALLOCATED_MSG =
		"Source CID already allocated";
		private static final String L2CAP_UNACCEPTABLE_PARAMETERS_MSG = "Unacceptable Parameters";
		private static final String L2CAP_INVALID_PARAMETERS_MSG = "Invalid Parameters";
		private static final String L2CAP_NO_RESOURCES_MSG = "No resources Available";
		private static final String L2CAP_NO_PSM_AVAILABLE_MSG = "No PSM available";
		private static final String L2CAP_TIMEOUT_MSG = "Connection Timeout";
		private static final String BLUETOOTH_OFF_FAILURE_MSG = "Bluetooth is off";
		private static final String SOCKET_MANAGER_FAILURE_MSG = "bt get socket manager failed";
		private static final String SOCKET_CLOSED_MSG = "socket closed";
		private static final String SOCKET_CONNECTION_FAILURE_MSG = "bt socket connect failed";
		private static final String NULL_DEVICE_MSG = "Connect is called on null device";

		@ErrorCode private final int mErrorCode;

		/**
		* Create a {@link BluetoothSocketException} with a {@link ErrorCode} and custom error message.
		*
		* @param code : {@link ErrorCode} representing the reason for failure.
		* @param msg : Custom error message associated to the failure.
		*/
		public BluetoothSocketException(@ErrorCode int code, @NonNull String msg) {
		super(msg);
		this.mErrorCode = code;
		}

		/**
		* Create a {@link BluetoothSocketException} with an error {@link ErrorCode}. A generic error
		* message is generated based on the {@code code} provided.
		*
		* @param code : {@link ErrorCode} representing the reason for failure.
		*/
		public BluetoothSocketException(@ErrorCode int code) {
		this(code, getMessage(code));
		}

		/**
		* Returns the error code associated to this failure.
		*/
		public @ErrorCode int getErrorCode() {
		return mErrorCode;
		}

		private static String getMessage(@ErrorCode int code) {
		switch(code) {
		case BLUETOOTH_OFF_FAILURE:
		return BLUETOOTH_OFF_FAILURE_MSG;
		case SOCKET_MANAGER_FAILURE:
		return SOCKET_MANAGER_FAILURE_MSG;
		case SOCKET_CLOSED:
		return SOCKET_CLOSED_MSG;
		case SOCKET_CONNECTION_FAILURE:
		return SOCKET_CONNECTION_FAILURE_MSG;
		case NULL_DEVICE:
		return NULL_DEVICE_MSG;
		case L2CAP_ACL_FAILURE:
		return L2CAP_ACL_FAILURE_MSG;
		case L2CAP_CLIENT_SECURITY_FAILURE:
		return L2CAP_CLIENT_SECURITY_FAILURE_MSG;
		case L2CAP_INSUFFICIENT_AUTHENTICATION:
		return L2CAP_INSUFFICIENT_AUTHENTICATION_MSG;
		case L2CAP_INSUFFICIENT_AUTHORIZATION:
		return L2CAP_INSUFFICIENT_AUTHORIZATION_MSG;
		case L2CAP_INSUFFICIENT_ENCRYPT_KEY_SIZE:
		return L2CAP_INSUFFICIENT_ENCRYPT_KEY_SIZE_MSG;
		case L2CAP_INSUFFICIENT_ENCRYPTION:
		return L2CAP_INSUFFICIENT_ENCRYPTION_MSG;
		case L2CAP_INVALID_SOURCE_CID:
		return L2CAP_INVALID_SOURCE_CID_MSG;
		case L2CAP_SOURCE_CID_ALREADY_ALLOCATED:
		return L2CAP_SOURCE_CID_ALREADY_ALLOCATED_MSG;
		case L2CAP_UNACCEPTABLE_PARAMETERS:
		return L2CAP_UNACCEPTABLE_PARAMETERS_MSG;
		case L2CAP_INVALID_PARAMETERS:
		return L2CAP_INVALID_PARAMETERS_MSG;
		case L2CAP_NO_RESOURCES:
		return L2CAP_NO_RESOURCES_MSG;
		case L2CAP_NO_PSM_AVAILABLE:
		return L2CAP_NO_PSM_AVAILABLE_MSG;
		case L2CAP_TIMEOUT:
		return L2CAP_TIMEOUT_MSG;
		case L2CAP_UNKNOWN:
		return L2CAP_UNKNOWN_MSG;
		case UNSPECIFIED:
		default:
		return UNSPECIFIED_MSG;
		}
		}
		}