blob: 9024eac331a4983e8749d95bd8f5fb5944f2d97d (
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2022-2024 Nordix Foundation
* Modifications Copyright (C) 2023 TechMahindra Ltd.
* ================================================================================
* 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.cps.ncmp.api.impl.inventory;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence;
import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
import org.onap.cps.spi.model.DataNode;
import org.onap.cps.spi.model.ModuleDefinition;
import org.onap.cps.spi.model.ModuleReference;
public interface InventoryPersistence extends NcmpPersistence {
/**
* Get the Cm Handle Composite State from the data node.
*
* @param cmHandleId cm handle id
* @return the cm handle composite state
*/
CompositeState getCmHandleState(String cmHandleId);
/**
* Save the cm handles state.
*
* @param cmHandleId cm handle id
* @param compositeState composite state
*/
void saveCmHandleState(String cmHandleId, CompositeState compositeState);
/**
* Save all cm handles states in batch.
*
* @param cmHandleStatePerCmHandleId contains cm handle id and updated state
*/
void saveCmHandleStateBatch(Map<String, CompositeState> cmHandleStatePerCmHandleId);
/**
* This method retrieves DMI service name, DMI properties and the state for a given cm handle.
*
* @param cmHandleId the id of the cm handle
* @return yang model cm handle
*/
YangModelCmHandle getYangModelCmHandle(String cmHandleId);
/**
* This method retrieves DMI service name, DMI properties and the state for a given cm handle.
*
* @param cmHandleIds a list of the ids of the cm handles
* @return collection of yang model cm handles
*/
Collection<YangModelCmHandle> getYangModelCmHandles(Collection<String> cmHandleIds);
/**
* Method to return module definitions by cmHandleId.
*
* @param cmHandleId cm handle ID
* @return a collection of module definitions (moduleName, revision and yang resource content)
*/
Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(String cmHandleId);
/**
* Method to return module references by cmHandleId.
*
* @param cmHandleId cm handle ID
* @return a collection of module references (moduleName and revision)
*/
Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandleId);
/**
* Method to save cmHandle.
*
* @param yangModelCmHandle cmHandle represented as Yang Model
*/
void saveCmHandle(YangModelCmHandle yangModelCmHandle);
/**
* Method to save batch of cm handles.
*
* @param yangModelCmHandles cm handle represented as Yang Models
*/
void saveCmHandleBatch(List<YangModelCmHandle> yangModelCmHandles);
/**
* Get data node of given cm handle.
*
* @param cmHandleId cmHandle ID
* @return data node
*/
Collection<DataNode> getCmHandleDataNode(String cmHandleId);
/**
* Get collection of data nodes of given cm handles.
*
* @param cmHandleIds collection of cmHandle IDs
* @return collection of data nodes
*/
Collection<DataNode> getCmHandleDataNodes(Collection<String> cmHandleIds);
/**
* get CM handles that has given module names.
*
* @param moduleNamesForQuery module names
* @return Collection of CM handle Ids
*/
Collection<String> getCmHandleIdsWithGivenModules(Collection<String> moduleNamesForQuery);
}
|
