Introduce Instrumentation

[cps.git] / cps-service / src / main / java / org / onap / cps / api / impl / YangTextSchemaSourceSetCache.java

diff --git a/cps-service/src/main/java/org/onap/cps/api/impl/YangTextSchemaSourceSetCache.java b/cps-service/src/main/java/org/onap/cps/api/impl/YangTextSchemaSourceSetCache.java
index af16727..4fdae5a 100644 (file)
--- a/cps-service/src/main/java/org/onap/cps/api/impl/YangTextSchemaSourceSetCache.java
+++ b/cps-service/src/main/java/org/onap/cps/api/impl/YangTextSchemaSourceSetCache.java
@@ -1,13 +1,15 @@
-package org.onap.cps.api.impl;
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Pantheon.tech
+ *  Copyright (C) 2021 Pantheon.tech
+ *  Modifications Copyright (C) 2022 Bell Canada
+ *  Modifications Copyright (C) 2022-2023 Nordix Foundation
  *  ================================================================================
  *  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.
@@ -18,13 +20,19 @@ package org.onap.cps.api.impl;
  *  ============LICENSE_END=========================================================
  */
 
+package org.onap.cps.api.impl;
+
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
+import io.micrometer.core.instrument.Metrics;
 import java.util.Map;
+import java.util.concurrent.atomic.AtomicInteger;
+import lombok.RequiredArgsConstructor;
 import org.onap.cps.spi.CpsModulePersistenceService;
+import org.onap.cps.spi.utils.CpsValidator;
 import org.onap.cps.yang.YangTextSchemaSourceSet;
 import org.onap.cps.yang.YangTextSchemaSourceSetBuilder;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.cache.annotation.CacheConfig;
+import org.springframework.cache.annotation.CacheEvict;
 import org.springframework.cache.annotation.CachePut;
 import org.springframework.cache.annotation.Cacheable;
 import org.springframework.stereotype.Service;
@@ -34,10 +42,14 @@ import org.springframework.stereotype.Service;
  */
 @Service
 @CacheConfig(cacheNames = {"yangSchema"})
+@RequiredArgsConstructor
 public class YangTextSchemaSourceSetCache {
 
-    @Autowired
-    private CpsModulePersistenceService cpsModulePersistenceService;
+    private final CpsModulePersistenceService cpsModulePersistenceService;
+    private final CpsValidator cpsValidator;
+
+    private final AtomicInteger yangSchemaCacheCounter = Metrics.gauge("cps.yangschema.cache.gauge",
+                                                                        new AtomicInteger(0));
 
     /**
      * Cache YangTextSchemaSourceSet.
@@ -48,6 +60,7 @@ public class YangTextSchemaSourceSetCache {
      */
     @Cacheable(key = "#p0.concat('-').concat(#p1)")
     public YangTextSchemaSourceSet get(final String dataspaceName, final String schemaSetName) {
+        cpsValidator.validateNameCharacters(dataspaceName, schemaSetName);
         final Map<String, String> yangResourceNameToContent =
                 cpsModulePersistenceService.getYangSchemaResources(dataspaceName, schemaSetName);
         return YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent);
@@ -56,8 +69,8 @@ public class YangTextSchemaSourceSetCache {
     /**
      * Updates cache YangTextSchemaSourceSet.
      *
-     * @param dataspaceName dataspace name
-     * @param schemaSetName schema set name
+     * @param dataspaceName           dataspace name
+     * @param schemaSetName           schema set name
      * @param yangTextSchemaSourceSet yangTextSchemaSourceSet
      * @return YangTextSchemaSourceSet
      */
@@ -65,6 +78,22 @@ public class YangTextSchemaSourceSetCache {
     @CanIgnoreReturnValue
     public YangTextSchemaSourceSet updateCache(final String dataspaceName, final String schemaSetName,
             final YangTextSchemaSourceSet yangTextSchemaSourceSet) {
+        cpsValidator.validateNameCharacters(dataspaceName, schemaSetName);
+        yangSchemaCacheCounter.incrementAndGet();
         return yangTextSchemaSourceSet;
     }
+
+    /**
+     * Remove the cached value for the given dataspace and schema-set.
+     *
+     * @param dataspaceName dataspace name
+     * @param schemaSetName schema set name
+     */
+    @CacheEvict(key = "#p0.concat('-').concat(#p1)")
+    public void removeFromCache(final String dataspaceName, final String schemaSetName) {
+        cpsValidator.validateNameCharacters(dataspaceName, schemaSetName);
+        yangSchemaCacheCounter.decrementAndGet();
+        // Spring provides implementation for removing object from cache
+    }
+
 }