Package org.apache.solr.cloud

Class ZkController

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public class ZkController
extends Object
implements Closeable
    Handle ZooKeeper interactions.

    notes: loads everything on init, creates what's not there - further updates are prompted with Watches.

    TODO: exceptions during close on attempts to update cloud state

    • Field Detail

      • TOUCHED_ZNODE_DATA

        public static final byte[] TOUCHED_ZNODE_DATA

      • zkStateReader

        public final org.apache.solr.common.cloud.ZkStateReader zkStateReader

      • overseer

        protected volatile Overseer overseer

    • Method Detail

      • getLeaderVoteWait

        public int getLeaderVoteWait()

      • getLeaderConflictResolveWait

        public int getLeaderConflictResolveWait()

      • getSysPropsCacher

        public org.apache.solr.common.cloud.NodesSysPropsCacher getSysPropsCacher()

      • preClose

        public void preClose()

      • close

        public void close()
        Closes the underlying ZooKeeper client.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable

      • giveupLeadership

        public void giveupLeadership​(CoreDescriptor cd)
        Best effort to give up the leadership of a shard in a core after hitting a tragic exception
        Parameters:
        cd - The current core descriptor

      • getClusterState

        public org.apache.solr.common.cloud.ClusterState getClusterState()
        Returns:
        information about the cluster from ZooKeeper

      • getSolrCloudManager

        public org.apache.solr.client.solrj.cloud.SolrCloudManager getSolrCloudManager()

      • getHostName

        public String getHostName()

      • getHostPort

        public int getHostPort()

      • getZkClient

        public org.apache.solr.common.cloud.SolrZkClient getZkClient()

      • getZkServerAddress

        public String getZkServerAddress()
        Returns:
        zookeeper server address

      • createClusterZkNodes

        public static void createClusterZkNodes​(org.apache.solr.common.cloud.SolrZkClient zkClient)
                                 throws org.apache.zookeeper.KeeperException,
                                        InterruptedException,
                                        IOException
        Create the zknodes necessary for a cluster to operate
        Parameters:
        zkClient - a SolrZkClient
        Throws:
        org.apache.zookeeper.KeeperException - if there is a Zookeeper error
        InterruptedException - on interrupt
        IOException

      • publishAndWaitForDownStates

        public void publishAndWaitForDownStates()
                                 throws org.apache.zookeeper.KeeperException,
                                        InterruptedException
        Throws:
        org.apache.zookeeper.KeeperException
        InterruptedException

      • publishAndWaitForDownStates

        public void publishAndWaitForDownStates​(int timeoutSeconds)
                                 throws org.apache.zookeeper.KeeperException,
                                        InterruptedException
        Throws:
        org.apache.zookeeper.KeeperException
        InterruptedException

      • checkChrootPath

        public static boolean checkChrootPath​(String zkHost,
                                      boolean create)
                               throws org.apache.zookeeper.KeeperException,
                                      InterruptedException
        Validates if the chroot exists in zk (or if it is successfully created). Optionally, if create is set to true this method will create the path in case it doesn't exist
        Returns:
        true if the path exists or is created false if the path doesn't exist and 'create' = false
        Throws:
        org.apache.zookeeper.KeeperException
        InterruptedException

      • isConnected

        public boolean isConnected()

      • getNodeName

        public String getNodeName()

      • register

        public String register​(String coreName,
                       CoreDescriptor desc,
                       boolean recoverReloadedCores,
                       boolean afterExpiration,
                       boolean skipRecovery)
                throws Exception
        Register shard with ZooKeeper.
        Returns:
        the shardId for the SolrCore
        Throws:
        Exception

      • startReplicationFromLeader

        public void startReplicationFromLeader​(String coreName,
                                       boolean switchTransactionLog)

      • stopReplicationFromLeader

        public void stopReplicationFromLeader​(String coreName)

      • getLeaderProps

        public org.apache.solr.common.cloud.ZkCoreNodeProps getLeaderProps​(String collection,
                                                                   String slice,
                                                                   int timeoutms)
                                                            throws InterruptedException,
                                                                   org.apache.zookeeper.KeeperException.SessionExpiredException
        Get leader props directly from zk nodes.
        Throws:
        org.apache.zookeeper.KeeperException.SessionExpiredException - on zk session expiration.
        InterruptedException

      • getLeaderProps

        public org.apache.solr.common.cloud.ZkCoreNodeProps getLeaderProps​(String collection,
                                                                   String slice,
                                                                   int timeoutms,
                                                                   boolean failImmediatelyOnExpiration)
                                                            throws InterruptedException,
                                                                   org.apache.zookeeper.KeeperException.SessionExpiredException
        Get leader props directly from zk nodes.
        Returns:
        leader props
        Throws:
        org.apache.zookeeper.KeeperException.SessionExpiredException - on zk session expiration.
        InterruptedException

      • getBaseUrl

        public String getBaseUrl()

      • publish

        public void publish​(CoreDescriptor cd,
                    org.apache.solr.common.cloud.Replica.State state,
                    boolean updateLastState,
                    boolean forcePublish)
             throws org.apache.zookeeper.KeeperException,
                    InterruptedException
        Publish core state to overseer.
        Throws:
        org.apache.zookeeper.KeeperException
        InterruptedException

      • clearZkCollectionTerms

        public void clearZkCollectionTerms()

      • getZkStateReader

        public org.apache.solr.common.cloud.ZkStateReader getZkStateReader()

      • preRegister

        public void preRegister​(CoreDescriptor cd,
                        boolean publishState)

      • tryCancelAllElections

        public void tryCancelAllElections()
        Attempts to cancel all leader elections. This method should be called on node shutdown.

      • linkConfSet

        public static void linkConfSet​(org.apache.solr.common.cloud.SolrZkClient zkClient,
                               String collection,
                               String confSetName)
                        throws org.apache.zookeeper.KeeperException,
                               InterruptedException
        Throws:
        org.apache.zookeeper.KeeperException
        InterruptedException

      • getOverseerRunningMap

        public DistributedMap getOverseerRunningMap()

      • getOverseerCompletedMap

        public DistributedMap getOverseerCompletedMap()

      • getOverseerFailureMap

        public DistributedMap getOverseerFailureMap()

      • claimAsyncId

        public boolean claimAsyncId​(String asyncId)
                     throws org.apache.zookeeper.KeeperException
        When an operation needs to be performed in an asynchronous mode, the asyncId needs to be claimed by calling this method to make sure it's not duplicate (hasn't been claimed by other request). If this method returns true, the asyncId in the parameter has been reserved for the operation, meaning that no other thread/operation can claim it. If for whatever reason, the operation is not scheduled, the asuncId needs to be cleared using clearAsyncId(String). If this method returns false, no reservation has been made, and this asyncId can't be used, since it's being used by another operation (currently or in the past)
        Parameters:
        asyncId - A string representing the asyncId of an operation. Can't be null.
        Returns:
        True if the reservation succeeds. False if this ID is already in use.
        Throws:
        org.apache.zookeeper.KeeperException

      • clearAsyncId

        public boolean clearAsyncId​(String asyncId)
                     throws org.apache.zookeeper.KeeperException
        Clears an asyncId previously claimed by calling claimAsyncId(String)
        Parameters:
        asyncId - A string representing the asyncId of an operation. Can't be null.
        Returns:
        True if the asyncId existed and was cleared. False if the asyncId didn't exist before.
        Throws:
        org.apache.zookeeper.KeeperException

      • getClientTimeout

        public int getClientTimeout()

      • getOverseer

        public Overseer getOverseer()

      • trimLeadingAndTrailingSlashes

        public static String trimLeadingAndTrailingSlashes​(String in)
        Utility method for trimming and leading and/or trailing slashes from its input. May return the empty string. May return null if and only if the input is null.

      • rejoinOverseerElection

        public void rejoinOverseerElection​(String electionNode,
                                   boolean joinAtHead)

      • rejoinShardLeaderElection

        public void rejoinShardLeaderElection​(org.apache.solr.common.params.SolrParams params)

      • checkOverseerDesignate

        public void checkOverseerDesignate()

      • throwErrorIfReplicaReplaced

        public void throwErrorIfReplicaReplaced​(CoreDescriptor desc)

      • addOnReconnectListener

        public void addOnReconnectListener​(org.apache.solr.common.cloud.OnReconnect listener)
        Add a listener to be notified once there is a new session created after a ZooKeeper session expiration occurs; in most cases, listeners will be components that have watchers that need to be re-created.

      • removeOnReconnectListener

        public void removeOnReconnectListener​(org.apache.solr.common.cloud.OnReconnect listener)
        Removed a previously registered OnReconnect listener, such as when a core is removed or reloaded.

      • persistConfigResourceToZooKeeper

        public static int persistConfigResourceToZooKeeper​(ZkSolrResourceLoader zkLoader,
                                                   int znodeVersion,
                                                   String resourceName,
                                                   byte[] content,
                                                   boolean createIfNotExists)
        Persists a config file to ZooKeeper using optimistic concurrency.
        Returns:
        true on success

      • registerConfListenerForCore

        public void registerConfListenerForCore​(String confDir,
                                        SolrCore core,
                                        Runnable listener)
        This will give a callback to the listener whenever a child is modified in the conf directory. It is the responsibility of the listener to check if the individual item of interest has been modified. When the last core which was interested in this conf directory is gone the listeners will be removed automatically.

      • getConfigDirListener

        public org.apache.solr.common.cloud.OnReconnect getConfigDirListener()

      • checkIfCoreNodeNameAlreadyExists

        public boolean checkIfCoreNodeNameAlreadyExists​(CoreDescriptor dcore)

      • publishNodeAsDown

        public void publishNodeAsDown​(String nodeName)
        Best effort to set DOWN state for all replicas on node.
        Parameters:
        nodeName - to operate on