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
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 highstreet technologies GmbH
* Modifications Copyright (C) 2021-2022 Nordix Foundation
* Modifications Copyright (C) 2021 Pantheon.tech
* Modifications Copyright (C) 2022 Bell Canada
* ================================================================================
* 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;
import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
import org.onap.cps.spi.model.ModuleReference;
/*
* Datastore interface for handling CPS data.
*/
public interface NetworkCmProxyDataService {
/**
* Registration of New CM Handles.
*
* @param dmiPluginRegistration Dmi Plugin Registration
* @return dmiPluginRegistrationResponse
*/
DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration);
/**
* Get resource data for data store pass-through operational
* using dmi.
*
* @param cmHandleId cm handle identifier
* @param resourceIdentifier resource identifier
* @param optionsParamInQuery options query
* @param topicParamInQuery topic name for (triggering) async responses
* @param requestId unique requestId for async request
* @return {@code Object} resource data
*/
Object getResourceDataOperationalForCmHandle(String cmHandleId,
String resourceIdentifier,
String optionsParamInQuery,
String topicParamInQuery,
String requestId);
/**
* Get resource data for data store pass-through running
* using dmi.
*
* @param cmHandleId cm handle identifier
* @param resourceIdentifier resource identifier
* @param optionsParamInQuery options query
* @param topicParamInQuery topic name for (triggering) async responses
* @param requestId unique requestId for async request
* @return {@code Object} resource data
*/
Object getResourceDataPassThroughRunningForCmHandle(String cmHandleId,
String resourceIdentifier,
String optionsParamInQuery,
String topicParamInQuery,
String requestId);
/**
* Write resource data for data store pass-through running
* using dmi for given cm-handle.
* @param cmHandleId cm handle identifier
* @param resourceIdentifier resource identifier
* @param operation required operation
* @param requestBody request body to create resource
* @param contentType content type in body
* @return {@code Object} return data
*/
Object writeResourceDataPassThroughRunningForCmHandle(String cmHandleId,
String resourceIdentifier,
OperationEnum operation,
String requestBody,
String contentType);
/**
* Retrieve module references for the given cm handle.
*
* @param cmHandleId cm handle identifier
* @return a collection of modules names and revisions
*/
Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandleId);
/**
* Query cm handle identifiers for the given collection of module names.
*
* @param moduleNames module names.
* @return a collection of cm handle identifiers. The schema set for each cm handle must include all the
* given module names
*/
Collection<String> executeCmHandleHasAllModulesSearch(Collection<String> moduleNames);
/**
* Query cm handle details by cm handle's name.
*
* @param cmHandleId cm handle identifier
* @return a collection of cm handle details.
*/
NcmpServiceCmHandle getNcmpServiceCmHandle(String cmHandleId);
/**
* Get cm handle public properties by cm handle id.
*
* @param cmHandleId cm handle identifier
* @return a collection of cm handle public properties.
*/
Map<String, String> getCmHandlePublicProperties(String cmHandleId);
/**
* Query and return cm handles that match the given query parameters.
*
* @param cmHandleQueryApiParameters the cm handle query parameters
* @return collection of cm handle ids
*/
Set<String> queryCmHandles(CmHandleQueryApiParameters cmHandleQueryApiParameters);
}
|
