org.springframework.yarn.configuration.ConfigurationUtils Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2013 the original author or authors.
*
* 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.
*/
package org.springframework.yarn.configuration;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.util.GenericOptionsParser;
import org.apache.hadoop.yarn.conf.YarnConfiguration;
import org.springframework.core.io.Resource;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
/**
* Reusable utility class for common {@link Configuration} operations.
*
* @author Costin Leau
* @author Janne Valkealahti
*/
public abstract class ConfigurationUtils {
/**
* Adds the specified properties to the given {@link Configuration} object.
*
* @param configuration configuration to manipulate. Should not be null.
* @param properties properties to add to the configuration. May be null.
*/
public static void addProperties(Configuration configuration, Properties properties) {
Assert.notNull(configuration, "A non-null configuration is required");
if (properties != null) {
Enumeration props = properties.propertyNames();
while (props.hasMoreElements()) {
String key = props.nextElement().toString();
configuration.set(key, properties.getProperty(key));
}
}
}
/**
* Creates a new {@link Configuration} based on the given arguments.
*
* @param original initial configuration to read from. May be null.
* @param properties properties object to add to the newly created configuration. May be null.
* @return newly created configuration based on the input parameters.
*/
public static Configuration createFrom(Configuration original, Properties properties) {
Configuration cfg = null;
if (original != null) {
cfg = (original instanceof YarnConfiguration ? new YarnConfiguration(original) : new Configuration(original));
}
else {
cfg = new YarnConfiguration();
}
addProperties(cfg, properties);
return cfg;
}
/**
* Creates a new {@link YarnConfiguration} based on the given arguments. Identical to
* {@link #createFrom(Configuration, Properties)} but forces the use of
* {@link YarnConfiguration}.
*
* @param original initial configuration to read from. May be null.
* @param properties properties object to add to the newly created configuration. May be null.
* @return newly created configuration based on the input parameters.
*/
public static YarnConfiguration createFrom(YarnConfiguration original, Properties properties) {
return (YarnConfiguration) createFrom((YarnConfiguration) original, properties);
}
/**
* Returns a static {@link Properties} copy of the given configuration.
*
* @param configuration Hadoop configuration
* @return the properties
*/
public static Properties asProperties(Configuration configuration) {
Properties props = new Properties();
if (configuration != null) {
for (Map.Entry entry : configuration) {
props.setProperty(entry.getKey(), entry.getValue());
}
}
return props;
}
/**
* Creates a new {@link Configuration} by merging the given configurations.
* Ordering is important - the second configuration overriding values in the first.
*
* @param one configuration to read from. May be null.
* @param two configuration to read from. May be null.
* @return the result of merging the two configurations.
*/
public static Configuration merge(Configuration one, Configuration two) {
if (one == null) {
if (two == null) {
return new YarnConfiguration();
}
return new YarnConfiguration(two);
}
Configuration c = new YarnConfiguration(one);
if (two == null) {
return c;
}
for (Map.Entry entry : two) {
c.set(entry.getKey(), entry.getValue());
}
return c;
}
public static void addLibs(Configuration configuration, Resource... libs) {
addResource(configuration, libs, "-libjars");
}
public static void addFiles(Configuration configuration, Resource... files) {
addResource(configuration, files, "-files");
}
public static void addArchives(Configuration configuration, Resource... archives) {
addResource(configuration, archives, "-archives");
}
private static void addResource(Configuration cfg, Resource[] args, String name) {
Assert.notNull(cfg, "a non-null configuration is required");
List list = new ArrayList();
try {
if (!ObjectUtils.isEmpty(args)) {
int count = args.length;
list.add(name);
StringBuilder sb = new StringBuilder();
for (Resource res : args) {
sb.append(res.getURI().toString());
if (--count > 0) {
sb.append(",");
}
}
list.add(sb.toString());
}
new GenericOptionsParser(cfg, list.toArray(new String[list.size()]));
} catch (IOException ex) {
throw new IllegalStateException(ex);
}
}
}