cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/cmsubscription/service/CmNotificationSubscriptionPersistenceService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api.impl.events.cmsubscription.service;
  22
  23 import java.util.Collection;
  24 import org.onap.cps.ncmp.api.impl.operations.DatastoreType;
  25
  26 public interface CmNotificationSubscriptionPersistenceService {
  27
  28     String NCMP_DATASPACE_NAME = "NCMP-Admin";
  29     String CM_SUBSCRIPTIONS_ANCHOR_NAME = "cm-data-subscriptions";
  30
  31     /**
  32      * Check if we have an ongoing cm subscription based on the parameters.
  33      *
  34      * @param datastoreType valid datastore type
  35      * @param cmHandleId    cmhandle id
  36      * @param xpath         valid xpath
  37      * @return true for ongoing cmsubscription , otherwise false
  38      */
  39     boolean isOngoingCmNotificationSubscription(final DatastoreType datastoreType, final String cmHandleId,
  40             final String xpath);
  41
  42     /**
  43      * Check if the subscription ID is unique against ongoing subscriptions.
  44      *
  45      * @param subscriptionId subscription ID
  46      * @return true if subscriptionId is not used in active subscriptions, otherwise false
  47      */
  48     boolean isUniqueSubscriptionId(final String subscriptionId);
  49
  50     /**
  51      * Get all ongoing cm notification subscription based on the parameters.
  52      *
  53      * @param datastoreType valid datastore type
  54      * @param cmHandleId    cmhandle id
  55      * @param xpath         valid xpath
  56      * @return collection of subscription ids of ongoing cm notification subscription
  57      */
  58     Collection<String> getOngoingCmNotificationSubscriptionIds(final DatastoreType datastoreType,
  59             final String cmHandleId, final String xpath);
  60
  61     /**
  62      * Add or update cm notification subscription.
  63      *
  64      * @param datastoreType valid datastore type
  65      * @param cmHandle cmhandle id
  66      * @param xpath valid xpath
  67      * @param newSubscriptionId subscription Id to be added
  68      */
  69     void addOrUpdateCmNotificationSubscription(final DatastoreType datastoreType, final String cmHandle,
  70                                                final String xpath, final String newSubscriptionId);
  71 }