Introduce using Amazon S3 - Cloud Object Storage - AWS for storing of data.
Change-Id: I68365c24c63544b5ad8e958a98f48d95f83e3084
Issue-ID: CCSDK-3810
Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
http.proxy-host:
http.proxy-port: 0
http.proxy-type: HTTP
- # path where the service can store data
+ # path where the service can store data. This parameter is not relevant if S3 Object store is configured.
vardata-directory: /var/policy-management-service
# the config-file-schema-path referres to a location in the jar file. If this property is empty or missing,
# no schema validation will be executed.
# A file containing an authorization token, which shall be inserted in each HTTP header (authorization).
# If the file name is empty, no authorization token is sent.
auth-token-file:
+ # S3 object store usage is enabled by defining the bucket to use. This will override the vardata-directory parameter.
+ s3:
+ endpointOverride: http://localhost:9000
+ accessKeyId: minio
+ secretAccessKey: miniostorage
+ bucket:
<guava.version>31.0.1-jre</guava.version>
<docker-maven-plugin>0.30.0</docker-maven-plugin>
<surefire-maven-plugin.version>3.0.0-M5</surefire-maven-plugin.version>
- <snakeyaml.version>1.32</snakeyaml.version><!-- overrides version included via spring-boot-starter:jar:2.6.11 to address CVE-2022-38752. Remove later if possible -->
- <!-- Version must be higher than version 2.19.1 that is defined in the parent pom for JUnit 5 tests to be run. Do not remove! -->
<jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version>
<swagger-codegen-maven-plugin.version>3.0.11</swagger-codegen-maven-plugin.version>
<exec.skip>true</exec.skip>
<ccsdk.project.version>${project.version}</ccsdk.project.version>
+ <software.amazon.awssdk.version>2.17.292</software.amazon.awssdk.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
+ <dependency>
+ <groupId>software.amazon.awssdk</groupId>
+ <artifactId>s3</artifactId>
+ <version>${software.amazon.awssdk.version}</version>
+ </dependency>
<!--REQUIRED TO GENERATE DOCUMENTATION -->
<dependency>
<groupId>io.springfox</groupId>
</plugin>
</plugins>
</build>
-</project>
+</project>
\ No newline at end of file
package org.onap.ccsdk.oran.a1policymanagementservice;
-import com.fasterxml.jackson.databind.ObjectMapper;
+
import org.apache.catalina.connector.Connector;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.SecurityContext;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
import org.springframework.beans.factory.annotation.Autowired;
@Bean
public Services getServices(@Autowired ApplicationConfig applicationConfig) {
- return new Services(applicationConfig);
+ Services services = new Services(applicationConfig);
+ services.restoreFromDatabase().subscribe();
+ return services;
}
@Bean
- public A1ClientFactory getA1ClientFactory(@Autowired ApplicationConfig applicationConfig,
- @Autowired SecurityContext securityContext) {
- return new A1ClientFactory(applicationConfig, securityContext);
+ public PolicyTypes getPolicyTypes(@Autowired ApplicationConfig applicationConfig) {
+ PolicyTypes types = new PolicyTypes(applicationConfig);
+ types.restoreFromDatabase().blockLast();
+ return types;
+ }
+
+ @Bean
+ public Policies getPolicies(@Autowired ApplicationConfig applicationConfig) {
+ return new Policies(applicationConfig);
}
@Bean
- public ObjectMapper mapper() {
- return new ObjectMapper();
+ public A1ClientFactory getA1ClientFactory(@Autowired ApplicationConfig applicationConfig,
+ @Autowired SecurityContext securityContext) {
+ return new A1ClientFactory(applicationConfig, securityContext);
}
@Bean
package org.onap.ccsdk.oran.a1policymanagementservice.configuration;
+import com.google.common.base.Strings;
+
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
@Value("${app.webclient.http.proxy-type:HTTP}")
private String httpProxyType = "HTTP";
+ @Getter
+ @Value("${app.s3.endpointOverride:}")
+ private String s3EndpointOverride;
+
+ @Getter
+ @Value("${app.s3.accessKeyId:}")
+ private String s3AccessKeyId;
+
+ @Getter
+ @Value("${app.s3.secretAccessKey:}")
+ private String s3SecretAccessKey;
+
+ @Getter
+ @Value("${app.s3.bucket:}")
+ private String s3Bucket;
+
private Map<String, RicConfig> ricConfigs = new HashMap<>();
@Getter
return Flux.fromIterable(modifications);
}
+
+ public boolean isS3Enabled() {
+ return !(Strings.isNullOrEmpty(s3EndpointOverride) || Strings.isNullOrEmpty(s3Bucket));
+ }
+
}
* ========================LICENSE_END===================================
*/
-package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
+package org.onap.ccsdk.oran.a1policymanagementservice.configuration;
import io.micrometer.core.instrument.MeterRegistry;
-import java.lang.invoke.MethodHandles;
-import lombok.AccessLevel;
-import lombok.Getter;
+
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
/**
- * The aim is to collect statistical values from the A1 Policy Management Service.
+ * The aim is to collect statistical values from the A1 Policy Management
+ * Service.
+ * The counters are being updated every minute.
*/
@Component
-public class RefreshCounterTask {
-
- private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
-
- @Autowired
- private final Rics rics;
-
- @Autowired
- private final PolicyTypes policyTypes;
+public class Meters {
@Autowired
- private final Policies policies;
-
- @Autowired
- @Getter(AccessLevel.PUBLIC)
- private final MeterRegistry meterRegistry;
-
- @Autowired
- public RefreshCounterTask(Rics rics, PolicyTypes policyTypes, Policies policies, MeterRegistry meterRegistry) {
- this.rics = rics;
- this.policyTypes = policyTypes;
- this.policies = policies;
- this.meterRegistry = meterRegistry;
-
- logger.trace("Counters have been initialized.");
+ public Meters(Rics rics, PolicyTypes policyTypes, Policies policies, MeterRegistry meterRegistry) {
meterRegistry.gauge("total_ric_count", rics, Rics::size);
meterRegistry.gauge("total_policy_type_count", policyTypes, PolicyTypes::size);
meterRegistry.gauge("total_policy_count", policies, Policies::size);
}
-
}
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
+
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
+
import java.lang.invoke.MethodHandles;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
+
import lombok.Getter;
+
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.VoidResponse;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2022 Nordix Foundation. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.ccsdk.oran.a1policymanagementservice.datastore;
+
+import com.google.common.base.Strings;
+
+import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+public interface DataStore {
+
+ public Flux<String> listObjects(String prefix);
+
+ public Mono<byte[]> readObject(String name);
+
+ public Mono<byte[]> writeObject(String name, byte[] fileData);
+
+ public Mono<Boolean> deleteObject(String name);
+
+ public Mono<String> createDataStore();
+
+ public Mono<String> deleteAllObjects();
+
+ public static DataStore create(ApplicationConfig appConfig, String location) {
+ if (appConfig.isS3Enabled()) {
+ return new S3ObjectStore(appConfig, location);
+ } else if (!Strings.isNullOrEmpty(appConfig.getVardataDirectory())) {
+ return new FileStore(appConfig, location);
+ } else {
+ return new NullStore(location);
+ }
+
+ }
+
+}
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2022 Nordix Foundation. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+
+package org.onap.ccsdk.oran.a1policymanagementservice.datastore;
+
+import com.google.common.base.Strings;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.lang.invoke.MethodHandles;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Stream;
+
+import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+class FileStore implements DataStore {
+ private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+ ApplicationConfig applicationConfig;
+ private final String location;
+
+ public FileStore(ApplicationConfig applicationConfig, String location) {
+ this.applicationConfig = applicationConfig;
+ this.location = location;
+ }
+
+ @Override
+ public Flux<String> listObjects(String prefix) {
+ Path root = Path.of(path().toString(), prefix);
+ if (!root.toFile().exists()) {
+ root = root.getParent();
+ }
+
+ logger.debug("Listing files in: {}", root);
+
+ List<String> result = new ArrayList<>();
+ try (Stream<Path> stream = Files.walk(root, Integer.MAX_VALUE)) {
+
+ stream.forEach(path -> filterListFiles(path, prefix, result));
+
+ return Flux.fromIterable(result);
+ } catch (Exception e) {
+ logger.warn("Could not list filed in {}, reason; {}", root, e.getMessage());
+ return Flux.error(e);
+ }
+ }
+
+ private void filterListFiles(Path path, String prefix, List<String> result) {
+ if (path.toFile().isFile() && externalName(path).startsWith(prefix)) {
+ result.add(externalName(path));
+ } else {
+ logger.trace("Ignoring file/directory {}, prefix: {}", path, prefix);
+ }
+ }
+
+ private String externalName(Path path) {
+ String fullName = path.toString();
+ String externalName = fullName.substring(path().toString().length());
+ if (externalName.startsWith("/")) {
+ externalName = externalName.substring(1);
+ }
+ return externalName;
+ }
+
+ @Override
+ public Mono<byte[]> readObject(String fileName) {
+ try {
+ byte[] contents = Files.readAllBytes(path(fileName));
+ return Mono.just(contents);
+ } catch (Exception e) {
+ return Mono.error(e);
+ }
+ }
+
+ @Override
+ public Mono<Boolean> deleteObject(String name) {
+ try {
+ Files.delete(path(name));
+ return Mono.just(true);
+ } catch (Exception e) {
+ logger.debug("Could not delete file: {}, reason: {}", path(name), e.getMessage());
+ return Mono.just(false);
+ }
+ }
+
+ @Override
+ public Mono<String> createDataStore() {
+ try {
+ if (!Strings.isNullOrEmpty(applicationConfig.getVardataDirectory())) {
+ Files.createDirectories(path());
+ }
+ } catch (IOException e) {
+ logger.error("Could not create directory: {}, reason: {}", path(), e.getMessage());
+ }
+ return Mono.just("OK");
+ }
+
+ private Path path(String name) {
+ return Path.of(path().toString(), name);
+ }
+
+ private Path path() {
+ return Path.of(applicationConfig.getVardataDirectory(), "database", this.location);
+ }
+
+ @Override
+ public Mono<String> deleteAllObjects() {
+ return listObjects("") //
+ .flatMap(this::deleteObject) //
+ .collectList() //
+ .map(o -> "OK");
+ }
+
+ @Override
+ public Mono<byte[]> writeObject(String fileName, byte[] fileData) {
+ try {
+ if (!Strings.isNullOrEmpty(applicationConfig.getVardataDirectory())) {
+ Files.createDirectories(path(fileName).getParent());
+ }
+ File outputFile = path(fileName).toFile();
+
+ try (FileOutputStream outputStream = new FileOutputStream(outputFile)) {
+ outputStream.write(fileData);
+ }
+ } catch (IOException e) {
+ logger.warn("Could not write file: {}, reason; {}", path(fileName), e.getMessage());
+ }
+ return Mono.just(fileData);
+ }
+
+}
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2022 Nordix Foundation. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.ccsdk.oran.a1policymanagementservice.datastore;
+
+import java.lang.invoke.MethodHandles;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+class NullStore implements DataStore {
+ private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+ public NullStore(String location) {
+ logger.warn("No storage defined for: {}", location);
+ }
+
+ @Override
+ public Flux<String> listObjects(String prefix) {
+ return Flux.empty();
+ }
+
+ @Override
+ public Mono<byte[]> readObject(String name) {
+ return Mono.just(new byte[0]);
+ }
+
+ @Override
+ public Mono<byte[]> writeObject(String name, byte[] fileData) {
+ return Mono.just(new byte[0]);
+ }
+
+ @Override
+ public Mono<Boolean> deleteObject(String name) {
+ return Mono.just(false);
+ }
+
+ @Override
+ public Mono<String> createDataStore() {
+ return Mono.just("");
+ }
+
+ @Override
+ public Mono<String> deleteAllObjects() {
+ return Mono.just("");
+ }
+
+}
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2022 Nordix Foundation. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.ccsdk.oran.a1policymanagementservice.datastore;
+
+import java.net.URI;
+import java.util.concurrent.CompletableFuture;
+
+import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.core.BytesWrapper;
+import software.amazon.awssdk.core.ResponseBytes;
+import software.amazon.awssdk.core.async.AsyncRequestBody;
+import software.amazon.awssdk.core.async.AsyncResponseTransformer;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.s3.S3AsyncClient;
+import software.amazon.awssdk.services.s3.S3AsyncClientBuilder;
+import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
+import software.amazon.awssdk.services.s3.model.CreateBucketResponse;
+import software.amazon.awssdk.services.s3.model.DeleteBucketRequest;
+import software.amazon.awssdk.services.s3.model.DeleteBucketResponse;
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
+import software.amazon.awssdk.services.s3.model.DeleteObjectResponse;
+import software.amazon.awssdk.services.s3.model.GetObjectRequest;
+import software.amazon.awssdk.services.s3.model.GetObjectResponse;
+import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
+import software.amazon.awssdk.services.s3.model.ListObjectsResponse;
+import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+import software.amazon.awssdk.services.s3.model.PutObjectResponse;
+import software.amazon.awssdk.services.s3.model.S3Object;
+
+class S3ObjectStore implements DataStore {
+ private static final Logger logger = LoggerFactory.getLogger(S3ObjectStore.class);
+ private final ApplicationConfig applicationConfig;
+
+ private static S3AsyncClient s3AsynchClient;
+ private final String location;
+
+ public S3ObjectStore(ApplicationConfig applicationConfig, String location) {
+ this.applicationConfig = applicationConfig;
+ this.location = location;
+
+ getS3AsynchClient(applicationConfig);
+ }
+
+ private static synchronized S3AsyncClient getS3AsynchClient(ApplicationConfig applicationConfig) {
+ if (applicationConfig.isS3Enabled() && s3AsynchClient == null) {
+ s3AsynchClient = getS3AsyncClientBuilder(applicationConfig).build();
+ }
+ return s3AsynchClient;
+ }
+
+ private static S3AsyncClientBuilder getS3AsyncClientBuilder(ApplicationConfig applicationConfig) {
+ URI uri = URI.create(applicationConfig.getS3EndpointOverride());
+ return S3AsyncClient.builder() //
+ .region(Region.US_EAST_1) //
+ .endpointOverride(uri) //
+ .credentialsProvider(StaticCredentialsProvider.create( //
+ AwsBasicCredentials.create(applicationConfig.getS3AccessKeyId(), //
+ applicationConfig.getS3SecretAccessKey())));
+ }
+
+ @Override
+ public Flux<String> listObjects(String prefix) {
+ return listObjectsInBucket(bucket(), location + "/" + prefix).map(S3Object::key) //
+ .map(this::externalName);
+ }
+
+ @Override
+ public Mono<Boolean> deleteObject(String name) {
+ DeleteObjectRequest request = DeleteObjectRequest.builder() //
+ .bucket(bucket()) //
+ .key(key(name)) //
+ .build();
+
+ CompletableFuture<DeleteObjectResponse> future = s3AsynchClient.deleteObject(request);
+
+ return Mono.fromFuture(future).map(resp -> true);
+ }
+
+ @Override
+ public Mono<byte[]> readObject(String name) {
+ return getDataFromS3Object(bucket(), name);
+ }
+
+ @Override
+ public Mono<byte[]> writeObject(String name, byte[] fileData) {
+
+ PutObjectRequest request = PutObjectRequest.builder() //
+ .bucket(bucket()) //
+ .key(key(name)) //
+ .build();
+
+ AsyncRequestBody body = AsyncRequestBody.fromBytes(fileData);
+
+ CompletableFuture<PutObjectResponse> future = s3AsynchClient.putObject(request, body);
+
+ return Mono.fromFuture(future) //
+ .map(putObjectResponse -> fileData) //
+ .doOnError(t -> logger.error("Failed to store object '{}' in S3 {}", key(name), t.getMessage()));
+ }
+
+ @Override
+ public Mono<String> createDataStore() {
+ return createS3Bucket(bucket());
+ }
+
+ private Mono<String> createS3Bucket(String s3Bucket) {
+
+ CreateBucketRequest request = CreateBucketRequest.builder() //
+ .bucket(s3Bucket) //
+ .build();
+
+ CompletableFuture<CreateBucketResponse> future = s3AsynchClient.createBucket(request);
+
+ return Mono.fromFuture(future) //
+ .map(f -> s3Bucket) //
+ .doOnError(t -> logger.debug("Could not create S3 bucket: {}", t.getMessage()))
+ .onErrorResume(t -> Mono.just(s3Bucket));
+ }
+
+ @Override
+ public Mono<String> deleteAllObjects() {
+ return listObjects("") //
+ .flatMap(this::deleteObject) //
+ .collectList() //
+ .map(resp -> "OK").onErrorResume(t -> Mono.just("NOK"));
+ }
+
+ public Mono<String> deleteBucket() {
+ DeleteBucketRequest request = DeleteBucketRequest.builder() //
+ .bucket(bucket()) //
+ .build();
+
+ CompletableFuture<DeleteBucketResponse> future = s3AsynchClient.deleteBucket(request);
+
+ return Mono.fromFuture(future) //
+ .doOnError(t -> logger.warn("Could not delete bucket: {}, reason: {}", bucket(), t.getMessage()))
+ .map(resp -> bucket()) //
+ .doOnNext(resp -> logger.debug("Deleted bucket: {}", bucket())).onErrorResume(t -> Mono.just("NOK"));
+ }
+
+ private String bucket() {
+ return applicationConfig.getS3Bucket();
+ }
+
+ private Flux<S3Object> listObjectsInBucket(String bucket, String prefix) {
+
+ return listObjectsRequest(bucket, prefix, null) //
+ .expand(response -> listObjectsRequest(bucket, prefix, response)) //
+ .map(ListObjectsResponse::contents) //
+ .doOnNext(f -> logger.debug("Found objects in {}: {}", bucket, f.size())) //
+ .doOnError(t -> logger.warn("Error fromlist objects: {}", t.getMessage())) //
+ .flatMap(Flux::fromIterable) //
+ .doOnNext(obj -> logger.debug("Found object: {}", obj.key()));
+ }
+
+ private Mono<ListObjectsResponse> listObjectsRequest(String bucket, String prefix,
+ ListObjectsResponse prevResponse) {
+ ListObjectsRequest.Builder builder = ListObjectsRequest.builder() //
+ .bucket(bucket) //
+ .maxKeys(1000) //
+ .prefix(prefix);
+
+ if (prevResponse != null) {
+ if (Boolean.TRUE.equals(prevResponse.isTruncated())) {
+ builder.marker(prevResponse.nextMarker());
+ } else {
+ return Mono.empty();
+ }
+ }
+
+ ListObjectsRequest listObjectsRequest = builder.build();
+ CompletableFuture<ListObjectsResponse> future = s3AsynchClient.listObjects(listObjectsRequest);
+ return Mono.fromFuture(future);
+ }
+
+ private Mono<byte[]> getDataFromS3Object(String bucket, String name) {
+
+ GetObjectRequest request = GetObjectRequest.builder() //
+ .bucket(bucket) //
+ .key(key(name)) //
+ .build();
+
+ CompletableFuture<ResponseBytes<GetObjectResponse>> future =
+ s3AsynchClient.getObject(request, AsyncResponseTransformer.toBytes());
+
+ return Mono.fromFuture(future) //
+ .map(BytesWrapper::asByteArray) //
+ .doOnError(t -> logger.error("Failed to get file from S3, key:{}, bucket: {}, {}", key(name), bucket,
+ t.getMessage())) //
+ .doOnEach(n -> logger.debug("Read file from S3: {} {}", bucket, key(name))) //
+ .onErrorResume(t -> Mono.empty());
+ }
+
+ private String key(String name) {
+ return location + "/" + name;
+ }
+
+ private String externalName(String internalName) {
+ return internalName.substring(key("").length());
+ }
+
+}
* ========================LICENSE_START=================================
* ONAP : ccsdk oran
* ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
+ * Copyright (C) 2019-2022 Nordix Foundation. All rights reserved.
* ======================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.PrintStream;
import java.lang.invoke.MethodHandles;
-import java.nio.file.Files;
-import java.nio.file.Path;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
import java.util.Vector;
import lombok.Getter;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.onap.ccsdk.oran.a1policymanagementservice.datastore.DataStore;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
-import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.util.FileSystemUtils;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
import reactor.util.annotation.Nullable;
@SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
-@Configuration
public class Policies {
@Getter
private MultiMap<Policy> policiesRic = new MultiMap<>();
private MultiMap<Policy> policiesService = new MultiMap<>();
private MultiMap<Policy> policiesType = new MultiMap<>();
+ private final DataStore dataStore;
private final ApplicationConfig appConfig;
private static Gson gson = new GsonBuilder().create();
public Policies(@Autowired ApplicationConfig appConfig) {
this.appConfig = appConfig;
+ this.dataStore = DataStore.create(appConfig, "policies");
+ }
+
+ public Flux<Policy> restoreFromDatabase(Ric ric, PolicyTypes types) {
+ return dataStore.createDataStore() //
+ .flatMapMany(x -> dataStore.listObjects(getPath(ric))) //
+ .flatMap(dataStore::readObject) //
+ .map(String::new) //
+ .map(json -> gson.fromJson(json, PersistentPolicyInfo.class)) //
+ .map(policyInfo -> toPolicy(policyInfo, ric, types)) //
+ .doOnNext(this::put) //
+ .filter(Objects::nonNull) //
+ .doOnError(t -> logger.warn("Could not restore policy database for RIC: {}, reason : {}", ric.id(),
+ t.getMessage())) //
+ .doFinally(sig -> logger.debug("Restored policy database for RIC: {}, number of policies: {}", ric.id(),
+ this.policiesRic.get(ric.id()).size())) //
+ .onErrorResume(t -> Flux.empty()) //
+ ;
}
public synchronized void put(Policy policy) {
public synchronized void remove(Policy policy) {
if (!policy.isTransient()) {
- try {
- Files.delete(getPath(policy));
- } catch (Exception e) {
- logger.debug("Could not delete policy from database: {}", e.getMessage());
- }
+ dataStore.deleteObject(getPath(policy)).subscribe();
}
policiesId.remove(policy.getId());
policiesRic.remove(policy.getRic().id(), policy.getId());
Set<String> keys = policiesId.keySet();
removeId(keys.iterator().next());
}
- try {
- if (this.appConfig.getVardataDirectory() != null) {
- FileSystemUtils.deleteRecursively(getDatabasePath());
- }
- } catch (Exception e) {
- logger.warn("Could not delete policy database : {}", e.getMessage());
- }
+ dataStore.deleteAllObjects().onErrorResume(t -> Mono.empty()).subscribe();
}
public void store(Policy policy) {
- try {
- Files.createDirectories(getDatabasePath(policy.getRic()));
- try (PrintStream out = new PrintStream(new FileOutputStream(getFile(policy)))) {
- out.print(gson.toJson(toStorageObject(policy)));
- }
- } catch (Exception e) {
- logger.warn("Could not store policy: {} {}", policy.getId(), e.getMessage());
- }
+
+ byte[] bytes = gson.toJson(toStorageObject(policy)).getBytes();
+ this.dataStore.writeObject(this.getPath(policy), bytes) //
+ .doOnError(t -> logger.error("Could not store job in S3, reason: {}", t.getMessage())) //
+ .subscribe();
}
private boolean isMatch(String filterValue, String actualValue) {
return filtered;
}
- private File getFile(Policy policy) throws ServiceException {
- return getPath(policy).toFile();
- }
-
- private Path getPath(Policy policy) throws ServiceException {
- return Path.of(getDatabaseDirectory(policy.getRic()), policy.getId() + ".json");
- }
-
- public synchronized void restoreFromDatabase(Ric ric, PolicyTypes types) {
- try {
- Files.createDirectories(getDatabasePath(ric));
- for (File file : getDatabasePath(ric).toFile().listFiles()) {
- String json = Files.readString(file.toPath());
- PersistentPolicyInfo policyStorage = gson.fromJson(json, PersistentPolicyInfo.class);
- this.put(toPolicy(policyStorage, ric, types));
- }
- logger.debug("Restored policy database for RIC: {}, number of policies: {}", ric.id(),
- this.policiesRic.get(ric.id()).size());
- } catch (Exception e) {
- logger.warn("Could not restore policy database for RIC: {}, reason : {}", ric.id(), e.getMessage());
- }
- }
-
private PersistentPolicyInfo toStorageObject(Policy p) {
return PersistentPolicyInfo.builder() //
.id(p.getId()) //
.build();
}
- Policy toPolicy(PersistentPolicyInfo p, Ric ric, PolicyTypes types) throws EntityNotFoundException {
- return Policy.builder() //
- .id(p.getId()) //
- .isTransient(p.isTransient()) //
- .json(p.getJson()) //
- .lastModified(Instant.parse(p.lastModified)) //
- .ownerServiceId(p.getOwnerServiceId()) //
- .ric(ric) //
- .statusNotificationUri(p.getStatusNotificationUri()) //
- .type(types.getType(p.getTypeId())) //
- .build();
- }
-
- private Path getDatabasePath(Ric ric) throws ServiceException {
- return Path.of(getDatabaseDirectory(ric));
+ private Policy toPolicy(PersistentPolicyInfo p, Ric ric, PolicyTypes types) {
+ try {
+ return Policy.builder() //
+ .id(p.getId()) //
+ .isTransient(p.isTransient()) //
+ .json(p.getJson()) //
+ .lastModified(Instant.parse(p.lastModified)) //
+ .ownerServiceId(p.getOwnerServiceId()) //
+ .ric(ric) //
+ .statusNotificationUri(p.getStatusNotificationUri()) //
+ .type(types.getType(p.getTypeId())) //
+ .build();
+ } catch (EntityNotFoundException e) {
+ logger.warn("Not found: {}", e.getMessage());
+ return null;
+ }
}
- private String getDatabaseDirectory(Ric ric) throws ServiceException {
- return getDatabaseDirectory() + "/" + ric.id();
+ private String getPath(Policy policy) {
+ return getPath(policy.getRic()) + "/" + policy.getId() + ".json";
}
- private String getDatabaseDirectory() throws ServiceException {
- if (appConfig.getVardataDirectory() == null) {
- throw new ServiceException("No database storage provided");
- }
- return appConfig.getVardataDirectory() + "/database/policyInstances";
+ private String getPath(Ric ric) {
+ return ric.id();
}
- private Path getDatabasePath() throws ServiceException {
- return Path.of(getDatabaseDirectory());
- }
}
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.PrintStream;
import java.lang.invoke.MethodHandles;
-import java.nio.file.Files;
-import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Vector;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.onap.ccsdk.oran.a1policymanagementservice.datastore.DataStore;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.context.annotation.Configuration;
import org.springframework.lang.Nullable;
-import org.springframework.util.FileSystemUtils;
-@Configuration
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
public class PolicyTypes {
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
private Map<String, PolicyType> types = new HashMap<>();
- private final ApplicationConfig appConfig;
private static Gson gson = new GsonBuilder().create();
+ private final DataStore dataStore;
public PolicyTypes(@Autowired ApplicationConfig appConfig) {
- this.appConfig = appConfig;
- restoreFromDatabase();
+ this.dataStore = DataStore.create(appConfig, "policytypes");
}
public synchronized PolicyType getType(String name) throws EntityNotFoundException {
public synchronized void clear() {
this.types.clear();
- try {
- FileSystemUtils.deleteRecursively(getDatabasePath());
- } catch (IOException | ServiceException e) {
- logger.warn("Could not delete policy type database : {}", e.getMessage());
- }
+ dataStore.deleteAllObjects().onErrorResume(t -> Mono.empty()).subscribe();
}
public void store(PolicyType type) {
- try {
- Files.createDirectories(getDatabasePath());
- try (PrintStream out = new PrintStream(new FileOutputStream(getFile(type)))) {
- out.print(gson.toJson(type));
- }
- } catch (ServiceException e) {
- logger.debug("Could not store policy type: {} {}", type.getId(), e.getMessage());
- } catch (IOException e) {
- logger.warn("Could not store policy type: {} {}", type.getId(), e.getMessage());
- }
+ byte[] bytes = gson.toJson(type).getBytes();
+ dataStore.writeObject(getPath(type), bytes) //
+ .doOnError(t -> logger.warn("Could not store policy type: {} {}", type.getId(), t.getMessage()))
+ .subscribe();
}
- private File getFile(PolicyType type) throws ServiceException {
- return Path.of(getDatabaseDirectory(), type.getId() + ".json").toFile();
- }
+ public Flux<PolicyType> restoreFromDatabase() {
- void restoreFromDatabase() {
- try {
- Files.createDirectories(getDatabasePath());
- for (File file : getDatabasePath().toFile().listFiles()) {
- String json = Files.readString(file.toPath());
- PolicyType type = gson.fromJson(json, PolicyType.class);
- this.types.put(type.getId(), type);
- }
- logger.debug("Restored type database,no of types: {}", this.types.size());
- } catch (ServiceException e) {
- logger.debug("Could not restore policy type database : {}", e.getMessage());
- } catch (Exception e) {
- logger.warn("Could not restore policy type database : {}", e.getMessage());
- }
- }
-
- private String getDatabaseDirectory() throws ServiceException {
- if (appConfig.getVardataDirectory() == null) {
- throw new ServiceException("No policy type storage provided");
- }
- return appConfig.getVardataDirectory() + "/database/policyTypes";
- }
+ return this.dataStore.createDataStore().flatMapMany(x -> dataStore.listObjects("")) //
+ .flatMap(dataStore::readObject) //
+ .map(String::new) //
+ .map(json -> gson.fromJson(json, PolicyType.class)).doOnNext(type -> this.types.put(type.getId(), type)) //
+ .doOnError(t -> logger.warn("Could not restore policy type database : {}", t.getMessage())) //
+ .doFinally(sig -> logger.debug("Restored type database,no of types: {}", this.types.size()))
+ .onErrorResume(t -> Flux.empty()); //
- private Path getDatabasePath() throws ServiceException {
- return Path.of(getDatabaseDirectory());
}
private static Collection<PolicyType> filterTypeName(Collection<PolicyType> types, String typeName) {
return result;
}
+ private String getPath(PolicyType type) {
+ return type.getId() + ".json";
+ }
+
}
* ========================LICENSE_START=================================
* ONAP : ccsdk oran
* ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
+ * Copyright (C) 2019-2022 Nordix Foundation. All rights reserved.
* ======================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
import com.google.gson.Gson;
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.PrintStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
import java.util.Vector;
import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.onap.ccsdk.oran.a1policymanagementservice.datastore.DataStore;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.util.FileSystemUtils;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
public class Services {
private static final Logger logger = LoggerFactory.getLogger(Services.class);
private static Gson gson = Service.createGson();
- private final ApplicationConfig appConfig;
+ private final DataStore dataStore;
private Map<String, Service> registeredServices = new HashMap<>();
public Services(@Autowired ApplicationConfig appConfig) {
- this.appConfig = appConfig;
- restoreFromDatabase();
+ this.dataStore = DataStore.create(appConfig, "services");
}
public synchronized Service getService(String name) throws ServiceException {
public synchronized void remove(String name) {
Service service = registeredServices.remove(name);
if (service != null) {
- try {
- Files.delete(getPath(service));
- } catch (Exception e) {
- // Doesn't matter.
- }
+ dataStore.deleteObject(getPath(service)).subscribe();
}
}
public synchronized void clear() {
registeredServices.clear();
- try {
- FileSystemUtils.deleteRecursively(getDatabasePath());
- } catch (Exception e) {
- logger.warn("Could not delete services database : {}", e.getMessage());
- }
+ dataStore.deleteAllObjects().onErrorResume(t -> Mono.empty()).subscribe();
}
public void store(Service service) {
- try {
- Files.createDirectories(getDatabasePath());
- try (PrintStream out = new PrintStream(new FileOutputStream(getFile(service)))) {
- String str = gson.toJson(service);
- out.print(str);
- }
- } catch (ServiceException e) {
- logger.debug("Could not store service: {} {}", service.getName(), e.getMessage());
- } catch (IOException e) {
- logger.warn("Could not store pservice: {} {}", service.getName(), e.getMessage());
- }
- }
-
- private File getFile(Service service) throws ServiceException {
- return getPath(service).toFile();
+ byte[] bytes = gson.toJson(service).getBytes();
+ dataStore.writeObject(getPath(service), bytes) //
+ .doOnError(t -> logger.warn("Could not service: {} {}", service.getName(), t.getMessage())).subscribe();
}
- private Path getPath(Service service) throws ServiceException {
- return Path.of(getDatabaseDirectory(), service.getName() + ".json");
+ public Flux<Service> restoreFromDatabase() {
+ return dataStore.createDataStore().flatMapMany(ds -> dataStore.listObjects("")) //
+ .flatMap(dataStore::readObject, 1) //
+ .map(String::new) //
+ .map(json -> gson.fromJson(json, Service.class))
+ .doOnNext(service -> this.registeredServices.put(service.getName(), service))
+ .doOnError(t -> logger.warn("Could not restore services database : {}", t.getMessage()))
+ .doFinally(sig -> logger.debug("Restored type database,no of services: {}",
+ this.registeredServices.size())) //
+ .onErrorResume(t -> Flux.empty()); //
}
- void restoreFromDatabase() {
- try {
- Files.createDirectories(getDatabasePath());
- for (File file : getDatabasePath().toFile().listFiles()) {
- String json = Files.readString(file.toPath());
- Service service = gson.fromJson(json, Service.class);
- this.registeredServices.put(service.getName(), service);
- }
- logger.debug("Restored type database,no of services: {}", this.registeredServices.size());
- } catch (ServiceException e) {
- logger.debug("Could not restore services database : {}", e.getMessage());
- } catch (Exception e) {
- logger.warn("Could not restore services database : {}", e.getMessage());
- }
+ private String getPath(Service service) {
+ return service.getName() + ".json";
}
- private String getDatabaseDirectory() throws ServiceException {
- if (appConfig.getVardataDirectory() == null) {
- throw new ServiceException("No storage provided");
- }
- return appConfig.getVardataDirectory() + "/database/services";
- }
-
- private Path getDatabasePath() throws ServiceException {
- return Path.of(getDatabaseDirectory());
- }
}
refreshTask = createRefreshTask() //
.subscribe(
notUsed -> logger.debug("Refreshed configuration data"), throwable -> logger
- .error("Configuration refresh terminated due to exception {}", throwable.toString()),
+ .error("Configuration refresh terminated due to exception {}", throwable.getMessage()),
() -> logger.error("Configuration refresh terminated"));
}
.flatMap(this::parseConfiguration) //
.flatMap(this::updateConfig, CONCURRENCY) //
.flatMap(this::handleUpdatedRicConfig) //
+ .doOnError(t -> logger.error("Cannot update config {}", t.getMessage()))
.doFinally(signal -> logger.error("Configuration refresh task is terminated: {}", signal));
}
void addRic(Ric ric) {
this.rics.put(ric);
if (this.appConfig.getVardataDirectory() != null) {
- this.policies.restoreFromDatabase(ric, this.policyTypes);
+ this.policies.restoreFromDatabase(ric, this.policyTypes).subscribe();
}
logger.debug("Added RIC: {}", ric.id());
}
package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
import java.util.Collection;
+
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
+
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
* ========================LICENSE_END===================================
*/
-package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
+package org.onap.ccsdk.oran.a1policymanagementservice.configuration;
import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.Mockito.spy;
-import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.prometheus.PrometheusConfig;
import io.micrometer.prometheus.PrometheusMeterRegistry;
+
import java.time.Instant;
import java.util.Arrays;
import java.util.Vector;
+
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.junit.jupiter.MockitoExtension;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
-import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
@ExtendWith(MockitoExtension.class)
-class RefreshCounterTaskTest {
+public class MetersTest {
private static final String POLICY_TYPE_1_NAME = "type1";
private static final PolicyType POLICY_TYPE_1 = PolicyType.builder().id(POLICY_TYPE_1_NAME).schema("").build();
.ric(RIC_1).type(POLICY_TYPE_1).lastModified(Instant.now()).isTransient(false)
.statusNotificationUri("statusNotificationUri").build();
- private final PrometheusMeterRegistry prometheusMeterRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
+ private PrometheusMeterRegistry prometheusMeterRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
private final ApplicationConfig appConfig = new ApplicationConfig();
- private PolicyTypes policyTypes;
+ private PolicyTypes types;
private Policies policies;
private Rics rics = new Rics();
+ Meters testObject;
+
@BeforeEach
void init() {
- policyTypes = new PolicyTypes(appConfig);
+ types = new PolicyTypes(appConfig);
policies = new Policies(appConfig);
rics.clear();
+ policies.clear();
+ types.clear();
+
RIC_1.setState(Ric.RicState.AVAILABLE);
RIC_1.clearSupportedPolicyTypes();
+
+ this.testObject = createMeters();
}
@Test
RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
rics.put(RIC_1);
- policyTypes.put(POLICY_TYPE_1);
+ types.put(POLICY_TYPE_1);
policies.put(POLICY_1);
- RefreshCounterTask spy = spy(createRefreshCounterTask()); // instantiate RefreshCounterTask
- MeterRegistry meterRegistry = spy.getMeterRegistry();
+ createMeters();
- assertThat(meterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
- assertThat(meterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(1);
- assertThat(meterRegistry.get("total_policy_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_count").gauge().value()).isEqualTo(1);
}
@Test
RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
rics.put(RIC_1);
- policyTypes.put(POLICY_TYPE_1);
+ types.put(POLICY_TYPE_1);
policies.put(POLICY_1);
String POLICY_2_ID = "policyId2";
- Policy POLICY_2 = Policy.builder()
- .id(POLICY_2_ID)
- .json("")
- .ownerServiceId("service")
- .ric(RIC_1)
- .type(POLICY_TYPE_1)
- .lastModified(Instant.now())
+ Policy POLICY_2 = Policy.builder() //
+ .id(POLICY_2_ID) //
+ .json("") //
+ .ownerServiceId("service") //
+ .ric(RIC_1) //
+ .type(POLICY_TYPE_1) //
+ .lastModified(Instant.now()) //
.isTransient(false) //
- .statusNotificationUri("statusNotificationUri")
+ .statusNotificationUri("statusNotificationUri") //
.build();
policies.put(POLICY_2);
- RefreshCounterTask spy = spy(createRefreshCounterTask()); // instantiate RefreshCounterTask
- MeterRegistry meterRegistry = spy.getMeterRegistry();
-
- assertThat(meterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
- assertThat(meterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(1);
- assertThat(meterRegistry.get("total_policy_count").gauge().value()).isEqualTo(2);
+ assertThat(prometheusMeterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_count").gauge().value()).isEqualTo(2);
}
@Test
RIC_1.setState(Ric.RicState.AVAILABLE);
String POLICY_TYPE_2_NAME = "type2";
- PolicyType POLICY_TYPE_2 = PolicyType.builder()
- .id(POLICY_TYPE_2_NAME)
- .schema("")
+ PolicyType POLICY_TYPE_2 = PolicyType.builder() //
+ .id(POLICY_TYPE_2_NAME) //
+ .schema("") //
.build();
RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
RIC_1.addSupportedPolicyType(POLICY_TYPE_2);
rics.put(RIC_1);
- policyTypes.put(POLICY_TYPE_1);
- policyTypes.put(POLICY_TYPE_2);
+ types.put(POLICY_TYPE_1);
+ types.put(POLICY_TYPE_2);
policies.put(POLICY_1);
- RefreshCounterTask spy = spy(createRefreshCounterTask()); // instantiate RefreshCounterTask
- MeterRegistry meterRegistry = spy.getMeterRegistry();
-
- assertThat(meterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
- assertThat(meterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(2);
- assertThat(meterRegistry.get("total_policy_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(2);
+ assertThat(prometheusMeterRegistry.get("total_policy_count").gauge().value()).isEqualTo(1);
}
- private RefreshCounterTask createRefreshCounterTask() {
- return new RefreshCounterTask(rics, policyTypes, policies, prometheusMeterRegistry);
+ private Meters createMeters() {
+ return new Meters(rics, types, policies, prometheusMeterRegistry);
}
}
import java.util.List;
import org.json.JSONObject;
+import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.TestPropertySource;
+import org.springframework.util.FileSystemUtils;
import org.springframework.web.reactive.function.client.WebClientResponseException;
import reactor.core.publisher.Mono;
"server.ssl.key-store=./config/keystore.jks", //
"app.webclient.trust-store=./config/truststore.jks", //
"app.webclient.trust-store-used=true", //
- "app.vardata-directory=./target/testdata", //
- "app.filepath=" //
+ "app.vardata-directory=/tmp/pmstest", //
+ "app.filepath=", //
+ "app.s3.bucket=" // If this is set, S3 will be used to store data.
})
class ApplicationTest {
private static final Logger logger = LoggerFactory.getLogger(ApplicationTest.class);
this.securityContext.setAuthTokenFilePath(null);
}
+ @AfterAll
+ static void clearTestDir() {
+ try {
+ FileSystemUtils.deleteRecursively(Path.of("/tmp/pmstest"));
+ } catch (Exception e) {
+ logger.warn("Could test directory : {}", e.getMessage());
+ }
+ }
+
@AfterEach
void verifyNoRicLocks() {
for (Ric ric : this.rics.getRics()) {
}
@Test
- void testPersistencyPolicies() throws ServiceException {
+ void testPersistencyPolicies() throws Exception {
Ric ric = this.addRic("ric1");
PolicyType type = this.addPolicyType("type1", ric.id());
for (int i = 0; i < noOfPolicies; ++i) {
addPolicy("id" + i, type.getId(), "service", ric.id());
}
+ waitforS3();
{
Policies policies = new Policies(this.applicationConfig);
- policies.restoreFromDatabase(ric, this.policyTypes);
+ policies.restoreFromDatabase(ric, this.policyTypes).blockLast();
assertThat(policies.size()).isEqualTo(noOfPolicies);
}
{
restClient().delete("/policies/id2").block();
Policies policies = new Policies(this.applicationConfig);
- policies.restoreFromDatabase(ric, this.policyTypes);
+ policies.restoreFromDatabase(ric, this.policyTypes).blockLast();
assertThat(policies.size()).isEqualTo(noOfPolicies - 1);
}
}
@Test
- void testPersistencyPolicyTypes() throws ServiceException {
+ void testPersistencyPolicyTypes() throws Exception {
Ric ric = this.addRic("ric1");
this.addPolicyType("type1", ric.id());
+ waitforS3();
+
PolicyTypes types = new PolicyTypes(this.applicationConfig);
+ types.restoreFromDatabase().blockLast();
assertThat(types.size()).isEqualTo(1);
}
+ @SuppressWarnings("squid:S2925") // "Thread.sleep" should not be used in tests.
+ private void waitforS3() throws Exception {
+ if (applicationConfig.isS3Enabled()) {
+ Thread.sleep(1000);
+ }
+ }
+
@Test
- void testPersistencyService() throws ServiceException {
+ void testPersistencyService() throws Exception {
final String SERVICE = "serviceName";
putService(SERVICE, 1234, HttpStatus.CREATED);
assertThat(this.services.size()).isEqualTo(1);
Service service = this.services.getService(SERVICE);
+ waitforS3();
Services servicesRestored = new Services(this.applicationConfig);
+ servicesRestored.restoreFromDatabase().blockLast();
Service serviceRestored = servicesRestored.getService(SERVICE);
assertThat(servicesRestored.size()).isEqualTo(1);
assertThat(serviceRestored.getCallbackUrl()).isEqualTo(service.getCallbackUrl());
import java.util.Collections;
import java.util.List;
import java.util.Vector;
+
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
"type": "integer",
"example": 404
}
- }
+ },
+ "example": null
},
"void": {
"description": "Void/empty",
- "type": "object"
+ "type": "object",
+ "example": null
},
"status_info_v2": {
"type": "object",
"properties": {"status": {
"description": "status text",
- "type": "string"
- }}
+ "type": "string",
+ "example": null
+ }},
+ "example": null
},
"ric_info_v2": {
"description": "Information for a Near-RT RIC",
"properties": {
"ric_id": {
"description": "identity of the Near-RT RIC",
- "type": "string"
+ "type": "string",
+ "example": null
},
"managed_element_ids": {
"description": "O1 identities for managed entities",
"type": "array",
"items": {
"description": "O1 identities for managed entities",
- "type": "string"
- }
+ "type": "string",
+ "example": null
+ },
+ "example": null
},
"state": {
"description": "Represents the states for a Near-RT RIC",
"AVAILABLE",
"SYNCHRONIZING",
"CONSISTENCY_CHECK"
- ]
+ ],
+ "example": null
},
"policytype_ids": {
"description": "supported policy types",
"type": "array",
"items": {
"description": "supported policy types",
- "type": "string"
- }
+ "type": "string",
+ "example": null
+ },
+ "example": null
}
- }
+ },
+ "example": null
},
"service_registration_info_v2": {
"description": "Information for one service",
"properties": {
"callback_url": {
"description": "callback for notifying of Near-RT RIC state changes",
- "type": "string"
+ "type": "string",
+ "example": null
},
"service_id": {
"description": "identity of the service",
- "type": "string"
+ "type": "string",
+ "example": null
},
"keep_alive_interval_seconds": {
"format": "int64",
"description": "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.",
- "type": "integer"
+ "type": "integer",
+ "example": null
}
- }
+ },
+ "example": null
},
"policy_info_list_v2": {
"description": "List of policy information",
"properties": {"policies": {
"description": "List of policy information",
"type": "array",
- "items": {"$ref": "#/components/schemas/policy_info_v2"}
- }}
+ "items": {"$ref": "#/components/schemas/policy_info_v2"},
+ "example": null
+ }},
+ "example": null
},
"policy_status_info_v2": {
"description": "Status for one A1-P Policy",
"properties": {
"last_modified": {
"description": "timestamp, last modification time",
- "type": "string"
+ "type": "string",
+ "example": null
},
"status": {
"description": "the Policy status",
- "type": "object"
+ "type": "object",
+ "example": null
}
- }
+ },
+ "example": null
},
"service_status_v2": {
"description": "List of service information",
"properties": {
"callback_url": {
"description": "callback for notifying of RIC synchronization",
- "type": "string"
+ "type": "string",
+ "example": null
},
"service_id": {
"description": "identity of the service",
- "type": "string"
+ "type": "string",
+ "example": null
},
"keep_alive_interval_seconds": {
"format": "int64",
"description": "policy keep alive timeout",
- "type": "integer"
+ "type": "integer",
+ "example": null
},
"time_since_last_activity_seconds": {
"format": "int64",
"description": "time since last invocation by the service",
- "type": "integer"
+ "type": "integer",
+ "example": null
}
- }
+ },
+ "example": null
},
"ric_info_list_v2": {
"description": "List of Near-RT RIC information",
"properties": {"rics": {
"description": "List of Near-RT RIC information",
"type": "array",
- "items": {"$ref": "#/components/schemas/ric_info_v2"}
- }}
+ "items": {"$ref": "#/components/schemas/ric_info_v2"},
+ "example": null
+ }},
+ "example": null
},
"policytype_v2": {
"description": "Policy type",
"type": "object",
"properties": {"policy_schema": {
"description": "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema",
- "type": "object"
- }}
+ "type": "object",
+ "example": null
+ }},
+ "example": null
},
"policytype_id_list_v2": {
"description": "Information about policy types",
"type": "array",
"items": {
"description": "Policy type identities",
- "type": "string"
- }
- }}
+ "type": "string",
+ "example": null
+ },
+ "example": null
+ }},
+ "example": null
},
"policy_info_v2": {
"description": "Information for one A1-P Policy",
"properties": {
"ric_id": {
"description": "identity of the target Near-RT RIC",
- "type": "string"
+ "type": "string",
+ "example": null
},
"policy_id": {
"description": "identity of the policy",
- "type": "string"
+ "type": "string",
+ "example": null
},
"transient": {
"description": "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",
- "type": "boolean"
+ "type": "boolean",
+ "example": null
},
"service_id": {
"description": "the identity of the service owning the policy",
- "type": "string"
+ "type": "string",
+ "example": null
},
"policy_data": {
"description": "the configuration of the policy",
- "type": "object"
+ "type": "object",
+ "example": null
},
"status_notification_uri": {
"description": "Callback URI for policy status updates",
- "type": "string"
+ "type": "string",
+ "example": null
},
"policytype_id": {
"description": "identity of the policy type",
- "type": "string"
+ "type": "string",
+ "example": null
}
- }
+ },
+ "example": null
},
"policy_id_list_v2": {
"description": "A list of policy identities",
"type": "array",
"items": {
"description": "Policy identities",
- "type": "string"
- }
- }}
+ "type": "string",
+ "example": null
+ },
+ "example": null
+ }},
+ "example": null
},
"service_list_v2": {
"description": "List of service information",
"properties": {"service_list": {
"description": "List of service information",
"type": "array",
- "items": {"$ref": "#/components/schemas/service_status_v2"}
- }}
+ "items": {"$ref": "#/components/schemas/service_status_v2"},
+ "example": null
+ }},
+ "example": null
},
"service_callback_info_v2": {
"description": "Information transferred as in Service callbacks (callback_url)",
"properties": {
"ric_id": {
"description": "identity of a Near-RT RIC",
- "type": "string"
+ "type": "string",
+ "example": null
},
"event_type": {
"description": "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management",
"type": "string",
- "enum": ["AVAILABLE"]
+ "enum": ["AVAILABLE"],
+ "example": null
}
- }
+ },
+ "example": null
},
"Link": {
"type": "object",
"properties": {
- "templated": {"type": "boolean"},
- "href": {"type": "string"}
- }
+ "templated": {
+ "type": "boolean",
+ "example": null
+ },
+ "href": {
+ "type": "string",
+ "example": null
+ }
+ },
+ "example": null
}
}},
"openapi": "3.0.1",
"responses": {
"200": {
"description": "Policies",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_list_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/policy_info_list_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Near-RT RIC, policy type or service not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "policytype_id",
"description": "Select policies with a given type identity.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "ric_id",
"description": "Select policies for a given Near-RT RIC identity.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "service_id",
"description": "Select policies owned by a given service.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "type_name",
"description": "Select policies of a given type name (type identity has the format <typename_version>)",
"operationId": "threaddump_2",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"operationId": "getStatus",
"responses": {"200": {
"description": "Service is living",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/status_info_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/status_info_v2"},
+ "example": null
+ }}
}},
"tags": ["Health Check"]
}},
"operationId": "loggers",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"operationId": "health-path",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"responses": {
"200": {
"description": "Near-RT RIC is found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ric_info_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/ric_info_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Near-RT RIC is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "managed_element_id",
"description": "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "ric_id",
"description": "The identity of a Near-RT RIC to get information for.",
"responses": {
"200": {
"description": "Policy type IDs",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policytype_id_list_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/policytype_id_list_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Near-RT RIC is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "ric_id",
"description": "Select types for the given Near-RT RIC identity.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "type_name",
"description": "Select types with the given type name (type identity has the format <typename_version>)",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "compatible_with_version",
"description": "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.",
"responses": {
"200": {
"description": "Policy found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/policy_info_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Policy is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "policy_id",
"required": true
"responses": {
"200": {
"description": "Not used",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
},
"423": {
"description": "Near-RT RIC is not operational",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
},
"204": {
"description": "Policy deleted",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
},
"404": {
"description": "Policy is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "policy_id",
"required": true
"operationId": "metrics-requiredMetricName",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "requiredMetricName",
"required": true
"responses": {
"200": {
"description": "Configuration",
- "content": {"application/json": {"schema": {"type": "object"}}}
+ "content": {"application/json": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
},
"404": {
"description": "File is not found or readable",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"tags": ["Management of configuration"]
"put": {
"summary": "Replace the current configuration file with the given configuration",
"requestBody": {
- "content": {"application/json": {"schema": {"type": "object"}}},
+ "content": {"application/json": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }},
"required": true
},
"operationId": "putConfiguration",
"responses": {
"200": {
"description": "Configuration updated",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
},
"400": {
"description": "Invalid configuration provided",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
},
"500": {
"description": "Something went wrong when replacing the configuration. Try again.",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"tags": ["Management of configuration"]
"operationId": "links",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {
- "additionalProperties": {
- "additionalProperties": {"$ref": "#/components/schemas/Link"},
- "type": "object"
+ "content": {"*/*": {
+ "schema": {
+ "additionalProperties": {
+ "additionalProperties": {"$ref": "#/components/schemas/Link"},
+ "type": "object",
+ "example": null
+ },
+ "type": "object",
+ "example": null
},
- "type": "object"
- }}}
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"operationId": "loggers-name",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "name",
"required": true
"operationId": "loggers-name_2",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "name",
"required": true
"responses": {
"200": {
"description": "Service supervision timer refreshed, OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
},
"404": {
"description": "The service is not found, needs re-registration",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "service_id",
"required": true
"operationId": "metrics",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"responses": {
"200": {
"description": "OK",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ric_info_list_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/ric_info_list_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Policy type is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "policytype_id",
"description": "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned",
"responses": {
"200": {
"description": "OK",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_list_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/service_list_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Service is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "service_id",
"description": "The identity of the service",
"put": {
"summary": "Register a service",
"requestBody": {
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_registration_info_v2"}}},
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/service_registration_info_v2"},
+ "example": null
+ }},
"required": true
},
"description": "Registering a service is needed to:<ul><li>Get callbacks.<\/li><li>Activate supervision of the service. If a service is inactive, its policies will be deleted.<\/li><\/ul>",
"responses": {
"200": {
"description": "Service updated",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
},
"201": {
"description": "Service created",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
},
"400": {
"description": "The ServiceRegistrationInfo is not accepted",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"tags": ["Service Registry and Supervision"]
"operationId": "info",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"operationId": "getStatusV1",
"responses": {"200": {
"description": "Service is living",
- "content": {"*/*": {"schema": {"type": "string"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "string",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Health Check"]
}},
"responses": {
"200": {
"description": "Policy type",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/policytype_v2"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/policytype_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Policy type is not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "policytype_id",
"required": true
"operationId": "logfile",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"operationId": "health",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"responses": {
"200": {
"description": "Policy identities",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_id_list_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/policy_id_list_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Near-RT RIC or type not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "policytype_id",
"description": "Select policies of a given policy type identity.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "ric_id",
"description": "Select policies of a given Near-RT RIC identity.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "service_id",
"description": "Select policies owned by a given service.",
"required": false
},
{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "query",
"name": "type_name",
"description": "Select policies of types with the given type name (type identity has the format <typename_version>)",
"put": {
"summary": "Create or update a policy",
"requestBody": {
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}},
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/policy_info_v2"},
+ "example": null
+ }},
"required": true
},
"operationId": "putPolicy",
"responses": {
"200": {
"description": "Policy updated",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
},
"201": {
"description": "Policy created",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
},
"423": {
"description": "Near-RT RIC is not operational",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
},
"404": {
"description": "Near-RT RIC or policy type is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"tags": ["A1 Policy Management"]
"/r-app/near-rt-ric-status": {"post": {
"summary": "Callback for Near-RT RIC status",
"requestBody": {
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_callback_info_v2"}}},
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/service_callback_info_v2"},
+ "example": null
+ }},
"required": true
},
"description": "The URL to this call is registered at Service registration.",
"operationId": "serviceCallback",
"responses": {"200": {
"description": "OK",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
}},
"tags": ["Callbacks"]
}},
"responses": {
"200": {
"description": "Not used",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/void"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/void"},
+ "example": null
+ }}
},
"204": {
"description": "Service unregistered",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
},
"404": {
"description": "Service not found",
- "content": {"*/*": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"*/*": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "service_id",
"required": true
"operationId": "heapdump",
"responses": {"200": {
"description": "OK",
- "content": {"*/*": {"schema": {"type": "object"}}}
+ "content": {"*/*": {
+ "schema": {
+ "type": "object",
+ "example": null
+ },
+ "example": null
+ }}
}},
"tags": ["Actuator"]
}},
"responses": {
"200": {
"description": "Policy status",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_status_info_v2"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/policy_status_info_v2"},
+ "example": null
+ }}
},
"404": {
"description": "Policy is not found",
- "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}}
+ "content": {"application/json": {
+ "schema": {"$ref": "#/components/schemas/error_information"},
+ "example": null
+ }}
}
},
"parameters": [{
- "schema": {"type": "string"},
+ "schema": {
+ "type": "string",
+ "example": null
+ },
"in": "path",
"name": "policy_id",
"required": true
Code Review / ccsdk / oran.git / commitdiff