Package org.apache.solr.client.solrj.impl

Class ZkClientClusterStateProvider

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, ClusterStateProvider, SolrCloseable

public class ZkClientClusterStateProvider
extends Object
implements ClusterStateProvider

Retrieves cluster state from Zookeeper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
void	connect()
static ZkClientClusterStateProvider	from(CloudSolrClient client)	Extracts this from the client, or throws an exception if of the wrong type.
Map<String,String>	getAliasProperties(String alias)	Return alias properties, or an empty map if the alias has no properties.
Map<String,Object>	getClusterProperties()	Obtain cluster properties.
Object	getClusterProperty(String propertyName)	Obtain a cluster property, or null if it doesn't exist.
<T> T	getClusterProperty(String propertyName, T def)	Obtain a cluster property, or the default value if it doesn't exist.
ClusterState	getClusterState()	Obtain the current cluster state.
Set<String>	getLiveNodes()	Obtain set of live_nodes for the cluster.
String	getPolicyNameByCollection(String coll)	Get the collection-specific policy
String	getQuorumHosts()
ClusterState.CollectionRef	getState(String collection)	Obtain the state of the collection (cluster status).
int	getZkClientTimeout()
int	getZkConnectTimeout()
String	getZkHost()
ZkStateReader	getZkStateReader()
boolean	isClosed()
List<String>	resolveAlias(String alias)	Given a collection alias, returns a list of collections it points to, or returns a singleton list of the input if it's not an alias.
String	resolveSimpleAlias(String alias)	Given a collection alias, return a single collection it points to, or the original name if it's not an alias.
void	setZkClientTimeout(int zkClientTimeout)	Set the timeout to the zookeeper ensemble in ms
void	setZkConnectTimeout(int zkConnectTimeout)	Set the connect timeout to the zookeeper ensemble in ms
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.client.solrj.impl.ClusterStateProvider

getCollection, isRoutedAlias

Constructor Detail

ZkClientClusterStateProvider

public ZkClientClusterStateProvider(ZkStateReader zkStateReader)

ZkClientClusterStateProvider

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

ZkClientClusterStateProvider

public ZkClientClusterStateProvider(String zkHost)

Method Detail

from

public static ZkClientClusterStateProvider from(CloudSolrClient client)

Extracts this from the client, or throws an exception if of the wrong type.

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

getLiveNodes

public Set<String> getLiveNodes()

Description copied from interface: ClusterStateProvider

Obtain set of live_nodes for the cluster.

Specified by:

getLiveNodes in interface ClusterStateProvider

resolveAlias

public List<String> resolveAlias(String alias)

Description copied from interface: ClusterStateProvider

Given a collection alias, returns a list of collections it points to, or returns a singleton list of the input if it's not an alias.

Specified by:

resolveAlias in interface ClusterStateProvider

getAliasProperties

public Map<String,String> getAliasProperties(String alias)

Description copied from interface: ClusterStateProvider

Return alias properties, or an empty map if the alias has no properties.

Specified by:

getAliasProperties in interface ClusterStateProvider

resolveSimpleAlias

public String resolveSimpleAlias(String alias)
                          throws IllegalArgumentException

Description copied from interface: ClusterStateProvider

Given a collection alias, return a single collection it points to, or the original name if it's not an alias.

Specified by:

resolveSimpleAlias in interface ClusterStateProvider

Throws:

IllegalArgumentException - if an alias points to more than 1 collection, either directly or indirectly.

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 <T> T getClusterProperty(String propertyName,
                                T 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

getClusterState

public ClusterState getClusterState()

Description copied from interface: ClusterStateProvider

Obtain the current cluster state.

Specified by:

getClusterState in interface ClusterStateProvider

getClusterProperties

public Map<String,Object> getClusterProperties()

Description copied from interface: ClusterStateProvider

Obtain cluster properties.

Specified by:

getClusterProperties in interface ClusterStateProvider

Returns:

configured cluster properties, or an empty map, never null.

getPolicyNameByCollection

public String getPolicyNameByCollection(String coll)

Description copied from interface: ClusterStateProvider

Get the collection-specific policy

Specified by:

getPolicyNameByCollection in interface ClusterStateProvider

connect

public void connect()

Specified by:

connect in interface ClusterStateProvider

getZkStateReader

public ZkStateReader getZkStateReader()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getQuorumHosts

public String getQuorumHosts()

Specified by:

getQuorumHosts in interface ClusterStateProvider

toString

public String toString()

Overrides:

toString in class Object

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SolrCloseable

getZkHost

public String getZkHost()

Returns:

the zkHost value used to connect to zookeeper.

getZkConnectTimeout

public int getZkConnectTimeout()

setZkConnectTimeout

public void setZkConnectTimeout(int zkConnectTimeout)

Set the connect timeout to the zookeeper ensemble in ms

getZkClientTimeout

public int getZkClientTimeout()

setZkClientTimeout

public void setZkClientTimeout(int zkClientTimeout)

Set the timeout to the zookeeper ensemble in ms