Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present 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.lisp.msg.protocols; |
| 17 | |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 18 | import org.onosproject.lisp.msg.types.LispAfiAddress; |
| 19 | |
| 20 | import java.util.List; |
| 21 | |
Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 22 | /** |
| 23 | * LISP map request message interface. |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 24 | * <p> |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 25 | * LISP map request message format is defined in RFC6830. |
| 26 | * https://tools.ietf.org/html/rfc6830#page-27 |
| 27 | * |
Yuta HIGUCHI | 4b02211 | 2016-08-03 10:56:55 -0700 | [diff] [blame] | 28 | * <pre> |
| 29 | * {@literal |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 30 | * <p> |
Jian Li | 4eb3e3a | 2016-08-21 16:20:20 +0900 | [diff] [blame] | 31 | * 0 1 2 3 |
| 32 | * 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 |
| 33 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 34 | * |Type=1 |A|M|P|S|p|s| Reserved | IRC | Record Count | |
| 35 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 36 | * | Nonce . . . | |
| 37 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 38 | * | . . . Nonce | |
| 39 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 40 | * | Source-EID-AFI | Source EID Address ... | |
| 41 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 42 | * | ITR-RLOC-AFI 1 | ITR-RLOC Address 1 ... | |
| 43 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 44 | * | ... | |
| 45 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 46 | * | ITR-RLOC-AFI n | ITR-RLOC Address n ... | |
| 47 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 48 | * / | Reserved | EID mask-len | EID-Prefix-AFI | |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 49 | * Rec +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Jian Li | 4eb3e3a | 2016-08-21 16:20:20 +0900 | [diff] [blame] | 50 | * \ | EID-Prefix ... | |
| 51 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 52 | * | Map-Reply Record ... | |
| 53 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Yuta HIGUCHI | 4b02211 | 2016-08-03 10:56:55 -0700 | [diff] [blame] | 54 | * }</pre> |
Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 55 | */ |
| 56 | public interface LispMapRequest extends LispMessage { |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 57 | |
| 58 | /** |
| 59 | * Obtains authoritative flag. |
| 60 | * |
| 61 | * @return authoritative flag |
| 62 | */ |
| 63 | boolean isAuthoritative(); |
| 64 | |
| 65 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 66 | * Obtains map data present flag. |
| 67 | * |
| 68 | * @return map data present flag |
| 69 | */ |
| 70 | boolean isMapDataPresent(); |
| 71 | |
| 72 | /** |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 73 | * Obtains probe flag. |
| 74 | * |
| 75 | * @return probe flag |
| 76 | */ |
| 77 | boolean isProbe(); |
| 78 | |
| 79 | /** |
| 80 | * Obtains SMR flag. |
| 81 | * |
| 82 | * @return SMR flag |
| 83 | */ |
| 84 | boolean isSmr(); |
| 85 | |
| 86 | /** |
| 87 | * Obtains PITR flag. |
| 88 | * |
| 89 | * @return PITR flag |
| 90 | */ |
| 91 | boolean isPitr(); |
| 92 | |
| 93 | /** |
| 94 | * Obtains SMR Invoked flag. |
| 95 | * |
| 96 | * @return SMR invoked flag |
| 97 | */ |
| 98 | boolean isSmrInvoked(); |
| 99 | |
| 100 | /** |
| 101 | * Obtains record count value. |
| 102 | * |
| 103 | * @return record count value |
| 104 | */ |
Jian Li | 42b3e43 | 2016-08-31 01:05:20 +0900 | [diff] [blame] | 105 | int getRecordCount(); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 106 | |
| 107 | /** |
| 108 | * Obtains nonce value. |
| 109 | * |
| 110 | * @return nonce value |
| 111 | */ |
| 112 | long getNonce(); |
| 113 | |
| 114 | /** |
| 115 | * Obtains source EID. |
| 116 | * |
| 117 | * @return source EID |
| 118 | */ |
| 119 | LispAfiAddress getSourceEid(); |
| 120 | |
| 121 | /** |
| 122 | * Obtains a collection of ITR RLOCs. |
| 123 | * |
| 124 | * @return a collection of ITR RLOCs |
| 125 | */ |
| 126 | List<LispAfiAddress> getItrRlocs(); |
| 127 | |
| 128 | /** |
| 129 | * Obtains a collection of EID records. |
| 130 | * |
| 131 | * @return a collection of EID records |
| 132 | */ |
Jian Li | 10a0906 | 2016-07-26 23:58:50 +0900 | [diff] [blame] | 133 | List<LispEidRecord> getEids(); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 134 | |
| 135 | /** |
| 136 | * A builder of LISP map request message. |
| 137 | */ |
| 138 | interface RequestBuilder extends Builder { |
| 139 | |
| 140 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 141 | * Sets authoritative flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 142 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 143 | * @param authoritative authoritative flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 144 | * @return RequestBuilder object |
| 145 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 146 | RequestBuilder withIsAuthoritative(boolean authoritative); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 147 | |
| 148 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 149 | * Sets probe flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 150 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 151 | * @param probe probe flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 152 | * @return RequestBuilder object |
| 153 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 154 | RequestBuilder withIsProbe(boolean probe); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 155 | |
| 156 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 157 | * Sets map data resent flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 158 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 159 | * @param mapDataPresent map data present flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 160 | * @return RequestBuilder object |
| 161 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 162 | RequestBuilder withIsMapDataPresent(boolean mapDataPresent); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 163 | |
| 164 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 165 | * Sets smr flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 166 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 167 | * @param smr smr flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 168 | * @return RequestBuilder object |
| 169 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 170 | RequestBuilder withIsSmr(boolean smr); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 171 | |
| 172 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 173 | * Sets pitr flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 174 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 175 | * @param pitr pitr flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 176 | * @return RequestBuilder object |
| 177 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 178 | RequestBuilder withIsPitr(boolean pitr); |
| 179 | |
| 180 | /** |
| 181 | * Sets smrInvoked flag. |
| 182 | * |
| 183 | * @param smrInvoked smrInvoked flag |
| 184 | * @return RequestBuilder object |
| 185 | */ |
| 186 | RequestBuilder withIsSmrInvoked(boolean smrInvoked); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 187 | |
| 188 | /** |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 189 | * Sets nonce value. |
| 190 | * |
| 191 | * @param nonce nonce value |
| 192 | * @return RequestBuilder object |
| 193 | */ |
| 194 | RequestBuilder withNonce(long nonce); |
| 195 | |
| 196 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 197 | * Sets source EID address. |
| 198 | * |
| 199 | * @param sourceEid source EID |
| 200 | * @return RequestBuilder object |
| 201 | */ |
| 202 | RequestBuilder withSourceEid(LispAfiAddress sourceEid); |
| 203 | |
| 204 | /** |
Jian Li | 4767190 | 2016-08-11 01:18:18 +0900 | [diff] [blame] | 205 | * Sets a collection of ITR RLOCs. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 206 | * |
Jian Li | 4767190 | 2016-08-11 01:18:18 +0900 | [diff] [blame] | 207 | * @param itrRlocs a collection of ITR RLOCs |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 208 | * @return RequestBuilder object |
| 209 | */ |
Jian Li | 4767190 | 2016-08-11 01:18:18 +0900 | [diff] [blame] | 210 | RequestBuilder withItrRlocs(List<LispAfiAddress> itrRlocs); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 211 | |
| 212 | /** |
Jian Li | 4767190 | 2016-08-11 01:18:18 +0900 | [diff] [blame] | 213 | * Sets a collection of EID records. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 214 | * |
Jian Li | 4767190 | 2016-08-11 01:18:18 +0900 | [diff] [blame] | 215 | * @param records a collection of EID records |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 216 | * @return RequestBuilder object |
| 217 | */ |
Jian Li | 4767190 | 2016-08-11 01:18:18 +0900 | [diff] [blame] | 218 | RequestBuilder withEidRecords(List<LispEidRecord> records); |
Jian Li | 525fded | 2016-08-04 01:15:33 +0900 | [diff] [blame] | 219 | |
| 220 | /** |
| 221 | * Builds LISP map request message. |
| 222 | * |
| 223 | * @return LISP map request message |
| 224 | */ |
| 225 | LispMapRequest build(); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 226 | } |
Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 227 | } |