restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/DataPutPath.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 org.eclipse.jdt.annotation.NonNullByDefault;
  13 import org.opendaylight.restconf.api.ApiPath;
  14 import org.opendaylight.restconf.nb.rfc8040.databind.DataPostBody;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  17 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  18
  19 /**
  20  * An {@link ApiPath} subpath of {@code /data} {@code PUT} HTTP operation, as defined in
  21  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>.
  22  *
  23  * @param databind Associated {@link DatabindContext}
  24  * @param inference Associated {@link Inference} pointing to the {@link EffectiveStatement} of the last ApiPath element.
  25  *                  This can be one of:
  26  *                  <ul>
  27  *                    <li>a datatore, inference being {@link Inference#isEmpty() empty}</li>
  28  *                    <li>a data resource, inference pointing to the the {@code data schema node} identified by
  29  *                        {@code instance}</li>
  30  *                  </ul>
  31  * @param instance Associated {@link YangInstanceIdentifier}
  32  * @see DataPostBody
  33  */
  34 @NonNullByDefault
  35 public record DataPutPath(DatabindContext databind, Inference inference, YangInstanceIdentifier instance)
  36         implements DatabindAware {
  37     public DataPutPath {
  38         requireNonNull(databind);
  39         requireNonNull(inference);
  40         requireNonNull(instance);
  41     }
  42
  43     public DataPutPath(final DatabindContext databind) {
  44         this(databind, Inference.ofDataTreePath(databind.modelContext()), YangInstanceIdentifier.of());
  45     }
  46 }