aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/types/attr/BgpLinkAttrMplsProtocolMask.java
blob: 61143fae2c7c520c321cc35d22e97e2b122113b9 (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
/*
 * 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 MPLS protocol mask attribute.
 */
public class BgpLinkAttrMplsProtocolMask implements BGPValueType {

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

    public static final int ATTRLINK_MPLSPROTOMASK = 1094;
    public static final int MASK_BYTE_LEN = 1;

    private final boolean bLdp;
    private final boolean bRsvpTe;

    public static final byte FIRST_BIT = (byte) 0x80;
    public static final byte SECOND_BIT = 0x40;

    /**
     * Constructor to initialize the values.
     *
     * @param bLdp boolean value true if LDP flag is available
     * @param bRsvpTe boolean value true if RSVP TE information is available
     */
    public BgpLinkAttrMplsProtocolMask(boolean bLdp, boolean bRsvpTe) {
        this.bLdp = bLdp;
        this.bRsvpTe = bRsvpTe;
    }

    /**
     * Returns object of this class with specified values.
     *
     * @param bLdp boolean value true if LDP flag is available
     * @param bRsvpTe boolean value true if RSVP TE information is available
     * @return object of BgpLinkAttrMplsProtocolMask
     */
    public static BgpLinkAttrMplsProtocolMask of(final boolean bLdp,
                                                 final boolean bRsvpTe) {
        return new BgpLinkAttrMplsProtocolMask(bLdp, bRsvpTe);
    }

    /**
     * Reads the BGP link attributes MPLS protocol mask.
     *
     * @param cb Channel buffer
     * @return object of type BgpLinkAttrMPLSProtocolMask
     * @throws BGPParseException while parsing BgpLinkAttrMplsProtocolMask
     */
    public static BgpLinkAttrMplsProtocolMask read(ChannelBuffer cb)
            throws BGPParseException {
        boolean bLdp = false;
        boolean bRsvpTe = false;

        short lsAttrLength = cb.readShort();

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

        byte flags = cb.readByte();

        bLdp = ((flags & (byte) FIRST_BIT) == FIRST_BIT);
        bRsvpTe = ((flags & (byte) SECOND_BIT) == SECOND_BIT);

        return BgpLinkAttrMplsProtocolMask.of(bLdp, bRsvpTe);
    }

    /**
     * Returns true if LDP bit is set.
     *
     * @return True if LDP information is set else false.
     */
    public boolean ldpBit() {
        return bLdp;
    }

    /**
     * Returns RSVP TE information.
     *
     * @return True if RSVP TE information is set else false.
     */
    public boolean rsvpBit() {
        return bRsvpTe;
    }

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

    @Override
    public int hashCode() {
        return Objects.hash(bLdp, bRsvpTe);
    }

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

        if (obj instanceof BgpLinkAttrMplsProtocolMask) {
            BgpLinkAttrMplsProtocolMask other = (BgpLinkAttrMplsProtocolMask) obj;
            return Objects.equals(bLdp, other.bLdp)
                    && Objects.equals(bRsvpTe, other.bRsvpTe);
        }
        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("bLdp", bLdp).add("bRsvpTe", bRsvpTe).toString();
    }
}