blob: 3b6365f4a92bbbd1cae92260d5fbde6881e34e2c [file] [log] [blame]
Santos Cordon80d9bdc2014-02-13 18:28:46 -08001/*
2 * Copyright 2014, The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.telecomm;
18
Evan Charltona05805b2014-03-05 08:21:46 -080019import android.os.Bundle;
Santos Cordon493e8f22014-02-19 03:15:12 -080020import android.telecomm.CallInfo;
Evan Charltona05805b2014-03-05 08:21:46 -080021import android.telecomm.CallService;
Santos Cordon80d9bdc2014-02-13 18:28:46 -080022
Santos Cordon80d9bdc2014-02-13 18:28:46 -080023import com.google.common.base.Preconditions;
24import com.google.common.collect.Maps;
25
26import java.util.Map;
27
28/**
Santos Cordon493e8f22014-02-19 03:15:12 -080029 * Utility class to retrieve details of an incoming call after receiving an incoming-call intent,
30 * see {@link CallActivity}. Binds with the specified call services and requests details of incoming
31 * calls. Upon receipt of the details, yields execution back to the switchboard to complete the
32 * incoming sequence. The entire process is timeboxed to protect against unresponsive call services.
Santos Cordon80d9bdc2014-02-13 18:28:46 -080033 */
34final class IncomingCallsManager {
35
Santos Cordon80d9bdc2014-02-13 18:28:46 -080036 private final Switchboard mSwitchboard;
37
Santos Cordon493e8f22014-02-19 03:15:12 -080038 /** Maps call ID to the call. */
39 private final Map<String, Call> mPendingIncomingCalls = Maps.newHashMap();
Santos Cordon80d9bdc2014-02-13 18:28:46 -080040
41 /**
42 * Persists the specified parameters.
43 *
44 * @param switchboard The switchboard.
45 */
46 IncomingCallsManager(Switchboard switchboard) {
47 mSwitchboard = switchboard;
48 }
49
Santos Cordon80d9bdc2014-02-13 18:28:46 -080050 /**
Santos Cordon493e8f22014-02-19 03:15:12 -080051 * Retrieves details of an incoming call through its associated call service (asynchronously).
Santos Cordon80d9bdc2014-02-13 18:28:46 -080052 * Starts the timeout sequence in case the call service is unresponsive.
53 *
54 * @param call The call object.
Evan Charltona05805b2014-03-05 08:21:46 -080055 * @param extras The optional extras passed with the incoming call intent (to be returned to
56 * the call service via {@link CallService#setIncomingCallId(String, android.os.Bundle)}).
Santos Cordon80d9bdc2014-02-13 18:28:46 -080057 */
Evan Charltona05805b2014-03-05 08:21:46 -080058 void retrieveIncomingCall(final Call call, Bundle extras) {
Santos Cordon80d9bdc2014-02-13 18:28:46 -080059 ThreadUtil.checkOnMainThread();
Sailesh Nepalf1c191d2014-03-07 18:17:39 -080060 Log.d(this, "retrieveIncomingCall");
Santos Cordon80d9bdc2014-02-13 18:28:46 -080061
Santos Cordon493e8f22014-02-19 03:15:12 -080062 final String callId = call.getId();
63 // Just to be safe, lets make sure we're not already processing this call.
64 Preconditions.checkState(!mPendingIncomingCalls.containsKey(callId));
65
66 mPendingIncomingCalls.put(callId, call);
67
Ben Gilad8e55d1d2014-02-26 16:25:56 -080068 Runnable errorCallback = new Runnable() {
69 @Override public void run() {
70 handleFailedIncomingCall(call);
71 }
72 };
Santos Cordon80d9bdc2014-02-13 18:28:46 -080073
Ben Gilad61925612014-03-11 19:06:36 -070074 call.getCallService().setIncomingCallId(callId, extras, errorCallback);
Santos Cordon80d9bdc2014-02-13 18:28:46 -080075 }
76
77 /**
78 * Notifies the switchboard of a successful incoming call after removing it from the pending
79 * list.
Santos Cordon80d9bdc2014-02-13 18:28:46 -080080 *
Santos Cordon493e8f22014-02-19 03:15:12 -080081 * @param callInfo The details of the call.
Santos Cordon80d9bdc2014-02-13 18:28:46 -080082 */
Santos Cordon493e8f22014-02-19 03:15:12 -080083 void handleSuccessfulIncomingCall(CallInfo callInfo) {
Santos Cordon80d9bdc2014-02-13 18:28:46 -080084 ThreadUtil.checkOnMainThread();
Santos Cordon493e8f22014-02-19 03:15:12 -080085
86 Call call = mPendingIncomingCalls.remove(callInfo.getId());
87 if (call != null) {
Sailesh Nepalf1c191d2014-03-07 18:17:39 -080088 Log.d(this, "Incoming call %s found.", call.getId());
Santos Cordon493e8f22014-02-19 03:15:12 -080089 call.setHandle(callInfo.getHandle());
90 call.setState(callInfo.getState());
91
Santos Cordon80d9bdc2014-02-13 18:28:46 -080092 mSwitchboard.handleSuccessfulIncomingCall(call);
93 }
94 }
95
96 /**
97 * Notifies switchboard of the failed incoming call after removing it from the pending list.
98 *
99 * @param call The call.
100 */
Santos Cordon493e8f22014-02-19 03:15:12 -0800101 private void handleFailedIncomingCall(Call call) {
Santos Cordon80d9bdc2014-02-13 18:28:46 -0800102 ThreadUtil.checkOnMainThread();
Santos Cordon493e8f22014-02-19 03:15:12 -0800103
104 if (mPendingIncomingCalls.remove(call.getId()) != null) {
Sailesh Nepalf1c191d2014-03-07 18:17:39 -0800105 Log.i(this, "Failed to get details for incoming call %s", call);
Santos Cordon493e8f22014-02-19 03:15:12 -0800106 // The call was found still waiting for details. Consider it failed.
Santos Cordon80d9bdc2014-02-13 18:28:46 -0800107 mSwitchboard.handleFailedIncomingCall(call);
108 }
109 }
Santos Cordon80d9bdc2014-02-13 18:28:46 -0800110}