aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/types/attr/BgpAttrRouterIdV4.java
blob: f3c0d17b4e2036c6516f9e221261403da67499d7 (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
/*
 * 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.onlab.packet.Ip4Address;
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 attribute node router ID.
 */
public final class BgpAttrRouterIdV4 implements BgpValueType {

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

    private final short sType;

    /* IPv4 Router-ID of Node */
    private final Ip4Address ip4RouterId;

    /**
     * Constructor to initialize the value.
     *
     * @param ip4RouterId IPV4 address of router
     * @param sType TLV type
     */
    private BgpAttrRouterIdV4(Ip4Address ip4RouterId, short sType) {
        this.ip4RouterId = ip4RouterId;
        this.sType = sType;
    }

    /**
     * Returns object of this class with specified values.
     *
     * @param ip4RouterId IPv4 address
     * @param sType Type of this TLV
     * @return object of BgpAttrRouterIdV4
     */
    public static BgpAttrRouterIdV4 of(final Ip4Address ip4RouterId,
                                       final short sType) {
        return new BgpAttrRouterIdV4(ip4RouterId, sType);
    }

    /**
     * Reads the IPv4 Router-ID.
     *
     * @param cb ChannelBuffer
     * @param sType tag type
     * @return object of BgpAttrRouterIdV4
     * @throws BgpParseException while parsing BgpAttrRouterIdV4
     */
    public static BgpAttrRouterIdV4 read(ChannelBuffer cb, short sType)
            throws BgpParseException {
        short lsAttrLength = cb.readShort();

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

        byte[] ipBytes = new byte[lsAttrLength];
        cb.readBytes(ipBytes, 0, lsAttrLength);
        Ip4Address ip4RouterId = Ip4Address.valueOf(ipBytes);
        return BgpAttrRouterIdV4.of(ip4RouterId, sType);
    }

    /**
     * Returns the IPV4 router ID.
     *
     * @return Router ID
     */
    public Ip4Address attrRouterId() {
        return ip4RouterId;
    }

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

    @Override
    public int hashCode() {
        return Objects.hash(ip4RouterId);
    }

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

        if (obj instanceof BgpAttrRouterIdV4) {
            BgpAttrRouterIdV4 other = (BgpAttrRouterIdV4) obj;
            return Objects.equals(ip4RouterId, other.ip4RouterId);
        }
        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()).omitNullValues()
                .add("ip4RouterId", ip4RouterId).toString();
    }

    @Override
    public int compareTo(Object o) {
        // TODO Auto-generated method stub
        return 0;
    }
}