# Package org.apache.solr.common.cloud

Common Solr Cloud and ZooKeeper related classes reused on both clients & server.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  BeforeReconnect |
  CollectionStatePredicate | Interface to determine if a collection state matches a required state
  CollectionStateWatcher | Callback registered with `ZkStateReader.registerCollectionStateWatcher(String, CollectionStateWatcher)` and called whenever the collection state changes.
  OnReconnect | Implementations are expected to implement a correct hashCode and equals method needed to uniquely identify the listener as listeners are managed in a Set.
  ZkACLProvider |
  ZkClientConnectionStrategy.ConnectedListener |
  ZkClientConnectionStrategy.DisconnectedListener |
  ZkCredentialsProvider |
  ZkMaintenanceUtils.ZkVisitor |

- Class Summary
  Class | Description
  --- | ---
  Aliases |
  ClusterProperties | Interact with solr cluster properties Note that all methods on this class make calls to ZK on every invocation.
  ClusterState | Immutable state of the cloud.
  ClusterState.CollectionRef |
  ClusterStateUtil |
  CompositeIdRouter |
  ConnectionManager |
  DefaultConnectionStrategy | TODO: improve backoff retry impl
  DefaultZkACLProvider |
  DefaultZkCredentialsProvider |
  DocCollection | Models a Collection in zookeeper (but that Java name is obviously taken, hence "DocCollection")
  DocRouter | Class to partition int range into n ranges.
  DocRouter.Range |
  HashBasedRouter |
  ImplicitDocRouter | This document router is for custom sharding
  PlainIdRouter |
  Replica |
  RoutingRule | Used for routing docs with particular keys into another collection
  SaslZkACLProvider | ZkACLProvider that gives all permissions for the user specified in System property "solr.authorization.superuser" (default: "solr") when using sasl, and gives read permissions for anyone else.
  SecurityAwareZkACLProvider | `ZkACLProvider` capable of returning a different set of `ACL`s for security-related znodes (default: subtree under /security) vs non-security-related znodes.
  Slice | A Slice contains immutable information about a logical shard (all replicas that share the same shard id).
  SolrZkClient | All Solr ZooKeeper interactions should go through this class rather than ZooKeeper.
  SolrZooKeeper |
  VMParamsAllAndReadonlyDigestZkACLProvider |
  VMParamsSingleSetCredentialsDigestZkCredentialsProvider |
  ZkClientConnectionStrategy |
  ZkClientConnectionStrategy.ZkUpdate |
  ZkCmdExecutor |
  ZkConfigManager | Class that manages named configs in Zookeeper
  ZkCoreNodeProps |
  ZkCredentialsProvider.ZkCredentials |
  ZkMaintenanceUtils | Class to hold ZK upload/download/move common code.
  ZkNodeProps | ZkNodeProps contains generic immutable properties.
  ZkOperation | A callback object which can be used for implementing retry-able operations.
  ZkStateReader |
  ZkStateReader.ConfigData |

- Enum Summary
  Enum | Description
  --- | ---
  Replica.State | The replica's state.
  Slice.State | The slice's state.
  ZkMaintenanceUtils.VISIT_ORDER |

- Exception Summary
  Exception | Description
  --- | ---
  ZooKeeperException |

## Package org.apache.solr.common.cloud Description

Common Solr Cloud and ZooKeeper related classes reused on both clients & server.

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.