Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2021-present Open Networking Foundation |
| 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.kubevirtnetworking.api; |
| 17 | |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 18 | import java.util.Map; |
| 19 | import java.util.Set; |
| 20 | |
| 21 | /** |
| 22 | * Representation of virtual router. |
| 23 | */ |
| 24 | public interface KubevirtRouter { |
| 25 | |
| 26 | /** |
| 27 | * Returns the router name. |
| 28 | * |
| 29 | * @return router name |
| 30 | */ |
| 31 | String name(); |
| 32 | |
| 33 | /** |
| 34 | * Returns the router description. |
| 35 | * |
| 36 | * @return router description |
| 37 | */ |
| 38 | String description(); |
| 39 | |
| 40 | /** |
| 41 | * Returns the SNAT enable flag. |
| 42 | * |
| 43 | * @return true if the router support SNAT, false otherwise |
| 44 | */ |
| 45 | boolean enableSnat(); |
| 46 | |
| 47 | /** |
| 48 | * Returns a set of internal networks. |
| 49 | * |
| 50 | * @return a set of internal networks |
| 51 | */ |
| 52 | Set<String> internal(); |
| 53 | |
| 54 | /** |
| 55 | * Returns external network along with external router IP address. |
| 56 | * We use IP address as the key, and external network name as the value. |
| 57 | * |
| 58 | * @return external network paired with external router IP address |
| 59 | */ |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame^] | 60 | Map<String, String> external(); |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 61 | |
| 62 | /** |
| 63 | * Returns external peer router. |
| 64 | * |
| 65 | * @return peer router |
| 66 | */ |
| 67 | KubevirtPeerRouter peerRouter(); |
| 68 | |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame^] | 69 | /** |
| 70 | * Updates the peer router. |
| 71 | * |
| 72 | * @param updated updated peer router |
| 73 | * @return kubevirt router with the updated peer router |
| 74 | */ |
| 75 | KubevirtRouter updatePeerRouter(KubevirtPeerRouter updated); |
| 76 | |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 77 | interface Builder { |
| 78 | |
| 79 | /** |
| 80 | * Builds an immutable network instance. |
| 81 | * |
| 82 | * @return kubevirt router |
| 83 | */ |
| 84 | KubevirtRouter build(); |
| 85 | |
| 86 | /** |
| 87 | * Returns kubevirt router builder with supplied router name. |
| 88 | * |
| 89 | * @param name router name |
| 90 | * @return router builder |
| 91 | */ |
| 92 | Builder name(String name); |
| 93 | |
| 94 | /** |
| 95 | * Returns kubevirt router builder with supplied router description. |
| 96 | * |
| 97 | * @param description router description |
| 98 | * @return router builder |
| 99 | */ |
| 100 | Builder description(String description); |
| 101 | |
| 102 | /** |
| 103 | * Returns kubevirt router builder with supplied enable SNAT flag. |
| 104 | * |
| 105 | * @param flag router flag |
| 106 | * @return router builder |
| 107 | */ |
| 108 | Builder enableSnat(boolean flag); |
| 109 | |
| 110 | /** |
| 111 | * Returns kubevirt router builder with supplied internal networks. |
| 112 | * |
| 113 | * @param internal internal network set |
| 114 | * @return router builder |
| 115 | */ |
| 116 | Builder internal(Set<String> internal); |
| 117 | |
| 118 | /** |
| 119 | * Returns kubevirt router builder with supplied external network with IP. |
| 120 | * |
| 121 | * @param external external network with IP |
| 122 | * @return router builder |
| 123 | */ |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame^] | 124 | Builder external(Map<String, String> external); |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 125 | |
| 126 | /** |
| 127 | * Returns kubevirt router builder with supplied peer router. |
| 128 | * |
| 129 | * @param router peer router |
| 130 | * @return router builder |
| 131 | */ |
| 132 | Builder peerRouter(KubevirtPeerRouter router); |
| 133 | } |
| 134 | } |