2 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.restconf.server.api;
12 import org.eclipse.jdt.annotation.NonNullByDefault;
13 import org.eclipse.jdt.annotation.Nullable;
14 import org.opendaylight.restconf.api.ApiPath;
15 import org.opendaylight.restconf.common.errors.RestconfFuture;
16 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
17 import org.opendaylight.yangtools.yang.common.Empty;
20 * An implementation of a RESTCONF server, implementing the
21 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.3">RESTCONF API Resource</a>.
24 public interface RestconfServer {
26 * Delete a data resource.
28 * @param identifier resource identifier
29 * @return A {@link RestconfFuture} of the operation
31 @SuppressWarnings("checkstyle:abbreviationAsWordInName")
32 RestconfFuture<Empty> dataDELETE(ApiPath identifier);
35 * Return the content of the datastore.
37 * @param params {@link DataGetParams} for this request
38 * @return A {@link RestconfFuture} of the {@link DataGetResult} content
40 RestconfFuture<DataGetResult> dataGET(DataGetParams params);
43 * Return the content of a data resource.
45 * @param identifier resource identifier
46 * @param params {@link DataGetParams} for this request
47 * @return A {@link RestconfFuture} of the {@link DataGetResult} content
49 RestconfFuture<DataGetResult> dataGET(ApiPath identifier, DataGetParams params);
52 * Partially modify the target data resource, as defined in
53 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
55 * @param body data node for put to config DS
56 * @return A {@link RestconfFuture} of the operation
58 RestconfFuture<DataPatchResult> dataPATCH(ResourceBody body);
61 * Partially modify the target data resource, as defined in
62 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
64 * @param identifier resource identifier
65 * @param body data node for put to config DS
66 * @return A {@link RestconfFuture} of the operation
68 RestconfFuture<DataPatchResult> dataPATCH(ApiPath identifier, ResourceBody body);
71 * Ordered list of edits that are applied to the datastore by the server, as defined in
72 * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
74 * @param body YANG Patch body
75 * @return A {@link RestconfFuture} of the {@link DataYangPatchResult} content
77 RestconfFuture<DataYangPatchResult> dataPATCH(PatchBody body);
80 * Ordered list of edits that are applied to the datastore by the server, as defined in
81 * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
83 * @param identifier path to target
84 * @param body YANG Patch body
85 * @return A {@link RestconfFuture} of the {@link DataYangPatchResult} content
87 RestconfFuture<DataYangPatchResult> dataPATCH(ApiPath identifier, PatchBody body);
89 RestconfFuture<DataPostResult.CreateResource> dataPOST(ChildBody body, Map<String, String> queryParameters);
92 * Create or invoke a operation, as described in
93 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4">RFC8040 section 4.4</a>.
95 * @param identifier path to target
96 * @param body body of the post request
97 * @param queryParameters query parameters
99 RestconfFuture<? extends DataPostResult> dataPOST(ApiPath identifier, DataPostBody body,
100 Map<String, String> queryParameters);
103 * Replace the data store, as described in
104 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>.
106 * @param body data node for put to config DS
107 * @param queryParameters Query parameters
108 * @return A {@link RestconfFuture} completing with {@link DataPutResult}
110 RestconfFuture<DataPutResult> dataPUT(ResourceBody body, Map<String, String> queryParameters);
113 * Create or replace a data store resource, as described in
114 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>.
116 * @param identifier resource identifier
117 * @param body data node for put to config DS
118 * @param queryParameters Query parameters
119 * @return A {@link RestconfFuture} completing with {@link DataPutResult}
121 RestconfFuture<DataPutResult> dataPUT(ApiPath identifier, ResourceBody body, Map<String, String> queryParameters);
124 * Return the set of supported RPCs supported by {@link #operationsPOST(URI, ApiPath, OperationInputBody)},
125 * as expressed in the <a href="https://www.rfc-editor.org/rfc/rfc8040#page-84">ietf-restconf.yang</a>
126 * {@code container operations} statement.
128 * @return A {@link RestconfFuture} completing with an {@link OperationsGetResult}
130 RestconfFuture<OperationsGetResult> operationsGET();
133 * Return the details about a particular operation supported by
134 * {@link #operationsPOST(URI, String, OperationInputBody)}, as expressed in the
135 * <a href="https://www.rfc-editor.org/rfc/rfc8040#page-84">ietf-restconfig.yang</a>
136 * {@code container operations} statement.
138 * @param operation An operation
139 * @return A {@link RestconfFuture} completing with an {@link OperationsGetResult}
141 RestconfFuture<OperationsGetResult> operationsGET(ApiPath operation);
144 * Invoke an RPC operation, as defined in
145 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.6">RFC8040 Operation Resource</a>.
147 * @param restconfURI Base URI of the request
148 * @param operation {@code <operation>} path, really an {@link ApiPath} to an {@code rpc}
149 * @param body RPC operation
150 * @return A {@link RestconfFuture} completing with {@link OperationsPostResult}
152 // FIXME: 'operation' should really be an ApiIdentifier with non-null module, but we also support yang-ext:mount,
153 // and hence it is a path right now
154 RestconfFuture<OperationsPostResult> operationsPOST(URI restconfURI, ApiPath operation, OperationInputBody body);
157 * Return the revision of {@code ietf-yang-library} module implemented by this server, as defined in
158 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.3.3">RFC8040 {+restconf}/yang-library-version</a>.
160 * @return A {@link RestconfFuture} completing with {@link NormalizedNodePayload} containing a single
161 * {@code yang-library-version} leaf element.
163 // FIXME: this is a simple encoding-variadic return, similar to how OperationsContent is handled use a common
164 // construct for both cases -- in this case it carries a yang.common.Revision
165 RestconfFuture<NormalizedNodePayload> yangLibraryVersionGET();
167 RestconfFuture<ModulesGetResult> modulesYangGET(String fileName, @Nullable String revision);
169 RestconfFuture<ModulesGetResult> modulesYangGET(ApiPath mountPath, String fileName, @Nullable String revision);
171 RestconfFuture<ModulesGetResult> modulesYinGET(String fileName, @Nullable String revision);
173 RestconfFuture<ModulesGetResult> modulesYinGET(ApiPath mountPath, String fileName, @Nullable String revision);