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
|
/*
* Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.netconf.sal.restconf.api;
import java.util.Optional;
import javax.ws.rs.core.MultivaluedMap;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yangtools.yang.common.OperationFailedException;
/**
* Provides restconf CRUD operations via code with input/output data in JSON format.
*
* @author Thomas Pantelis.
*/
public interface JSONRestconfService {
/**
* The data tree root path.
*/
String ROOT_PATH = null;
/**
* Issues a restconf PUT request to the configuration data store.
*
* @param uriPath the yang instance identifier path, eg "opendaylight-inventory:nodes/node/device-id".
* To specify the root, use {@link ROOT_PATH}.
* @param payload the payload data in JSON format.
* @throws OperationFailedException if the request fails.
*/
void put(String uriPath, @NonNull String payload) throws OperationFailedException;
/**
* Issues a restconf POST request to the configuration data store.
*
* @param uriPath the yang instance identifier path, eg "opendaylight-inventory:nodes/node/device-id".
* To specify the root, use {@link ROOT_PATH}.
* @param payload the payload data in JSON format.
* @throws OperationFailedException if the request fails.
*/
void post(String uriPath, @NonNull String payload) throws OperationFailedException;
/**
* Issues a restconf DELETE request to the configuration data store.
*
* @param uriPath the yang instance identifier path, eg "opendaylight-inventory:nodes/node/device-id".
* To specify the root, use {@link ROOT_PATH}.
* @throws OperationFailedException if the request fails.
*/
void delete(String uriPath) throws OperationFailedException;
/**
* Issues a restconf GET request to the given data store.
*
* @param uriPath the yang instance identifier path, eg "opendaylight-inventory:nodes/node/device-id".
* To specify the root, use {@link ROOT_PATH}.
* @param datastoreType the data store type to read from.
* @return an Optional containing the data in JSON format if present.
* @throws OperationFailedException if the request fails.
*/
Optional<String> get(String uriPath, LogicalDatastoreType datastoreType)
throws OperationFailedException;
/**
* Invokes a yang-defined RPC.
*
* @param uriPath the path representing the RPC to invoke, eg "toaster:make-toast".
* @param input the input in JSON format if the RPC takes input.
* @return an Optional containing the output in JSON format if the RPC returns output.
* @throws OperationFailedException if the request fails.
*/
Optional<String> invokeRpc(@NonNull String uriPath, Optional<String> input) throws OperationFailedException;
/**
* Issues a restconf PATCH request to the configuration data store.
*
* @param uriPath the yang instance identifier path, eg "opendaylight-inventory:nodes/node/device-id".
* To specify the root, use {@link ROOT_PATH}.
* @param payload the payload data in JSON format.
* @return an Optional containing the patch response data in JSON format.
* @throws OperationFailedException if the request fails.
*/
Optional<String> patch(@NonNull String uriPath, @NonNull String payload) throws OperationFailedException;
/**
* Subscribe to a stream.
* @param identifier the identifier of the stream, e.g., "data-change-event-subscription/neutron:neutron/...
* ...neutron:ports/datastore=OPERATIONAL/scope=SUBTREE".
* @param params HTTP query parameters or null.
* @return On optional containing the JSON response.
* @throws OperationFailedException if the requests fails.
*/
Optional<String> subscribeToStream(@NonNull String identifier, MultivaluedMap<String, String> params)
throws OperationFailedException;
}
|
