org.apache.solr.client.solrj.impl

Class ZkClientClusterStateProvider

java.lang.Object

org.apache.solr.client.solrj.impl.ZkClientClusterStateProvider

All Implemented Interfaces:

Closeable, AutoCloseable, ClusterStateProvider

public class ZkClientClusterStateProvider
extends Object
implements ClusterStateProvider

Constructor Summary

Constructors

Constructor and Description
ZkClientClusterStateProvider(Collection<String> zkHosts, String chroot)
ZkClientClusterStateProvider(String zkHost)
ZkClientClusterStateProvider(ZkStateReader zkStateReader)

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect()
void	downloadConfig(String configName, Path downloadPath) Download a named config from Zookeeper to a location on the filesystem
String	getAlias(String alias) Given an alias, returns the collection name that this alias points to
Object	getClusterProperty(String propertyName) Obtain a cluster property, or null if it doesn't exist.
Object	getClusterProperty(String propertyName, String def) Obtain a cluster property, or the default value if it doesn't exist.
String	getCollectionName(String name) Given a name, returns the collection name if an alias by that name exists, or returns the name itself, if no alias exists.
ClusterState.CollectionRef	getState(String collection) Obtain the state of the collection (cluster status).
ZkStateReader	getZkStateReader()
Set<String>	liveNodes() Obtain set of live_nodes for the cluster.
String	toString()
void	uploadConfig(Path configPath, String configName) Upload a set of config files to Zookeeper and give it a name NOTE: You should only allow trusted users to upload configs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZkClientClusterStateProvider

public ZkClientClusterStateProvider(ZkStateReader zkStateReader)

ZkClientClusterStateProvider

public ZkClientClusterStateProvider(Collection<String> zkHosts,
                                    String chroot)

ZkClientClusterStateProvider

public ZkClientClusterStateProvider(String zkHost)

Method Detail

getState

public ClusterState.CollectionRef getState(String collection)

Description copied from interface: ClusterStateProvider

Obtain the state of the collection (cluster status).

Specified by:

getState in interface ClusterStateProvider

Returns:

the collection state, or null is collection doesn't exist

getZkStateReader

public ZkStateReader getZkStateReader()

liveNodes

public Set<String> liveNodes()

Description copied from interface: ClusterStateProvider

Obtain set of live_nodes for the cluster.

Specified by:

liveNodes in interface ClusterStateProvider

getAlias

public String getAlias(String alias)

Description copied from interface: ClusterStateProvider

Given an alias, returns the collection name that this alias points to

Specified by:

getAlias in interface ClusterStateProvider

getClusterProperty

public Object getClusterProperty(String propertyName)

Description copied from interface: ClusterStateProvider

Obtain a cluster property, or null if it doesn't exist.

Specified by:

getClusterProperty in interface ClusterStateProvider

getClusterProperty

public Object getClusterProperty(String propertyName,
                                 String def)

Description copied from interface: ClusterStateProvider

Obtain a cluster property, or the default value if it doesn't exist.

Specified by:

getClusterProperty in interface ClusterStateProvider

getCollectionName

public String getCollectionName(String name)

Description copied from interface: ClusterStateProvider

Given a name, returns the collection name if an alias by that name exists, or returns the name itself, if no alias exists.

Specified by:

getCollectionName in interface ClusterStateProvider

downloadConfig

public void downloadConfig(String configName,
                           Path downloadPath)
                    throws IOException

Download a named config from Zookeeper to a location on the filesystem

Parameters:

configName - the name of the config

downloadPath - the path to write config files to

Throws:

IOException - if an I/O exception occurs

uploadConfig

public void uploadConfig(Path configPath,
                         String configName)
                  throws IOException

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.

Parameters:

configPath - Path to the config files

configName - the name of the config

Throws:

IOException - if an IO error occurs

connect

public void connect()

Specified by:

connect in interface ClusterStateProvider

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object