Jian Li | ff8b9f9 | 2018-06-05 17:36:37 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-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.openstacktelemetry.api.config; |
| 17 | |
| 18 | import java.util.Map; |
| 19 | |
| 20 | /** |
| 21 | * Configuration API of Kafka for publishing openstack telemetry. |
| 22 | */ |
Jian Li | 52c1122 | 2018-06-07 11:39:17 +0900 | [diff] [blame] | 23 | public interface KafkaTelemetryConfig extends TelemetryConfig { |
Jian Li | ff8b9f9 | 2018-06-05 17:36:37 +0900 | [diff] [blame] | 24 | |
| 25 | /** |
| 26 | * Obtains kafka IP address. |
| 27 | * |
| 28 | * @return kafka IP address |
| 29 | */ |
| 30 | String address(); |
| 31 | |
| 32 | /** |
| 33 | * Obtains kafka port number. |
| 34 | * |
| 35 | * @return kafka port number |
| 36 | */ |
| 37 | int port(); |
| 38 | |
| 39 | /** |
| 40 | * Obtains numbers of request retries. |
| 41 | * |
| 42 | * @return number of request retries |
| 43 | */ |
| 44 | int retries(); |
| 45 | |
| 46 | /** |
| 47 | * Obtains required acknowledgement. |
| 48 | * |
| 49 | * @return required acknowledgement |
| 50 | */ |
| 51 | String requiredAcks(); |
| 52 | |
| 53 | /** |
| 54 | * Obtains batch size. |
| 55 | * |
| 56 | * @return batch size |
| 57 | */ |
| 58 | int batchSize(); |
| 59 | |
| 60 | /** |
| 61 | * Obtains linger. |
| 62 | * |
| 63 | * @return linger |
| 64 | */ |
| 65 | int lingerMs(); |
| 66 | |
| 67 | /** |
| 68 | * Obtains memory buffer size. |
| 69 | * |
| 70 | * @return memory buffer size |
| 71 | */ |
| 72 | int memoryBuffer(); |
| 73 | |
| 74 | /** |
| 75 | * Obtains kafka key serializer. |
| 76 | * |
| 77 | * @return kafka key serializer |
| 78 | */ |
| 79 | String keySerializer(); |
| 80 | |
| 81 | /** |
| 82 | * Obtains kafka value serializer. |
| 83 | * |
| 84 | * @return kafka value serializer |
| 85 | */ |
| 86 | String valueSerializer(); |
| 87 | |
| 88 | /** |
| 89 | * Obtains kafka config maps. |
| 90 | * |
| 91 | * @return kafka config map |
| 92 | */ |
| 93 | Map<String, Object> configMap(); |
| 94 | |
| 95 | /** |
| 96 | * Builder class of KafkaTelemetryConfig. |
| 97 | */ |
Jian Li | 52c1122 | 2018-06-07 11:39:17 +0900 | [diff] [blame] | 98 | interface Builder extends TelemetryConfig.Builder { |
Jian Li | ff8b9f9 | 2018-06-05 17:36:37 +0900 | [diff] [blame] | 99 | |
| 100 | /** |
| 101 | * Sets kafka IP address. |
| 102 | * |
| 103 | * @param address kafka IP address |
| 104 | * @return builder instances |
| 105 | */ |
| 106 | Builder withAddress(String address); |
| 107 | |
| 108 | /** |
| 109 | * Sets kafka port number. |
| 110 | * |
| 111 | * @param port kafka port number |
| 112 | * @return builder instance |
| 113 | */ |
| 114 | Builder withPort(int port); |
| 115 | |
| 116 | /** |
| 117 | * Sets number of request retries. |
| 118 | * |
| 119 | * @param retries number of request retries |
| 120 | * @return builder instance |
| 121 | */ |
| 122 | Builder withRetries(int retries); |
| 123 | |
| 124 | /** |
| 125 | * Sets the required acknowledgment. |
| 126 | * |
| 127 | * @param requiredAcks required acknowledgement |
| 128 | * @return builder instance |
| 129 | */ |
| 130 | Builder withRequiredAcks(String requiredAcks); |
| 131 | |
| 132 | /** |
| 133 | * Sets batch size. |
| 134 | * |
| 135 | * @param batchSize batch size |
| 136 | * @return builder instance |
| 137 | */ |
| 138 | Builder withBatchSize(int batchSize); |
| 139 | |
| 140 | /** |
| 141 | * Sets linger ms. |
| 142 | * |
| 143 | * @param lingerMs linger ms |
| 144 | * @return builder instance |
| 145 | */ |
| 146 | Builder withLingerMs(int lingerMs); |
| 147 | |
| 148 | /** |
| 149 | * Sets memory buffer size. |
| 150 | * |
| 151 | * @param memoryBuffer memory buffer size |
| 152 | * @return builder instance |
| 153 | */ |
| 154 | Builder withMemoryBuffer(int memoryBuffer); |
| 155 | |
| 156 | /** |
| 157 | * Sets kafka key serializer. |
| 158 | * |
| 159 | * @param keySerializer kafka key serializer |
| 160 | * @return builder instance |
| 161 | */ |
| 162 | Builder withKeySerializer(String keySerializer); |
| 163 | |
| 164 | /** |
| 165 | * Sets kafka value serializer. |
| 166 | * |
| 167 | * @param valueSerializer kafka value serializer |
| 168 | * @return builder instance |
| 169 | */ |
| 170 | Builder withValueSerializer(String valueSerializer); |
| 171 | |
| 172 | /** |
| 173 | * Sets other kafka configuration map. |
| 174 | * |
| 175 | * @param configMap kafka configuration map |
| 176 | * @return builder instance |
| 177 | */ |
| 178 | Builder withConfigMap(Map<String, Object> configMap); |
| 179 | |
| 180 | /** |
| 181 | * Creates a kafka telemetry config instance. |
| 182 | * |
| 183 | * @return kafka telemetry config instance |
| 184 | */ |
| 185 | KafkaTelemetryConfig build(); |
| 186 | } |
| 187 | } |