Add the CallService base class and the necessary call-service-provider

AIDL interfaces.

Change-Id: Ic0aab1245d259f1148d403033647d795e07ab015
This commit is contained in:
Ben Gilad
2013-12-16 16:39:52 -08:00
committed by Evan Charlton
parent bb69b0c2d8
commit e57944dd55
5 changed files with 252 additions and 7 deletions

View File

@@ -429,6 +429,8 @@ aidl_files := \
telecomm/java/android/telecomm/CallInfo.aidl \
telecomm/java/android/telecomm/ICallService.aidl \
telecomm/java/android/telecomm/ICallServiceAdapter.aidl \
telecomm/java/android/telecomm/ICallServiceProvider.aidl \
telecomm/java/android/telecomm/ICallServiceProviderAdapter.aidl \
frameworks/base/telephony/java/android/telephony/ServiceState.aidl \
frameworks/base/telephony/java/com/android/internal/telephony/IPhoneSubInfo.aidl \
frameworks/base/telephony/java/com/android/internal/telephony/ITelephony.aidl \

View File

@@ -0,0 +1,164 @@
/*
* Copyright (C) 2013 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.telecomm;
import android.app.Service;
import android.content.Intent;
import android.os.Handler;
import android.os.IBinder;
import android.os.Message;
import android.ICallService;
import android.ICallServiceAdapter;
/**
* Base implementation of CallService which can be used to provide calls for the system
* in-call UI. CallService is a one-way service from the framework's CallsManager to any app
* that would like to provide calls managed by the default system in-call user interface.
* When the service is bound by the framework, CallsManager will call setCallServiceAdapter
* which will provide CallService with an instance of {@link CallServiceAdapter} to be used
* for communicating back to CallsManager. Subsequently, more specific methods of the service
* will be called to perform various call actions including making an outgoing call and
* disconnected existing calls.
* TODO(santoscordon): Needs more about AndroidManifest.xml service registrations before
* we can unhide this API.
*
* Most public methods of this function are backed by a one-way AIDL interface which precludes
* syncronous responses. As a result, most responses are handled by (or have TODOs to handle)
* response objects instead of return values.
* TODO(santoscordon): Improve paragraph above once the final design is in place.
* @hide
*/
public abstract class CallService extends Service {
/**
* Default Handler used to consolidate binder method calls onto a single thread.
*/
private final class CallServiceMessageHandler extends Handler {
@Override
public void handleMessage(Message msg) {
switch (msg.what) {
case MSG_SET_CALL_SERVICE_ADAPTER:
setCallServiceAdapter((ICallServiceAdapter) msg.obj);
break;
case MSG_IS_COMPATIBLE_WITH:
isCompatibleWith((String) msg.obj);
break;
case MSG_CALL:
call((String) msg.obj);
break;
case MSG_DISCONNECT:
disconnect((String) msg.obj);
break;
default:
break;
}
}
}
/**
* Default ICallService implementation provided to CallsManager via {@link #onBind}.
*/
private final class CallServiceWrapper extends ICallService.Stub {
@Override
public void setCallServiceAdapter(ICallServiceAdapter callServiceAdapter) {
mMessageHandler.obtainMessage(MSG_SET_CALL_SERVICE_ADAPTER, callServiceAdapter)
.sendToTarget();
}
@Override
public void isCompatibleWith(String handle) {
mMessageHandler.obtainMessage(MSG_IS_COMPATIBLE_WITH, handle).sendToTarget();
}
@Override
public void call(String handle) {
mMessageHandler.obtainMessage(MSG_CALL, handle).sendToTarget();
}
@Override
public void disconnect(String callId) {
mMessageHandler.obtainMessage(MSG_DISCONNECT, callId).sendToTarget();
}
}
// Only used internally by this class.
// Binder method calls on this service can occur on multiple threads. These messages are used
// in conjunction with {@link #mMessageHandler} to ensure that all callbacks are handled on a
// single thread. Keeping it on a single thread allows CallService implementations to avoid
// needing multi-threaded code in their own callback routines.
private static final int
MSG_SET_CALL_SERVICE_ADAPTER = 1,
MSG_IS_COMPATIBLE_WITH = 2,
MSG_CALL = 3,
MSG_DISCONNECT = 4;
/**
* Message handler for consolidating binder callbacks onto a single thread.
* See {@link #CallServiceMessageHandler}.
*/
private final CallServiceMessageHandler mMessageHandler;
/**
* Default binder implementation of {@link ICallService} interface.
*/
private final CallServiceWrapper mBinder;
/**
* Protected constructor called only by subclasses creates the binder interface and
* single-threaded message handler.
*/
protected CallService() {
mMessageHandler = new CallServiceMessageHandler();
mBinder = new CallServiceWrapper();
}
/** {@inheritDoc} */
public IBinder onBind(Intent intent) {
return mBinder;
}
/**
* Sets an implementation of ICallServiceAdapter for adding new calls and communicating state
* changes of existing calls.
* TODO(santoscordon): Should we not reference ICallServiceAdapter directly from here? Should we
* wrap that in a wrapper like we do for CallService/ICallService?
* @param callServiceAdapter Adapter object for communicating call to CallsManager
*/
public abstract void setCallServiceAdapter(ICallServiceAdapter callServiceAdapter);
/**
* Determines if the CallService can make calls to the handle.
* @param handle The handle to test for compatibility.
* TODO(santoscordon): Need response parameter.
*/
public abstract void isCompatibleWith(String handle);
/**
* Calls the specified handle. Handle type is dynamically extensible and can be a phone number,
* a SIP address, or other types. Only called if {@link #isCompatibleWith} returns true for the
* same handle and this service is selected by the switchboard to handle the call.
* @param handle The handle to call.
*/
public abstract void call(String handle);
/**
* Disconnects the specified call.
* @param callId The ID of the call to disconnect.
*/
public abstract void disconnect(String callId);
}

