1/*
2 * Copyright (C) 2008 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 android.net;
18
19import android.os.Parcel;
20import android.os.Parcelable;
21
22import com.google.android.collect.Sets;
23
24import java.util.HashSet;
25
26/**
27 * Configuration details for a network interface.
28 *
29 * @hide
30 */
31public class InterfaceConfiguration implements Parcelable {
32    private String mHwAddr;
33    private LinkAddress mAddr;
34    private HashSet<String> mFlags = Sets.newHashSet();
35
36    private static final String FLAG_UP = "up";
37    private static final String FLAG_DOWN = "down";
38
39    @Override
40    public String toString() {
41        final StringBuilder builder = new StringBuilder();
42        builder.append("mHwAddr=").append(mHwAddr);
43        builder.append(" mAddr=").append(String.valueOf(mAddr));
44        builder.append(" mFlags=").append(getFlags());
45        return builder.toString();
46    }
47
48    public Iterable<String> getFlags() {
49        return mFlags;
50    }
51
52    public boolean hasFlag(String flag) {
53        validateFlag(flag);
54        return mFlags.contains(flag);
55    }
56
57    public void clearFlag(String flag) {
58        validateFlag(flag);
59        mFlags.remove(flag);
60    }
61
62    public void setFlag(String flag) {
63        validateFlag(flag);
64        mFlags.add(flag);
65    }
66
67    /**
68     * Set flags to mark interface as up.
69     */
70    public void setInterfaceUp() {
71        mFlags.remove(FLAG_DOWN);
72        mFlags.add(FLAG_UP);
73    }
74
75    /**
76     * Set flags to mark interface as down.
77     */
78    public void setInterfaceDown() {
79        mFlags.remove(FLAG_UP);
80        mFlags.add(FLAG_DOWN);
81    }
82
83    /**
84     * Set flags so that no changes will be made to the up/down status.
85     */
86    public void ignoreInterfaceUpDownStatus() {
87        mFlags.remove(FLAG_UP);
88        mFlags.remove(FLAG_DOWN);
89    }
90
91    public LinkAddress getLinkAddress() {
92        return mAddr;
93    }
94
95    public void setLinkAddress(LinkAddress addr) {
96        mAddr = addr;
97    }
98
99    public String getHardwareAddress() {
100        return mHwAddr;
101    }
102
103    public void setHardwareAddress(String hwAddr) {
104        mHwAddr = hwAddr;
105    }
106
107    /**
108     * This function determines if the interface is up and has a valid IP
109     * configuration (IP address has a non zero octet).
110     *
111     * Note: It is supposed to be quick and hence should not initiate
112     * any network activity
113     */
114    public boolean isActive() {
115        try {
116            if (isUp()) {
117                for (byte b : mAddr.getAddress().getAddress()) {
118                    if (b != 0) return true;
119                }
120            }
121        } catch (NullPointerException e) {
122            return false;
123        }
124        return false;
125    }
126
127    public boolean isUp() {
128        return hasFlag(FLAG_UP);
129    }
130
131    /** {@inheritDoc} */
132    public int describeContents() {
133        return 0;
134    }
135
136    /** {@inheritDoc} */
137    public void writeToParcel(Parcel dest, int flags) {
138        dest.writeString(mHwAddr);
139        if (mAddr != null) {
140            dest.writeByte((byte)1);
141            dest.writeParcelable(mAddr, flags);
142        } else {
143            dest.writeByte((byte)0);
144        }
145        dest.writeInt(mFlags.size());
146        for (String flag : mFlags) {
147            dest.writeString(flag);
148        }
149    }
150
151    public static final Creator<InterfaceConfiguration> CREATOR = new Creator<
152            InterfaceConfiguration>() {
153        public InterfaceConfiguration createFromParcel(Parcel in) {
154            InterfaceConfiguration info = new InterfaceConfiguration();
155            info.mHwAddr = in.readString();
156            if (in.readByte() == 1) {
157                info.mAddr = in.readParcelable(null);
158            }
159            final int size = in.readInt();
160            for (int i = 0; i < size; i++) {
161                info.mFlags.add(in.readString());
162            }
163            return info;
164        }
165
166        public InterfaceConfiguration[] newArray(int size) {
167            return new InterfaceConfiguration[size];
168        }
169    };
170
171    private static void validateFlag(String flag) {
172        if (flag.indexOf(' ') >= 0) {
173            throw new IllegalArgumentException("flag contains space: " + flag);
174        }
175    }
176}
177