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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
"""ONAP SDK CPS anchor module."""
# Copyright 2022 Orange, Deutsche Telekom AG
#
# 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.
from typing import Any, Dict, TYPE_CHECKING
from .cps_element import CpsElement
if TYPE_CHECKING:
from .schemaset import SchemaSet # pylint: disable=cyclic-import
class Anchor(CpsElement):
"""CPS anchor class."""
def __init__(self, name: str, schema_set: "SchemaSet") -> None:
"""Initialise CPS anchor object.
Args:
name (str): Anchor name
schema_set (SchemaSet): Schema set
"""
super().__init__()
self.name: str = name
self.schema_set: "SchemaSet" = schema_set
def __repr__(self) -> str:
"""Human readable representation of the object.
Returns:
str: Human readable string
"""
return f"Anchor(name={self.name}, "\
f"schema set={self.schema_set.name}, "\
f"dataspace={self.schema_set.dataspace.name})"
@property
def url(self) -> str:
"""Anchor url.
Returns:
str: Anchor url
"""
return f"{self._url}/cps/api/v1/dataspaces/"\
f"{self.schema_set.dataspace.name}/anchors/{self.name}"
def delete(self) -> None:
"""Delete anchor."""
self.send_message(
"DELETE",
f"Delete {self.name} anchor",
self.url,
auth=self.auth
)
def create_node(self, node_data: str) -> None:
"""Create anchor node.
Fill CPS anchor with a data.
Args:
node_data (str): Node data. Should be JSON formatted.
"""
self.send_message(
"POST",
f"Create {self.name} anchor node",
f"{self.url}/nodes",
data=node_data,
auth=self.auth
)
def get_node(self, xpath: str, include_descendants: bool = False) -> Dict[Any, Any]:
"""Get anchor node data.
Using XPATH get anchor's node data.
Args:
xpath (str): Anchor node xpath.
include_descendants (bool, optional): Determies if descendants should be included in
response. Defaults to False.
Returns:
Dict[Any, Any]: Anchor node data.
"""
return self.send_message_json(
"GET",
f"Get {self.name} anchor node with {xpath} xpath",
f"{self.url}/node?xpath={xpath}&include-descendants={include_descendants}",
auth=self.auth
)
def update_node(self, xpath: str, node_data: str) -> None:
"""Update anchor node data.
Using XPATH update anchor's node data.
Args:
xpath (str): Anchor node xpath.
node_data (str): Node data.
"""
self.send_message(
"PATCH",
f"Update {self.name} anchor node with {xpath} xpath",
f"{self.url}/nodes?xpath={xpath}",
data=node_data,
auth=self.auth
)
def replace_node(self, xpath: str, node_data: str) -> None:
"""Replace anchor node data.
Using XPATH replace anchor's node data.
Args:
xpath (str): Anchor node xpath.
node_data (str): Node data.
"""
self.send_message(
"PUT",
f"Replace {self.name} anchor node with {xpath} xpath",
f"{self.url}/nodes?xpath={xpath}",
data=node_data,
auth=self.auth
)
def add_list_node(self, xpath: str, node_data: str) -> None:
"""Add an element to the list node of an anchor.
Args:
xpath (str): Xpath to the list node.
node_data (str): Data to be added.
"""
self.send_message(
"POST",
f"Add element to {self.name} anchor node with {xpath} xpath",
f"{self.url}/list-nodes?xpath={xpath}",
data=node_data,
auth=self.auth
)
def query_node(self, query: str, include_descendants: bool = False) -> Dict[Any, Any]:
"""Query CPS anchor data.
Args:
query (str): Query
include_descendants (bool, optional): Determies if descendants should be included in
response. Defaults to False.
Returns:
Dict[Any, Any]: Query return values.
"""
return self.send_message_json(
"GET",
f"Get {self.name} anchor node with {query} query",
f"{self.url}/nodes/query?cps-path={query}&include-descendants={include_descendants}",
auth=self.auth
)
def delete_nodes(self, xpath: str) -> None:
"""Delete nodes.
Use XPATH to delete Anchor nodes.
Args:
xpath (str): Nodes to delete
"""
self.send_message(
"DELETE",
f"Delete {self.name} anchor nodes with {xpath} xpath",
f"{self.url}/nodes?xpath={xpath}",
auth=self.auth
)
|
