restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/RestconfServer.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.restconf.server.api;
   9
  10 import java.net.URI;
  11 import java.util.Map;
  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.api.FormattableBody;
  16 import org.opendaylight.restconf.common.errors.RestconfFuture;
  17 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  18 import org.opendaylight.yangtools.yang.common.Empty;
  19
  20 /**
  21  * An implementation of a RESTCONF server, implementing the
  22  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.3">RESTCONF API Resource</a>.
  23  */
  24 @NonNullByDefault
  25 public interface RestconfServer {
  26     /**
  27      * Delete a data resource.
  28      *
  29      * @param identifier resource identifier
  30      * @return A {@link RestconfFuture} of the operation
  31      */
  32     @SuppressWarnings("checkstyle:abbreviationAsWordInName")
  33     RestconfFuture<Empty> dataDELETE(ApiPath identifier);
  34
  35     /**
  36      * Return the content of the datastore.
  37      *
  38      * @param params {@link DataGetParams} for this request
  39      * @return A {@link RestconfFuture} of the {@link DataGetResult} content
  40      */
  41     RestconfFuture<DataGetResult> dataGET(DataGetParams params);
  42
  43     /**
  44      * Return the content of a data resource.
  45      *
  46      * @param identifier resource identifier
  47      * @param params {@link DataGetParams} for this request
  48      * @return A {@link RestconfFuture} of the {@link DataGetResult} content
  49      */
  50     RestconfFuture<DataGetResult> dataGET(ApiPath identifier, DataGetParams params);
  51
  52     /**
  53      * Partially modify the target data resource, as defined in
  54      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
  55      *
  56      * @param body data node for put to config DS
  57      * @return A {@link RestconfFuture} of the operation
  58      */
  59     RestconfFuture<DataPatchResult> dataPATCH(ResourceBody body);
  60
  61     /**
  62      * Partially modify the target data resource, as defined in
  63      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040, section 4.6.1</a>.
  64      *
  65      * @param identifier resource identifier
  66      * @param body data node for put to config DS
  67      * @return A {@link RestconfFuture} of the operation
  68      */
  69     RestconfFuture<DataPatchResult> dataPATCH(ApiPath identifier, ResourceBody body);
  70
  71     /**
  72      * Ordered list of edits that are applied to the datastore by the server, as defined in
  73      * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
  74      *
  75      * @param body YANG Patch body
  76      * @return A {@link RestconfFuture} of the {@link DataYangPatchResult} content
  77      */
  78     RestconfFuture<DataYangPatchResult> dataPATCH(PatchBody body);
  79
  80     /**
  81      * Ordered list of edits that are applied to the datastore by the server, as defined in
  82      * <a href="https://www.rfc-editor.org/rfc/rfc8072#section-2">RFC8072, section 2</a>.
  83      *
  84      * @param identifier path to target
  85      * @param body YANG Patch body
  86      * @return A {@link RestconfFuture} of the {@link DataYangPatchResult} content
  87      */
  88     RestconfFuture<DataYangPatchResult> dataPATCH(ApiPath identifier, PatchBody body);
  89
  90     RestconfFuture<CreateResourceResult> dataPOST(ChildBody body, Map<String, String> queryParameters);
  91
  92     /**
  93      * Create or invoke a operation, as described in
  94      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4">RFC8040 section 4.4</a>.
  95      *
  96      * @param identifier path to target
  97      * @param body body of the post request
  98      * @param queryParameters query parameters
  99      */
 100     RestconfFuture<? extends DataPostResult> dataPOST(ApiPath identifier, DataPostBody body,
 101         Map<String, String> queryParameters);
 102
 103     /**
 104      * Replace the data store, as described in
 105      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>.
 106      *
 107      * @param body data node for put to config DS
 108      * @param queryParameters Query parameters
 109      * @return A {@link RestconfFuture} completing with {@link DataPutResult}
 110      */
 111     RestconfFuture<DataPutResult> dataPUT(ResourceBody body, Map<String, String> queryParameters);
 112
 113     /**
 114      * Create or replace a data store resource, as described in
 115      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>.
 116      *
 117      * @param identifier resource identifier
 118      * @param body data node for put to config DS
 119      * @param queryParameters Query parameters
 120      * @return A {@link RestconfFuture} completing with {@link DataPutResult}
 121      */
 122     RestconfFuture<DataPutResult> dataPUT(ApiPath identifier, ResourceBody body, Map<String, String> queryParameters);
 123
 124     /**
 125      * Return the set of supported RPCs supported by {@link #operationsPOST(URI, ApiPath, Map, OperationInputBody)},
 126      * as expressed in the <a href="https://www.rfc-editor.org/rfc/rfc8040#page-84">ietf-restconf.yang</a>
 127      * {@code container operations} statement.
 128      *
 129      * @return A {@link RestconfFuture} completing with an {@link FormattableBody}
 130      */
 131     RestconfFuture<FormattableBody> operationsGET();
 132
 133     /*
 134      * Return the details about a particular operation supported by
 135      * {@link #operationsPOST(URI, String, OperationInputBody)}, as expressed in the
 136      * <a href="https://www.rfc-editor.org/rfc/rfc8040#page-84">ietf-restconfig.yang</a>
 137      * {@code container operations} statement.
 138      *
 139      * @param operation An operation
 140      * @return A {@link RestconfFuture} completing with an {@link FormattableBody}
 141      */
 142     RestconfFuture<FormattableBody> operationsGET(ApiPath operation);
 143
 144     /**
 145      * Invoke an RPC operation, as defined in
 146      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.6">RFC8040 Operation Resource</a>.
 147      *
 148      * @param restconfURI Base URI of the request
 149      * @param operation {@code <operation>} path, really an {@link ApiPath} to an {@code rpc}
 150      * @param queryParameters query parameters
 151      * @param body RPC operation
 152      * @return A {@link RestconfFuture} completing with {@link InvokeResult}
 153      */
 154     // FIXME: 'operation' should really be an ApiIdentifier with non-null module, but we also support yang-ext:mount,
 155     //        and hence it is a path right now
 156     RestconfFuture<InvokeResult> operationsPOST(URI restconfURI, ApiPath operation, Map<String, String> queryParameters,
 157         OperationInputBody body);
 158
 159     /**
 160      * Return the revision of {@code ietf-yang-library} module implemented by this server, as defined in
 161      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.3.3">RFC8040 {+restconf}/yang-library-version</a>.
 162      *
 163      * @return A {@link RestconfFuture} completing with {@link NormalizedNodePayload} containing a single
 164      *        {@code yang-library-version} leaf element.
 165      */
 166     // FIXME: this is a simple encoding-variadic return, similar to how OperationsContent is handled use a common
 167     //        construct for both cases -- in this case it carries a yang.common.Revision
 168     RestconfFuture<NormalizedNodePayload> yangLibraryVersionGET();
 169
 170     RestconfFuture<ModulesGetResult> modulesYangGET(String fileName, @Nullable String revision);
 171
 172     RestconfFuture<ModulesGetResult> modulesYangGET(ApiPath mountPath, String fileName, @Nullable String revision);
 173
 174     RestconfFuture<ModulesGetResult> modulesYinGET(String fileName, @Nullable String revision);
 175
 176     RestconfFuture<ModulesGetResult> modulesYinGET(ApiPath mountPath, String fileName, @Nullable String revision);
 177 }