Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +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 | */ |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 16 | package org.onosproject.bgpio.protocol; |
| 17 | |
| 18 | import java.util.LinkedList; |
| 19 | |
| 20 | import org.onosproject.bgpio.exceptions.BGPParseException; |
| 21 | import org.onosproject.bgpio.types.BGPHeader; |
| 22 | import org.onosproject.bgpio.types.BGPValueType; |
| 23 | |
| 24 | /** |
| 25 | * Abstraction of an entity providing BGP Open Message. |
| 26 | */ |
| 27 | public interface BGPOpenMsg extends BGPMessage { |
| 28 | |
| 29 | @Override |
| 30 | BGPHeader getHeader(); |
| 31 | |
| 32 | @Override |
| 33 | BGPVersion getVersion(); |
| 34 | |
| 35 | @Override |
| 36 | BGPType getType(); |
| 37 | |
| 38 | /** |
| 39 | * Returns hold time of Open Message. |
| 40 | * |
| 41 | * @return hold time of Open Message |
| 42 | */ |
| 43 | short getHoldTime(); |
| 44 | |
| 45 | /** |
| 46 | * Returns AS Number of Open Message. |
| 47 | * |
| 48 | * @return AS Number of Open Message |
| 49 | */ |
| 50 | short getAsNumber(); |
| 51 | |
| 52 | /** |
| 53 | * Returns BGP Identifier of Open Message. |
| 54 | * |
| 55 | * @return BGP Identifier of Open Message |
| 56 | */ |
| 57 | int getBgpId(); |
| 58 | |
| 59 | /** |
| 60 | * Returns capabilities of Open Message. |
| 61 | * |
| 62 | * @return capabilities of Open Message |
| 63 | */ |
| 64 | LinkedList<BGPValueType> getCapabilityTlv(); |
| 65 | |
| 66 | /** |
| 67 | * Builder interface with get and set functions to build Open message. |
| 68 | */ |
| 69 | interface Builder extends BGPMessage.Builder { |
| 70 | |
| 71 | @Override |
| 72 | BGPOpenMsg build() throws BGPParseException; |
| 73 | |
| 74 | @Override |
| 75 | BGPHeader getHeader(); |
| 76 | |
| 77 | @Override |
| 78 | BGPVersion getVersion(); |
| 79 | |
| 80 | @Override |
| 81 | BGPType getType(); |
| 82 | |
| 83 | /** |
| 84 | * Returns hold time of Open Message. |
| 85 | * |
| 86 | * @return hold time of Open Message |
| 87 | */ |
| 88 | short getHoldTime(); |
| 89 | |
| 90 | /** |
| 91 | * Sets hold time in Open Message and return its builder. |
| 92 | * |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame^] | 93 | * @param holdtime hold timer value in open message |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 94 | * @return builder by setting hold time |
| 95 | */ |
| 96 | Builder setHoldTime(short holdtime); |
| 97 | |
| 98 | /** |
| 99 | * Returns as number of Open Message. |
| 100 | * |
| 101 | * @return as number of Open Message |
| 102 | */ |
| 103 | short getAsNumber(); |
| 104 | |
| 105 | /** |
| 106 | * Sets AS number in Open Message and return its builder. |
| 107 | * |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame^] | 108 | * @param asNumber as number in open message |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 109 | * @return builder by setting asNumber |
| 110 | */ |
| 111 | Builder setAsNumber(short asNumber); |
| 112 | |
| 113 | /** |
| 114 | * Returns BGP Identifier of Open Message. |
| 115 | * |
| 116 | * @return BGP Identifier of Open Message |
| 117 | */ |
| 118 | int getBgpId(); |
| 119 | |
| 120 | /** |
| 121 | * Sets BGP Identifier in Open Message and return its builder. |
| 122 | * |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame^] | 123 | * @param bgpId BGP Identifier in open message |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 124 | * @return builder by setting BGP Identifier |
| 125 | */ |
| 126 | Builder setBgpId(int bgpId); |
| 127 | |
| 128 | /** |
| 129 | * Returns capabilities of Open Message. |
| 130 | * |
| 131 | * @return capabilities of Open Message |
| 132 | */ |
| 133 | LinkedList<BGPValueType> getCapabilityTlv(); |
| 134 | |
| 135 | /** |
| 136 | * Sets capabilities in Open Message and return its builder. |
| 137 | * |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame^] | 138 | * @param capabilityTlv capabilities in open message |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 139 | * @return builder by setting capabilities |
| 140 | */ |
| 141 | Builder setCapabilityTlv(LinkedList<BGPValueType> capabilityTlv); |
| 142 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame^] | 143 | /** |
| 144 | * Sets isLargeAsCapabilityTlvSet and return its builder. |
| 145 | * |
| 146 | * @param isLargeAsCapabilitySet |
| 147 | * boolean value to know whether large AS capability is set or not |
| 148 | * @return builder by setting capabilities |
| 149 | */ |
| 150 | Builder setLargeAsCapabilityTlv(boolean isLargeAsCapabilitySet); |
| 151 | |
| 152 | /** |
| 153 | * Sets isLsCapabilityTlvSet and return its builder. |
| 154 | * |
| 155 | * @param isLsCapabilitySet |
| 156 | * boolean value to know whether LS capability is set or not |
| 157 | * @return builder by setting capabilities |
| 158 | */ |
| 159 | Builder setLsCapabilityTlv(boolean isLsCapabilitySet); |
| 160 | |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 161 | @Override |
| 162 | Builder setHeader(BGPHeader bgpMsgHeader); |
| 163 | } |
| 164 | } |