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