/*
* Copyright (c) 2016 Cisco Systems, Inc. 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.nb.rfc8040.rests.utils;
import static java.util.Objects.requireNonNull;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import java.util.Arrays;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
/**
* Constants for RestconfDataService.
*
*/
public final class RestconfDataServiceConstant {
public static final QName NETCONF_BASE_QNAME = SchemaContext.NAME;
private RestconfDataServiceConstant() {
throw new UnsupportedOperationException("Util class.");
}
/**
* Constants for read data.
*
*/
public static final class ReadData {
// URI parameters
public static final String CONTENT = "content";
public static final String DEPTH = "depth";
public static final String FIELDS = "fields";
// content values
public static final String CONFIG = "config";
public static final String ALL = "all";
public static final String NONCONFIG = "nonconfig";
// depth values
public static final String UNBOUNDED = "unbounded";
public static final int MIN_DEPTH = 1;
public static final int MAX_DEPTH = 65535;
public static final String WITH_DEFAULTS = "with-defaults";
/**
* With-default values, as per
* RFC8040 section 4.8.9.
*/
enum WithDefaults {
/**
* All data nodes are reported.
*/
REPORT_ALL("report-all"),
/**
* Data nodes set to the YANG default are not reported.
*/
TRIM("trim"),
/**
* Data nodes set to the YANG default by the client are reported.
*/
EXPLICIT("explicit"),
/**
* All data nodes are reported, and defaults are tagged.
*/
REPORT_ALL_TAGGED("report-all-tagged");
private static final ImmutableMap VALUES =
Maps.uniqueIndex(Arrays.asList(values()), WithDefaults::value);
private @NonNull String value;
WithDefaults(final @NonNull String value) {
this.value = value;
}
public @NonNull String value() {
return value;
}
static @Nullable WithDefaults forValue(final String value) {
return VALUES.get(requireNonNull(value));
}
static @Nullable Set possibleValues() {
return VALUES.keySet();
}
}
private ReadData() {
throw new UnsupportedOperationException("Util class.");
}
}
/**
* Common for PostData and PutData.
*/
public static final class PostPutQueryParameters {
public static final String INSERT = "insert";
public static final String POINT = "point";
/**
* Insert values, as per RFC8040 section 4.8.5.
*/
public enum Insert {
/**
* Insert the new data as the new first entry.
*/
FIRST("first"),
/**
* Insert the new data as the new last entry.
*/
LAST("last"),
/**
* Insert the new data before the insertion point, as specified by the value of the "point" parameter.
*/
BEFORE("before"),
/**
* Insert the new data after the insertion point, as specified by the value of the "point" parameter.
*/
AFTER("after");
private static final ImmutableMap VALUES =
Maps.uniqueIndex(Arrays.asList(values()), Insert::value);
private @NonNull String value;
Insert(final @NonNull String value) {
this.value = value;
}
public @NonNull String value() {
return value;
}
public static @Nullable Insert forValue(final String value) {
return VALUES.get(requireNonNull(value));
}
}
private PostPutQueryParameters() {
// Hidden on purpose
}
}
}