org.opendaylight.restconf.server.api.RestconfServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restconf-nb Show documentation
RESTCONF Northbound application
There is a newer version: 8.0.2
/*
 * Copyright (c) 2023 PANTHEON.tech, s.r.o. 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.restconf.server.api;

import java.net.URI;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.restconf.api.ApiPath;
import org.opendaylight.restconf.api.FormattableBody;
import org.opendaylight.restconf.common.errors.RestconfFuture;
import org.opendaylight.yangtools.yang.common.Empty;

/**
 * An implementation of a RESTCONF server, implementing the
 * RESTCONF API Resource.
 */
@NonNullByDefault
public interface RestconfServer {
    /**
     * Delete a data resource.
     *
     * @param identifier resource identifier
     * @return A {@link RestconfFuture} of the operation
     */
    @SuppressWarnings("checkstyle:abbreviationAsWordInName")
    RestconfFuture dataDELETE(ServerRequest request, ApiPath identifier);

    /**
     * Return the content of the datastore.
     *
     * @param request {@link ServerRequest} for this request
     * @return A {@link RestconfFuture} of the {@link DataGetResult} content
     */
    RestconfFuture dataGET(ServerRequest request);

    /**
     * Return the content of a data resource.
     *
     * @param request {@link ServerRequest} for this request
     * @param identifier resource identifier
     * @return A {@link RestconfFuture} of the {@link DataGetResult} content
     */
    RestconfFuture dataGET(ServerRequest request, ApiPath identifier);

    /**
     * Partially modify the target data resource, as defined in
     * RFC8040, section 4.6.1.
     *
     * @param request {@link ServerRequest} for this request
     * @param body data node for put to config DS
     * @return A {@link RestconfFuture} of the operation
     */
    RestconfFuture dataPATCH(ServerRequest request, ResourceBody body);

    /**
     * Partially modify the target data resource, as defined in
     * RFC8040, section 4.6.1.
     *
     * @param request {@link ServerRequest} for this request
     * @param identifier resource identifier
     * @param body data node for put to config DS
     * @return A {@link RestconfFuture} of the operation
     */
    RestconfFuture dataPATCH(ServerRequest request, ApiPath identifier, ResourceBody body);

    /**
     * Ordered list of edits that are applied to the datastore by the server, as defined in
     * RFC8072, section 2.
     *
     * @param request {@link ServerRequest} for this request
     * @param body YANG Patch body
     * @return A {@link RestconfFuture} of the {@link DataYangPatchResult} content
     */
    RestconfFuture dataPATCH(ServerRequest request, PatchBody body);

    /**
     * Ordered list of edits that are applied to the datastore by the server, as defined in
     * RFC8072, section 2.
     *
     * @param request {@link ServerRequest} for this request
     * @param identifier path to target
     * @param body YANG Patch body
     * @return A {@link RestconfFuture} of the {@link DataYangPatchResult} content
     */
    RestconfFuture dataPATCH(ServerRequest request, ApiPath identifier, PatchBody body);

    RestconfFuture dataPOST(ServerRequest request, ChildBody body);

    /**
     * Create or invoke a operation, as described in
     * RFC8040 section 4.4.
     *
     * @param request {@link ServerRequest} for this request
     * @param identifier path to target
     * @param body body of the post request
     */
    RestconfFuture dataPOST(ServerRequest request, ApiPath identifier, DataPostBody body);

    /**
     * Replace the data store, as described in
     * RFC8040 section 4.5.
     *
     * @param request {@link ServerRequest} for this request
     * @param body data node for put to config DS
     * @return A {@link RestconfFuture} completing with {@link DataPutResult}
     */
    RestconfFuture dataPUT(ServerRequest request, ResourceBody body);

    /**
     * Create or replace a data store resource, as described in
     * RFC8040 section 4.5.
     *
     * @param request {@link ServerRequest} for this request
     * @param identifier resource identifier
     * @param body data node for put to config DS
     * @return A {@link RestconfFuture} completing with {@link DataPutResult}
     */
    RestconfFuture dataPUT(ServerRequest request, ApiPath identifier, ResourceBody body);

    /**
     * Return the set of supported RPCs supported by
     * {@link #operationsPOST(ServerRequest, URI, ApiPath, OperationInputBody)},
     * as expressed in the ietf-restconf.yang
     * {@code container operations} statement.
     *
     * @param request {@link ServerRequest} for this request
     * @return A {@link RestconfFuture} completing with an {@link FormattableBody}
     */
    RestconfFuture operationsGET(ServerRequest request);

    /*
     * Return the details about a particular operation supported by
     * {@link #operationsPOST(URI, String, OperationInputBody)}, as expressed in the
     * ietf-restconfig.yang
     * {@code container operations} statement.
     *
     * @param request {@link ServerRequest} for this request
     * @param operation An operation
     * @return A {@link RestconfFuture} completing with an {@link FormattableBody}
     */
    RestconfFuture operationsGET(ServerRequest request, ApiPath operation);

    /**
     * Invoke an RPC operation, as defined in
     * RFC8040 Operation Resource.
     *
     * @param request {@link ServerRequest} for this request
     * @param restconfURI Base URI of the request, the absolute equivalent to {@code {+restconf}} URI with a trailing
     *                    slash
     * @param operation {@code } path, really an {@link ApiPath} to an {@code rpc}
     * @param body RPC operation
     * @return A {@link RestconfFuture} completing with {@link InvokeResult}
     */
    // FIXME: 'operation' should really be an ApiIdentifier with non-null module, but we also support yang-ext:mount,
    //        and hence it is a path right now
    RestconfFuture operationsPOST(ServerRequest request, URI restconfURI, ApiPath operation,
        OperationInputBody body);

    /**
     * Return the revision of {@code ietf-yang-library} module implemented by this server, as defined in
     * RFC8040 {+restconf}/yang-library-version.
     *
     * @param request {@link ServerRequest} for this request
     * @return A {@link RestconfFuture} completing with {@link FormattableBody} containing a single
     *        {@code yang-library-version} leaf element.
     */
    RestconfFuture yangLibraryVersionGET(ServerRequest request);

    RestconfFuture modulesYangGET(ServerRequest request, String fileName, @Nullable String revision);

    RestconfFuture modulesYangGET(ServerRequest request, ApiPath mountPath, String fileName,
        @Nullable String revision);

    RestconfFuture modulesYinGET(ServerRequest request, String fileName, @Nullable String revision);

    RestconfFuture modulesYinGET(ServerRequest request, ApiPath mountPath, String fileName,
        @Nullable String revision);
}