View File

@@ -33,6 +33,13 @@ import android.telecomm.ICallServiceAdapter;
*/
oneway interface ICallService {
/**
* Sets an implementation of ICallServiceAdapter which the call service can use to add new calls
* and communicate state changes of existing calls. This is the first method that is called
* after a the framework binds to the call service.
*/
void setCallServiceAdapter(ICallServiceAdapter callServiceAdapter);
/**
* Determines if the CallService can make calls to the handle.
* TODO(santoscordon): Move this method into its own service interface long term.
@@ -54,11 +61,4 @@ oneway interface ICallService {
* Disconnects the call identified by callId.
*/
void disconnect(String callId);
/**
* Sets an implementation of ICallServiceAdapter which the call service can use to add new calls
* and communicate state changes of existing calls. This is the first method that is called
* after a the framework binds to the call service.
*/
void setCallServiceAdapter(ICallServiceAdapter callServiceAdapter);
}

View File

@@ -0,0 +1,47 @@
/*
* Copyright (C) 2013 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.telecomm;
/**
* Interface for applications interested in providing call-service implementations. Only used in
* outgoing-call scenarios where the best-candidate service to issue the call over may need to be
* decided dynamically (unlike incoming call scenario where the call-service is known).
*
* Intended usage at time of writing is: Call intent received by the CallsManager, which in turn
* gathers and binds all ICallServiceProvider implementations (using the framework). The actual
* bind is between each CallServiceProvider and the CallServiceProviderAdapter. Once bound, the
* CallsManager invokes the initiateDiscoveryProtocol API of each bound provider and waits until
* either all providers reply (asynchronously) or some timeout is met. The resulted list is then
* processed by the CallsManager and its helpers (potentially requesting input from the user) to
* identify the best CallService. The user should obviously be notified upon zero candidates as
* well as all (one or more) candidates failing to issue the call.
* @hide
*/
oneway interface ICallServiceProvider {
/**
* Sets an implementation of ICallServiceProviderAdapter to allow call-service providers to
* communicate with the CallsManager.
*/
void setCallServiceProviderAdapter(ICallServiceProviderAdapter callServiceProviderAdapter);
/**
* Provides the application with the opportunity to "register" ICallServiceProvider
* implementations with the CallsManager for the purpose of issuing outgoing calls.
*/
void initiateDiscoveryProtocol();
}

View File

@@ -0,0 +1,32 @@
/*
* Copyright (C) 2013 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.telecomm;
import android.telecomm.CallService;
/**
* Provides ICallServiceProvider implementations with the relevant CallsManager APIs.
* @hide
*/
oneway interface ICallServiceProviderAdapter {
/**
* Provides the CallsManager with the services made available by this application.
* @param callServices the relevant services to make the CallManager aware of.
*/
void registerCallServices(List<CallService> callServices);
}