aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/bgp/bgpio/src/main/java/org/onosproject/bgpio/types/attr/BgpPrefixAttrExtRouteTag.java
blob: a2d7c57e97081c6fc86d13318034acdd87a8365f (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
/*
 * 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 static com.google.common.base.Preconditions.checkNotNull;

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 Extended tag attribute.
 */
public class BgpPrefixAttrExtRouteTag implements BgpValueType {

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

    public static final int ATTR_PREFIX_EXTROUTETAG = 1154;
    public static final int ATTR_PREFIX_EXT_LEN = 8;

    /* Prefix Route Tag */
    private List<Long> pfxExtRouteTag = new ArrayList<Long>();

    /**
     * Constructor to initialize the values.
     *
     * @param pfxExtRouteTag Extended route tag
     */
    public BgpPrefixAttrExtRouteTag(List<Long> pfxExtRouteTag) {
        this.pfxExtRouteTag = checkNotNull(pfxExtRouteTag);
    }

    /**
     * Returns object of this class with specified values.
     *
     * @param pfxExtRouteTag Prefix Metric
     * @return object of BgpPrefixAttrMetric
     */
    public static BgpPrefixAttrExtRouteTag of(ArrayList<Long> pfxExtRouteTag) {
        return new BgpPrefixAttrExtRouteTag(pfxExtRouteTag);
    }

    /**
     * Reads the Extended Tag.
     *
     * @param cb ChannelBuffer
     * @return object of BgpPrefixAttrExtRouteTag
     * @throws BgpParseException while parsing BgpPrefixAttrExtRouteTag
     */
    public static BgpPrefixAttrExtRouteTag read(ChannelBuffer cb)
            throws BgpParseException {
        ArrayList<Long> pfxExtRouteTag = new ArrayList<Long>();
        long temp;

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

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

        for (int i = 0; i < len; i++) {
            temp = cb.readLong();
            pfxExtRouteTag.add(new Long(temp));
        }

        return new BgpPrefixAttrExtRouteTag(pfxExtRouteTag);
    }

    /**
     * Returns Extended route tag.
     *
     * @return route tag
     */
    public List<Long> pfxExtRouteTag() {
        return pfxExtRouteTag;
    }

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

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

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

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

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