Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 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 | |
| 17 | package org.onosproject.pcepio.protocol; |
| 18 | |
| 19 | /** |
| 20 | * Abstraction of an Message factory providing Builder functions to PCEP Messages and Objects. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 21 | */ |
| 22 | public interface PcepFactory { |
| 23 | |
| 24 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 25 | * Returns Builder Object for Open Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 26 | * |
| 27 | * @return Builder Object for Open Message |
| 28 | */ |
| 29 | PcepOpenMsg.Builder buildOpenMsg(); |
| 30 | |
| 31 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 32 | * Returns Builder Object for Open Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 33 | * |
| 34 | * @return Builder Object for Open Object |
| 35 | */ |
| 36 | PcepOpenObject.Builder buildOpenObject(); |
| 37 | |
| 38 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 39 | * Returns Builder Object for Keepalive Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 40 | * |
| 41 | * @return Builder Object for Keepalive Message |
| 42 | */ |
| 43 | PcepKeepaliveMsg.Builder buildKeepaliveMsg(); |
| 44 | |
| 45 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 46 | * Returns Builder Object for Close Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 47 | * |
| 48 | * @return Builder Object for Close Message |
| 49 | */ |
| 50 | PcepCloseMsg.Builder buildCloseMsg(); |
| 51 | |
| 52 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 53 | * Returns Builder Object for Report Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 54 | * |
| 55 | * @return Builder Object for Report Message |
| 56 | */ |
| 57 | PcepReportMsg.Builder buildReportMsg(); |
| 58 | |
| 59 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 60 | * Returns Builder Object for Update Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 61 | * |
| 62 | * @return Builder Object for Update Message |
| 63 | */ |
| 64 | PcepUpdateMsg.Builder buildUpdateMsg(); |
| 65 | |
| 66 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 67 | * Returns Builder Object for Initiate Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 68 | * |
| 69 | * @return Builder Object for Initiate Message |
| 70 | */ |
| 71 | PcepInitiateMsg.Builder buildPcepInitiateMsg(); |
| 72 | |
| 73 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 74 | * Returns Builder Object for LSP Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 75 | * |
| 76 | * @return Builder Object for LSP Object |
| 77 | */ |
| 78 | PcepLspObject.Builder buildLspObject(); |
| 79 | |
| 80 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 81 | * Returns Builder Object for SRP Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 82 | * |
| 83 | * @return Builder Object for SRP Object |
| 84 | */ |
| 85 | PcepSrpObject.Builder buildSrpObject(); |
| 86 | |
| 87 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 88 | * Returns Builder Object for EndPoints Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 89 | * |
| 90 | * @return Builder Object for EndPoints Object |
| 91 | */ |
| 92 | PcepEndPointsObject.Builder buildEndPointsObject(); |
| 93 | |
| 94 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 95 | * Returns Builder Object for ERO Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 96 | * |
| 97 | * @return Builder Object for ERO Object |
| 98 | */ |
| 99 | PcepEroObject.Builder buildEroObject(); |
| 100 | |
| 101 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 102 | * Returns Builder Object for RRO Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 103 | * |
| 104 | * @return Builder Object for RRO Object |
| 105 | */ |
| 106 | PcepRroObject.Builder buildRroObject(); |
| 107 | |
| 108 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 109 | * Returns Builder Object for LSPA Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 110 | * |
| 111 | * @return Builder Object for LSPA Object |
| 112 | */ |
| 113 | PcepLspaObject.Builder buildLspaObject(); |
| 114 | |
| 115 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 116 | * Returns Builder Object for IRO Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 117 | * |
| 118 | * @return Builder Object for IRO Object |
| 119 | */ |
| 120 | PcepIroObject.Builder buildIroObject(); |
| 121 | |
| 122 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 123 | * Returns Builder Object for METRIC Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 124 | * |
| 125 | * @return Builder Object for METRIC Object |
| 126 | */ |
| 127 | PcepMetricObject.Builder buildMetricObject(); |
| 128 | |
| 129 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 130 | * Returns Builder Object for Bandwidth Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 131 | * |
| 132 | * @return Builder Object for Bandwidth Object |
| 133 | */ |
| 134 | PcepBandwidthObject.Builder buildBandwidthObject(); |
| 135 | |
| 136 | /** |
| 137 | * Returns PCEP Message Reader. |
| 138 | * |
| 139 | * @return PCEP Message Reader |
| 140 | */ |
| 141 | PcepMessageReader<PcepMessage> getReader(); |
| 142 | |
| 143 | /** |
| 144 | * Returns PCEP version. |
| 145 | * |
| 146 | * @return PCEP version |
| 147 | */ |
| 148 | PcepVersion getVersion(); |
| 149 | |
| 150 | /** |
| 151 | * Returns PcepStateReport. |
| 152 | * |
| 153 | * @return PcepStateReport |
| 154 | */ |
| 155 | PcepStateReport.Builder buildPcepStateReport(); |
| 156 | |
| 157 | /** |
| 158 | * Returns PcepUpdateRequest. |
| 159 | * |
| 160 | * @return PcepUpdateRequest |
| 161 | */ |
| 162 | PcepUpdateRequest.Builder buildPcepUpdateRequest(); |
| 163 | |
| 164 | /** |
| 165 | * Returns PcInitiatedLspRequest. |
| 166 | * |
| 167 | * @return PcInitiatedLspRequest |
| 168 | */ |
| 169 | PcInitiatedLspRequest.Builder buildPcInitiatedLspRequest(); |
| 170 | |
| 171 | /** |
| 172 | * Returns PcepMsgPath. |
| 173 | * |
| 174 | * @return PcepMsgPath |
| 175 | */ |
| 176 | PcepMsgPath.Builder buildPcepMsgPath(); |
| 177 | |
| 178 | /** |
| 179 | * Return PcepAttribute list. |
| 180 | * |
| 181 | * @return PcepAttribute |
| 182 | */ |
| 183 | PcepAttribute.Builder buildPcepAttribute(); |
| 184 | |
| 185 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 186 | * Returns Builder Object for LabelUpdate message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 187 | * |
| 188 | * @return Builder Object for LabelUpdate message |
| 189 | */ |
| 190 | PcepLabelUpdateMsg.Builder buildPcepLabelUpdateMsg(); |
| 191 | |
| 192 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 193 | * Returns Builder Object for PcepLabelUpdate Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 194 | * |
| 195 | * @return Builder Object for PcepLabelUpdate Object |
| 196 | */ |
| 197 | PcepLabelUpdate.Builder buildPcepLabelUpdateObject(); |
| 198 | |
| 199 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 200 | * Returns Builder Object for PcepLabel Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 201 | * |
| 202 | * @return Builder Object for PcepLabel Object |
| 203 | */ |
| 204 | PcepLabelObject.Builder buildLabelObject(); |
| 205 | |
| 206 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 207 | * Returns Builder Object for Error Message. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 208 | * |
| 209 | * @return Builder Object for Error Message |
| 210 | */ |
| 211 | PcepErrorMsg.Builder buildPcepErrorMsg(); |
| 212 | |
| 213 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 214 | * Returns Builder Object for Error Object. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 215 | * |
| 216 | * @return Builder Object for Error Object |
| 217 | */ |
| 218 | PcepErrorObject.Builder buildPcepErrorObject(); |
| 219 | |
| 220 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 221 | * Returns Builder Object for FecIpv4Adjacency. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 222 | * |
| 223 | * @return Builder Object for FecIpv4Adjacency |
| 224 | */ |
| 225 | PcepFecObjectIPv4Adjacency.Builder buildFecIpv4Adjacency(); |
| 226 | |
| 227 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 228 | * Returns Builder Object for FecObjectIPv4. |
| 229 | * |
| 230 | * @return Builder Object for FecObjectIPv4 |
| 231 | */ |
| 232 | PcepFecObjectIPv4.Builder buildFecObjectIpv4(); |
| 233 | |
| 234 | /** |
| 235 | * Returns Builder Object for ErrorInfo. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 236 | * |
| 237 | * @return Builder Object for ErrorInfo |
| 238 | */ |
| 239 | PcepErrorInfo.Builder buildPcepErrorInfo(); |
| 240 | |
| 241 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 242 | * Returns Builder Object for PcepError. |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 243 | * |
| 244 | * @return Builder Object for PcepError |
| 245 | */ |
| 246 | PcepError.Builder buildPcepError(); |
bharat saraswal | e180630 | 2015-08-21 12:16:46 +0530 | [diff] [blame] | 247 | |
| 248 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 249 | * Returns Builder Object for PcepLabelRangeObject. |
bharat saraswal | e180630 | 2015-08-21 12:16:46 +0530 | [diff] [blame] | 250 | * |
| 251 | * @return Builder Object for PcepLabelRangeObject |
| 252 | */ |
| 253 | PcepLabelRangeObject.Builder buildPcepLabelRangeObject(); |
| 254 | |
| 255 | /** |
Priyanka B | bd455ca | 2016-05-05 22:13:25 +0530 | [diff] [blame] | 256 | * Returns Builder Object for PcepLabelRangeResvMsg. |
bharat saraswal | e180630 | 2015-08-21 12:16:46 +0530 | [diff] [blame] | 257 | * |
| 258 | * @return Builder Object for PcepLabelRangeResvMsg |
| 259 | */ |
| 260 | PcepLabelRangeResvMsg.Builder buildPcepLabelRangeResvMsg(); |
Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 261 | } |