| /* |
| * Copyright (C) 2012 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.support.v4.net; |
| |
| import android.content.Intent; |
| import android.net.ConnectivityManager; |
| import android.net.NetworkInfo; |
| import android.os.Build; |
| import android.support.annotation.IntDef; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| |
| import static android.net.ConnectivityManager.TYPE_MOBILE; |
| import static android.net.ConnectivityManager.TYPE_MOBILE_DUN; |
| import static android.net.ConnectivityManager.TYPE_MOBILE_HIPRI; |
| import static android.net.ConnectivityManager.TYPE_MOBILE_MMS; |
| import static android.net.ConnectivityManager.TYPE_MOBILE_SUPL; |
| import static android.net.ConnectivityManager.TYPE_WIFI; |
| import static android.net.ConnectivityManager.TYPE_WIMAX; |
| |
| /** |
| * Helper for accessing features in {@link ConnectivityManager} introduced after |
| * API level 16 in a backwards compatible fashion. |
| */ |
| public final class ConnectivityManagerCompat { |
| |
| interface ConnectivityManagerCompatImpl { |
| boolean isActiveNetworkMetered(ConnectivityManager cm); |
| |
| @RestrictBackgroundStatus |
| int getRestrictBackgroundStatus(ConnectivityManager cm); |
| } |
| |
| /** @hide */ |
| @Retention(RetentionPolicy.SOURCE) |
| @IntDef(flag = false, value = { |
| RESTRICT_BACKGROUND_STATUS_DISABLED, |
| RESTRICT_BACKGROUND_STATUS_WHITELISTED, |
| RESTRICT_BACKGROUND_STATUS_ENABLED, |
| }) |
| public @interface RestrictBackgroundStatus { |
| } |
| |
| /** |
| * Device is not restricting metered network activity while application is running on |
| * background. |
| */ |
| public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1; |
| |
| /** |
| * Device is restricting metered network activity while application is running on background, |
| * but application is allowed to bypass it. |
| * <p> |
| * In this state, application should take action to mitigate metered network access. |
| * For example, a music streaming application should switch to a low-bandwidth bitrate. |
| */ |
| public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2; |
| |
| /** |
| * Device is restricting metered network activity while application is running on background. |
| * <p> |
| * In this state, application should not try to use the network while running on background, |
| * because it would be denied. |
| */ |
| public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3; |
| |
| static class BaseConnectivityManagerCompatImpl implements ConnectivityManagerCompatImpl { |
| @Override |
| public boolean isActiveNetworkMetered(ConnectivityManager cm) { |
| final NetworkInfo info = cm.getActiveNetworkInfo(); |
| if (info == null) { |
| // err on side of caution |
| return true; |
| } |
| |
| final int type = info.getType(); |
| switch (type) { |
| case TYPE_MOBILE: |
| case TYPE_MOBILE_DUN: |
| case TYPE_MOBILE_HIPRI: |
| case TYPE_MOBILE_MMS: |
| case TYPE_MOBILE_SUPL: |
| case TYPE_WIMAX: |
| return true; |
| case TYPE_WIFI: |
| return false; |
| default: |
| // err on side of caution |
| return true; |
| } |
| } |
| |
| @Override |
| public int getRestrictBackgroundStatus(ConnectivityManager cm) { |
| return RESTRICT_BACKGROUND_STATUS_ENABLED; |
| } |
| } |
| |
| static class HoneycombMR2ConnectivityManagerCompatImpl |
| extends BaseConnectivityManagerCompatImpl { |
| @Override |
| public boolean isActiveNetworkMetered(ConnectivityManager cm) { |
| return ConnectivityManagerCompatHoneycombMR2.isActiveNetworkMetered(cm); |
| } |
| } |
| |
| static class JellyBeanConnectivityManagerCompatImpl |
| extends HoneycombMR2ConnectivityManagerCompatImpl { |
| @Override |
| public boolean isActiveNetworkMetered(ConnectivityManager cm) { |
| return ConnectivityManagerCompatJellyBean.isActiveNetworkMetered(cm); |
| } |
| } |
| |
| static class Api24ConnectivityManagerCompatImpl |
| extends JellyBeanConnectivityManagerCompatImpl { |
| @Override |
| public int getRestrictBackgroundStatus(ConnectivityManager cm) { |
| //noinspection ResourceType |
| return ConnectivityManagerCompatApi24.getRestrictBackgroundStatus(cm); |
| } |
| } |
| |
| private static final ConnectivityManagerCompatImpl IMPL; |
| |
| static { |
| if (Build.VERSION.SDK_INT >= 24) { |
| IMPL = new Api24ConnectivityManagerCompatImpl(); |
| } else if (Build.VERSION.SDK_INT >= 16) { |
| IMPL = new JellyBeanConnectivityManagerCompatImpl(); |
| } else if (Build.VERSION.SDK_INT >= 13) { |
| IMPL = new HoneycombMR2ConnectivityManagerCompatImpl(); |
| } else { |
| IMPL = new BaseConnectivityManagerCompatImpl(); |
| } |
| } |
| |
| /** |
| * Returns if the currently active data network is metered. A network is |
| * classified as metered when the user is sensitive to heavy data usage on |
| * that connection. You should check this before doing large data transfers, |
| * and warn the user or delay the operation until another network is |
| * available. |
| */ |
| public static boolean isActiveNetworkMetered(ConnectivityManager cm) { |
| return IMPL.isActiveNetworkMetered(cm); |
| } |
| |
| /** |
| * Return the {@link NetworkInfo} that caused the given |
| * {@link ConnectivityManager#CONNECTIVITY_ACTION} broadcast. This obtains |
| * the current state from {@link ConnectivityManager} instead of using the |
| * potentially-stale value from |
| * {@link ConnectivityManager#EXTRA_NETWORK_INFO}. May be {@code null}. |
| */ |
| public static NetworkInfo getNetworkInfoFromBroadcast(ConnectivityManager cm, Intent intent) { |
| final NetworkInfo info = intent.getParcelableExtra(ConnectivityManager.EXTRA_NETWORK_INFO); |
| if (info != null) { |
| return cm.getNetworkInfo(info.getType()); |
| } else { |
| return null; |
| } |
| } |
| |
| /** |
| * Determines if the calling application is subject to metered network restrictions while |
| * running on background. |
| * |
| * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED}, |
| * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED}, |
| * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED} |
| */ |
| @RestrictBackgroundStatus |
| public static int getRestrictBackgroundStatus(ConnectivityManager cm) { |
| return IMPL.getRestrictBackgroundStatus(cm); |
| } |
| |
| private ConnectivityManagerCompat() {} |
| } |