blob: 6b59949ca08d2a4f367d05c88200ce096ac5acf5 (
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
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020 Nordix Foundation
* Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
* ================================================================================
* 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.api;
import java.io.File;
import org.onap.cps.api.model.AnchorDetails;
import org.onap.cps.exceptions.CpsValidationException;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
/**
* Configuration and persistency service interface which holds methods for parsing and storing yang models and data.
*/
public interface CpService {
/**
* Parse and validate a string representing a yang model to generate a schema context.
*
* @param yangModelContent the input stream
* @return the schema context
*/
SchemaContext parseAndValidateModel(String yangModelContent);
/**
* Parse and validate a file representing a yang model to generate a schema context.
*
* @param yangModelFile the yang file
* @return the schema context
*/
SchemaContext parseAndValidateModel(File yangModelFile);
/**
* Store schema context for a yang model.
*
* @param schemaContext the schema context
* @param dataspaceName the dataspace name
*/
void storeSchemaContext(SchemaContext schemaContext, String dataspaceName);
/**
* Store the JSON structure in the database.
*
* @param jsonStructure the JSON structure.
* @return entity ID.
*/
Integer storeJsonStructure(String jsonStructure);
/**
* Read a JSON Object using the object identifier.
*
* @param jsonObjectId the JSON object identifier.
* @return the JSON structure.
*/
String getJsonById(int jsonObjectId);
/**
* Delete a JSON Object using the object identifier.
*
* @param jsonObjectId the JSON object identifier.
*/
void deleteJsonById(int jsonObjectId);
/**
* Create an anchor using provided anchorDetails object.
*
* @param anchorDetails the anchor details object.
* @return the anchor name.
* @throws CpsValidationException if input data is invalid.
*/
String createAnchor(AnchorDetails anchorDetails);
}
|
