/*
 * Copyright (C) 2008 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 android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Binder;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;

import java.util.ArrayList;
import java.util.List;

This class provides the APIs to control the Bluetooth SIM Access Profile (SAP).

BluetoothSap is a proxy object for controlling the Bluetooth Service via IPC. Use BluetoothAdapter.getProfileProxy to get the BluetoothSap proxy object.

Each method is protected with its appropriate permission.

@hide
/** * This class provides the APIs to control the Bluetooth SIM * Access Profile (SAP). * * <p>BluetoothSap is a proxy object for controlling the Bluetooth * Service via IPC. Use {@link BluetoothAdapter#getProfileProxy} to get * the BluetoothSap proxy object. * * <p>Each method is protected with its appropriate permission. * * @hide */
public final class BluetoothSap implements BluetoothProfile { private static final String TAG = "BluetoothSap"; private static final boolean DBG = true; private static final boolean VDBG = false;
Intent used to broadcast the change in connection state of the profile.

This intent will have 4 extras:

BluetoothProfile.EXTRA_STATE or BluetoothProfile.EXTRA_PREVIOUS_STATE can be any of BluetoothProfile.STATE_DISCONNECTED, BluetoothProfile.STATE_CONNECTING, BluetoothProfile.STATE_CONNECTED, BluetoothProfile.STATE_DISCONNECTING.

Requires BLUETOOTH.BLUETOOTH permission to receive.

@hide
/** * Intent used to broadcast the change in connection state of the profile. * * <p>This intent will have 4 extras: * <ul> * <li> {@link #EXTRA_STATE} - The current state of the profile. </li> * <li> {@link #EXTRA_PREVIOUS_STATE}- The previous state of the profile.</li> * <li> {@link BluetoothDevice#EXTRA_DEVICE} - The remote device. </li> * </ul> * * <p>{@link #EXTRA_STATE} or {@link #EXTRA_PREVIOUS_STATE} can be any of * {@link #STATE_DISCONNECTED}, {@link #STATE_CONNECTING}, * {@link #STATE_CONNECTED}, {@link #STATE_DISCONNECTING}. * * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission to * receive. * * @hide */
public static final String ACTION_CONNECTION_STATE_CHANGED = "android.bluetooth.sap.profile.action.CONNECTION_STATE_CHANGED"; private volatile IBluetoothSap mService; private final Context mContext; private ServiceListener mServiceListener; private BluetoothAdapter mAdapter;
There was an error trying to obtain the state.
@hide
/** * There was an error trying to obtain the state. * * @hide */
public static final int STATE_ERROR = -1;
Connection state change succceeded.
@hide
/** * Connection state change succceeded. * * @hide */
public static final int RESULT_SUCCESS = 1;
Connection canceled before completion.
@hide
/** * Connection canceled before completion. * * @hide */
public static final int RESULT_CANCELED = 2; private final IBluetoothStateChangeCallback mBluetoothStateChangeCallback = new IBluetoothStateChangeCallback.Stub() { public void onBluetoothStateChange(boolean up) { if (DBG) Log.d(TAG, "onBluetoothStateChange: up=" + up); if (!up) { if (VDBG) Log.d(TAG, "Unbinding service..."); synchronized (mConnection) { try { mService = null; mContext.unbindService(mConnection); } catch (Exception re) { Log.e(TAG, "", re); } } } else { synchronized (mConnection) { try { if (mService == null) { if (VDBG) Log.d(TAG, "Binding service..."); doBind(); } } catch (Exception re) { Log.e(TAG, "", re); } } } } };
Create a BluetoothSap proxy object.
/** * Create a BluetoothSap proxy object. */
/*package*/ BluetoothSap(Context context, ServiceListener l) { if (DBG) Log.d(TAG, "Create BluetoothSap proxy object"); mContext = context; mServiceListener = l; mAdapter = BluetoothAdapter.getDefaultAdapter(); IBluetoothManager mgr = mAdapter.getBluetoothManager(); if (mgr != null) { try { mgr.registerStateChangeCallback(mBluetoothStateChangeCallback); } catch (RemoteException e) { Log.e(TAG, "", e); } } doBind(); } boolean doBind() { Intent intent = new Intent(IBluetoothSap.class.getName()); ComponentName comp = intent.resolveSystemService(mContext.getPackageManager(), 0); intent.setComponent(comp); if (comp == null || !mContext.bindServiceAsUser(intent, mConnection, 0, mContext.getUser())) { Log.e(TAG, "Could not bind to Bluetooth SAP Service with " + intent); return false; } return true; } protected void finalize() throws Throwable { try { close(); } finally { super.finalize(); } }
Close the connection to the backing service. Other public functions of BluetoothSap will return default error results once close() has been called. Multiple invocations of close() are ok.
@hide
/** * Close the connection to the backing service. * Other public functions of BluetoothSap will return default error * results once close() has been called. Multiple invocations of close() * are ok. * * @hide */
public synchronized void close() { IBluetoothManager mgr = mAdapter.getBluetoothManager(); if (mgr != null) { try { mgr.unregisterStateChangeCallback(mBluetoothStateChangeCallback); } catch (Exception e) { Log.e(TAG, "", e); } } synchronized (mConnection) { if (mService != null) { try { mService = null; mContext.unbindService(mConnection); } catch (Exception re) { Log.e(TAG, "", re); } } } mServiceListener = null; }
Get the current state of the BluetoothSap service.
Returns:One of the STATE_ return codes, or STATE_ERROR if this proxy object is currently not connected to the Sap service.
@hide
/** * Get the current state of the BluetoothSap service. * * @return One of the STATE_ return codes, or STATE_ERROR if this proxy object is currently not * connected to the Sap service. * @hide */
public int getState() { if (VDBG) log("getState()"); final IBluetoothSap service = mService; if (service != null) { try { return service.getState(); } catch (RemoteException e) { Log.e(TAG, e.toString()); } } else { Log.w(TAG, "Proxy not attached to service"); if (DBG) log(Log.getStackTraceString(new Throwable())); } return BluetoothSap.STATE_ERROR; }
Get the currently connected remote Bluetooth device (PCE).
Returns:The remote Bluetooth device, or null if not in connected or connecting state, or if this proxy object is not connected to the Sap service.
@hide
/** * Get the currently connected remote Bluetooth device (PCE). * * @return The remote Bluetooth device, or null if not in connected or connecting state, or if * this proxy object is not connected to the Sap service. * @hide */
public BluetoothDevice getClient() { if (VDBG) log("getClient()"); final IBluetoothSap service = mService; if (service != null) { try { return service.getClient(); } catch (RemoteException e) { Log.e(TAG, e.toString()); } } else { Log.w(TAG, "Proxy not attached to service"); if (DBG) log(Log.getStackTraceString(new Throwable())); } return null; }
Returns true if the specified Bluetooth device is connected. Returns false if not connected, or if this proxy object is not currently connected to the Sap service.
@hide
/** * Returns true if the specified Bluetooth device is connected. * Returns false if not connected, or if this proxy object is not * currently connected to the Sap service. * * @hide */
public boolean isConnected(BluetoothDevice device) { if (VDBG) log("isConnected(" + device + ")"); final IBluetoothSap service = mService; if (service != null) { try { return service.isConnected(device); } catch (RemoteException e) { Log.e(TAG, e.toString()); } } else { Log.w(TAG, "Proxy not attached to service"); if (DBG) log(Log.getStackTraceString(new Throwable())); } return false; }
Initiate connection. Initiation of outgoing connections is not supported for SAP server.
@hide
/** * Initiate connection. Initiation of outgoing connections is not * supported for SAP server. * * @hide */
public boolean connect(BluetoothDevice device) { if (DBG) log("connect(" + device + ")" + "not supported for SAPS"); return false; }
Initiate disconnect.
Params:
  • device – Remote Bluetooth Device
Returns:false on error, true otherwise
@hide
/** * Initiate disconnect. * * @param device Remote Bluetooth Device * @return false on error, true otherwise * @hide */
public boolean disconnect(BluetoothDevice device) { if (DBG) log("disconnect(" + device + ")"); final IBluetoothSap service = mService; if (service != null && isEnabled() && isValidDevice(device)) { try { return service.disconnect(device); } catch (RemoteException e) { Log.e(TAG, Log.getStackTraceString(new Throwable())); return false; } } if (service == null) Log.w(TAG, "Proxy not attached to service"); return false; }
Get the list of connected devices. Currently at most one.
Returns:list of connected devices
@hide
/** * Get the list of connected devices. Currently at most one. * * @return list of connected devices * @hide */
public List<BluetoothDevice> getConnectedDevices() { if (DBG) log("getConnectedDevices()"); final IBluetoothSap service = mService; if (service != null && isEnabled()) { try { return service.getConnectedDevices(); } catch (RemoteException e) { Log.e(TAG, Log.getStackTraceString(new Throwable())); return new ArrayList<BluetoothDevice>(); } } if (service == null) Log.w(TAG, "Proxy not attached to service"); return new ArrayList<BluetoothDevice>(); }
Get the list of devices matching specified states. Currently at most one.
Returns:list of matching devices
@hide
/** * Get the list of devices matching specified states. Currently at most one. * * @return list of matching devices * @hide */
public List<BluetoothDevice> getDevicesMatchingConnectionStates(int[] states) { if (DBG) log("getDevicesMatchingStates()"); final IBluetoothSap service = mService; if (service != null && isEnabled()) { try { return service.getDevicesMatchingConnectionStates(states); } catch (RemoteException e) { Log.e(TAG, Log.getStackTraceString(new Throwable())); return new ArrayList<BluetoothDevice>(); } } if (service == null) Log.w(TAG, "Proxy not attached to service"); return new ArrayList<BluetoothDevice>(); }
Get connection state of device
Returns:device connection state
@hide
/** * Get connection state of device * * @return device connection state * @hide */
public int getConnectionState(BluetoothDevice device) { if (DBG) log("getConnectionState(" + device + ")"); final IBluetoothSap service = mService; if (service != null && isEnabled() && isValidDevice(device)) { try { return service.getConnectionState(device); } catch (RemoteException e) { Log.e(TAG, Log.getStackTraceString(new Throwable())); return BluetoothProfile.STATE_DISCONNECTED; } } if (service == null) Log.w(TAG, "Proxy not attached to service"); return BluetoothProfile.STATE_DISCONNECTED; }
Set priority of the profile

The device should already be paired.

Params:
  • device – Paired bluetooth device
  • priority –
Returns:true if priority is set, false on error
@hide
/** * Set priority of the profile * * <p> The device should already be paired. * * @param device Paired bluetooth device * @param priority * @return true if priority is set, false on error * @hide */
public boolean setPriority(BluetoothDevice device, int priority) { if (DBG) log("setPriority(" + device + ", " + priority + ")"); final IBluetoothSap service = mService; if (service != null && isEnabled() && isValidDevice(device)) { if (priority != BluetoothProfile.PRIORITY_OFF && priority != BluetoothProfile.PRIORITY_ON) { return false; } try { return service.setPriority(device, priority); } catch (RemoteException e) { Log.e(TAG, Log.getStackTraceString(new Throwable())); return false; } } if (service == null) Log.w(TAG, "Proxy not attached to service"); return false; }
Get the priority of the profile.
Params:
  • device – Bluetooth device
Returns:priority of the device
@hide
/** * Get the priority of the profile. * * @param device Bluetooth device * @return priority of the device * @hide */
public int getPriority(BluetoothDevice device) { if (VDBG) log("getPriority(" + device + ")"); final IBluetoothSap service = mService; if (service != null && isEnabled() && isValidDevice(device)) { try { return service.getPriority(device); } catch (RemoteException e) { Log.e(TAG, Log.getStackTraceString(new Throwable())); return PRIORITY_OFF; } } if (service == null) Log.w(TAG, "Proxy not attached to service"); return PRIORITY_OFF; } private final ServiceConnection mConnection = new ServiceConnection() { public void onServiceConnected(ComponentName className, IBinder service) { if (DBG) log("Proxy object connected"); mService = IBluetoothSap.Stub.asInterface(Binder.allowBlocking(service)); if (mServiceListener != null) { mServiceListener.onServiceConnected(BluetoothProfile.SAP, BluetoothSap.this); } } public void onServiceDisconnected(ComponentName className) { if (DBG) log("Proxy object disconnected"); mService = null; if (mServiceListener != null) { mServiceListener.onServiceDisconnected(BluetoothProfile.SAP); } } }; private static void log(String msg) { Log.d(TAG, msg); } private boolean isEnabled() { BluetoothAdapter adapter = BluetoothAdapter.getDefaultAdapter(); if (adapter != null && adapter.getState() == BluetoothAdapter.STATE_ON) { return true; } log("Bluetooth is Not enabled"); return false; } private static boolean isValidDevice(BluetoothDevice device) { return device != null && BluetoothAdapter.checkBluetoothAddress(device.getAddress()); } }