e3cc5795c9448f3616b9b796f2e7aa9df2c6446e
[android/platform/frameworks/opt/net/ims.git] / src / java / com / android / ims / ImsManager.java
1 /*
2  * Copyright (c) 2013 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
17 package com.android.ims;
18
19 import android.app.PendingIntent;
20 import android.app.QueuedWork;
21 import android.content.Context;
22 import android.content.Intent;
23 import android.content.SharedPreferences;
24 import android.os.IBinder;
25 import android.os.Message;
26 import android.os.PersistableBundle;
27 import android.os.RemoteException;
28 import android.os.ServiceManager;
29 import android.os.SystemProperties;
30 import android.preference.PreferenceManager;
31 import android.provider.Settings;
32 import android.telecom.TelecomManager;
33 import android.telephony.CarrierConfigManager;
34 import android.telephony.Rlog;
35 import android.telephony.SubscriptionManager;
36 import android.telephony.TelephonyManager;
37
38 import com.android.ims.internal.IImsCallSession;
39 import com.android.ims.internal.IImsEcbm;
40 import com.android.ims.internal.IImsEcbmListener;
41 import com.android.ims.internal.IImsRegistrationListener;
42 import com.android.ims.internal.IImsService;
43 import com.android.ims.internal.IImsUt;
44 import com.android.ims.internal.ImsCallSession;
45 import com.android.ims.internal.IImsConfig;
46
47 import java.util.HashMap;
48
49 /**
50  * Provides APIs for IMS services, such as initiating IMS calls, and provides access to
51  * the operator's IMS network. This class is the starting point for any IMS actions.
52  * You can acquire an instance of it with {@link #getInstance getInstance()}.</p>
53  * <p>The APIs in this class allows you to:</p>
54  *
55  * @hide
56  */
57 public class ImsManager {
58
59     /*
60      * Debug flag to override configuration flag
61      */
62     public static final String PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE = "persist.dbg.volte_avail_ovr";
63     public static final int PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE_DEFAULT = 0;
64     public static final String PROPERTY_DBG_VT_AVAIL_OVERRIDE = "persist.dbg.vt_avail_ovr";
65     public static final int PROPERTY_DBG_VT_AVAIL_OVERRIDE_DEFAULT = 0;
66     public static final String PROPERTY_DBG_WFC_AVAIL_OVERRIDE = "persist.dbg.wfc_avail_ovr";
67     public static final int PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT = 0;
68
69     /**
70      * For accessing the IMS related service.
71      * Internal use only.
72      * @hide
73      */
74     private static final String IMS_SERVICE = "ims";
75
76     /**
77      * The result code to be sent back with the incoming call {@link PendingIntent}.
78      * @see #open(PendingIntent, ImsConnectionStateListener)
79      */
80     public static final int INCOMING_CALL_RESULT_CODE = 101;
81
82     /**
83      * Key to retrieve the call ID from an incoming call intent.
84      * @see #open(PendingIntent, ImsConnectionStateListener)
85      */
86     public static final String EXTRA_CALL_ID = "android:imsCallID";
87
88     /**
89      * Action to broadcast when ImsService is up.
90      * Internal use only.
91      * @hide
92      */
93     public static final String ACTION_IMS_SERVICE_UP =
94             "com.android.ims.IMS_SERVICE_UP";
95
96     /**
97      * Action to broadcast when ImsService is down.
98      * Internal use only.
99      * @hide
100      */
101     public static final String ACTION_IMS_SERVICE_DOWN =
102             "com.android.ims.IMS_SERVICE_DOWN";
103
104     /**
105      * Action to broadcast when ImsService registration fails.
106      * Internal use only.
107      * @hide
108      */
109     public static final String ACTION_IMS_REGISTRATION_ERROR =
110             "com.android.ims.REGISTRATION_ERROR";
111
112     /**
113      * Part of the ACTION_IMS_SERVICE_UP or _DOWN intents.
114      * A long value; the phone ID corresponding to the IMS service coming up or down.
115      * Internal use only.
116      * @hide
117      */
118     public static final String EXTRA_PHONE_ID = "android:phone_id";
119
120     /**
121      * Action for the incoming call intent for the Phone app.
122      * Internal use only.
123      * @hide
124      */
125     public static final String ACTION_IMS_INCOMING_CALL =
126             "com.android.ims.IMS_INCOMING_CALL";
127
128     /**
129      * Part of the ACTION_IMS_INCOMING_CALL intents.
130      * An integer value; service identifier obtained from {@link ImsManager#open}.
131      * Internal use only.
132      * @hide
133      */
134     public static final String EXTRA_SERVICE_ID = "android:imsServiceId";
135
136     /**
137      * Part of the ACTION_IMS_INCOMING_CALL intents.
138      * An boolean value; Flag to indicate that the incoming call is a normal call or call for USSD.
139      * The value "true" indicates that the incoming call is for USSD.
140      * Internal use only.
141      * @hide
142      */
143     public static final String EXTRA_USSD = "android:ussd";
144
145     /**
146      * Part of the ACTION_IMS_INCOMING_CALL intents.
147      * A boolean value; Flag to indicate whether the call is an unknown
148      * dialing call. Such calls are originated by sending commands (like
149      * AT commands) directly to modem without Android involvement.
150      * Even though they are not incoming calls, they are propagated
151      * to Phone app using same ACTION_IMS_INCOMING_CALL intent.
152      * Internal use only.
153      * @hide
154      */
155     public static final String EXTRA_IS_UNKNOWN_CALL = "android:isUnknown";
156
157     private static final String TAG = "ImsManager";
158     private static final boolean DBG = true;
159
160     private static HashMap<Integer, ImsManager> sImsManagerInstances =
161             new HashMap<Integer, ImsManager>();
162
163     private Context mContext;
164     private int mPhoneId;
165     private IImsService mImsService = null;
166     private ImsServiceDeathRecipient mDeathRecipient = new ImsServiceDeathRecipient();
167     // Ut interface for the supplementary service configuration
168     private ImsUt mUt = null;
169     // Interface to get/set ims config items
170     private ImsConfig mConfig = null;
171     private boolean mConfigUpdated = false;
172     private static final String PREF_ENABLE_VIDEO_CALLING_KEY = "enable_video_calling";
173
174     // ECBM interface
175     private ImsEcbm mEcbm = null;
176
177     /**
178      * Gets a manager instance.
179      *
180      * @param context application context for creating the manager object
181      * @param phoneId the phone ID for the IMS Service
182      * @return the manager instance corresponding to the phoneId
183      */
184     public static ImsManager getInstance(Context context, int phoneId) {
185         synchronized (sImsManagerInstances) {
186             if (sImsManagerInstances.containsKey(phoneId))
187                 return sImsManagerInstances.get(phoneId);
188
189             ImsManager mgr = new ImsManager(context, phoneId);
190             sImsManagerInstances.put(phoneId, mgr);
191
192             return mgr;
193         }
194     }
195
196     /**
197      * Returns the user configuration of Enhanced 4G LTE Mode setting
198      */
199     public static boolean isEnhanced4gLteModeSettingEnabledByUser(Context context) {
200         int enabled = android.provider.Settings.Global.getInt(
201                     context.getContentResolver(),
202                     android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED, ImsConfig.FeatureValueConstants.ON);
203         return (enabled == 1) ? true : false;
204     }
205
206     /**
207      * Change persistent Enhanced 4G LTE Mode setting
208      */
209     public static void setEnhanced4gLteModeSetting(Context context, boolean enabled) {
210         int value = enabled ? 1 : 0;
211         android.provider.Settings.Global.putInt(
212                 context.getContentResolver(),
213                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED, value);
214
215         if (isNonTtyOrTtyOnVolteEnabled(context)) {
216             ImsManager imsManager = ImsManager.getInstance(context,
217                     SubscriptionManager.getDefaultVoicePhoneId());
218             if (imsManager != null) {
219                 try {
220                     imsManager.setAdvanced4GMode(enabled);
221                 } catch (ImsException ie) {
222                     // do nothing
223                 }
224             }
225         }
226     }
227
228     /**
229      * Indicates whether the call is non-TTY or if TTY - whether TTY on VoLTE is
230      * supported.
231      */
232     public static boolean isNonTtyOrTtyOnVolteEnabled(Context context) {
233         if (getBooleanCarrierConfig(context,
234                     CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
235             return true;
236         }
237
238         return Settings.Secure.getInt(context.getContentResolver(),
239                 Settings.Secure.PREFERRED_TTY_MODE, TelecomManager.TTY_MODE_OFF)
240                 == TelecomManager.TTY_MODE_OFF;
241     }
242
243     /**
244      * Returns a platform configuration for VoLTE which may override the user setting.
245      */
246     public static boolean isVolteEnabledByPlatform(Context context) {
247         if (SystemProperties.getInt(PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE,
248                 PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE_DEFAULT) == 1) {
249             return true;
250         }
251
252         return context.getResources().getBoolean(
253                 com.android.internal.R.bool.config_device_volte_available)
254                 && getBooleanCarrierConfig(context,
255                         CarrierConfigManager.KEY_CARRIER_VOLTE_AVAILABLE_BOOL)
256                 && isGbaValid(context);
257     }
258
259     /*
260      * Indicates whether VoLTE is provisioned on device
261      */
262     public static boolean isVolteProvisionedOnDevice(Context context) {
263         boolean isProvisioned = true;
264         if (getBooleanCarrierConfig(context,
265                     CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
266             isProvisioned = false; // disable on any error
267             ImsManager mgr = ImsManager.getInstance(context,
268                     SubscriptionManager.getDefaultVoicePhoneId());
269             if (mgr != null) {
270                 try {
271                     ImsConfig config = mgr.getConfigInterface();
272                     if (config != null) {
273                         isProvisioned = config.getVolteProvisioned();
274                     }
275                 } catch (ImsException ie) {
276                     // do nothing
277                 }
278             }
279         }
280
281         return isProvisioned;
282     }
283
284     /**
285      * Returns a platform configuration for VT which may override the user setting.
286      *
287      * Note: VT presumes that VoLTE is enabled (these are configuration settings
288      * which must be done correctly).
289      */
290     public static boolean isVtEnabledByPlatform(Context context) {
291         if (SystemProperties.getInt(PROPERTY_DBG_VT_AVAIL_OVERRIDE,
292                 PROPERTY_DBG_VT_AVAIL_OVERRIDE_DEFAULT) == 1) {
293             return true;
294         }
295
296         return
297                 context.getResources().getBoolean(
298                         com.android.internal.R.bool.config_device_vt_available) &&
299                 getBooleanCarrierConfig(context,
300                         CarrierConfigManager.KEY_CARRIER_VT_AVAILABLE_BOOL) &&
301                 isGbaValid(context);
302     }
303
304     /**
305      * Returns the user configuration of VT setting
306      */
307     public static boolean isVtEnabledByUser(Context context) {
308         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
309                 android.provider.Settings.Global.VT_IMS_ENABLED,
310                 ImsConfig.FeatureValueConstants.ON);
311         return (enabled == 1) ? true : false;
312     }
313
314     /**
315      * Change persistent VT enabled setting
316      */
317     public static void setVtSetting(Context context, boolean enabled) {
318         int value = enabled ? 1 : 0;
319         android.provider.Settings.Global.putInt(context.getContentResolver(),
320                 android.provider.Settings.Global.VT_IMS_ENABLED, value);
321
322         ImsManager imsManager = ImsManager.getInstance(context,
323                 SubscriptionManager.getDefaultVoicePhoneId());
324         if (imsManager != null) {
325             try {
326                 ImsConfig config = imsManager.getConfigInterface();
327                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
328                         TelephonyManager.NETWORK_TYPE_LTE,
329                         enabled ? ImsConfig.FeatureValueConstants.ON
330                                 : ImsConfig.FeatureValueConstants.OFF, null);
331
332                 if (enabled) {
333                     imsManager.turnOnIms();
334                 } else if (getBooleanCarrierConfig(context,
335                         CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
336                         && (!isVolteEnabledByPlatform(context)
337                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
338                     log("setVtSetting() : imsServiceAllowTurnOff -> turnOffIms");
339                     imsManager.turnOffIms();
340                 }
341             } catch (ImsException e) {
342                 loge("setVtSetting(): " + e);
343             }
344         }
345     }
346
347     /**
348      * Returns the user configuration of WFC setting
349      */
350     public static boolean isWfcEnabledByUser(Context context) {
351         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
352                 android.provider.Settings.Global.WFC_IMS_ENABLED,
353                 ImsConfig.FeatureValueConstants.OFF);
354         return (enabled == 1) ? true : false;
355     }
356
357     /**
358      * Change persistent WFC enabled setting
359      */
360     public static void setWfcSetting(Context context, boolean enabled) {
361         int value = enabled ? 1 : 0;
362         android.provider.Settings.Global.putInt(context.getContentResolver(),
363                 android.provider.Settings.Global.WFC_IMS_ENABLED, value);
364
365         ImsManager imsManager = ImsManager.getInstance(context,
366                 SubscriptionManager.getDefaultVoicePhoneId());
367         if (imsManager != null) {
368             try {
369                 ImsConfig config = imsManager.getConfigInterface();
370                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
371                         TelephonyManager.NETWORK_TYPE_IWLAN,
372                         enabled ? ImsConfig.FeatureValueConstants.ON
373                                 : ImsConfig.FeatureValueConstants.OFF, null);
374
375                 if (enabled) {
376                     imsManager.turnOnIms();
377                 } else if (getBooleanCarrierConfig(context,
378                         CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
379                         && (!isVolteEnabledByPlatform(context)
380                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
381                     log("setWfcSetting() : imsServiceAllowTurnOff -> turnOffIms");
382                     imsManager.turnOffIms();
383                 }
384
385                 // Force IMS to register over LTE when turning off WFC
386                 setWfcModeInternal(context, enabled
387                         ? getWfcMode(context)
388                         : ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED);
389             } catch (ImsException e) {
390                 loge("setWfcSetting(): " + e);
391             }
392         }
393     }
394
395     /**
396      * Returns the user configuration of WFC modem setting
397      */
398     public static int getWfcMode(Context context) {
399         int setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
400                 android.provider.Settings.Global.WFC_IMS_MODE,
401                 ImsConfig.WfcModeFeatureValueConstants.WIFI_PREFERRED);
402         if (DBG) log("getWfcMode - setting=" + setting);
403         return setting;
404     }
405
406     /**
407      * Returns the user configuration of WFC modem setting
408      */
409     public static void setWfcMode(Context context, int wfcMode) {
410         if (DBG) log("setWfcMode - setting=" + wfcMode);
411         android.provider.Settings.Global.putInt(context.getContentResolver(),
412                 android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
413
414         setWfcModeInternal(context, wfcMode);
415     }
416
417     private static void setWfcModeInternal(Context context, int wfcMode) {
418         final ImsManager imsManager = ImsManager.getInstance(context,
419                 SubscriptionManager.getDefaultVoicePhoneId());
420         if (imsManager != null) {
421             final int value = wfcMode;
422             QueuedWork.singleThreadExecutor().submit(new Runnable() {
423                 public void run() {
424                     try {
425                         imsManager.getConfigInterface().setProvisionedValue(
426                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_MODE,
427                                 value);
428                     } catch (ImsException e) {
429                         // do nothing
430                     }
431                 }
432             });
433         }
434     }
435
436     /**
437      * Returns the user configuration of WFC roaming setting
438      */
439     public static boolean isWfcRoamingEnabledByUser(Context context) {
440         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
441                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
442                 ImsConfig.FeatureValueConstants.OFF);
443         return (enabled == 1) ? true : false;
444     }
445
446     /**
447      * Change persistent WFC roaming enabled setting
448      */
449     public static void setWfcRoamingSetting(Context context, boolean enabled) {
450         android.provider.Settings.Global.putInt(context.getContentResolver(),
451                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
452                 enabled
453                         ? ImsConfig.FeatureValueConstants.ON
454                         : ImsConfig.FeatureValueConstants.OFF);
455
456         setWfcRoamingSettingInternal(context, enabled);
457     }
458
459     private static void setWfcRoamingSettingInternal(Context context, boolean enabled) {
460         final ImsManager imsManager = ImsManager.getInstance(context,
461                 SubscriptionManager.getDefaultVoicePhoneId());
462         if (imsManager != null) {
463             final int value = enabled
464                     ? ImsConfig.FeatureValueConstants.ON
465                     : ImsConfig.FeatureValueConstants.OFF;
466             QueuedWork.singleThreadExecutor().submit(new Runnable() {
467                 public void run() {
468                     try {
469                         imsManager.getConfigInterface().setProvisionedValue(
470                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_ROAMING,
471                                 value);
472                     } catch (ImsException e) {
473                         // do nothing
474                     }
475                 }
476             });
477         }
478     }
479
480     /**
481      * Returns a platform configuration for WFC which may override the user
482      * setting. Note: WFC presumes that VoLTE is enabled (these are
483      * configuration settings which must be done correctly).
484      */
485     public static boolean isWfcEnabledByPlatform(Context context) {
486         if (SystemProperties.getInt(PROPERTY_DBG_WFC_AVAIL_OVERRIDE,
487                 PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT) == 1) {
488             return true;
489         }
490
491         return
492                context.getResources().getBoolean(
493                        com.android.internal.R.bool.config_device_wfc_ims_available) &&
494                getBooleanCarrierConfig(context,
495                        CarrierConfigManager.KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL) &&
496                isGbaValid(context);
497     }
498
499     /**
500      * If carrier requires that IMS is only available if GBA capable SIM is used,
501      * then this function checks GBA bit in EF IST.
502      *
503      * Format of EF IST is defined in 3GPP TS 31.103 (Section 4.2.7).
504      */
505     private static boolean isGbaValid(Context context) {
506         if (getBooleanCarrierConfig(context,
507                 CarrierConfigManager.KEY_CARRIER_IMS_GBA_REQUIRED_BOOL)) {
508             final TelephonyManager telephonyManager = TelephonyManager.getDefault();
509             String efIst = telephonyManager.getIsimIst();
510             if (efIst == null) {
511                 loge("ISF is NULL");
512                 return true;
513             }
514             boolean result = efIst != null && efIst.length() > 1 &&
515                     (0x02 & (byte)efIst.charAt(1)) != 0;
516             if (DBG) log("GBA capable=" + result + ", ISF=" + efIst);
517             return result;
518         }
519         return true;
520     }
521
522     /**
523      * Sync carrier config and user settings with ImsConfig.
524      *
525      * @param context for the manager object
526      * @param phoneId phone id
527      * @param force update
528      */
529     public static void updateImsServiceConfig(Context context, int phoneId, boolean force) {
530         final ImsManager imsManager = ImsManager.getInstance(context, phoneId);
531         if (imsManager != null && (!imsManager.mConfigUpdated || force)) {
532             try {
533                 boolean isImsUsed = imsManager.updateVolteFeatureValue();
534                 isImsUsed |= imsManager.updateVideoCallFeatureValue();
535                 isImsUsed |= imsManager.updateWfcFeatureAndProvisionedValues();
536
537                 if (isImsUsed || !getBooleanCarrierConfig(context,
538                       CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)) {
539                     // Turn on IMS if it is used.
540                     // Also, if turning off is not allowed for current carrier,
541                     // we need to turn IMS on because it might be turned off before
542                     // phone switched to current carrier.
543                     imsManager.turnOnIms();
544                 } else {
545                     // Turn off IMS if it is not used AND turning off is allowed for carrier.
546                     imsManager.turnOffIms();
547                 }
548
549                 imsManager.mConfigUpdated = true;
550             } catch (ImsException e) {
551                 loge("updateImsServiceConfig: " + e);
552                 imsManager.mConfigUpdated = false;
553             }
554         }
555     }
556
557     /**
558      * Update VoLTE config
559      * @return whether feature is On
560      * @throws ImsException
561      */
562     private boolean updateVolteFeatureValue() throws ImsException {
563         boolean available = isVolteEnabledByPlatform(mContext);
564         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext);
565         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
566         boolean isFeatureOn = available && enabled && isNonTty;
567
568         log("updateVolteFeatureValue: available = " + available
569                 + ", enabled = " + enabled
570                 + ", nonTTY = " + isNonTty);
571
572         getConfigInterface().setFeatureValue(
573                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
574                 TelephonyManager.NETWORK_TYPE_LTE,
575                 isFeatureOn ?
576                         ImsConfig.FeatureValueConstants.ON :
577                         ImsConfig.FeatureValueConstants.OFF,
578                 null);
579
580         return isFeatureOn;
581     }
582
583     /**
584      * Update VC config
585      * @return whether feature is On
586      * @throws ImsException
587      */
588     private boolean updateVideoCallFeatureValue() throws ImsException {
589         boolean available = isVtEnabledByPlatform(mContext);
590         SharedPreferences sharedPrefs =
591                 PreferenceManager.getDefaultSharedPreferences(mContext);
592         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext) &&
593                 sharedPrefs.getBoolean(PREF_ENABLE_VIDEO_CALLING_KEY, true);
594         boolean isNonTty = Settings.Secure.getInt(mContext.getContentResolver(),
595                 Settings.Secure.PREFERRED_TTY_MODE, TelecomManager.TTY_MODE_OFF)
596                 == TelecomManager.TTY_MODE_OFF;
597         boolean isFeatureOn = available && enabled && isNonTty;
598
599         log("updateVideoCallFeatureValue: available = " + available
600                 + ", enabled = " + enabled
601                 + ", nonTTY = " + isNonTty);
602
603         getConfigInterface().setFeatureValue(
604                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
605                 TelephonyManager.NETWORK_TYPE_LTE,
606                 isFeatureOn ?
607                         ImsConfig.FeatureValueConstants.ON :
608                         ImsConfig.FeatureValueConstants.OFF,
609                 null);
610
611         return isFeatureOn;
612     }
613
614     /**
615      * Update WFC config
616      * @return whether feature is On
617      * @throws ImsException
618      */
619     private boolean updateWfcFeatureAndProvisionedValues() throws ImsException {
620         boolean available = isWfcEnabledByPlatform(mContext);
621         boolean enabled = isWfcEnabledByUser(mContext);
622         int mode = getWfcMode(mContext);
623         boolean roaming = isWfcRoamingEnabledByUser(mContext);
624         boolean isFeatureOn = available && enabled;
625
626         log("updateWfcFeatureAndProvisionedValues: available = " + available
627                 + ", enabled = " + enabled
628                 + ", mode = " + mode
629                 + ", roaming = " + roaming);
630
631         getConfigInterface().setFeatureValue(
632                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
633                 TelephonyManager.NETWORK_TYPE_IWLAN,
634                 isFeatureOn ?
635                         ImsConfig.FeatureValueConstants.ON :
636                         ImsConfig.FeatureValueConstants.OFF,
637                 null);
638
639         if (!isFeatureOn) {
640             mode = ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED;
641             roaming = false;
642         }
643         setWfcModeInternal(mContext, mode);
644         setWfcRoamingSettingInternal(mContext, roaming);
645
646         return isFeatureOn;
647     }
648
649     private ImsManager(Context context, int phoneId) {
650         mContext = context;
651         mPhoneId = phoneId;
652         createImsService(true);
653     }
654
655     /*
656      * Returns a flag indicating whether the IMS service is available.
657      */
658     public boolean isServiceAvailable() {
659         if (mImsService != null) {
660             return true;
661         }
662
663         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
664         if (binder != null) {
665             return true;
666         }
667
668         return false;
669     }
670
671     /**
672      * Opens the IMS service for making calls and/or receiving generic IMS calls.
673      * The caller may make subsquent calls through {@link #makeCall}.
674      * The IMS service will register the device to the operator's network with the credentials
675      * (from ISIM) periodically in order to receive calls from the operator's network.
676      * When the IMS service receives a new call, it will send out an intent with
677      * the provided action string.
678      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
679      *
680      * @param serviceClass a service class specified in {@link ImsServiceClass}
681      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
682      * @param incomingCallPendingIntent When an incoming call is received,
683      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
684      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
685      *        as the result code and the intent to fill in the call ID; It cannot be null
686      * @param listener To listen to IMS registration events; It cannot be null
687      * @return identifier (greater than 0) for the specified service
688      * @throws NullPointerException if {@code incomingCallPendingIntent}
689      *      or {@code listener} is null
690      * @throws ImsException if calling the IMS service results in an error
691      * @see #getCallId
692      * @see #getServiceId
693      */
694     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
695             ImsConnectionStateListener listener) throws ImsException {
696         checkAndThrowExceptionIfServiceUnavailable();
697
698         if (incomingCallPendingIntent == null) {
699             throw new NullPointerException("incomingCallPendingIntent can't be null");
700         }
701
702         if (listener == null) {
703             throw new NullPointerException("listener can't be null");
704         }
705
706         int result = 0;
707
708         try {
709             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
710                     createRegistrationListenerProxy(serviceClass, listener));
711         } catch (RemoteException e) {
712             throw new ImsException("open()", e,
713                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
714         }
715
716         if (result <= 0) {
717             // If the return value is a minus value,
718             // it means that an error occurred in the service.
719             // So, it needs to convert to the reason code specified in ImsReasonInfo.
720             throw new ImsException("open()", (result * (-1)));
721         }
722
723         return result;
724     }
725
726     /**
727      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
728      * All the resources that were allocated to the service are also released.
729      *
730      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
731      * @throws ImsException if calling the IMS service results in an error
732      */
733     public void close(int serviceId) throws ImsException {
734         checkAndThrowExceptionIfServiceUnavailable();
735
736         try {
737             mImsService.close(serviceId);
738         } catch (RemoteException e) {
739             throw new ImsException("close()", e,
740                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
741         } finally {
742             mUt = null;
743             mConfig = null;
744             mEcbm = null;
745         }
746     }
747
748     /**
749      * Gets the configuration interface to provision / withdraw the supplementary service settings.
750      *
751      * @param serviceId a service id which is obtained from {@link ImsManager#open}
752      * @return the Ut interface instance
753      * @throws ImsException if getting the Ut interface results in an error
754      */
755     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
756             throws ImsException {
757         // FIXME: manage the multiple Ut interfaces based on the service id
758         if (mUt == null) {
759             checkAndThrowExceptionIfServiceUnavailable();
760
761             try {
762                 IImsUt iUt = mImsService.getUtInterface(serviceId);
763
764                 if (iUt == null) {
765                     throw new ImsException("getSupplementaryServiceConfiguration()",
766                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
767                 }
768
769                 mUt = new ImsUt(iUt);
770             } catch (RemoteException e) {
771                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
772                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
773             }
774         }
775
776         return mUt;
777     }
778
779     /**
780      * Checks if the IMS service has successfully registered to the IMS network
781      * with the specified service & call type.
782      *
783      * @param serviceId a service id which is obtained from {@link ImsManager#open}
784      * @param serviceType a service type that is specified in {@link ImsCallProfile}
785      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
786      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
787      * @param callType a call type that is specified in {@link ImsCallProfile}
788      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
789      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
790      *        {@link ImsCallProfile#CALL_TYPE_VT}
791      *        {@link ImsCallProfile#CALL_TYPE_VS}
792      * @return true if the specified service id is connected to the IMS network;
793      *        false otherwise
794      * @throws ImsException if calling the IMS service results in an error
795      */
796     public boolean isConnected(int serviceId, int serviceType, int callType)
797             throws ImsException {
798         checkAndThrowExceptionIfServiceUnavailable();
799
800         try {
801             return mImsService.isConnected(serviceId, serviceType, callType);
802         } catch (RemoteException e) {
803             throw new ImsException("isServiceConnected()", e,
804                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
805         }
806     }
807
808     /**
809      * Checks if the specified IMS service is opend.
810      *
811      * @param serviceId a service id which is obtained from {@link ImsManager#open}
812      * @return true if the specified service id is opened; false otherwise
813      * @throws ImsException if calling the IMS service results in an error
814      */
815     public boolean isOpened(int serviceId) throws ImsException {
816         checkAndThrowExceptionIfServiceUnavailable();
817
818         try {
819             return mImsService.isOpened(serviceId);
820         } catch (RemoteException e) {
821             throw new ImsException("isOpened()", e,
822                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
823         }
824     }
825
826     /**
827      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
828      *
829      * @param serviceId a service id which is obtained from {@link ImsManager#open}
830      * @param serviceType a service type that is specified in {@link ImsCallProfile}
831      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
832      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
833      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
834      * @param callType a call type that is specified in {@link ImsCallProfile}
835      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
836      *        {@link ImsCallProfile#CALL_TYPE_VT}
837      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
838      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
839      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
840      *        {@link ImsCallProfile#CALL_TYPE_VS}
841      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
842      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
843      * @return a {@link ImsCallProfile} object
844      * @throws ImsException if calling the IMS service results in an error
845      */
846     public ImsCallProfile createCallProfile(int serviceId,
847             int serviceType, int callType) throws ImsException {
848         checkAndThrowExceptionIfServiceUnavailable();
849
850         try {
851             return mImsService.createCallProfile(serviceId, serviceType, callType);
852         } catch (RemoteException e) {
853             throw new ImsException("createCallProfile()", e,
854                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
855         }
856     }
857
858     /**
859      * Creates a {@link ImsCall} to make a call.
860      *
861      * @param serviceId a service id which is obtained from {@link ImsManager#open}
862      * @param profile a call profile to make the call
863      *      (it contains service type, call type, media information, etc.)
864      * @param participants participants to invite the conference call
865      * @param listener listen to the call events from {@link ImsCall}
866      * @return a {@link ImsCall} object
867      * @throws ImsException if calling the IMS service results in an error
868      */
869     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
870             ImsCall.Listener listener) throws ImsException {
871         if (DBG) {
872             log("makeCall :: serviceId=" + serviceId
873                     + ", profile=" + profile + ", callees=" + callees);
874         }
875
876         checkAndThrowExceptionIfServiceUnavailable();
877
878         ImsCall call = new ImsCall(mContext, profile);
879
880         call.setListener(listener);
881         ImsCallSession session = createCallSession(serviceId, profile);
882
883         if ((callees != null) && (callees.length == 1)) {
884             call.start(session, callees[0]);
885         } else {
886             call.start(session, callees);
887         }
888
889         return call;
890     }
891
892     /**
893      * Creates a {@link ImsCall} to take an incoming call.
894      *
895      * @param serviceId a service id which is obtained from {@link ImsManager#open}
896      * @param incomingCallIntent the incoming call broadcast intent
897      * @param listener to listen to the call events from {@link ImsCall}
898      * @return a {@link ImsCall} object
899      * @throws ImsException if calling the IMS service results in an error
900      */
901     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
902             ImsCall.Listener listener) throws ImsException {
903         if (DBG) {
904             log("takeCall :: serviceId=" + serviceId
905                     + ", incomingCall=" + incomingCallIntent);
906         }
907
908         checkAndThrowExceptionIfServiceUnavailable();
909
910         if (incomingCallIntent == null) {
911             throw new ImsException("Can't retrieve session with null intent",
912                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
913         }
914
915         int incomingServiceId = getServiceId(incomingCallIntent);
916
917         if (serviceId != incomingServiceId) {
918             throw new ImsException("Service id is mismatched in the incoming call intent",
919                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
920         }
921
922         String callId = getCallId(incomingCallIntent);
923
924         if (callId == null) {
925             throw new ImsException("Call ID missing in the incoming call intent",
926                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
927         }
928
929         try {
930             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
931
932             if (session == null) {
933                 throw new ImsException("No pending session for the call",
934                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
935             }
936
937             ImsCall call = new ImsCall(mContext, session.getCallProfile());
938
939             call.attachSession(new ImsCallSession(session));
940             call.setListener(listener);
941
942             return call;
943         } catch (Throwable t) {
944             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
945         }
946     }
947
948     /**
949      * Gets the config interface to get/set service/capability parameters.
950      *
951      * @return the ImsConfig instance.
952      * @throws ImsException if getting the setting interface results in an error.
953      */
954     public ImsConfig getConfigInterface() throws ImsException {
955
956         if (mConfig == null) {
957             checkAndThrowExceptionIfServiceUnavailable();
958
959             try {
960                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
961                 if (config == null) {
962                     throw new ImsException("getConfigInterface()",
963                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
964                 }
965                 mConfig = new ImsConfig(config, mContext);
966             } catch (RemoteException e) {
967                 throw new ImsException("getConfigInterface()", e,
968                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
969             }
970         }
971         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
972         return mConfig;
973     }
974
975     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
976             throws ImsException {
977
978         checkAndThrowExceptionIfServiceUnavailable();
979
980         try {
981             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
982         } catch (RemoteException e) {
983             throw new ImsException("setTTYMode()", e,
984                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
985         }
986
987         if (!getBooleanCarrierConfig(context,
988                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
989             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
990                     isEnhanced4gLteModeSettingEnabledByUser(context));
991         }
992     }
993
994     /**
995      * Get the boolean config from carrier config manager.
996      *
997      * @param context the context to get carrier service
998      * @param key config key defined in CarrierConfigManager
999      * @return boolean value of corresponding key.
1000      */
1001     private static boolean getBooleanCarrierConfig(Context context, String key) {
1002         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1003                 Context.CARRIER_CONFIG_SERVICE);
1004         PersistableBundle b = null;
1005         if (configManager != null) {
1006             b = configManager.getConfig();
1007         }
1008         if (b != null) {
1009             return b.getBoolean(key);
1010         } else {
1011             // Return static default defined in CarrierConfigManager.
1012             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
1013         }
1014     }
1015
1016     /**
1017      * Gets the call ID from the specified incoming call broadcast intent.
1018      *
1019      * @param incomingCallIntent the incoming call broadcast intent
1020      * @return the call ID or null if the intent does not contain it
1021      */
1022     private static String getCallId(Intent incomingCallIntent) {
1023         if (incomingCallIntent == null) {
1024             return null;
1025         }
1026
1027         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
1028     }
1029
1030     /**
1031      * Gets the service type from the specified incoming call broadcast intent.
1032      *
1033      * @param incomingCallIntent the incoming call broadcast intent
1034      * @return the service identifier or -1 if the intent does not contain it
1035      */
1036     private static int getServiceId(Intent incomingCallIntent) {
1037         if (incomingCallIntent == null) {
1038             return (-1);
1039         }
1040
1041         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
1042     }
1043
1044     /**
1045      * Binds the IMS service only if the service is not created.
1046      */
1047     private void checkAndThrowExceptionIfServiceUnavailable()
1048             throws ImsException {
1049         if (mImsService == null) {
1050             createImsService(true);
1051
1052             if (mImsService == null) {
1053                 throw new ImsException("Service is unavailable",
1054                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1055             }
1056         }
1057     }
1058
1059     private static String getImsServiceName(int phoneId) {
1060         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
1061         return IMS_SERVICE;
1062     }
1063
1064     /**
1065      * Binds the IMS service to make/receive the call.
1066      */
1067     private void createImsService(boolean checkService) {
1068         if (checkService) {
1069             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
1070
1071             if (binder == null) {
1072                 return;
1073             }
1074         }
1075
1076         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
1077
1078         if (b != null) {
1079             try {
1080                 b.linkToDeath(mDeathRecipient, 0);
1081             } catch (RemoteException e) {
1082             }
1083         }
1084
1085         mImsService = IImsService.Stub.asInterface(b);
1086     }
1087
1088     /**
1089      * Creates a {@link ImsCallSession} with the specified call profile.
1090      * Use other methods, if applicable, instead of interacting with
1091      * {@link ImsCallSession} directly.
1092      *
1093      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1094      * @param profile a call profile to make the call
1095      */
1096     private ImsCallSession createCallSession(int serviceId,
1097             ImsCallProfile profile) throws ImsException {
1098         try {
1099             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
1100         } catch (RemoteException e) {
1101             return null;
1102         }
1103     }
1104
1105     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
1106             ImsConnectionStateListener listener) {
1107         ImsRegistrationListenerProxy proxy =
1108                 new ImsRegistrationListenerProxy(serviceClass, listener);
1109         return proxy;
1110     }
1111
1112     private static void log(String s) {
1113         Rlog.d(TAG, s);
1114     }
1115
1116     private static void loge(String s) {
1117         Rlog.e(TAG, s);
1118     }
1119
1120     private static void loge(String s, Throwable t) {
1121         Rlog.e(TAG, s, t);
1122     }
1123
1124     /**
1125      * Used for turning on IMS.if its off already
1126      */
1127     private void turnOnIms() throws ImsException {
1128         checkAndThrowExceptionIfServiceUnavailable();
1129
1130         try {
1131             mImsService.turnOnIms(mPhoneId);
1132         } catch (RemoteException e) {
1133             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1134         }
1135     }
1136
1137     private boolean isImsTurnOffAllowed() {
1138         return getBooleanCarrierConfig(mContext,
1139                 CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
1140                 && (!isWfcEnabledByPlatform(mContext)
1141                 || !isWfcEnabledByUser(mContext));
1142     }
1143
1144     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
1145         checkAndThrowExceptionIfServiceUnavailable();
1146
1147         try {
1148             ImsConfig config = getConfigInterface();
1149             if (config != null && (turnOn || !isImsTurnOffAllowed())) {
1150                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
1151                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
1152                 if (isVtEnabledByPlatform(mContext)) {
1153                     // TODO: once VT is available on platform:
1154                     // - replace the '1' with the current user configuration of VT.
1155                     // - separate exception checks for setFeatureValue() failures for VoLTE and VT.
1156                     //   I.e. if VoLTE fails still try to configure VT.
1157                     config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
1158                             TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
1159                 }
1160             }
1161         } catch (ImsException e) {
1162             log("setAdvanced4GMode() : " + e);
1163         }
1164         if (turnOn) {
1165             turnOnIms();
1166         } else if (isImsTurnOffAllowed()) {
1167             log("setAdvanced4GMode() : imsServiceAllowTurnOff -> turnOffIms");
1168             turnOffIms();
1169         }
1170     }
1171
1172     /**
1173      * Used for turning off IMS completely in order to make the device CSFB'ed.
1174      * Once turned off, all calls will be over CS.
1175      */
1176     private void turnOffIms() throws ImsException {
1177         checkAndThrowExceptionIfServiceUnavailable();
1178
1179         try {
1180             mImsService.turnOffIms(mPhoneId);
1181         } catch (RemoteException e) {
1182             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1183         }
1184     }
1185
1186     /**
1187      * Death recipient class for monitoring IMS service.
1188      */
1189     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
1190         @Override
1191         public void binderDied() {
1192             mImsService = null;
1193             mUt = null;
1194             mConfig = null;
1195             mEcbm = null;
1196
1197             if (mContext != null) {
1198                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
1199                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
1200                 mContext.sendBroadcast(new Intent(intent));
1201             }
1202         }
1203     }
1204
1205     /**
1206      * Adapter class for {@link IImsRegistrationListener}.
1207      */
1208     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
1209         private int mServiceClass;
1210         private ImsConnectionStateListener mListener;
1211
1212         public ImsRegistrationListenerProxy(int serviceClass,
1213                 ImsConnectionStateListener listener) {
1214             mServiceClass = serviceClass;
1215             mListener = listener;
1216         }
1217
1218         public boolean isSameProxy(int serviceClass) {
1219             return (mServiceClass == serviceClass);
1220         }
1221
1222         @Override
1223         public void registrationConnected() {
1224             if (DBG) {
1225                 log("registrationConnected ::");
1226             }
1227
1228             if (mListener != null) {
1229                 mListener.onImsConnected();
1230             }
1231         }
1232
1233         @Override
1234         public void registrationProgressing() {
1235             if (DBG) {
1236                 log("registrationProgressing ::");
1237             }
1238
1239             if (mListener != null) {
1240                 mListener.onImsProgressing();
1241             }
1242         }
1243
1244         @Override
1245         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1246             if (DBG) {
1247                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1248             }
1249
1250             if (mListener != null) {
1251                 mListener.onImsDisconnected(imsReasonInfo);
1252             }
1253         }
1254
1255         @Override
1256         public void registrationResumed() {
1257             if (DBG) {
1258                 log("registrationResumed ::");
1259             }
1260
1261             if (mListener != null) {
1262                 mListener.onImsResumed();
1263             }
1264         }
1265
1266         @Override
1267         public void registrationSuspended() {
1268             if (DBG) {
1269                 log("registrationSuspended ::");
1270             }
1271
1272             if (mListener != null) {
1273                 mListener.onImsSuspended();
1274             }
1275         }
1276
1277         @Override
1278         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1279             log("registrationServiceCapabilityChanged :: serviceClass=" +
1280                     serviceClass + ", event=" + event);
1281
1282             if (mListener != null) {
1283                 mListener.onImsConnected();
1284             }
1285         }
1286
1287         @Override
1288         public void registrationFeatureCapabilityChanged(int serviceClass,
1289                 int[] enabledFeatures, int[] disabledFeatures) {
1290             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1291                     serviceClass);
1292             if (mListener != null) {
1293                 mListener.onFeatureCapabilityChanged(serviceClass,
1294                         enabledFeatures, disabledFeatures);
1295             }
1296         }
1297
1298         @Override
1299         public void voiceMessageCountUpdate(int count) {
1300             log("voiceMessageCountUpdate :: count=" + count);
1301
1302             if (mListener != null) {
1303                 mListener.onVoiceMessageCountChanged(count);
1304             }
1305         }
1306
1307     }
1308     /**
1309      * Gets the ECBM interface to request ECBM exit.
1310      *
1311      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1312      * @return the ECBM interface instance
1313      * @throws ImsException if getting the ECBM interface results in an error
1314      */
1315     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1316         if (mEcbm == null) {
1317             checkAndThrowExceptionIfServiceUnavailable();
1318
1319             try {
1320                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1321
1322                 if (iEcbm == null) {
1323                     throw new ImsException("getEcbmInterface()",
1324                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1325                 }
1326                 mEcbm = new ImsEcbm(iEcbm);
1327             } catch (RemoteException e) {
1328                 throw new ImsException("getEcbmInterface()", e,
1329                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1330             }
1331         }
1332         return mEcbm;
1333     }
1334
1335     /**
1336      * Resets ImsManager settings back to factory defaults.
1337      *
1338      * @hide
1339      */
1340     public static void factoryReset(Context context) {
1341         // Set VoLTE to default
1342         android.provider.Settings.Global.putInt(context.getContentResolver(),
1343                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED,
1344                 ImsConfig.FeatureValueConstants.ON);
1345
1346         // Set VoWiFi to default
1347         android.provider.Settings.Global.putInt(context.getContentResolver(),
1348                 android.provider.Settings.Global.WFC_IMS_ENABLED,
1349                 ImsConfig.FeatureValueConstants.OFF);
1350
1351         // Set VoWiFi mode to default
1352         android.provider.Settings.Global.putInt(context.getContentResolver(),
1353                 android.provider.Settings.Global.WFC_IMS_MODE,
1354                 ImsConfig.WfcModeFeatureValueConstants.WIFI_PREFERRED);
1355
1356         // Set VoWiFi roaming to default
1357         android.provider.Settings.Global.putInt(context.getContentResolver(),
1358                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
1359                 ImsConfig.FeatureValueConstants.OFF);
1360
1361         // Set VT to default
1362         SharedPreferences sharedPrefs =
1363                 PreferenceManager.getDefaultSharedPreferences(context);
1364         SharedPreferences.Editor editor = sharedPrefs.edit();
1365         editor.putBoolean(PREF_ENABLE_VIDEO_CALLING_KEY, true);
1366         editor.commit();
1367
1368         // Push settings to ImsConfig
1369         ImsManager.updateImsServiceConfig(context,
1370                 SubscriptionManager.getDefaultVoicePhoneId(), true);
1371     }
1372 }