zookeeper-server/src/main/java/org/apache/zookeeper/Testable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.zookeeper;

import java.io.IOException;

/**
 * Abstraction that exposes various methods useful for testing ZooKeeper
 */
public interface Testable {

    /**
     * Cause the ZooKeeper instance to behave as if the session expired
     */
    void injectSessionExpiration();

    /**
     * Allow an event to be inserted into the event queue
     *
     * @param event event to insert
     */
    void queueEvent(WatchedEvent event);

    /**
     * Close the ClientCnxn socket for testing purposes
     */
    default void closeSocket() throws IOException { }

}