aboutsummaryrefslogtreecommitdiffstats
path: root/adapters/etsi-sol003-adapter/etsi-sol003-pkgm/etsi-sol003-pkgm-adapter/src/main/java/org/onap/so/adapters/etsisol003adapter/pkgm/cache/PkgmCacheServiceProvider.java
blob: 34ed1cfc0cd1d21ecf8cc54419e8ecaba4d32f4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2020 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.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.so.adapters.etsisol003adapter.pkgm.cache;

import java.util.Map;
import java.util.Optional;
import org.onap.so.adapters.etsisol003adapter.pkgm.model.PkgmSubscriptionRequest;

/**
 * Interface which provides methods for communicating with the cache
 *
 * @author Ronan Kenny (ronan.kenny@est.tech)
 * @author Gareth Roper (gareth.roper@est.tech)
 *
 */
public interface PkgmCacheServiceProvider {

    /**
     * Checks cache if subscription request Id is already present. If not, it adds the subscription to the cache.
     * 
     * @param subscriptionId
     * @param pkgmSubscriptionRequest
     */
    void addSubscription(final String subscriptionId, final PkgmSubscriptionRequest pkgmSubscriptionRequest);

    /**
     * Gets individual subscription from cache
     * 
     * @param subscriptionId
     * @return <AbstractMap.SimpleImmutableEntry<String, PkgmSubscriptionRequest>>
     */
    Optional<PkgmSubscriptionRequest> getSubscription(final String subscriptionId);

    /**
     * Gets Map of subscriptions from cache
     * 
     * @return Map<String, PkgmSubscriptionRequest>>
     */
    Map<String, PkgmSubscriptionRequest> getSubscriptions();

    /**
     * Delete subscription from cache
     * 
     * @param subscriptionId
     * @return Boolean
     */
    boolean deleteSubscription(final String subscriptionId);

    /**
     * Checks if subscription exists in cache and return its subscriptionId
     * 
     * @param pkgmSubscriptionRequest
     * @return Subscription Id
     */
    Optional<String> getSubscriptionId(final PkgmSubscriptionRequest pkgmSubscriptionRequest);
}