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      * Whether the user explicitly set that this network should be validated even if presence of
56      * only partial internet connectivity.
57      */
58     public boolean acceptPartialConnectivity;
59 
60     /**
61      * Set to avoid surfacing the "Sign in to network" notification.
62      * if carrier receivers/apps are registered to handle the carrier-specific provisioning
63      * procedure, a carrier specific provisioning notification will be placed.
64      * only one notification should be displayed. This field is set based on
65      * which notification should be used for provisioning.
66      */
67     public boolean provisioningNotificationDisabled;
68 
69     /**
70      * For mobile networks, this is the subscriber ID (such as IMSI).
71      */
72     public String subscriberId;
73 
74     /**
75      * Set to skip 464xlat. This means the device will treat the network as IPv6-only and
76      * will not attempt to detect a NAT64 via RFC 7050 DNS lookups.
77      */
78     public boolean skip464xlat;
79 
NetworkMisc()80     public NetworkMisc() {
81     }
82 
NetworkMisc(NetworkMisc nm)83     public NetworkMisc(NetworkMisc nm) {
84         if (nm != null) {
85             allowBypass = nm.allowBypass;
86             explicitlySelected = nm.explicitlySelected;
87             acceptUnvalidated = nm.acceptUnvalidated;
88             subscriberId = nm.subscriberId;
89             provisioningNotificationDisabled = nm.provisioningNotificationDisabled;
90             skip464xlat = nm.skip464xlat;
91         }
92     }
93 
94     @Override
describeContents()95     public int describeContents() {
96         return 0;
97     }
98 
99     @Override
writeToParcel(Parcel out, int flags)100     public void writeToParcel(Parcel out, int flags) {
101         out.writeInt(allowBypass ? 1 : 0);
102         out.writeInt(explicitlySelected ? 1 : 0);
103         out.writeInt(acceptUnvalidated ? 1 : 0);
104         out.writeString(subscriberId);
105         out.writeInt(provisioningNotificationDisabled ? 1 : 0);
106         out.writeInt(skip464xlat ? 1 : 0);
107     }
108 
109     public static final @android.annotation.NonNull Creator<NetworkMisc> CREATOR = new Creator<NetworkMisc>() {
110         @Override
111         public NetworkMisc createFromParcel(Parcel in) {
112             NetworkMisc networkMisc = new NetworkMisc();
113             networkMisc.allowBypass = in.readInt() != 0;
114             networkMisc.explicitlySelected = in.readInt() != 0;
115             networkMisc.acceptUnvalidated = in.readInt() != 0;
116             networkMisc.subscriberId = in.readString();
117             networkMisc.provisioningNotificationDisabled = in.readInt() != 0;
118             networkMisc.skip464xlat = in.readInt() != 0;
119             return networkMisc;
120         }
121 
122         @Override
123         public NetworkMisc[] newArray(int size) {
124             return new NetworkMisc[size];
125         }
126     };
127 }
128