restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/legacy/NormalizedNodePayload.java

   1 /*
   2  * Copyright (c) 2021 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.nb.rfc8040.legacy;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import java.net.URI;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.eclipse.jdt.annotation.Nullable;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  18 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  19
  20 /**
  21  * A RFC8040 overlay from our marriage to NormalizedNodeContext. This represents a NormalizedNode along with further
  22  * messy details needed to deal with the payload.
  23  */
  24 public final class NormalizedNodePayload {
  25     private final InstanceIdentifierContext context;
  26     private final @NonNull ImmutableMap<String, Object> headers;
  27     private final @NonNull QueryParameters writerParameters;
  28     private final NormalizedNode data;
  29
  30     private NormalizedNodePayload(final InstanceIdentifierContext context, final NormalizedNode data,
  31             final QueryParameters writerParameters, final ImmutableMap<String, Object> headers) {
  32         this.context = context;
  33         this.data = data;
  34         this.writerParameters = requireNonNull(writerParameters);
  35         this.headers = requireNonNull(headers);
  36     }
  37
  38     public static @NonNull NormalizedNodePayload empty(final InstanceIdentifierContext path) {
  39         return new NormalizedNodePayload(requireNonNull(path), null, QueryParameters.empty(), ImmutableMap.of());
  40     }
  41
  42     public static @NonNull NormalizedNodePayload of(final InstanceIdentifierContext path, final NormalizedNode data) {
  43         return new NormalizedNodePayload(requireNonNull(path), requireNonNull(data), QueryParameters.empty(),
  44             ImmutableMap.of());
  45     }
  46
  47     public static @NonNull NormalizedNodePayload ofNullable(final InstanceIdentifierContext path,
  48             final NormalizedNode data) {
  49         return data == null ? empty(path) : of(path, data);
  50     }
  51
  52     public static @NonNull NormalizedNodePayload ofLocation(final InstanceIdentifierContext path,
  53             final NodeIdentifier leafId, final URI location) {
  54         return new NormalizedNodePayload(requireNonNull(path), ImmutableNodes.leafNode(leafId, location.toString()),
  55             QueryParameters.empty(), ImmutableMap.of("Location", location));
  56     }
  57
  58     public static Object ofReadData(final InstanceIdentifierContext path, final NormalizedNode data,
  59             final QueryParameters parameters) {
  60         return new NormalizedNodePayload(requireNonNull(path), requireNonNull(data), parameters, ImmutableMap.of());
  61     }
  62
  63     public InstanceIdentifierContext getInstanceIdentifierContext() {
  64         return context;
  65     }
  66
  67     public @Nullable NormalizedNode getData() {
  68         return data;
  69     }
  70
  71     /**
  72      * Return headers response headers.
  73      *
  74      * @return map of headers
  75      */
  76     // FIXME: this is only used for redirect on subscribe
  77     public @NonNull ImmutableMap<String, Object> getNewHeaders() {
  78         return headers;
  79     }
  80
  81     public @NonNull QueryParameters getWriterParameters() {
  82         return writerParameters;
  83     }
  84 }