aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/protocols/pcep/pcepio/src/main/java/org/onosproject/pcepio/protocol/ver1/PcepLabelRangeResvMsgVer1.java
blob: 6f3648afde3996c7ecd6865fd227609493dac23b (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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/*
 * 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.pcepio.protocol.ver1;

import org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.pcepio.exceptions.PcepParseException;
import org.onosproject.pcepio.protocol.PcepLabelRange;
import org.onosproject.pcepio.protocol.PcepLabelRangeResvMsg;
import org.onosproject.pcepio.protocol.PcepMessageReader;
import org.onosproject.pcepio.protocol.PcepMessageWriter;
import org.onosproject.pcepio.protocol.PcepType;
import org.onosproject.pcepio.protocol.PcepVersion;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.base.MoreObjects;

/**
 * Provides PCEP label range reserve message.
 */
class PcepLabelRangeResvMsgVer1 implements PcepLabelRangeResvMsg {

    // Pcep version: 1

    /*
       The format of a PCLRResv message is as follows:

               PCLRResv Message>::= <Common Header>
                                    <label-range>
          Where:

               <label-range> ::= <SRP>
                                 <labelrange-list>

          Where
               <labelrange-list>::=<LABEL-RANGE>[<labelrange-list>]
     */
    protected static final Logger log = LoggerFactory.getLogger(PcepLabelRangeResvMsgVer1.class);

    public static final byte PACKET_VERSION = 1;
    // LabelRangeResvMsgMinLength = COMMON-HEADER(4)+SrpObjMinLentgh(12)+LABEL-RANGE-MIN-LENGTH(12)
    public static final int PACKET_MINIMUM_LENGTH = 28;
    public static final PcepType MSG_TYPE = PcepType.LABEL_RANGE_RESERV;
    //<label-range>
    PcepLabelRange labelRange;

    public static final PcepLabelRangeResvMsgVer1.Reader READER = new Reader();

    /**
     * Reader reads LabelRangeResv Message from the channel.
     */
    static class Reader implements PcepMessageReader<PcepLabelRangeResvMsg> {

        @Override
        public PcepLabelRangeResvMsg readFrom(ChannelBuffer cb) throws PcepParseException {

            if (cb.readableBytes() < PACKET_MINIMUM_LENGTH) {
                throw new PcepParseException("Channel buffer has less readable bytes than Packet minimum length.");
            }
            // fixed value property version == 1
            byte version = cb.readByte();
            version = (byte) (version >> PcepMessageVer1.SHIFT_FLAG);
            if (version != PACKET_VERSION) {
                throw new PcepParseException("Wrong version. Expected=PcepVersion.PCEP_1(1), got=" + version);
            }
            // fixed value property type == 15
            byte type = cb.readByte();
            if (type != MSG_TYPE.getType()) {
                throw new PcepParseException("Wrong type. Expected=PcepType.LABEL_RANGE_RESERV(15), got=" + type);
            }
            short length = cb.readShort();
            if (length < PACKET_MINIMUM_LENGTH) {
                throw new PcepParseException("Wrong length.Expected to be >= " + PACKET_MINIMUM_LENGTH + ", is: "
                        + length);
            }
            // parse <label-range>
            PcepLabelRange labelRange = PcepLabelRangeVer1.read(cb);
            return new PcepLabelRangeResvMsgVer1(labelRange);
        }
    }

    /**
     * Constructor to initialize PCEP label range.
     *
     * @param labelRange PCEP label range
     */
    PcepLabelRangeResvMsgVer1(PcepLabelRange labelRange) {
        this.labelRange = labelRange;
    }

    /**
     * Builder class for PCEP label range reserve message.
     */
    static class Builder implements PcepLabelRangeResvMsg.Builder {

        PcepLabelRange labelRange = new PcepLabelRangeVer1();

        @Override
        public PcepVersion getVersion() {
            return PcepVersion.PCEP_1;
        }

        @Override
        public PcepType getType() {
            return PcepType.LABEL_RANGE_RESERV;
        }

        @Override
        public PcepLabelRangeResvMsg build() {
            return new PcepLabelRangeResvMsgVer1(this.labelRange);
        }

        @Override
        public PcepLabelRange getLabelRange() {
            return this.labelRange;
        }

        @Override
        public Builder setLabelRange(PcepLabelRange labelRange) {
            this.labelRange = labelRange;
            return this;
        }
    }

    @Override
    public void writeTo(ChannelBuffer cb) throws PcepParseException {
        WRITER.write(cb, this);
    }

    static final Writer WRITER = new Writer();

    /**
     * Writer writes LabelRangeResv Message to the channel.
     */
    static class Writer implements PcepMessageWriter<PcepLabelRangeResvMsgVer1> {

        @Override
        public void write(ChannelBuffer cb, PcepLabelRangeResvMsgVer1 message) throws PcepParseException {

            int startIndex = cb.writerIndex();
            // first 3 bits set to version
            cb.writeByte((byte) (PACKET_VERSION << PcepMessageVer1.SHIFT_FLAG));
            // message type
            cb.writeByte(MSG_TYPE.getType());
            // Length will be set after calculating length, but currently set it as 0.
            int msgLenIndex = cb.writerIndex();

            cb.writeShort((short) 0);
            //write Label Range
            message.labelRange.write(cb);

            // update message length field
            int length = cb.writerIndex() - startIndex;
            cb.setShort(msgLenIndex, (short) length);
        }
    }

    @Override
    public PcepVersion getVersion() {
        return PcepVersion.PCEP_1;
    }

    @Override
    public PcepType getType() {
        return MSG_TYPE;
    }

    @Override
    public PcepLabelRange getLabelRange() {
        return this.labelRange;
    }

    @Override
    public void setLabelRange(PcepLabelRange lr) {
        this.labelRange = lr;
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(getClass())
                .add("labelRange", labelRange)
                .toString();
    }
}