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 | a7b394d | 2016-08-21 23:11:46 +0900 | [diff] [blame] | 18 | import java.util.List; |
| 19 | |
Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 20 | /** |
| 21 | * LISP map reply message interface. |
Jian Li | 8fc2d2f | 2016-08-08 14:43:53 +0900 | [diff] [blame] | 22 | * <p> |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 23 | * LISP map reply message format is defined in RFC6830. |
| 24 | * https://tools.ietf.org/html/rfc6830#page-31 |
| 25 | * |
Yuta HIGUCHI | 4b02211 | 2016-08-03 10:56:55 -0700 | [diff] [blame] | 26 | * <pre> |
| 27 | * {@literal |
Jian Li | 4eb3e3a | 2016-08-21 16:20:20 +0900 | [diff] [blame] | 28 | * 0 1 2 3 |
| 29 | * 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 |
| 30 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 31 | * |Type=2 |P|E|S| Reserved | Record Count | |
| 32 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 33 | * | Nonce . . . | |
| 34 | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 35 | * | . . . Nonce | |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 36 | * +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 37 | * | | Record TTL | |
| 38 | * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 39 | * R | Locator Count | EID mask-len | ACT |A| Reserved | |
| 40 | * e +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 41 | * c | Rsvd | Map-Version Number | EID-Prefix-AFI | |
| 42 | * o +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 43 | * r | EID-Prefix | |
| 44 | * d +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 45 | * | /| Priority | Weight | M Priority | M Weight | |
| 46 | * | L +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 47 | * | o | Unused Flags |L|p|R| Loc-AFI | |
| 48 | * | c +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 49 | * | \| Locator | |
| 50 | * +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
Yuta HIGUCHI | 4b02211 | 2016-08-03 10:56:55 -0700 | [diff] [blame] | 51 | * }</pre> |
Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 52 | */ |
| 53 | public interface LispMapReply extends LispMessage { |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 54 | |
| 55 | /** |
| 56 | * Obtains probe flag. |
| 57 | * |
| 58 | * @return probe flag |
| 59 | */ |
| 60 | boolean isProbe(); |
| 61 | |
| 62 | /** |
| 63 | * Obtains ETR flag. |
| 64 | * |
| 65 | * @return ETR flag |
| 66 | */ |
| 67 | boolean isEtr(); |
| 68 | |
| 69 | /** |
| 70 | * Obtains security flag. |
| 71 | * |
| 72 | * @return security flag |
| 73 | */ |
| 74 | boolean isSecurity(); |
| 75 | |
| 76 | /** |
| 77 | * Obtains record count value. |
| 78 | * |
| 79 | * @return record count value |
| 80 | */ |
Jian Li | 42b3e43 | 2016-08-31 01:05:20 +0900 | [diff] [blame] | 81 | int getRecordCount(); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 82 | |
| 83 | /** |
| 84 | * Obtains nonce value. |
| 85 | * |
| 86 | * @return nonce value |
| 87 | */ |
| 88 | long getNonce(); |
| 89 | |
| 90 | /** |
Jian Li | a7b394d | 2016-08-21 23:11:46 +0900 | [diff] [blame] | 91 | * Obtains map records. |
| 92 | * |
| 93 | * @return map records |
| 94 | */ |
| 95 | List<LispMapRecord> getMapRecords(); |
| 96 | |
| 97 | /** |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 98 | * A builder of LISP map reply message. |
| 99 | */ |
| 100 | interface ReplyBuilder extends Builder { |
| 101 | |
| 102 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 103 | * Sets probe flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 104 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 105 | * @param probe probe flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 106 | * @return ReplyBuilder object |
| 107 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 108 | ReplyBuilder withIsProbe(boolean probe); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 109 | |
| 110 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 111 | * Sets etr flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 112 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 113 | * @param etr etr flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 114 | * @return ReplyBuilder object |
| 115 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 116 | ReplyBuilder withIsEtr(boolean etr); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 117 | |
| 118 | /** |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 119 | * Sets security flag. |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 120 | * |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 121 | * @param security security flag |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 122 | * @return ReplyBuilder object |
| 123 | */ |
Jian Li | f59c0ad | 2016-08-02 18:11:30 +0900 | [diff] [blame] | 124 | ReplyBuilder withIsSecurity(boolean security); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 125 | |
| 126 | /** |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 127 | * Sets nonce value. |
| 128 | * |
| 129 | * @param nonce nonce value |
| 130 | * @return ReplyBuilder object |
| 131 | */ |
| 132 | ReplyBuilder withNonce(long nonce); |
Jian Li | 525fded | 2016-08-04 01:15:33 +0900 | [diff] [blame] | 133 | |
| 134 | /** |
Jian Li | a7b394d | 2016-08-21 23:11:46 +0900 | [diff] [blame] | 135 | * Sets a collection of map records. |
| 136 | * |
| 137 | * @param mapRecords a collection of map records |
| 138 | * @return ReplyBuilder object |
| 139 | */ |
| 140 | ReplyBuilder withMapRecords(List<LispMapRecord> mapRecords); |
| 141 | |
| 142 | /** |
Jian Li | 525fded | 2016-08-04 01:15:33 +0900 | [diff] [blame] | 143 | * Builds LISP map reply message. |
| 144 | * |
| 145 | * @return LISP map reply message |
| 146 | */ |
| 147 | LispMapReply build(); |
Jian Li | 719b3bf | 2016-07-22 00:38:29 +0900 | [diff] [blame] | 148 | } |
Jian Li | 451175e | 2016-07-19 23:22:20 +0900 | [diff] [blame] | 149 | } |