Class ZkStateReader
- java.lang.Object
-
- org.apache.solr.common.cloud.ZkStateReader
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,org.apache.solr.common.SolrCloseable
public class ZkStateReader extends Object implements org.apache.solr.common.SolrCloseable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
ZkStateReader.AliasesManager
A class to manage the aliases instance, including watching for changes.protected static class
ZkStateReader.CollectionWatch<T>
static class
ZkStateReader.ConfigData
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ZkStateReader(String zkServerAddress, int zkClientTimeout, int zkClientConnectTimeout)
ZkStateReader(String zkServerAddress, int zkClientTimeout, int zkClientConnectTimeout, boolean canUseZkACLs)
ZkStateReader(SolrZkClient zkClient)
ZkStateReader(SolrZkClient zkClient, Runnable securityNodeListener)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
close()
Integer
compareStateVersions(String coll, int version)
void
createClusterStateWatchersAndUpdate()
void
forceUpdateCollection(String collection)
Forcibly refresh a collection's internal state from ZK.void
forciblyRefreshAllClusterStateSlow()
Forcibly refresh cluster state from ZK.static ZkStateReader
from(org.apache.solr.client.solrj.impl.CloudSolrClient solrClient)
Gets the ZkStateReader inside a ZK based SolrClient.org.apache.solr.common.cloud.Aliases
getAliases()
Get an immutable copy of the present state of the aliases.ZkStateReader.AliasesManager
getAliasesManager()
String
getBaseUrlForNodeName(String nodeName)
Returns the baseURL corresponding to a given node's nodeName -- NOTE: does not (currently) imply that the nodeName (or resulting baseURL) exists in the cluster.String
getBaseUrlV2ForNodeName(String nodeName)
Returns the V2 baseURL corresponding to a given node's nodeName -- NOTE: does not (currently) imply that the nodeName (or resulting baseURL) exists in the cluster.Map<String,Object>
getClusterProperties()
Get all cluster properties for this cluster<T> T
getClusterProperty(String key, T defaultValue)
Get a cluster property<T> T
getClusterProperty(List<String> keyPath, T defaultValue)
Same as the above but allows a full json path as a list of partsorg.apache.solr.common.cloud.ClusterState
getClusterState()
org.apache.solr.common.cloud.DocCollection
getCollection(String collection)
org.apache.solr.common.cloud.DocCollection
getCollectionLive(String coll)
static String
getCollectionPath(String coll)
Deprecated.static String
getCollectionPathRoot(String coll)
Deprecated.Map<String,String>
getCollectionProperties(String collection)
Get properties for a specific collectionMap<String,String>
getCollectionProperties(String collection, long cacheForMillis)
Get and cache collection properties for a given collectionSet<String>
getCurrentCollections()
org.apache.solr.common.cloud.Replica
getLeader(String collection, String shard)
org.apache.solr.common.cloud.Replica
getLeader(Set<String> liveNodes, org.apache.solr.common.cloud.DocCollection docCollection, String shard)
org.apache.solr.common.cloud.Replica
getLeaderRetry(String collection, String shard)
Get shard leader properties, with retry if none exist.org.apache.solr.common.cloud.Replica
getLeaderRetry(String collection, String shard, int timeout)
Get shard leader properties, with retry if none exist.String
getLeaderUrl(String collection, String shard, int timeout)
List<org.apache.solr.common.cloud.ZkCoreNodeProps>
getReplicaProps(String collection, String shardId, String thisCoreNodeName)
List<org.apache.solr.common.cloud.ZkCoreNodeProps>
getReplicaProps(String collection, String shardId, String thisCoreNodeName, org.apache.solr.common.cloud.Replica.State mustMatchStateFilter)
List<org.apache.solr.common.cloud.ZkCoreNodeProps>
getReplicaProps(String collection, String shardId, String thisCoreNodeName, org.apache.solr.common.cloud.Replica.State mustMatchStateFilter, org.apache.solr.common.cloud.Replica.State mustNotMatchStateFilter)
List<org.apache.solr.common.cloud.ZkCoreNodeProps>
getReplicaProps(String collection, String shardId, String thisCoreNodeName, org.apache.solr.common.cloud.Replica.State mustMatchStateFilter, org.apache.solr.common.cloud.Replica.State mustNotMatchStateFilter, EnumSet<org.apache.solr.common.cloud.Replica.Type> acceptReplicaType)
ZkStateReader.ConfigData
getSecurityProps(boolean getFresh)
Returns the content of /security.json from ZooKeeper as a Map If the files doesn't exist, it returns null.static String
getShardLeadersElectPath(String collection, String shardId)
Get path where shard leader elections ephemeral nodes are.static String
getShardLeadersPath(String collection, String shardId)
Get path where shard leader properties live in zookeeper.Object
getUpdateLock()
SolrZkClient
getZkClient()
SolrZkClient
getZKClient()
boolean
isClosed()
boolean
isNodeLive(String node)
void
registerCloudCollectionsListener(CloudCollectionsListener cloudCollectionsListener)
Register a CloudCollectionsListener to be called when the set of collections within a cloud changes.void
registerClusterPropertiesListener(ClusterPropertiesListener listener)
void
registerCollectionPropsWatcher(String collection, CollectionPropsWatcher propsWatcher)
void
registerCollectionStateWatcher(String collection, CollectionStateWatcher stateWatcher)
Register a CollectionStateWatcher to be called when the state of a collection changes or the set of live nodes changes.void
registerCore(String collection)
Notify this reader that a local Core is a member of a collection, and so that collection state should be watched.void
registerDocCollectionWatcher(String collection, DocCollectionWatcher docCollectionWatcher)
Register a DocCollectionWatcher to be called when the cluster state for a collection changes.void
registerLiveNodesListener(LiveNodesListener listener)
void
removeCloudCollectionsListener(CloudCollectionsListener cloudCollectionsListener)
Remove a registered CloudCollectionsListener.void
removeClusterPropertiesListener(ClusterPropertiesListener listener)
void
removeCollectionPropsWatcher(String collection, CollectionPropsWatcher watcher)
void
removeCollectionStateWatcher(String collection, CollectionStateWatcher watcher)
Remove a watcher from a collection's watch list.void
removeDocCollectionWatcher(String collection, DocCollectionWatcher watcher)
Remove a watcher from a collection's watch list.void
removeLiveNodesListener(LiveNodesListener listener)
void
unregisterCore(String collection)
Notify this reader that a local core that is a member of a collection has been closed.void
updateLiveNodes()
Refresh the set of live nodes.void
waitForLiveNodes(long wait, TimeUnit unit, LiveNodesPredicate predicate)
Block until a LiveNodesStatePredicate returns true, or the wait times outorg.apache.solr.common.cloud.DocCollection
waitForState(String collection, long wait, TimeUnit unit, Predicate<org.apache.solr.common.cloud.DocCollection> predicate)
Block until a Predicate returns true, or the wait times outvoid
waitForState(String collection, long wait, TimeUnit unit, org.apache.solr.common.cloud.CollectionStatePredicate predicate)
Block until a CollectionStatePredicate returns true, or the wait times out
-
-
-
Field Detail
-
STATE_UPDATE_DELAY
public static final int STATE_UPDATE_DELAY
-
BASE_URL_PROP
public static final String BASE_URL_PROP
- See Also:
- Constant Field Values
-
NODE_NAME_PROP
public static final String NODE_NAME_PROP
- See Also:
- Constant Field Values
-
CORE_NODE_NAME_PROP
public static final String CORE_NODE_NAME_PROP
- See Also:
- Constant Field Values
-
ROLES_PROP
public static final String ROLES_PROP
- See Also:
- Constant Field Values
-
STATE_PROP
public static final String STATE_PROP
- See Also:
- Constant Field Values
-
FORCE_SET_STATE_PROP
public static final String FORCE_SET_STATE_PROP
- See Also:
- Constant Field Values
-
CORE_NAME_PROP
public static final String CORE_NAME_PROP
SolrCore name.- See Also:
- Constant Field Values
-
COLLECTION_PROP
public static final String COLLECTION_PROP
- See Also:
- Constant Field Values
-
ELECTION_NODE_PROP
public static final String ELECTION_NODE_PROP
- See Also:
- Constant Field Values
-
SHARD_ID_PROP
public static final String SHARD_ID_PROP
- See Also:
- Constant Field Values
-
REPLICA_PROP
public static final String REPLICA_PROP
- See Also:
- Constant Field Values
-
SHARD_RANGE_PROP
public static final String SHARD_RANGE_PROP
- See Also:
- Constant Field Values
-
SHARD_STATE_PROP
public static final String SHARD_STATE_PROP
- See Also:
- Constant Field Values
-
SHARD_PARENT_PROP
public static final String SHARD_PARENT_PROP
- See Also:
- Constant Field Values
-
NUM_SHARDS_PROP
public static final String NUM_SHARDS_PROP
- See Also:
- Constant Field Values
-
LEADER_PROP
public static final String LEADER_PROP
- See Also:
- Constant Field Values
-
SHARED_STORAGE_PROP
public static final String SHARED_STORAGE_PROP
- See Also:
- Constant Field Values
-
PROPERTY_PROP
public static final String PROPERTY_PROP
- See Also:
- Constant Field Values
-
PROPERTY_PROP_PREFIX
public static final String PROPERTY_PROP_PREFIX
- See Also:
- Constant Field Values
-
PROPERTY_VALUE_PROP
public static final String PROPERTY_VALUE_PROP
- See Also:
- Constant Field Values
-
MAX_AT_ONCE_PROP
public static final String MAX_AT_ONCE_PROP
- See Also:
- Constant Field Values
-
MAX_WAIT_SECONDS_PROP
public static final String MAX_WAIT_SECONDS_PROP
- See Also:
- Constant Field Values
-
STATE_TIMESTAMP_PROP
public static final String STATE_TIMESTAMP_PROP
- See Also:
- Constant Field Values
-
COLLECTIONS_ZKNODE
public static final String COLLECTIONS_ZKNODE
- See Also:
- Constant Field Values
-
LIVE_NODES_ZKNODE
public static final String LIVE_NODES_ZKNODE
- See Also:
- Constant Field Values
-
NODE_ROLES
public static final String NODE_ROLES
The following, node_roles and roles.json are for assigning roles to nodes. The node_roles is the preferred way (using -Dsolr.node.roles param), and roles.json is used by legacy ADDROLE API command.- See Also:
- Constant Field Values
-
ROLES
public static final String ROLES
- See Also:
- Constant Field Values
-
ALIASES
public static final String ALIASES
- See Also:
- Constant Field Values
-
UNSUPPORTED_CLUSTER_STATE
public static final String UNSUPPORTED_CLUSTER_STATE
This ZooKeeper file is no longer used starting with Solr 9 but keeping the name around to check if it is still present and non-empty (in case of upgrade from previous Solr version). It used to contain collection state for all collections in the cluster.- See Also:
- Constant Field Values
-
CLUSTER_PROPS
public static final String CLUSTER_PROPS
- See Also:
- Constant Field Values
-
COLLECTION_PROPS_ZKNODE
public static final String COLLECTION_PROPS_ZKNODE
- See Also:
- Constant Field Values
-
REJOIN_AT_HEAD_PROP
public static final String REJOIN_AT_HEAD_PROP
- See Also:
- Constant Field Values
-
SOLR_SECURITY_CONF_PATH
public static final String SOLR_SECURITY_CONF_PATH
- See Also:
- Constant Field Values
-
SOLR_PKGS_PATH
public static final String SOLR_PKGS_PATH
- See Also:
- Constant Field Values
-
DEFAULT_SHARD_PREFERENCES
public static final String DEFAULT_SHARD_PREFERENCES
- See Also:
- Constant Field Values
-
REPLICATION_FACTOR
public static final String REPLICATION_FACTOR
- See Also:
- Constant Field Values
-
MAX_CORES_PER_NODE
public static final String MAX_CORES_PER_NODE
- See Also:
- Constant Field Values
-
PULL_REPLICAS
public static final String PULL_REPLICAS
- See Also:
- Constant Field Values
-
NRT_REPLICAS
public static final String NRT_REPLICAS
- See Also:
- Constant Field Values
-
TLOG_REPLICAS
public static final String TLOG_REPLICAS
- See Also:
- Constant Field Values
-
READ_ONLY
public static final String READ_ONLY
- See Also:
- Constant Field Values
-
CONFIGS_ZKNODE
public static final String CONFIGS_ZKNODE
- See Also:
- Constant Field Values
-
CONFIGNAME_PROP
public static final String CONFIGNAME_PROP
- See Also:
- Constant Field Values
-
URL_SCHEME
public static final String URL_SCHEME
- See Also:
- Constant Field Values
-
HTTP
public static final String HTTP
- See Also:
- Constant Field Values
-
HTTPS
public static final String HTTPS
- See Also:
- Constant Field Values
-
HTTPS_PORT_PROP
public static final String HTTPS_PORT_PROP
- See Also:
- Constant Field Values
-
REPLICA_TYPE
public static final String REPLICA_TYPE
- See Also:
- Constant Field Values
-
CONTAINER_PLUGINS
public static final String CONTAINER_PLUGINS
- See Also:
- Constant Field Values
-
PLACEMENT_PLUGIN
public static final String PLACEMENT_PLUGIN
- See Also:
- Constant Field Values
-
clusterState
protected volatile org.apache.solr.common.cloud.ClusterState clusterState
A view of the current state of all collections.
-
LEADER_ELECT_ZKNODE
public static final String LEADER_ELECT_ZKNODE
- See Also:
- Constant Field Values
-
SHARD_LEADERS_ZKNODE
public static final String SHARD_LEADERS_ZKNODE
- See Also:
- Constant Field Values
-
ELECTION_NODE
public static final String ELECTION_NODE
- See Also:
- Constant Field Values
-
aliasesManager
public final ZkStateReader.AliasesManager aliasesManager
Access to theAliases
.
-
-
Constructor Detail
-
ZkStateReader
public ZkStateReader(SolrZkClient zkClient)
-
ZkStateReader
public ZkStateReader(SolrZkClient zkClient, Runnable securityNodeListener)
-
ZkStateReader
public ZkStateReader(String zkServerAddress, int zkClientTimeout, int zkClientConnectTimeout)
-
ZkStateReader
public ZkStateReader(String zkServerAddress, int zkClientTimeout, int zkClientConnectTimeout, boolean canUseZkACLs)
-
-
Method Detail
-
from
public static ZkStateReader from(org.apache.solr.client.solrj.impl.CloudSolrClient solrClient)
Gets the ZkStateReader inside a ZK based SolrClient.- Throws:
IllegalArgumentException
- if solrClient isn't ZK based.
-
forciblyRefreshAllClusterStateSlow
public void forciblyRefreshAllClusterStateSlow() throws org.apache.zookeeper.KeeperException, InterruptedException
Forcibly refresh cluster state from ZK. Do this only to avoid race conditions because it's expensive.It is cheaper to call
forceUpdateCollection(String)
on a single collection if you must.- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
forceUpdateCollection
public void forceUpdateCollection(String collection) throws org.apache.zookeeper.KeeperException, InterruptedException
Forcibly refresh a collection's internal state from ZK. Try to avoid having to resort to this when a better design is possible.- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
updateLiveNodes
public void updateLiveNodes() throws org.apache.zookeeper.KeeperException, InterruptedException
Refresh the set of live nodes.- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
createClusterStateWatchersAndUpdate
public void createClusterStateWatchersAndUpdate() throws org.apache.zookeeper.KeeperException, InterruptedException
- Throws:
org.apache.zookeeper.KeeperException
InterruptedException
-
registerCloudCollectionsListener
public void registerCloudCollectionsListener(CloudCollectionsListener cloudCollectionsListener)
Register a CloudCollectionsListener to be called when the set of collections within a cloud changes.
-
removeCloudCollectionsListener
public void removeCloudCollectionsListener(CloudCollectionsListener cloudCollectionsListener)
Remove a registered CloudCollectionsListener.
-
registerClusterPropertiesListener
public void registerClusterPropertiesListener(ClusterPropertiesListener listener)
-
removeClusterPropertiesListener
public void removeClusterPropertiesListener(ClusterPropertiesListener listener)
-
registerLiveNodesListener
public void registerLiveNodesListener(LiveNodesListener listener)
-
removeLiveNodesListener
public void removeLiveNodesListener(LiveNodesListener listener)
-
getClusterState
public org.apache.solr.common.cloud.ClusterState getClusterState()
- Returns:
- information about the cluster from ZooKeeper
-
getUpdateLock
public Object getUpdateLock()
-
getZKClient
public SolrZkClient getZKClient()
-
close
public void close()
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-
isClosed
public boolean isClosed()
- Specified by:
isClosed
in interfaceorg.apache.solr.common.SolrCloseable
-
getLeaderUrl
public String getLeaderUrl(String collection, String shard, int timeout) throws InterruptedException
- Throws:
InterruptedException
-
getLeader
public org.apache.solr.common.cloud.Replica getLeader(Set<String> liveNodes, org.apache.solr.common.cloud.DocCollection docCollection, String shard)
-
isNodeLive
public boolean isNodeLive(String node)
-
getLeaderRetry
public org.apache.solr.common.cloud.Replica getLeaderRetry(String collection, String shard) throws InterruptedException
Get shard leader properties, with retry if none exist.- Throws:
InterruptedException
-
getLeaderRetry
public org.apache.solr.common.cloud.Replica getLeaderRetry(String collection, String shard, int timeout) throws InterruptedException
Get shard leader properties, with retry if none exist.- Throws:
InterruptedException
-
getShardLeadersPath
public static String getShardLeadersPath(String collection, String shardId)
Get path where shard leader properties live in zookeeper.
-
getShardLeadersElectPath
public static String getShardLeadersElectPath(String collection, String shardId)
Get path where shard leader elections ephemeral nodes are.
-
getReplicaProps
public List<org.apache.solr.common.cloud.ZkCoreNodeProps> getReplicaProps(String collection, String shardId, String thisCoreNodeName)
-
getReplicaProps
public List<org.apache.solr.common.cloud.ZkCoreNodeProps> getReplicaProps(String collection, String shardId, String thisCoreNodeName, org.apache.solr.common.cloud.Replica.State mustMatchStateFilter)
-
getReplicaProps
public List<org.apache.solr.common.cloud.ZkCoreNodeProps> getReplicaProps(String collection, String shardId, String thisCoreNodeName, org.apache.solr.common.cloud.Replica.State mustMatchStateFilter, org.apache.solr.common.cloud.Replica.State mustNotMatchStateFilter)
-
getReplicaProps
public List<org.apache.solr.common.cloud.ZkCoreNodeProps> getReplicaProps(String collection, String shardId, String thisCoreNodeName, org.apache.solr.common.cloud.Replica.State mustMatchStateFilter, org.apache.solr.common.cloud.Replica.State mustNotMatchStateFilter, EnumSet<org.apache.solr.common.cloud.Replica.Type> acceptReplicaType)
-
getZkClient
public SolrZkClient getZkClient()
-
getClusterProperty
public <T> T getClusterProperty(String key, T defaultValue)
Get a cluster propertyN.B. Cluster properties are updated via ZK watchers, and so may not necessarily be completely up-to-date. If you need to get the latest version, then use a
ClusterProperties
instance.- Type Parameters:
T
- the type of the property- Parameters:
key
- the property to readdefaultValue
- a default value to use if no such property exists- Returns:
- the cluster property, or a default if the property is not set
-
getClusterProperty
public <T> T getClusterProperty(List<String> keyPath, T defaultValue)
Same as the above but allows a full json path as a list of parts- Parameters:
keyPath
- path to the property example ["collectionDefauls", "numShards"]defaultValue
- a default value to use if no such property exists- Returns:
- the cluster property, or a default if the property is not set
-
getClusterProperties
public Map<String,Object> getClusterProperties()
Get all cluster properties for this clusterN.B. Cluster properties are updated via ZK watchers, and so may not necessarily be completely up-to-date. If you need to get the latest version, then use a
ClusterProperties
instance.- Returns:
- a Map of cluster properties
-
getCollectionProperties
public Map<String,String> getCollectionProperties(String collection)
Get properties for a specific collection
-
getCollectionProperties
public Map<String,String> getCollectionProperties(String collection, long cacheForMillis)
Get and cache collection properties for a given collection
-
getSecurityProps
public ZkStateReader.ConfigData getSecurityProps(boolean getFresh)
Returns the content of /security.json from ZooKeeper as a Map If the files doesn't exist, it returns null.
-
getBaseUrlForNodeName
public String getBaseUrlForNodeName(String nodeName)
Returns the baseURL corresponding to a given node's nodeName -- NOTE: does not (currently) imply that the nodeName (or resulting baseURL) exists in the cluster.- Parameters:
nodeName
- name of the node- Returns:
- url that looks like
https://localhost:8983/solr
-
getBaseUrlV2ForNodeName
public String getBaseUrlV2ForNodeName(String nodeName)
Returns the V2 baseURL corresponding to a given node's nodeName -- NOTE: does not (currently) imply that the nodeName (or resulting baseURL) exists in the cluster.- Parameters:
nodeName
- name of the node- Returns:
- url that looks like
https://localhost:8983/api
-
getCollectionLive
public org.apache.solr.common.cloud.DocCollection getCollectionLive(String coll)
-
getCollectionPathRoot
@Deprecated public static String getCollectionPathRoot(String coll)
Deprecated.
-
getCollectionPath
@Deprecated public static String getCollectionPath(String coll)
Deprecated.
-
registerCore
public void registerCore(String collection)
Notify this reader that a local Core is a member of a collection, and so that collection state should be watched.Not a public API. This method should only be called from ZkController.
The number of cores per-collection is tracked, and adding multiple cores from the same collection does not increase the number of watches.
- Parameters:
collection
- the collection that the core is a member of- See Also:
unregisterCore(String)
-
unregisterCore
public void unregisterCore(String collection)
Notify this reader that a local core that is a member of a collection has been closed.Not a public API. This method should only be called from ZkController.
If no cores are registered for a collection, and there are no
CollectionStateWatcher
s for that collection either, the collection watch will be removed.- Parameters:
collection
- the collection that the core belongs to
-
registerCollectionStateWatcher
public void registerCollectionStateWatcher(String collection, CollectionStateWatcher stateWatcher)
Register a CollectionStateWatcher to be called when the state of a collection changes or the set of live nodes changes.The Watcher will automatically be removed when it's
onStateChanged
returnstrue
This is method is just syntactic sugar for registering both a
DocCollectionWatcher
and aLiveNodesListener
. Callers that only care about one or the other (but not both) are encouraged to use the more specific methods register methods as it may reduce the number of ZooKeeper watchers needed, and reduce the amount of network/cpu used.- Parameters:
collection
- the collection to watchstateWatcher
- a watcher that will be called when the state changes- See Also:
registerDocCollectionWatcher(java.lang.String, org.apache.solr.common.cloud.DocCollectionWatcher)
,registerLiveNodesListener(org.apache.solr.common.cloud.LiveNodesListener)
-
registerDocCollectionWatcher
public void registerDocCollectionWatcher(String collection, DocCollectionWatcher docCollectionWatcher)
Register a DocCollectionWatcher to be called when the cluster state for a collection changes.The Watcher will automatically be removed when it's
onStateChanged
returnstrue
-
waitForState
public void waitForState(String collection, long wait, TimeUnit unit, org.apache.solr.common.cloud.CollectionStatePredicate predicate) throws InterruptedException, TimeoutException
Block until a CollectionStatePredicate returns true, or the wait times outNote that the predicate may be called again even after it has returned true, so implementors should avoid changing state within the predicate call itself.
This implementation utilizes
CollectionStateWatcher
internally. Callers that don't care about liveNodes are encouraged to use aDocCollection
Predicate
instead- Parameters:
collection
- the collection to watchwait
- how long to waitunit
- the units of the wait parameterpredicate
- the predicate to call on state changes- Throws:
InterruptedException
- on interruptTimeoutException
- on timeout- See Also:
waitForState(String, long, TimeUnit, Predicate)
,registerCollectionStateWatcher(java.lang.String, org.apache.solr.common.cloud.CollectionStateWatcher)
-
waitForState
public org.apache.solr.common.cloud.DocCollection waitForState(String collection, long wait, TimeUnit unit, Predicate<org.apache.solr.common.cloud.DocCollection> predicate) throws InterruptedException, TimeoutException
Block until a Predicate returns true, or the wait times outNote that the predicate may be called again even after it has returned true, so implementors should avoid changing state within the predicate call itself. The predicate may also be called concurrently when multiple state changes are seen in rapid succession.
- Parameters:
collection
- the collection to watchwait
- how long to waitunit
- the units of the wait parameterpredicate
- the predicate to call on state changes- Returns:
- the state of the doc collection after the predicate succeeds
- Throws:
InterruptedException
- on interruptTimeoutException
- on timeout
-
waitForLiveNodes
public void waitForLiveNodes(long wait, TimeUnit unit, LiveNodesPredicate predicate) throws InterruptedException, TimeoutException
Block until a LiveNodesStatePredicate returns true, or the wait times outNote that the predicate may be called again even after it has returned true, so implementors should avoid changing state within the predicate call itself.
- Parameters:
wait
- how long to waitunit
- the units of the wait parameterpredicate
- the predicate to call on state changes- Throws:
InterruptedException
- on interruptTimeoutException
- on timeout
-
removeCollectionStateWatcher
public void removeCollectionStateWatcher(String collection, CollectionStateWatcher watcher)
Remove a watcher from a collection's watch list.This allows Zookeeper watches to be removed if there is no interest in the collection.
- Parameters:
collection
- the collectionwatcher
- the watcher- See Also:
registerCollectionStateWatcher(java.lang.String, org.apache.solr.common.cloud.CollectionStateWatcher)
-
removeDocCollectionWatcher
public void removeDocCollectionWatcher(String collection, DocCollectionWatcher watcher)
Remove a watcher from a collection's watch list.This allows Zookeeper watches to be removed if there is no interest in the collection.
- Parameters:
collection
- the collectionwatcher
- the watcher- See Also:
registerDocCollectionWatcher(java.lang.String, org.apache.solr.common.cloud.DocCollectionWatcher)
-
registerCollectionPropsWatcher
public void registerCollectionPropsWatcher(String collection, CollectionPropsWatcher propsWatcher)
-
removeCollectionPropsWatcher
public void removeCollectionPropsWatcher(String collection, CollectionPropsWatcher watcher)
-
getAliases
public org.apache.solr.common.cloud.Aliases getAliases()
Get an immutable copy of the present state of the aliases. References to this object should not be retained in any context where it will be important to know if aliases have changed.- Returns:
- The current aliases, Aliases.EMPTY if not solr cloud, or no aliases have existed yet. Never returns null.
-
getAliasesManager
public ZkStateReader.AliasesManager getAliasesManager()
-
getCollection
public org.apache.solr.common.cloud.DocCollection getCollection(String collection)
-
-