restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/DataPostResult.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 static java.util.Objects.requireNonNull;
  11
  12 import java.time.Instant;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  16
  17 /**
  18  * Result of a {@code POST} request as defined in
  19  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4">RFC8040 section 4.4</a>.
  20  */
  21 public sealed interface DataPostResult {
  22     /**
  23      * Result of a {@code POST} request in as defined in
  24      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4.1">RFC8040 Create Resource Mode</a>.
  25      *
  26      * @param createdPath API path of the newly-created resource
  27      * @param entityTag response {@code ETag} header, or {@code null} if not applicable
  28      * @param lastModified response {@code Last-Modified} header, or {@code null} if not applicable
  29      */
  30     record CreateResource(
  31             // FIXME: use ApiPath instead of String
  32             @NonNull String createdPath,
  33             @Nullable EntityTag entityTag,
  34             @Nullable Instant lastModified) implements DataPostResult, ConfigurationMetadata {
  35         public CreateResource {
  36             requireNonNull(createdPath);
  37         }
  38
  39         public CreateResource(final @NonNull String createdPath) {
  40             this(createdPath, null, null);
  41         }
  42     }
  43
  44     /**
  45      * Result of a {@code POST} request as defined in
  46      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4.2">RFC8040 Invoke Operation Mode</a>.
  47      *
  48      * @param output Non-empty operation output, or {@code null}
  49      */
  50     record InvokeOperation(@Nullable NormalizedNodePayload output) implements DataPostResult {
  51         public static final InvokeOperation EMPTY = new InvokeOperation(null);
  52     }
  53 }