org.apache.solr.common.cloud

Class ClusterState

java.lang.Object

org.apache.solr.common.cloud.ClusterState

All Implemented Interfaces:

org.noggit.JSONWriter.Writable

public class ClusterState
extends Object
implements org.noggit.JSONWriter.Writable

Immutable state of the cloud. Normally you can get the state by using ZkStateReader.getClusterState().

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterState.CollectionRef

Constructor Summary

Constructors

Constructor and Description
ClusterState(Integer znodeVersion, Set<String> liveNodes, Map<String,DocCollection> collectionStates) Use this constr when ClusterState is meant for consumption.
ClusterState(Set<String> liveNodes, Map<String,ClusterState.CollectionRef> collectionStates, Integer znodeVersion) Use this if all the collection states are not readily available and some needs to be lazily loaded

Method Summary

Modifier and Type	Method and Description
ClusterState	copyWith(String collectionName, DocCollection collection) Returns a new cluster state object modified with the given collection.
boolean	equals(Object obj)
void	forEachCollection(Consumer<DocCollection> consumer)
DocCollection	getCollection(String collection) Get the named DocCollection object, or throw an exception if it doesn't exist.
DocCollection	getCollectionOrNull(String collectionName) Returns the corresponding DocCollection object for the given collection name if such a collection exists.
ClusterState.CollectionRef	getCollectionRef(String coll)
Map<String,DocCollection>	getCollectionsMap() Get a map of collection name vs DocCollection objects Implementation note: This method resolves the collection reference by calling ClusterState.CollectionRef.get() which can make a call to ZooKeeper.
Map<String,ClusterState.CollectionRef>	getCollectionStates() Be aware that this may return collections which may not exist now.
Set<String>	getLiveNodes() Get names of the currently live nodes.
String	getShardId(String nodeName, String coreName)
String	getShardId(String collectionName, String nodeName, String coreName)
Integer	getZkClusterStateVersion() Deprecated. true cluster state spans many ZK nodes, stop depending on the version number of the shared node! will be removed in 8.0
boolean	hasCollection(String collectionName) Returns true if the specified collection name exists, false otherwise.
int	hashCode()
boolean	liveNodesContain(String name) Check if node is alive.
static ClusterState	load(Integer version, byte[] bytes, Set<String> liveNodes)
static ClusterState	load(Integer version, byte[] bytes, Set<String> liveNodes, String znode) Create ClusterState from json string that is typically stored in zookeeper.
static ClusterState	load(Integer version, Map<String,Object> stateMap, Set<String> liveNodes, String znode)
String	toString()
void	write(org.noggit.JSONWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterState

public ClusterState(Integer znodeVersion,
                    Set<String> liveNodes,
                    Map<String,DocCollection> collectionStates)

Use this constr when ClusterState is meant for consumption.

ClusterState

public ClusterState(Set<String> liveNodes,
                    Map<String,ClusterState.CollectionRef> collectionStates,
                    Integer znodeVersion)

Use this if all the collection states are not readily available and some needs to be lazily loaded

Method Detail

copyWith

public ClusterState copyWith(String collectionName,
                             DocCollection collection)

Returns a new cluster state object modified with the given collection.

Parameters:

collectionName - the name of the modified (or deleted) collection

collection - the collection object. A null value deletes the collection from the state

Returns:

the updated cluster state which preserves the current live nodes and zk node version

hasCollection

public boolean hasCollection(String collectionName)

Returns true if the specified collection name exists, false otherwise. Implementation note: This method resolves the collection reference by calling ClusterState.CollectionRef.get() which can make a call to ZooKeeper. This is necessary because the semantics of how collection list is loaded have changed in SOLR-6629. Please see javadocs in ZkStateReader.refreshCollectionList(Watcher)

getCollection

public DocCollection getCollection(String collection)

Get the named DocCollection object, or throw an exception if it doesn't exist.

getCollectionRef

public ClusterState.CollectionRef getCollectionRef(String coll)

getCollectionOrNull

public DocCollection getCollectionOrNull(String collectionName)

Returns the corresponding DocCollection object for the given collection name if such a collection exists. Returns null otherwise. Implementation note: This method resolves the collection reference by calling ClusterState.CollectionRef.get() which may make a call to ZooKeeper. This is necessary because the semantics of how collection list is loaded have changed in SOLR-6629. Please see javadocs in ZkStateReader.refreshCollectionList(Watcher)

getCollectionsMap

public Map<String,DocCollection> getCollectionsMap()

Get a map of collection name vs DocCollection objects Implementation note: This method resolves the collection reference by calling ClusterState.CollectionRef.get() which can make a call to ZooKeeper. This is necessary because the semantics of how collection list is loaded have changed in SOLR-6629. Please see javadocs in ZkStateReader.refreshCollectionList(Watcher)

Returns:

a map of collection name vs DocCollection object

getLiveNodes

public Set<String> getLiveNodes()

Get names of the currently live nodes.

getShardId

public String getShardId(String nodeName,
                         String coreName)

getShardId

public String getShardId(String collectionName,
                         String nodeName,
                         String coreName)

liveNodesContain

public boolean liveNodesContain(String name)

Check if node is alive.

toString

public String toString()

Overrides:

toString in class Object

load

public static ClusterState load(Integer version,
                                byte[] bytes,
                                Set<String> liveNodes)

load

public static ClusterState load(Integer version,
                                byte[] bytes,
                                Set<String> liveNodes,
                                String znode)

Create ClusterState from json string that is typically stored in zookeeper.

Parameters:

version - zk version of the clusterstate.json file (bytes)

bytes - clusterstate.json as a byte array

liveNodes - list of live nodes

Returns:

the ClusterState

load

public static ClusterState load(Integer version,
                                Map<String,Object> stateMap,
                                Set<String> liveNodes,
                                String znode)

write

public void write(org.noggit.JSONWriter jsonWriter)

Specified by:

write in interface org.noggit.JSONWriter.Writable

getZkClusterStateVersion

@Deprecated
public Integer getZkClusterStateVersion()

Deprecated. true cluster state spans many ZK nodes, stop depending on the version number of the shared node! will be removed in 8.0

The version of clusterstate.json in ZooKeeper.

Returns:

null if ClusterState was created for publication, not consumption

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getCollectionStates

public Map<String,ClusterState.CollectionRef> getCollectionStates()

Be aware that this may return collections which may not exist now. You can confirm that this collection exists after verifying CollectionRef.get() != null

forEachCollection

public void forEachCollection(Consumer<DocCollection> consumer)