aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/types/attr/BgpPrefixAttrRouteTag.java
blob: 426eb274a77f637854cc94703a38fbacb3961fe1 (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
/*
 * 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.ArrayList;
import java.util.List;
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 route tag attribute.
 */
public class BgpPrefixAttrRouteTag implements BGPValueType {

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

    public static final short ATTR_PREFIX_ROUTETAG = 1153;

    /* Prefix Route Tag */
    private List<Integer> pfxRouteTag = new ArrayList<Integer>();

    /**
     * Constructor to initialize the values.
     *
     * @param pfxRouteTag prefix route tag
     */
    public BgpPrefixAttrRouteTag(List<Integer> pfxRouteTag) {
        this.pfxRouteTag = pfxRouteTag;
    }

    /**
     * Returns object of this class with specified values.
     *
     * @param pfxRouteTag Prefix Metric
     * @return object of BgpPrefixAttrRouteTag
     */
    public static BgpPrefixAttrRouteTag of(ArrayList<Integer> pfxRouteTag) {
        return new BgpPrefixAttrRouteTag(pfxRouteTag);
    }

    /**
     * Reads the Route Tag.
     *
     * @param cb ChannelBuffer
     * @return object of BgpPrefixAttrRouteTag
     * @throws BGPParseException while parsing BgpPrefixAttrRouteTag
     */
    public static BgpPrefixAttrRouteTag read(ChannelBuffer cb)
            throws BGPParseException {
        int tmp;
        ArrayList<Integer> pfxRouteTag = new ArrayList<Integer>();

        short lsAttrLength = cb.readShort();
        int len = lsAttrLength / Integer.SIZE;

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

        for (int i = 0; i < len; i++) {
            tmp = cb.readInt();
            pfxRouteTag.add(new Integer(tmp));
        }

        return BgpPrefixAttrRouteTag.of(pfxRouteTag);
    }

    /**
     * Returns the prefix route tag.
     *
     * @return route tag
     */
    public List<Integer> getPfxRouteTag() {
        return pfxRouteTag;
    }

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

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

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

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