aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/types/attr/BgpLinkAttrProtectionType.java
blob: b45d95b8d570d56cc8e0d2cd0b86bc8725a95f23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * 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 org.onosproject.bgpio.types.attr;

import java.util.Objects;

import org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.bgpio.exceptions.BGPParseException;
import org.onosproject.bgpio.types.BGPErrorType;
import org.onosproject.bgpio.types.BGPValueType;
import org.onosproject.bgpio.util.Validation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.base.MoreObjects;

/**
 * Implements BGP link protection type attribute.
 */
public final class BgpLinkAttrProtectionType implements BGPValueType {

    protected static final Logger log = LoggerFactory
            .getLogger(BgpLinkAttrProtectionType.class);

    public static final int ATTRLINK_PROTECTIONTYPE = 1093;
    public static final int LINK_PROTECTION_LEN = 2;

    public static final int EXTRA_TRAFFIC = 0x01;
    public static final int UNPROTECTED = 0x02;
    public static final int SHARED = 0x04;
    public static final int DEDICATED_ONE_ISTO_ONE = 0x08;
    public static final int DEDICATED_ONE_PLUS_ONE = 0x10;
    public static final int ENHANCED = 0x20;

    /* Link Protection type flags */
    private final boolean bExtraTraffic;
    private final boolean bUnprotected;
    private final boolean bShared;
    private final boolean bDedOneIstoOne;
    private final boolean bDedOnePlusOne;
    private final boolean bEnhanced;

    /**
     * Constructor to initialize the value.
     *
     * @param bExtraTraffic Extra Traffic
     * @param bUnprotected Unprotected
     * @param bShared Shared
     * @param bDedOneIstoOne Dedicated 1:1
     * @param bDedOnePlusOne Dedicated 1+1
     * @param bEnhanced Enhanced
     */
    private BgpLinkAttrProtectionType(boolean bExtraTraffic,
                                      boolean bUnprotected,
                                      boolean bShared, boolean bDedOneIstoOne,
                                      boolean bDedOnePlusOne, boolean bEnhanced) {
        this.bExtraTraffic = bExtraTraffic;
        this.bUnprotected = bUnprotected;
        this.bShared = bShared;
        this.bDedOneIstoOne = bDedOneIstoOne;
        this.bDedOnePlusOne = bDedOnePlusOne;
        this.bEnhanced = bEnhanced;
    }

    /**
     * Returns object of this class with specified values.
     *
     * @param bExtraTraffic Extra Traffic
     * @param bUnprotected Unprotected
     * @param bShared Shared
     * @param bDedOneIstoOne Dedicated 1:1
     * @param bDedOnePlusOne Dedicated 1+1
     * @param bEnhanced Enhanced
     * @return object of BgpLinkAttrProtectionType
     */
    public static BgpLinkAttrProtectionType of(boolean bExtraTraffic,
                                               boolean bUnprotected,
                                               boolean bShared,
                                               boolean bDedOneIstoOne,
                                               boolean bDedOnePlusOne,
                                               boolean bEnhanced) {
        return new BgpLinkAttrProtectionType(bExtraTraffic, bUnprotected,
                                             bShared, bDedOneIstoOne,
                                             bDedOnePlusOne, bEnhanced);
    }

    /**
     * Reads the BGP link attributes protection type.
     *
     * @param cb Channel buffer
     * @return object of type BgpLinkAttrProtectionType
     * @throws BGPParseException while parsing BgpLinkAttrProtectionType
     */
    public static BgpLinkAttrProtectionType read(ChannelBuffer cb)
            throws BGPParseException {
        short linkProtectionType;
        byte higherByte;
        short lsAttrLength = cb.readShort();

        boolean bExtraTraffic;
        boolean bUnprotected;
        boolean bShared;
        boolean bDedOneIstoOne;
        boolean bDedOnePlusOne;
        boolean bEnhanced;

        if ((lsAttrLength != LINK_PROTECTION_LEN)
                || (cb.readableBytes() < lsAttrLength)) {
            Validation.validateLen(BGPErrorType.UPDATE_MESSAGE_ERROR,
                                   BGPErrorType.ATTRIBUTE_LENGTH_ERROR,
                                   lsAttrLength);
        }

        linkProtectionType = cb.readShort();
        higherByte = (byte) (linkProtectionType >> 8);

        bExtraTraffic = ((higherByte & (byte) EXTRA_TRAFFIC) == EXTRA_TRAFFIC);
        bUnprotected = ((higherByte & (byte) UNPROTECTED) == UNPROTECTED);
        bShared = ((higherByte & (byte) SHARED) == SHARED);
        bDedOneIstoOne = ((higherByte & (byte) DEDICATED_ONE_ISTO_ONE) == DEDICATED_ONE_ISTO_ONE);
        bDedOnePlusOne = ((higherByte & (byte) DEDICATED_ONE_PLUS_ONE) == DEDICATED_ONE_PLUS_ONE);
        bEnhanced = ((higherByte & (byte) ENHANCED) == ENHANCED);

        return BgpLinkAttrProtectionType.of(bExtraTraffic, bUnprotected,
                                            bShared, bDedOneIstoOne,
                                            bDedOnePlusOne, bEnhanced);
    }

    /**
     * Returns ExtraTraffic Bit.
     *
     * @return ExtraTraffic Bit
     */
    public boolean extraTraffic() {
        return bExtraTraffic;
    }

    /**
     * Returns Unprotected Bit.
     *
     * @return Unprotected Bit
     */
    public boolean unprotected() {
        return bUnprotected;
    }

    /**
     * Returns Shared Bit.
     *
     * @return Shared Bit
     */
    public boolean shared() {
        return bShared;
    }

    /**
     * Returns DedOneIstoOne Bit.
     *
     * @return DedOneIstoOne Bit
     */
    public boolean dedOneIstoOne() {
        return bDedOneIstoOne;
    }

    /**
     * Returns DedOnePlusOne Bit.
     *
     * @return DedOnePlusOne Bit
     */
    public boolean dedOnePlusOne() {
        return bDedOnePlusOne;
    }

    /**
     * Returns Enhanced Bit.
     *
     * @return Enhanced Bit
     */
    public boolean enhanced() {
        return bEnhanced;
    }

    @Override
    public short getType() {
        return ATTRLINK_PROTECTIONTYPE;
    }

    @Override
    public int hashCode() {
        return Objects.hash(bExtraTraffic, bUnprotected, bShared,
                            bDedOneIstoOne, bDedOnePlusOne, bEnhanced);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        if (obj instanceof BgpLinkAttrProtectionType) {
            BgpLinkAttrProtectionType other = (BgpLinkAttrProtectionType) obj;
            return Objects.equals(bExtraTraffic, other.bExtraTraffic)
                    && Objects.equals(bUnprotected, other.bUnprotected)
                    && Objects.equals(bShared, other.bShared)
                    && Objects.equals(bDedOneIstoOne, other.bDedOneIstoOne)
                    && Objects.equals(bDedOnePlusOne, other.bDedOnePlusOne)
                    && Objects.equals(bEnhanced, other.bEnhanced);
        }
        return false;
    }

    @Override
    public int write(ChannelBuffer cb) {
        // TODO This will be implemented in the next version
        return 0;
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(getClass())
                .add("bExtraTraffic", bExtraTraffic)
                .add("bUnprotected", bUnprotected).add("bShared", bShared)
                .add("bDedOneIstoOne", bDedOneIstoOne)
                .add("bDedOnePlusOne", bDedOnePlusOne)
                .add("bEnhanced", bEnhanced).toString();
    }
}