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
  16 /**
  17  * Result of a {@code POST} request as defined in
  18  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4">RFC8040 section 4.4</a>.
  19  */
  20 public sealed interface DataPostResult permits DataPostResult.CreateResource, InvokeResult {
  21     /**
  22      * Result of a {@code POST} request in as defined in
  23      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4.1">RFC8040 Create Resource Mode</a>.
  24      *
  25      * @param createdPath API path of the newly-created resource
  26      * @param entityTag response {@code ETag} header, or {@code null} if not applicable
  27      * @param lastModified response {@code Last-Modified} header, or {@code null} if not applicable
  28      */
  29     record CreateResource(
  30             // FIXME: use ApiPath instead of String
  31             @NonNull String createdPath,
  32             @Nullable EntityTag entityTag,
  33             @Nullable Instant lastModified) implements DataPostResult, ConfigurationMetadata {
  34         public CreateResource {
  35             requireNonNull(createdPath);
  36         }
  37
  38         public CreateResource(final @NonNull String createdPath) {
  39             this(createdPath, null, null);
  40         }
  41     }
  42 }