ZooKeeperConnectionListener.java

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed 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.springframework.xd.dirt.zookeeper;

import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.state.ConnectionStateListener;

/**
 * Listener for ZooKeeper connection and disconnection events.
 *
 * @author Mark Fisher
 */
public interface ZooKeeperConnectionListener {

	/**
	 * Called when the Curator {@link ConnectionStateListener} receives a
	 * {@link org.apache.curator.framework.state.ConnectionState#CONNECTED} event.
	 *
	 * @param client the {@link CuratorFramework} instance
	 */
	void onConnect(CuratorFramework client);

	/**
	 * Called when the Curator {@link ConnectionStateListener} receives a
	 * {@link org.apache.curator.framework.state.ConnectionState#RECONNECTED} event.
	 *
	 * @param client the {@link CuratorFramework} instance
	 */
	void onResume(CuratorFramework client);

	/**
	 * Called when the Curator {@link ConnectionStateListener} receives a
	 * {@link org.apache.curator.framework.state.ConnectionState#LOST} event.
	 *
	 * @param client the {@link CuratorFramework} instance
	 */
	void onDisconnect(CuratorFramework client);

	/**
	 * Called when the Curator {@link ConnectionStateListener} receives a
	 * {@link org.apache.curator.framework.state.ConnectionState#SUSPENDED} event.
	 *
	 * @param client the {@link CuratorFramework} instance
	 */
	void onSuspend(CuratorFramework client);

}