aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/types/attr/BgpPrefixAttrMetric.java
blob: 1886102c7bdf8297d81817f5e4bb3ed854258115 (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
/*
 * 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 prefix metric attribute.
 */
public class BgpPrefixAttrMetric implements BgpValueType {

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

    public static final int ATTR_PREFIX_METRIC = 1155;
    public static final int ATTR_PREFIX_LEN = 4;

    /* TE Default Metric */
    private final int linkPfxMetric;

    /**
     * Constructor to initialize value.
     *
     * @param linkPfxMetric Prefix Metric
     */
    public BgpPrefixAttrMetric(int linkPfxMetric) {
        this.linkPfxMetric = linkPfxMetric;
    }

    /**
     * Returns object of this class with specified values.
     *
     * @param linkPfxMetric Prefix Metric
     * @return object of BgpPrefixAttrMetric
     */
    public static BgpPrefixAttrMetric of(final int linkPfxMetric) {
        return new BgpPrefixAttrMetric(linkPfxMetric);
    }

    /**
     * Reads the Prefix Metric.
     *
     * @param cb ChannelBuffer
     * @return object of BgpPrefixAttrMetric
     * @throws BgpParseException while parsing BgpPrefixAttrMetric
     */
    public static BgpPrefixAttrMetric read(ChannelBuffer cb)
            throws BgpParseException {
        int linkPfxMetric;

        short lsAttrLength = cb.readShort(); // 4 Bytes

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

        linkPfxMetric = cb.readInt();

        return BgpPrefixAttrMetric.of(linkPfxMetric);
    }

    /**
     * Returns the Prefix Metric.
     *
     * @return Prefix Metric
     */
    public int attrPfxMetric() {
        return linkPfxMetric;
    }

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

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

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

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

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