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

Go to download
/*
 * 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 static java.util.Objects.requireNonNull;

import java.time.Instant;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;

/**
 * Result of a {@code POST} request as defined in
 * RFC8040 section 4.4.
 */
public sealed interface DataPostResult {
    /**
     * Result of a {@code POST} request in as defined in
     * RFC8040 Create Resource Mode.
     *
     * @param createdPath API path of the newly-created resource
     * @param entityTag response {@code ETag} header, or {@code null} if not applicable
     * @param lastModified response {@code Last-Modified} header, or {@code null} if not applicable
     */
    record CreateResource(
            // FIXME: use ApiPath instead of String
            @NonNull String createdPath,
            @Nullable EntityTag entityTag,
            @Nullable Instant lastModified) implements DataPostResult, ConfigurationMetadata {
        public CreateResource {
            requireNonNull(createdPath);
        }

        public CreateResource(final @NonNull String createdPath) {
            this(createdPath, null, null);
        }
    }

    /**
     * Result of a {@code POST} request as defined in
     * RFC8040 Invoke Operation Mode.
     *
     * @param output Non-empty operation output, or {@code null}
     */
    record InvokeOperation(@Nullable NormalizedNodePayload output) implements DataPostResult {
        public static final InvokeOperation EMPTY = new InvokeOperation(null);
    }
}