2 * ============LICENSE_START======================================================================
3 * Copyright (C) 2018, 2020 NOKIA Intellectual Property, 2018-2023 Nordix Foundation. All rights reserved.
4 * ===============================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
6 * in compliance with the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software distributed under the License
11 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12 * or implied. See the License for the specific language governing permissions and limitations under
14 * ============LICENSE_END========================================================================
17 package org.oran.datafile.tasks;
19 import com.google.gson.Gson;
20 import com.google.gson.GsonBuilder;
22 import java.nio.file.Files;
23 import java.nio.file.Path;
24 import java.nio.file.Paths;
25 import java.time.Duration;
26 import java.util.ArrayList;
27 import java.util.HashMap;
30 import org.apache.kafka.clients.producer.ProducerConfig;
31 import org.apache.kafka.clients.producer.ProducerRecord;
32 import org.apache.kafka.common.header.Header;
33 import org.apache.kafka.common.header.internals.RecordHeader;
34 import org.apache.kafka.common.serialization.StringSerializer;
35 import org.oran.datafile.configuration.AppConfig;
36 import org.oran.datafile.configuration.CertificateConfig;
37 import org.oran.datafile.datastore.DataStore;
38 import org.oran.datafile.datastore.DataStore.Bucket;
39 import org.oran.datafile.exceptions.DatafileTaskException;
40 import org.oran.datafile.http.HttpsClientConnectionManagerUtil;
41 import org.oran.datafile.model.Counters;
42 import org.oran.datafile.model.FileData;
43 import org.oran.datafile.model.FilePublishInformation;
44 import org.oran.datafile.model.FileReadyMessage;
45 import org.oran.datafile.oauth2.SecurityContext;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48 import org.springframework.stereotype.Component;
50 import reactor.core.publisher.Flux;
51 import reactor.core.publisher.Mono;
52 import reactor.core.scheduler.Scheduler;
53 import reactor.core.scheduler.Schedulers;
54 import reactor.kafka.sender.KafkaSender;
55 import reactor.kafka.sender.SenderOptions;
56 import reactor.kafka.sender.SenderRecord;
57 import reactor.kafka.sender.SenderResult;
58 import reactor.util.retry.Retry;
61 * This implements the main flow of the data file collector. Fetch file ready
63 * message router, fetch new files from the PNF publish these in the data
67 public class CollectAndReportFiles {
69 private static Gson gson = new GsonBuilder() //
70 .disableHtmlEscaping() //
73 private static final long FILE_TRANSFER_MAX_RETRIES = 2;
74 private static final Duration FILE_TRANSFER_INITIAL_RETRY_TIMEOUT = Duration.ofSeconds(2);
76 private static final Logger logger = LoggerFactory.getLogger(CollectAndReportFiles.class);
78 private final AppConfig appConfig;
80 private Counters counters = new Counters();
82 private final KafkaSender<String, String> kafkaSender;
84 private final DataStore dataStore;
86 private final SecurityContext securityContext;
89 * Constructor for task registration in Datafile Workflow.
91 * @param applicationConfiguration - application configuration
93 public CollectAndReportFiles(SecurityContext securityContext, AppConfig applicationConfiguration) {
94 this.appConfig = applicationConfiguration;
95 this.kafkaSender = KafkaSender.create(kafkaSenderOptions());
96 this.securityContext = securityContext;
99 this.dataStore = DataStore.create(applicationConfiguration);
104 private void initCerts() {
106 CertificateConfig certificateConfig = appConfig.getCertificateConfiguration();
107 HttpsClientConnectionManagerUtil.setupOrUpdate(certificateConfig.keyCert, certificateConfig.keyPasswordPath,
108 certificateConfig.trustedCa, certificateConfig.trustedCaPasswordPath, true);
109 } catch (DatafileTaskException e) {
110 logger.error("Could not setup HttpsClient certs, reason: {}", e.getMessage());
115 * Main function for scheduling for the file collection Workflow.
117 public void start() {
121 private void start(int delayMillis) {
123 logger.trace("Starting");
124 if (appConfig.isS3Enabled()) {
125 this.dataStore.create(Bucket.FILES).subscribe();
126 this.dataStore.create(Bucket.LOCKS).subscribe();
128 Thread.sleep(delayMillis);
129 createMainTask().subscribe(null, s -> start(2000), null);
130 } catch (Exception e) {
131 logger.error("Unexpected exception: {}", e.toString(), e);
132 Thread.currentThread().interrupt();
136 Flux<FilePublishInformation> createMainTask() {
137 final int noOfWorkerThreads = appConfig.getNoOfWorkerThreads();
138 Scheduler scheduler = Schedulers.newParallel("FileCollectorWorker", noOfWorkerThreads);
139 return fetchFromKafka() //
140 .doOnNext(fileReadyMessage -> counters.threadPoolQueueSize.incrementAndGet()) //
141 .doOnNext(fileReadyMessage -> counters.incNoOfReceivedEvents()) //
142 .parallel(noOfWorkerThreads) // Each FileReadyMessage in a separate thread
144 .doOnNext(fileReadyMessage -> counters.threadPoolQueueSize.decrementAndGet()) //
145 .flatMap(fileReadyMessage -> Flux.fromIterable(FileData.createFileData(fileReadyMessage)), true, 1) //
146 .flatMap(this::filterNotFetched, false, 1, 1) //
147 .flatMap(this::fetchFile, false, 1, 1) //
148 .flatMap(data -> reportFetchedFile(data, appConfig.getCollectedFileTopic()), false, 1) //
150 .doOnError(t -> logger.error("Received error: {}", t.toString())); //
153 private Mono<FileData> deleteLock(FileData info) {
154 return dataStore.deleteLock(lockName(info.name())).map(b -> info); //
157 private Mono<FilePublishInformation> moveFileToS3Bucket(FilePublishInformation info) {
158 if (this.appConfig.isS3Enabled()) {
159 return dataStore.copyFileTo(locaFilePath(info), info.getName())
160 .doOnError(t -> logger.warn("Failed to store file '{}' in S3 {}", info.getName(), t.getMessage())) //
161 .retryWhen(Retry.backoff(4, Duration.ofMillis(1000))) //
163 .doOnError(t -> logger.error("Failed to store file '{}' in S3 after retries {}", info.getName(),
165 .doOnNext(n -> logger.debug("Stored file in S3: {}", info.getName())) //
166 .doOnNext(sig -> deleteLocalFile(info));
168 return Mono.just(info);
172 private Mono<FileData> filterNotFetched(FileData fileData) {
173 Path localPath = fileData.getLocalFilePath(this.appConfig);
175 return dataStore.fileExists(Bucket.FILES, fileData.name()) //
176 .filter(exists -> !exists) //
177 .filter(exists -> !localPath.toFile().exists()) //
178 .map(f -> fileData); //
182 private String lockName(String fileName) {
183 return fileName + ".lck";
186 private Path locaFilePath(FilePublishInformation info) {
187 return Paths.get(appConfig.getCollectedFilesPath(), info.getName());
190 private void deleteLocalFile(FilePublishInformation info) {
191 Path path = locaFilePath(info);
194 } catch (Exception e) {
195 logger.warn("Could not delete local file: {}, reason:{}", path, e.getMessage());
199 private Flux<FilePublishInformation> reportFetchedFile(FilePublishInformation fileData, String topic) {
200 String json = gson.toJson(fileData);
201 return sendDataToStream(topic, fileData.getSourceName(), json) //
202 .map(result -> fileData);
205 public Flux<SenderResult<Integer>> sendDataToStream(String topic, String sourceName, String value) {
206 return sendDataToKafkaStream(Flux.just(senderRecord(topic, sourceName, value)));
209 private SenderRecord<String, String, Integer> senderRecord(String topic, String sourceName, String value) {
210 int correlationMetadata = 2;
212 var producerRecord = new ProducerRecord<>(topic, null, null, key, value, kafkaHeaders(sourceName));
213 return SenderRecord.create(producerRecord, correlationMetadata);
216 private Iterable<Header> kafkaHeaders(String sourceName) {
217 ArrayList<Header> result = new ArrayList<>();
218 Header h = new RecordHeader("SourceName", sourceName.getBytes());
223 private Flux<SenderResult<Integer>> sendDataToKafkaStream(Flux<SenderRecord<String, String, Integer>> dataToSend) {
224 return kafkaSender.send(dataToSend) //
225 .doOnError(e -> logger.error("Send to kafka failed", e));
228 private SenderOptions<String, String> kafkaSenderOptions() {
229 String bootstrapServers = this.appConfig.getKafkaBootStrapServers();
231 Map<String, Object> props = new HashMap<>();
232 props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, bootstrapServers);
233 props.put(ProducerConfig.ACKS_CONFIG, "all");
234 props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
235 props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
236 this.appConfig.addKafkaSecurityProps(props);
237 return SenderOptions.create(props);
240 public Counters getCounters() {
241 return this.counters;
244 protected FileCollector createFileCollector() {
245 return new FileCollector(securityContext, appConfig, counters);
248 private Mono<FilePublishInformation> fetchFile(FileData fileData) {
249 return this.dataStore.createLock(lockName(fileData.name())).filter(granted -> granted) //
250 .map(granted -> createFileCollector()) //
251 .flatMap(collector -> collector.collectFile(fileData, FILE_TRANSFER_MAX_RETRIES,
252 FILE_TRANSFER_INITIAL_RETRY_TIMEOUT)) //
253 .flatMap(this::moveFileToS3Bucket) //
254 .doOnNext(b -> deleteLock(fileData).subscribe()) //
255 .doOnError(b -> deleteLock(fileData).subscribe()) //
256 .onErrorResume(exception -> handleFetchFileFailure(fileData, exception)); //
259 private Mono<FilePublishInformation> handleFetchFileFailure(FileData fileData, Throwable t) {
260 Path localFilePath = fileData.getLocalFilePath(this.appConfig);
261 logger.error("File fetching failed, path {}, reason: {}", fileData.remoteFilePath(), t.getMessage());
262 deleteFile(localFilePath);
263 if (FileData.Scheme.isFtpScheme(fileData.scheme())) {
264 counters.incNoOfFailedFtp();
266 counters.incNoOfFailedHttp();
272 * Fetch more messages from the message router. This is done in a
273 * polling/blocking fashion.
275 private Flux<FileReadyMessage> fetchFromKafka() {
276 KafkaTopicListener listener = new KafkaTopicListener(this.appConfig);
277 return listener.getFlux() //
278 .flatMap(this::parseReceivedFileReadyMessage, 1);
282 Mono<FileReadyMessage> parseReceivedFileReadyMessage(KafkaTopicListener.DataFromTopic data) {
284 FileReadyMessage msg = gson.fromJson(data.value, FileReadyMessage.class);
285 logger.debug("Received: {}", msg);
286 return Mono.just(msg);
287 } catch (Exception e) {
288 logger.warn("Could not parse received: {}, reason: {}", data.value, e.getMessage());
293 private static void deleteFile(Path localFile) {
294 logger.trace("Deleting file: {}", localFile);
296 Files.delete(localFile);
297 } catch (Exception e) {
298 logger.trace("Could not delete file: {}, reason: {}", localFile, e.getMessage());