Priyanka B | 9aaa311 | 2015-10-09 17:19:33 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.bgpio.protocol.ver4; |
| 17 | |
| 18 | import org.jboss.netty.buffer.ChannelBuffer; |
| 19 | import org.onosproject.bgpio.exceptions.BGPParseException; |
| 20 | import org.onosproject.bgpio.protocol.BGPMessageReader; |
| 21 | import org.onosproject.bgpio.protocol.BGPMessageWriter; |
| 22 | import org.onosproject.bgpio.protocol.BGPNotificationMsg; |
| 23 | import org.onosproject.bgpio.protocol.BGPType; |
| 24 | import org.onosproject.bgpio.protocol.BGPVersion; |
| 25 | import org.onosproject.bgpio.types.BGPErrorType; |
| 26 | import org.onosproject.bgpio.types.BGPHeader; |
| 27 | import org.slf4j.Logger; |
| 28 | import org.slf4j.LoggerFactory; |
| 29 | |
| 30 | import com.google.common.base.MoreObjects; |
| 31 | |
| 32 | /** |
| 33 | * A NOTIFICATION message is sent when an error condition is detected. The BGP connection is closed immediately after it |
| 34 | * is sent. |
| 35 | */ |
| 36 | class BGPNotificationMsgVer4 implements BGPNotificationMsg { |
| 37 | |
| 38 | /* |
| 39 | 0 1 2 3 |
| 40 | 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 |
| 41 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 42 | | Error code | Error subcode | Data (variable) | |
| 43 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 44 | REFERENCE : RFC 4271 |
| 45 | */ |
| 46 | |
Priyanka B | 715854a | 2015-10-27 16:11:53 +0530 | [diff] [blame^] | 47 | private static final Logger log = LoggerFactory.getLogger(BGPNotificationMsgVer4.class); |
Priyanka B | 9aaa311 | 2015-10-09 17:19:33 +0530 | [diff] [blame] | 48 | |
| 49 | static final byte PACKET_VERSION = 4; |
| 50 | //BGPHeader(19) + Error code(1) + Error subcode(1) |
| 51 | static final int TOTAL_MESSAGE_MIN_LENGTH = 21; |
| 52 | static final int PACKET_MINIMUM_LENGTH = 2; |
| 53 | static final BGPType MSG_TYPE = BGPType.NOTIFICATION; |
| 54 | static final byte DEFAULT_ERRORSUBCODE = 0; |
Priyanka B | 715854a | 2015-10-27 16:11:53 +0530 | [diff] [blame^] | 55 | static final byte[] MARKER = {(byte) 0xff, (byte) 0xff, (byte) 0xff, |
| 56 | (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, |
| 57 | (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, |
| 58 | (byte) 0xff, (byte) 0xff, (byte) 0xff }; |
Priyanka B | 9aaa311 | 2015-10-09 17:19:33 +0530 | [diff] [blame] | 59 | static final byte MESSAGE_TYPE = 3; |
| 60 | static final BGPHeader DEFAULT_MESSAGE_HEADER = new BGPHeader(MARKER, BGPHeader.DEFAULT_HEADER_LENGTH, |
| 61 | MESSAGE_TYPE); |
| 62 | |
| 63 | private byte errorCode; |
| 64 | private byte errorSubCode; |
| 65 | private byte[] data; |
| 66 | private BGPHeader bgpHeader; |
| 67 | public static final BGPNotificationMsgVer4.Reader READER = new Reader(); |
| 68 | |
| 69 | /** |
Priyanka B | 715854a | 2015-10-27 16:11:53 +0530 | [diff] [blame^] | 70 | * Initialize fields. |
Priyanka B | 9aaa311 | 2015-10-09 17:19:33 +0530 | [diff] [blame] | 71 | */ |
| 72 | public BGPNotificationMsgVer4() { |
| 73 | this.bgpHeader = null; |
| 74 | this.data = null; |
| 75 | this.errorCode = 0; |
| 76 | this.errorSubCode = 0; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Constructor to initialize parameters. |
| 81 | * |
| 82 | * @param bgpHeader BGP Header in notification message |
| 83 | * @param errorCode error code |
| 84 | * @param errorSubCode error subcode |
| 85 | * @param data field |
| 86 | */ |
| 87 | public BGPNotificationMsgVer4(BGPHeader bgpHeader, byte errorCode, byte errorSubCode, byte[] data) { |
| 88 | this.bgpHeader = bgpHeader; |
| 89 | this.data = data; |
| 90 | this.errorCode = errorCode; |
| 91 | this.errorSubCode = errorSubCode; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Reader reads BGP Notification Message from the channel buffer. |
| 96 | */ |
| 97 | static class Reader implements BGPMessageReader<BGPNotificationMsg> { |
| 98 | @Override |
| 99 | public BGPNotificationMsg readFrom(ChannelBuffer cb, BGPHeader bgpHeader) throws BGPParseException { |
| 100 | byte errorCode; |
| 101 | byte errorSubCode; |
| 102 | if (cb.readableBytes() < PACKET_MINIMUM_LENGTH) { |
| 103 | throw new BGPParseException("Not enough readable bytes"); |
| 104 | } |
| 105 | errorCode = cb.readByte(); |
| 106 | errorSubCode = cb.readByte(); |
| 107 | //Message Length = 21 + Data Length |
| 108 | int dataLength = bgpHeader.getLength() - TOTAL_MESSAGE_MIN_LENGTH; |
| 109 | byte[] data = new byte[dataLength]; |
| 110 | cb.readBytes(data, 0, dataLength); |
| 111 | return new BGPNotificationMsgVer4(bgpHeader, errorCode, errorSubCode, data); |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * Builder class for BGP notification message. |
| 117 | */ |
| 118 | static class Builder implements BGPNotificationMsg.Builder { |
| 119 | private byte errorCode; |
| 120 | private byte errorSubCode; |
| 121 | private byte[] data; |
| 122 | private BGPHeader bgpHeader; |
| 123 | private boolean isErrorCodeSet = false; |
| 124 | private boolean isErrorSubCodeSet = false; |
| 125 | private boolean isBGPHeaderSet = false; |
| 126 | |
| 127 | @Override |
Priyanka B | 9aaa311 | 2015-10-09 17:19:33 +0530 | [diff] [blame] | 128 | public BGPNotificationMsg build() throws BGPParseException { |
| 129 | BGPHeader bgpHeader = this.isBGPHeaderSet ? this.bgpHeader : DEFAULT_MESSAGE_HEADER; |
| 130 | if (!this.isErrorCodeSet) { |
| 131 | throw new BGPParseException("Error code must be present"); |
| 132 | } |
| 133 | |
| 134 | byte errorSubCode = this.isErrorSubCodeSet ? this.errorSubCode : DEFAULT_ERRORSUBCODE; |
| 135 | return new BGPNotificationMsgVer4(bgpHeader, this.errorCode, errorSubCode, this.data); |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public Builder setErrorCode(byte errorCode) { |
| 140 | this.errorCode = errorCode; |
| 141 | this.isErrorCodeSet = true; |
| 142 | return this; |
| 143 | } |
| 144 | |
| 145 | @Override |
| 146 | public Builder setErrorSubCode(byte errorSubCode) { |
| 147 | this.errorSubCode = errorSubCode; |
| 148 | this.isErrorSubCodeSet = true; |
| 149 | return this; |
| 150 | } |
| 151 | |
| 152 | @Override |
| 153 | public Builder setData(byte[] data) { |
| 154 | this.data = data; |
| 155 | return this; |
| 156 | } |
| 157 | |
| 158 | @Override |
Priyanka B | 9aaa311 | 2015-10-09 17:19:33 +0530 | [diff] [blame] | 159 | public Builder setHeader(BGPHeader bgpMsgHeader) { |
| 160 | this.bgpHeader = bgpMsgHeader; |
| 161 | return this; |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | @Override |
| 166 | public BGPVersion getVersion() { |
| 167 | return BGPVersion.BGP_4; |
| 168 | } |
| 169 | |
| 170 | @Override |
| 171 | public BGPType getType() { |
| 172 | return BGPType.NOTIFICATION; |
| 173 | } |
| 174 | |
| 175 | @Override |
| 176 | public void writeTo(ChannelBuffer cb) throws BGPParseException { |
| 177 | WRITER.write(cb, this); |
| 178 | } |
| 179 | |
| 180 | static final Writer WRITER = new Writer(); |
| 181 | |
| 182 | /** |
| 183 | * Writer writes BGP notification message to channel buffer. |
| 184 | */ |
| 185 | static class Writer implements BGPMessageWriter<BGPNotificationMsgVer4> { |
| 186 | @Override |
| 187 | public void write(ChannelBuffer cb, BGPNotificationMsgVer4 message) throws BGPParseException { |
| 188 | int msgStartIndex = cb.writerIndex(); |
| 189 | int headerLenIndex = message.bgpHeader.write(cb); |
| 190 | if (headerLenIndex <= 0) { |
| 191 | throw new BGPParseException(BGPErrorType.MESSAGE_HEADER_ERROR, (byte) 0, null); |
| 192 | } |
| 193 | cb.writeByte(message.errorCode); |
| 194 | cb.writeByte(message.errorSubCode); |
| 195 | cb.writeBytes(message.data); |
| 196 | |
| 197 | //Update message length field in notification message |
| 198 | int length = cb.writerIndex() - msgStartIndex; |
| 199 | cb.setShort(headerLenIndex, (short) length); |
| 200 | message.bgpHeader.setLength((short) length); |
| 201 | } |
| 202 | } |
| 203 | |
| 204 | @Override |
| 205 | public byte getErrorCode() { |
| 206 | return this.errorCode; |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Sets errorcode with specified errorcode. |
| 211 | * |
| 212 | * @param errorCode field |
| 213 | */ |
| 214 | public void setErrorCode(byte errorCode) { |
| 215 | this.errorCode = errorCode; |
| 216 | } |
| 217 | |
| 218 | @Override |
| 219 | public byte getErrorSubCode() { |
| 220 | return this.errorSubCode; |
| 221 | } |
| 222 | |
| 223 | /** |
| 224 | * Sets error subcode with specified errorSubCode. |
| 225 | * |
| 226 | * @param errorSubCode field |
| 227 | */ |
| 228 | public void setErrorSubCode(byte errorSubCode) { |
| 229 | this.errorSubCode = errorSubCode; |
| 230 | } |
| 231 | |
| 232 | @Override |
| 233 | public byte[] getData() { |
| 234 | return this.data; |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Sets error data with specified data. |
| 239 | * |
| 240 | * @param data field |
| 241 | */ |
| 242 | public void setData(byte[] data) { |
| 243 | this.data = data; |
| 244 | } |
| 245 | |
| 246 | @Override |
| 247 | public BGPHeader getHeader() { |
| 248 | return this.bgpHeader; |
| 249 | } |
| 250 | |
| 251 | @Override |
| 252 | public String toString() { |
| 253 | return MoreObjects.toStringHelper(getClass()) |
| 254 | .omitNullValues() |
| 255 | .add("bgpHeader", bgpHeader) |
| 256 | .add("data", data) |
| 257 | .add("errorCode", errorCode) |
| 258 | .add("errorSubCode", errorSubCode) |
| 259 | .toString(); |
| 260 | } |
| 261 | } |