org.restheart.plugins.ConfigurablePlugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of restheart-commons Show documentation
Show all versions of restheart-commons Show documentation
RESTHeart Commons - Common classes for core components and plugins.
/*-
* ========================LICENSE_START=================================
* restheart-commons
* %%
* Copyright (C) 2019 - 2024 SoftInstigate
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =========================LICENSE_END==================================
*/
package org.restheart.plugins;
import java.util.Map;
import org.restheart.configuration.ConfigurationException;
import org.restheart.utils.PluginUtils;
/**
*
* @author Andrea Di Cesare {@literal }
*/
public interface ConfigurablePlugin extends Plugin {
/**
*
* @param return value
* @param args
* @param argKey
* @return the string arg value of argKey from args
* @throws ConfigurationException
*/
@SuppressWarnings("unchecked")
public static V argValue(final Map args, final String argKey) throws ConfigurationException {
if (args == null || !args.containsKey(argKey)) {
throw new ConfigurationException("Required configuration argument '" + argKey + "' non found");
} else {
return (V) args.get(argKey);
}
}
public static V argValueOrDefault(final Map args, final String argKey, V value) throws ConfigurationException {
if (args == null || !args.containsKey(argKey)) {
return value;
} else {
return argValue(args, argKey);
}
}
@SuppressWarnings("unchecked")
default public V arg(final Map args, final String argKey) throws ConfigurationException {
if (args == null || !args.containsKey(argKey)) {
throw new ConfigurationException("The plugin " + PluginUtils.name(this) + " requires the missing configuration argument '" + argKey + "'");
} else {
return (V) args.get(argKey);
}
}
default public V argOrDefault(final Map args, final String argKey, V value) throws ConfigurationException {
if (args == null || !args.containsKey(argKey)) {
return value;
} else {
return arg(args, argKey);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy