org.apache.solr.client.solrj.impl.ZkClientClusterStateProvider Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.apache.solr.client.solrj.impl;
import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.solr.common.AlreadyClosedException;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.cloud.ClusterState;
import org.apache.solr.common.cloud.ZkStateReader;
import org.apache.solr.common.cloud.ZooKeeperException;
import org.apache.zookeeper.KeeperException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@SuppressWarnings({"unchecked"})
public class ZkClientClusterStateProvider implements ClusterStateProvider {
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
volatile ZkStateReader zkStateReader;
private boolean closeZkStateReader = true;
String zkHost;
private final boolean canUseZkACLs;
int zkConnectTimeout = 15000;
int zkClientTimeout = 45000;
private volatile boolean isClosed = false;
public ZkClientClusterStateProvider(ZkStateReader zkStateReader) {
this.zkStateReader = zkStateReader;
this.closeZkStateReader = false;
this.canUseZkACLs = true;
}
public ZkClientClusterStateProvider(Collection zkHosts, String chroot) {
this(zkHosts, chroot, true);
}
public ZkClientClusterStateProvider(
Collection zkHosts, String chroot, boolean canUseZkACLs) {
zkHost = buildZkHostString(zkHosts, chroot);
this.canUseZkACLs = canUseZkACLs;
}
public ZkClientClusterStateProvider(String zkHost){
this.zkHost = zkHost;
this.canUseZkACLs = true;
}
@Override
public ClusterState.CollectionRef getState(String collection) {
ClusterState clusterState = getZkStateReader().getClusterState();
if (clusterState != null) {
return clusterState.getCollectionRef(collection);
} else {
return null;
}
}
@Override
public Set getLiveNodes() {
ClusterState clusterState = getZkStateReader().getClusterState();
if (clusterState != null) {
return clusterState.getLiveNodes();
} else {
return Collections.emptySet();
}
}
@Override
public List resolveAlias(String alias) {
return getZkStateReader().getAliases().resolveAliases(alias); // if not an alias, returns itself
}
@Override
public Map getAliasProperties(String alias) {
return getZkStateReader().getAliases().getCollectionAliasProperties(alias);
}
@Override
public String resolveSimpleAlias(String alias) throws IllegalArgumentException {
return getZkStateReader().getAliases().resolveSimpleAlias(alias);
}
@Override
public Object getClusterProperty(String propertyName) {
Map props = getZkStateReader().getClusterProperties();
return props.get(propertyName);
}
@Override
public T getClusterProperty(String propertyName, T def) {
Map props = getZkStateReader().getClusterProperties();
if (props.containsKey(propertyName)) {
return (T)props.get(propertyName);
}
return def;
}
@Override
public ClusterState getClusterState() throws IOException {
return getZkStateReader().getClusterState();
}
@Override
public Map getClusterProperties() {
return getZkStateReader().getClusterProperties();
}
@Override
public String getPolicyNameByCollection(String coll) {
ClusterState.CollectionRef state = getState(coll);
return state == null || state.get() == null ? null : (String) state.get().getProperties().get("policy");
}
/**
* Download a named config from Zookeeper to a location on the filesystem
* @param configName the name of the config
* @param downloadPath the path to write config files to
* @throws IOException if an I/O exception occurs
*/
public void downloadConfig(String configName, Path downloadPath) throws IOException {
getZkStateReader().getConfigManager().downloadConfigDir(configName, downloadPath);
}
/**
* Upload a set of config files to Zookeeper and give it a name
*
* NOTE: You should only allow trusted users to upload configs. If you
* are allowing client access to zookeeper, you should protect the
* /configs node against unauthorised write access.
*
* @param configPath {@link java.nio.file.Path} to the config files
* @param configName the name of the config
* @throws IOException if an IO error occurs
*/
public void uploadConfig(Path configPath, String configName) throws IOException {
getZkStateReader().getConfigManager().uploadConfigDir(configPath, configName);
}
@Override
public void connect() {
// Esentially a No-Op, but force a check that we're not closed and the ZkStateReader is available...
final ZkStateReader ignored = getZkStateReader();
}
public ZkStateReader getZkStateReader() {
if (isClosed) { // quick check...
throw new AlreadyClosedException();
}
if (zkStateReader == null) {
synchronized (this) {
if (isClosed) { // while we were waiting for sync lock another thread may have closed
throw new AlreadyClosedException();
}
if (zkStateReader == null) {
ZkStateReader zk = null;
try {
zk = new ZkStateReader(zkHost, zkClientTimeout, zkConnectTimeout, canUseZkACLs);
zk.createClusterStateWatchersAndUpdate();
log.info("Cluster at {} ready", zkHost);
zkStateReader = zk;
} catch (InterruptedException e) {
zk.close();
Thread.currentThread().interrupt();
throw new ZooKeeperException(SolrException.ErrorCode.SERVER_ERROR, "", e);
} catch (KeeperException e) {
zk.close();
throw new ZooKeeperException(SolrException.ErrorCode.SERVER_ERROR, "", e);
} catch (Exception e) {
if (zk != null) zk.close();
// do not wrap because clients may be relying on the underlying exception being thrown
throw e;
}
}
}
}
return zkStateReader;
}
@Override
public void close() throws IOException {
synchronized (this) {
if (false == isClosed && zkStateReader != null) {
isClosed = true;
// force zkStateReader to null first so that any parallel calls drop into the synch block
// getZkStateReader() as soon as possible.
final ZkStateReader zkToClose = zkStateReader;
zkStateReader = null;
if (closeZkStateReader) {
zkToClose.close();
}
}
}
}
static String buildZkHostString(Collection zkHosts, String chroot) {
if (zkHosts == null || zkHosts.isEmpty()) {
throw new IllegalArgumentException("Cannot create CloudSearchClient without valid ZooKeeper host; none specified!");
}
StringBuilder zkBuilder = new StringBuilder();
int lastIndexValue = zkHosts.size() - 1;
int i = 0;
for (String zkHost : zkHosts) {
zkBuilder.append(zkHost);
if (i < lastIndexValue) {
zkBuilder.append(",");
}
i++;
}
if (chroot != null) {
if (chroot.startsWith("/")) {
zkBuilder.append(chroot);
} else {
throw new IllegalArgumentException(
"The chroot must start with a forward slash.");
}
}
/* Log the constructed connection string and then initialize. */
final String zkHostString = zkBuilder.toString();
log.debug("Final constructed zkHost string: {}", zkHostString);
return zkHostString;
}
@Override
public String toString() {
return zkHost;
}
@Override
public boolean isClosed() {
return isClosed;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy