1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 package org.apache.giraph.zk; 19 20 import org.apache.giraph.conf.ImmutableClassesGiraphConfigurable; 21 22 import java.io.IOException; 23 24 /** 25 * ZooKeeper wrapper interface. 26 * Implementation should provide a way to start, stop and cleanup 27 * zookeeper. 28 */ 29 public interface ZooKeeperRunner extends ImmutableClassesGiraphConfigurable { 30 31 /** 32 * Starts zookeeper service in specified working directory with 33 * specified config file. 34 * @param zkDir working directory 35 * @param config zookeeper configuration 36 * @return port zookeeper runs on 37 * @throws IOException 38 */ 39 int start(String zkDir, ZookeeperConfig config) throws IOException; 40 41 /** 42 * Stops zookeeper. 43 */ 44 void stop(); 45 46 /** 47 * Does necessary cleanup after zookeeper job is complete. 48 */ 49 void cleanup(); 50 }