2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
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
9 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 * SPDX-License-Identifier: Apache-2.0
17 * ============LICENSE_END=========================================================
20 package org.onap.cps.nfproxy.api;
22 import org.checkerframework.checker.nullness.qual.NonNull;
23 import org.onap.cps.spi.FetchDescendantsOption;
24 import org.onap.cps.spi.model.DataNode;
27 * Datastore interface for handling CPS data.
29 public interface NfProxyDataService {
32 * Retrieves datanode by XPath for a given cm handle.
34 * @param cmHandle The identifier for a network function, network element, subnetwork or any other
35 * cm object by managed NF-Proxy
37 * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
38 * (recursively) as well
39 * @return data node object
41 DataNode getDataNode(@NonNull String cmHandle, @NonNull String xpath,
42 @NonNull FetchDescendantsOption fetchDescendantsOption);