org.elasticsearch.hadoop.util.SettingsUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-spark-30_2.12 Show documentation
Show all versions of elasticsearch-spark-30_2.12 Show documentation
Elasticsearch Spark (for Spark 3.X)
The newest version!
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you 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.elasticsearch.hadoop.util;
import org.elasticsearch.hadoop.EsHadoopIllegalArgumentException;
import org.elasticsearch.hadoop.EsHadoopIllegalStateException;
import org.elasticsearch.hadoop.cfg.ConfigurationOptions;
import org.elasticsearch.hadoop.cfg.InternalConfigurationOptions;
import org.elasticsearch.hadoop.cfg.Settings;
import org.elasticsearch.hadoop.serialization.dto.NodeInfo;
import org.elasticsearch.hadoop.serialization.field.FieldFilter;
import org.elasticsearch.hadoop.serialization.field.FieldFilter.NumberedInclude;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
public abstract class SettingsUtils {
private static List qualifyNodes(String nodes, int defaultPort, boolean resolveHostNames) {
List list = StringUtils.tokenize(nodes);
for (int i = 0; i < list.size(); i++) {
String nodeIp = (resolveHostNames ? resolveHostToIpIfNecessary(list.get(i)) : list.get(i));
list.set(i, qualifyNode(nodeIp, defaultPort));
}
return list;
}
private static String qualifyNode(String node, int defaultPort) {
int index = node.lastIndexOf(':');
if (index > 0) {
if (index + 1 < node.length()) {
// the port is already in the node
if (Character.isDigit(node.charAt(index + 1))) {
return node;
}
}
}
return node + ":" + defaultPort;
}
private static String resolveHostToIpIfNecessary(String host) {
String schemaDelimiter = "://";
String schema = StringUtils.EMPTY;
if (host.contains(schemaDelimiter)) {
int index = host.indexOf(schemaDelimiter);
schema = host.substring(0, index);
host = host.substring(index + schemaDelimiter.length());
}
int index = host.lastIndexOf(':');
String name = index > 0 ? host.substring(0, index) : host;
// if the port is specified, include the ":"
String port = index > 0 ? host.substring(index) : "";
if (StringUtils.hasLetter(name)) {
try {
String hostAddress = InetAddress.getByName(name).getHostAddress() + port;
return StringUtils.hasText(schema) ? schema + schemaDelimiter + hostAddress : hostAddress;
} catch (UnknownHostException ex) {
throw new EsHadoopIllegalArgumentException("Cannot resolve ip for hostname: " + name);
}
}
return host;
}
public static void pinNode(Settings settings, String address) {
settings.setProperty(InternalConfigurationOptions.INTERNAL_ES_PINNED_NODE, address);
}
public static boolean hasPinnedNode(Settings settings) {
return StringUtils.hasText(settings.getProperty(InternalConfigurationOptions.INTERNAL_ES_PINNED_NODE));
}
public static String getPinnedNode(Settings settings) {
String node = settings.getProperty(InternalConfigurationOptions.INTERNAL_ES_PINNED_NODE);
Assert.hasText(node, "Task has not been pinned to a node...");
return node;
}
public static void setJobTransportPoolingKey(Settings settings, String key) {
settings.setProperty(InternalConfigurationOptions.INTERNAL_TRANSPORT_POOLING_KEY, key);
}
public static void ensureJobTransportPoolingKey(Settings settings) {
if (!hasJobTransportPoolingKey(settings)) {
throw new EsHadoopIllegalStateException("Job has not been assigned a transport pooling key. Required `"+InternalConfigurationOptions.INTERNAL_TRANSPORT_POOLING_KEY+"` to be set but it was not assigned.");
}
}
public static boolean hasJobTransportPoolingKey(Settings settings) {
return StringUtils.hasText(settings.getProperty(InternalConfigurationOptions.INTERNAL_TRANSPORT_POOLING_KEY));
}
public static String getJobTransportPoolingKey(Settings settings) {
String jobKey = settings.getProperty(InternalConfigurationOptions.INTERNAL_TRANSPORT_POOLING_KEY);
Assert.hasText(jobKey, "Job has not been assigned a transport pooling key...");
return jobKey;
}
public static void addDiscoveredNodes(Settings settings, List discoveredNodes) {
// clean-up and merge
Set nodes = new LinkedHashSet();
nodes.addAll(declaredNodes(settings));
for (NodeInfo node : discoveredNodes) {
if (node.hasHttp()) {
nodes.add(node.getPublishAddress());
}
}
setDiscoveredNodes(settings, nodes);
}
public static void setDiscoveredNodes(Settings settings, Collection nodes) {
settings.setProperty(InternalConfigurationOptions.INTERNAL_ES_DISCOVERED_NODES, StringUtils.concatenate(nodes));
}
public static List declaredNodes(Settings settings) {
return qualifyNodes(settings.getNodes(), settings.getPort(), settings.getNodesResolveHostnames());
}
public static List discoveredOrDeclaredNodes(Settings settings) {
// returned the discovered nodes or, if not defined, the set nodes
String discoveredNodes = settings.getProperty(InternalConfigurationOptions.INTERNAL_ES_DISCOVERED_NODES);
return (StringUtils.hasText(discoveredNodes) ? StringUtils.tokenize(discoveredNodes) : declaredNodes(settings));
}
public static Map aliases(String definition, boolean caseInsensitive) {
List aliases = StringUtils.tokenize(definition);
Map aliasMap = new LinkedHashMap();
if (aliases != null) {
for (String string : aliases) {
// split alias
string = string.trim();
int index = string.indexOf(":");
if (index > 0) {
String key = string.substring(0, index);
aliasMap.put(key, string.substring(index + 1));
aliasMap.put(caseInsensitive ? key.toLowerCase(Locale.ROOT) : key, string.substring(index + 1));
}
}
}
return aliasMap;
}
public static void setFilters(Settings settings, String... filters) {
// clear any filters inside the settings
settings.setProperty(InternalConfigurationOptions.INTERNAL_ES_QUERY_FILTERS, "");
if (ObjectUtils.isEmpty(filters)) {
return;
}
settings.setProperty(InternalConfigurationOptions.INTERNAL_ES_QUERY_FILTERS, IOUtils.serializeToJsonString(filters));
}
public static String[] getFilters(Settings settings) {
return IOUtils.deserializeFromJsonString(settings.getProperty(InternalConfigurationOptions.INTERNAL_ES_QUERY_FILTERS), String[].class);
}
public static String determineSourceFields(Settings settings) {
String internalScrollFields = settings.getScrollFields();
String userProvided = settings.getReadSourceFilter();
if (StringUtils.hasText(userProvided) && StringUtils.hasText(internalScrollFields)) {
// Conflict found
throw new EsHadoopIllegalStateException("User specified source filters were found ["+userProvided+"], " +
"but the connector is executing in a state where it has provided its own source filtering " +
"["+internalScrollFields+"]. Please clear the user specified source fields under the " +
"["+ConfigurationOptions.ES_READ_SOURCE_FILTER+"] property to continue. Bailing out...");
}
String sourceFields = null;
if (StringUtils.hasText(userProvided)) {
sourceFields = userProvided;
}
if (StringUtils.hasText(internalScrollFields)) {
sourceFields = internalScrollFields;
}
return sourceFields;
}
/**
* Whether the settings indicate a ES 5.0.x (which introduces breaking changes) or otherwise.
* @deprecated Prefer to use {@link Settings#getClusterInfoOrThrow()} to check version is on or after 5.X
*/
@Deprecated
public static boolean isEs50(Settings settings) {
EsMajorVersion version = settings.getInternalVersionOrLatest();
return version.onOrAfter(EsMajorVersion.V_5_X);
}
public static List getFieldArrayFilterInclude(Settings settings) {
String includeString = settings.getReadFieldAsArrayInclude();
List includes = StringUtils.tokenize(includeString);
try {
return FieldFilter.toNumberedFilter(includes);
} catch (EsHadoopIllegalArgumentException iae) {
throw new EsHadoopIllegalArgumentException("Failed to parse [" +
ConfigurationOptions.ES_READ_FIELD_AS_ARRAY_INCLUDE + "] option with value of [" +
includeString + "]", iae);
}
}
public static String getFixedRouting(Settings settings) {
String routing = settings.getMappingRouting();
if (StringUtils.hasText(routing)) {
// instead of using ConstantExtractor (which is useful for JSON), parse the constant manually
routing = routing.trim();
if (routing.startsWith("<") && routing.endsWith(">")) {
return routing.substring(1, routing.length() -1);
}
}
return null;
}
}