Home | History | Annotate | Download | only in net 
      1 /*
      2  * Copyright (C) 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 
     17 package android.net;
     18 
     19 import android.os.Parcel;
     20 import android.os.Parcelable;
     21 
     22 /**
     23  * A grab-bag of information (metadata, policies, properties, etc) about a
     24  * {@link Network}. Since this contains PII, it should not be sent outside the
     25  * system.
     26  *
     27  * @hide
     28  */
     29 public class NetworkMisc implements Parcelable {
     30 
     31     /**
     32      * If the {@link Network} is a VPN, whether apps are allowed to bypass the
     33      * VPN. This is set by a {@link VpnService} and used by
     34      * {@link ConnectivityManager} when creating a VPN.
     35      */
     36     public boolean allowBypass;
     37 
     38     /**
     39      * Set if the network was manually/explicitly connected to by the user either from settings
     40      * or a 3rd party app.  For example, turning on cell data is not explicit but tapping on a wifi
     41      * ap in the wifi settings to trigger a connection is explicit.  A 3rd party app asking to
     42      * connect to a particular access point is also explicit, though this may change in the future
     43      * as we want apps to use the multinetwork apis.
     44      */
     45     public boolean explicitlySelected;
     46 
     47     /**
     48      * Set if the user desires to use this network even if it is unvalidated. This field has meaning
     49      * only if {#link explicitlySelected} is true. If it is, this field must also be set to the
     50      * appropriate value based on previous user choice.
     51      */
     52     public boolean acceptUnvalidated;
     53 
     54     /**
     55      * Set to avoid surfacing the "Sign in to network" notification.
     56      * if carrier receivers/apps are registered to handle the carrier-specific provisioning
     57      * procedure, a carrier specific provisioning notification will be placed.
     58      * only one notification should be displayed. This field is set based on
     59      * which notification should be used for provisioning.
     60      */
     61     public boolean provisioningNotificationDisabled;
     62 
     63     /**
     64      * For mobile networks, this is the subscriber ID (such as IMSI).
     65      */
     66     public String subscriberId;
     67 
     68     public NetworkMisc() {
     69     }
     70 
     71     public NetworkMisc(NetworkMisc nm) {
     72         if (nm != null) {
     73             allowBypass = nm.allowBypass;
     74             explicitlySelected = nm.explicitlySelected;
     75             acceptUnvalidated = nm.acceptUnvalidated;
     76             subscriberId = nm.subscriberId;
     77             provisioningNotificationDisabled = nm.provisioningNotificationDisabled;
     78         }
     79     }
     80 
     81     @Override
     82     public int describeContents() {
     83         return 0;
     84     }
     85 
     86     @Override
     87     public void writeToParcel(Parcel out, int flags) {
     88         out.writeInt(allowBypass ? 1 : 0);
     89         out.writeInt(explicitlySelected ? 1 : 0);
     90         out.writeInt(acceptUnvalidated ? 1 : 0);
     91         out.writeString(subscriberId);
     92         out.writeInt(provisioningNotificationDisabled ? 1 : 0);
     93     }
     94 
     95     public static final Creator<NetworkMisc> CREATOR = new Creator<NetworkMisc>() {
     96         @Override
     97         public NetworkMisc createFromParcel(Parcel in) {
     98             NetworkMisc networkMisc = new NetworkMisc();
     99             networkMisc.allowBypass = in.readInt() != 0;
    100             networkMisc.explicitlySelected = in.readInt() != 0;
    101             networkMisc.acceptUnvalidated = in.readInt() != 0;
    102             networkMisc.subscriberId = in.readString();
    103             networkMisc.provisioningNotificationDisabled = in.readInt() != 0;
    104             return networkMisc;
    105         }
    106 
    107         @Override
    108         public NetworkMisc[] newArray(int size) {
    109             return new NetworkMisc[size];
    110         }
    111     };
    112 }
    113