InterfaceConfiguration.java revision ddba10622dfd3122cf99c795706754e0d41858c3 
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    /**
49     * Return flags separated by spaces.
50     */
51    public String getFlags() {
52        final int size = mFlags.size();
53        if (size == 0) {
54            return "";
55        }
56
57        final String[] flags = mFlags.toArray(new String[size]);
58        final StringBuilder builder = new StringBuilder();
59
60        builder.append(flags[0]);
61        for (int i = 1; i < flags.length; i++) {
62            builder.append(' ');
63            builder.append(flags[i]);
64        }
65        return builder.toString();
66    }
67
68    public boolean hasFlag(String flag) {
69        validateFlag(flag);
70        return mFlags.contains(flag);
71    }
72
73    public void clearFlag(String flag) {
74        validateFlag(flag);
75        mFlags.remove(flag);
76    }
77
78    public void setFlag(String flag) {
79        validateFlag(flag);
80        mFlags.add(flag);
81    }
82
83    /**
84     * Set flags to mark interface as up.
85     */
86    public void setInterfaceUp() {
87        mFlags.remove(FLAG_DOWN);
88        mFlags.add(FLAG_UP);
89    }
90
91    /**
92     * Set flags to mark interface as down.
93     */
94    public void setInterfaceDown() {
95        mFlags.remove(FLAG_UP);
96        mFlags.add(FLAG_DOWN);
97    }
98
99    public LinkAddress getLinkAddress() {
100        return mAddr;
101    }
102
103    public void setLinkAddress(LinkAddress addr) {
104        mAddr = addr;
105    }
106
107    public String getHardwareAddress() {
108        return mHwAddr;
109    }
110
111    public void setHardwareAddress(String hwAddr) {
112        mHwAddr = hwAddr;
113    }
114
115    /**
116     * This function determines if the interface is up and has a valid IP
117     * configuration (IP address has a non zero octet).
118     *
119     * Note: It is supposed to be quick and hence should not initiate
120     * any network activity
121     */
122    public boolean isActive() {
123        try {
124            if (hasFlag(FLAG_UP)) {
125                for (byte b : mAddr.getAddress().getAddress()) {
126                    if (b != 0) return true;
127                }
128            }
129        } catch (NullPointerException e) {
130            return false;
131        }
132        return false;
133    }
134
135    /** {@inheritDoc} */
136    public int describeContents() {
137        return 0;
138    }
139
140    /** {@inheritDoc} */
141    public void writeToParcel(Parcel dest, int flags) {
142        dest.writeString(mHwAddr);
143        if (mAddr != null) {
144            dest.writeByte((byte)1);
145            dest.writeParcelable(mAddr, flags);
146        } else {
147            dest.writeByte((byte)0);
148        }
149        dest.writeInt(mFlags.size());
150        for (String flag : mFlags) {
151            dest.writeString(flag);
152        }
153    }
154
155    public static final Creator<InterfaceConfiguration> CREATOR = new Creator<
156            InterfaceConfiguration>() {
157        public InterfaceConfiguration createFromParcel(Parcel in) {
158            InterfaceConfiguration info = new InterfaceConfiguration();
159            info.mHwAddr = in.readString();
160            if (in.readByte() == 1) {
161                info.mAddr = in.readParcelable(null);
162            }
163            final int size = in.readInt();
164            for (int i = 0; i < size; i++) {
165                info.mFlags.add(in.readString());
166            }
167            return info;
168        }
169
170        public InterfaceConfiguration[] newArray(int size) {
171            return new InterfaceConfiguration[size];
172        }
173    };
174
175    private static void validateFlag(String flag) {
176        if (flag.indexOf(' ') >= 0) {
177            throw new IllegalArgumentException("flag contains space: " + flag);
178        }
179    }
180}
181