Java tutorial
/** * 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.hama.zookeeper; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.io.PrintWriter; import java.net.InetAddress; import java.net.NetworkInterface; import java.net.UnknownHostException; import java.util.ArrayList; import java.util.Enumeration; import java.util.List; import java.util.Map.Entry; import java.util.Properties; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.hadoop.conf.Configuration; import org.apache.hadoop.net.DNS; import org.apache.hadoop.util.StringUtils; import org.apache.hama.Constants; import org.apache.hama.HamaConfiguration; import org.apache.hama.bsp.BSPMaster; import org.apache.zookeeper.server.ServerConfig; import org.apache.zookeeper.server.ZooKeeperServerMain; import org.apache.zookeeper.server.quorum.QuorumPeerConfig; import org.apache.zookeeper.server.quorum.QuorumPeerMain; /** * This class starts and runs the QuorumPeers */ public class QuorumPeer implements Constants { private static final Log LOG = LogFactory.getLog(QuorumPeer.class); private static final String VARIABLE_START = "${"; private static final int VARIABLE_START_LENGTH = VARIABLE_START.length(); private static final String VARIABLE_END = "}"; private static final int VARIABLE_END_LENGTH = VARIABLE_END.length(); private static final String ZK_CFG_PROPERTY = "hama.zookeeper.property."; private static final int ZK_CFG_PROPERTY_SIZE = ZK_CFG_PROPERTY.length(); /** * Parse ZooKeeper configuration from Hama XML config and run a QuorumPeer. * This method checks if we are in localmode to prevent zookeeper from * starting. * * @param baseConf Hadoop Configuration. */ public static void run(Configuration baseConf) { Configuration conf = new HamaConfiguration(baseConf); if (BSPMaster.getAddress(conf) == null) { System.out.println(BSPMaster.localModeMessage); LOG.info(BSPMaster.localModeMessage); System.exit(0); } try { runZooKeeper(conf); } catch (Exception e) { LOG.error("Exception during ZooKeeper startup - exiting...", e); System.exit(-1); } } /** * Parse ZooKeeper configuration from Hama XML config and run a QuorumPeer. * * @param conf Hadoop Configuration. */ public static void runZooKeeper(Configuration conf) throws Exception { Properties zkProperties = makeZKProps(conf); writeMyID(zkProperties); QuorumPeerConfig zkConfig = new QuorumPeerConfig(); zkConfig.parseProperties(zkProperties); runZKServer(zkConfig); } /** * Runs a shutdownable Zookeeper main server. This does not work with multiple * quorums! * * @param conf the configuration to be used to start ZK * @return a <code>ZookeeperTuple</code> * @throws Exception */ public static ZookeeperTuple runShutdownableZooKeeper(Configuration conf) throws Exception { Properties zkProperties = makeZKProps(conf); writeMyID(zkProperties); QuorumPeerConfig zkConfig = new QuorumPeerConfig(); zkConfig.parseProperties(zkProperties); ShutdownableZooKeeperServerMain zk = new ShutdownableZooKeeperServerMain(); ServerConfig serverConfig = new ServerConfig(); serverConfig.readFrom(zkConfig); return new ZookeeperTuple(zk, serverConfig); } private static void runZKServer(QuorumPeerConfig zkConfig) throws UnknownHostException, IOException { if (zkConfig.isDistributed()) { QuorumPeerMain qp = new QuorumPeerMain(); qp.runFromConfig(zkConfig); } else { ZooKeeperServerMain zk = new ZooKeeperServerMain(); ServerConfig serverConfig = new ServerConfig(); serverConfig.readFrom(zkConfig); zk.runFromConfig(serverConfig); } } private static boolean addressIsLocalHost(String address) { return address.equals("localhost") || address.equals("127.0.0.1"); } private static void writeMyID(Properties properties) throws IOException { long myId = -1; Configuration conf = new HamaConfiguration(); String myAddress = DNS.getDefaultHost(conf.get("hama.zookeeper.dns.interface", "default"), conf.get("hama.zookeeper.dns.nameserver", "default")); List<String> ips = new ArrayList<String>(); // Add what could be the best (configured) match ips.add(myAddress.contains(".") ? myAddress : StringUtils.simpleHostname(myAddress)); // For all nics get all hostnames and IPs Enumeration<?> nics = NetworkInterface.getNetworkInterfaces(); while (nics.hasMoreElements()) { Enumeration<?> rawAdrs = ((NetworkInterface) nics.nextElement()).getInetAddresses(); while (rawAdrs.hasMoreElements()) { InetAddress inet = (InetAddress) rawAdrs.nextElement(); ips.add(StringUtils.simpleHostname(inet.getHostName())); ips.add(inet.getHostAddress()); } } for (Entry<Object, Object> entry : properties.entrySet()) { String key = entry.getKey().toString().trim(); String value = entry.getValue().toString().trim(); if (key.startsWith("server.")) { int dot = key.indexOf('.'); long id = Long.parseLong(key.substring(dot + 1)); String[] parts = value.split(":"); String address = parts[0]; if (addressIsLocalHost(address) || ips.contains(address)) { myId = id; break; } } } if (myId == -1) { throw new IOException( "Could not find my address: " + myAddress + " in list of ZooKeeper quorum servers"); } String dataDirStr = properties.get("dataDir").toString().trim(); File dataDir = new File(dataDirStr); if (!dataDir.isDirectory()) { if (!dataDir.mkdirs()) { throw new IOException("Unable to create data dir " + dataDir); } } File myIdFile = new File(dataDir, "myid"); PrintWriter w = new PrintWriter(myIdFile); w.println(myId); w.close(); } /** * Make a Properties object holding ZooKeeper config equivalent to zoo.cfg. If * there is a zoo.cfg in the classpath, simply read it in. Otherwise parse the * corresponding config options from the Hama XML configs and generate the * appropriate ZooKeeper properties. * * @param conf Configuration to read from. * @return Properties holding mappings representing ZooKeeper zoo.cfg file. */ public static Properties makeZKProps(Configuration conf) { // First check if there is a zoo.cfg in the CLASSPATH. If so, simply read // it and grab its configuration properties. ClassLoader cl = QuorumPeer.class.getClassLoader(); InputStream inputStream = cl.getResourceAsStream(ZOOKEEPER_CONFIG_NAME); if (inputStream != null) { try { return parseZooCfg(conf, inputStream); } catch (IOException e) { LOG.warn("Cannot read " + ZOOKEEPER_CONFIG_NAME + ", loading from XML files", e); } } // Otherwise, use the configuration options from Hama's XML files. Properties zkProperties = new Properties(); // Set the max session timeout from the provided client-side timeout zkProperties.setProperty("maxSessionTimeout", conf.get(Constants.ZOOKEEPER_SESSION_TIMEOUT, "1200000")); // Directly map all of the hama.zookeeper.property.KEY properties. for (Entry<String, String> entry : conf) { String key = entry.getKey(); if (key.startsWith(ZK_CFG_PROPERTY)) { String zkKey = key.substring(ZK_CFG_PROPERTY_SIZE); String value = entry.getValue(); // If the value has variables substitutions, need to do a get. if (value.contains(VARIABLE_START)) { value = conf.get(key); } zkProperties.put(zkKey, value); } } // If clientPort is not set, assign the default if (zkProperties.getProperty(ZOOKEEPER_CLIENT_PORT) == null) { zkProperties.put(ZOOKEEPER_CLIENT_PORT, DEFAULT_ZOOKEEPER_CLIENT_PORT); } // Create the server.X properties. int peerPort = conf.getInt("hama.zookeeper.peerport", 2888); int leaderPort = conf.getInt("hama.zookeeper.leaderport", 3888); String[] serverHosts = conf.getStrings(ZOOKEEPER_QUORUM, "localhost"); for (int i = 0; i < serverHosts.length; ++i) { String serverHost = serverHosts[i]; String address = serverHost + ":" + peerPort + ":" + leaderPort; String key = "server." + i; zkProperties.put(key, address); } return zkProperties; } /** * Parse ZooKeeper's zoo.cfg, injecting Hama Configuration variables in. This * method is used for testing so we can pass our own InputStream. * * @param conf Configuration to use for injecting variables. * @param inputStream InputStream to read from. * @return Properties parsed from config stream with variables substituted. * @throws IOException if anything goes wrong parsing config */ public static Properties parseZooCfg(Configuration conf, InputStream inputStream) throws IOException { Properties properties = new Properties(); try { properties.load(inputStream); } catch (IOException e) { String msg = "fail to read properties from " + ZOOKEEPER_CONFIG_NAME; LOG.fatal(msg); throw new IOException(msg, e); } for (Entry<Object, Object> entry : properties.entrySet()) { String value = entry.getValue().toString().trim(); String key = entry.getKey().toString().trim(); StringBuilder newValue = new StringBuilder(); int varStart = value.indexOf(VARIABLE_START); int varEnd = 0; while (varStart != -1) { varEnd = value.indexOf(VARIABLE_END, varStart); if (varEnd == -1) { String msg = "variable at " + varStart + " has no end marker"; LOG.fatal(msg); throw new IOException(msg); } String variable = value.substring(varStart + VARIABLE_START_LENGTH, varEnd); String substituteValue = System.getProperty(variable); if (substituteValue == null) { substituteValue = conf.get(variable); } if (substituteValue == null) { String msg = "variable " + variable + " not set in system property " + "or hama configs"; LOG.fatal(msg); throw new IOException(msg); } newValue.append(substituteValue); varEnd += VARIABLE_END_LENGTH; varStart = value.indexOf(VARIABLE_START, varEnd); } // Special case for 'hama.cluster.distributed' property being 'true' if (key.startsWith("server.")) { if (conf.get(CLUSTER_DISTRIBUTED).equals(CLUSTER_IS_DISTRIBUTED) && value.startsWith("localhost")) { String msg = "The server in zoo.cfg cannot be set to localhost " + "in a fully-distributed setup because it won't be reachable. " + "See \"Getting Started\" for more information."; LOG.fatal(msg); throw new IOException(msg); } } newValue.append(value.substring(varEnd)); properties.setProperty(key, newValue.toString()); } return properties; } /** * Return the ZK Quorum servers string given zk properties returned by * makeZKProps * * @param properties the ZK properties * @return Quorum servers String */ public static String getZKQuorumServersString(Properties properties) { String clientPort = null; List<String> servers = new ArrayList<String>(); // The clientPort option may come after the server.X hosts, so we need to // grab everything and then create the final host:port comma separated list. boolean anyValid = false; for (Entry<Object, Object> property : properties.entrySet()) { String key = property.getKey().toString().trim(); String value = property.getValue().toString().trim(); if (key.equals("clientPort")) { clientPort = value; } else if (key.startsWith("server.")) { String host = value.substring(0, value.indexOf(':')); servers.add(host); try { // noinspection ResultOfMethodCallIgnored InetAddress.getByName(host); anyValid = true; } catch (UnknownHostException e) { LOG.warn(StringUtils.stringifyException(e)); } } } if (!anyValid) { LOG.error("no valid quorum servers found in " + Constants.ZOOKEEPER_CONFIG_NAME); return null; } if (clientPort == null) { LOG.error("no clientPort found in " + Constants.ZOOKEEPER_CONFIG_NAME); return null; } if (servers.isEmpty()) { LOG.fatal("No server.X lines found in conf/zoo.cfg. Hama must have a " + "ZooKeeper cluster configured for its operation."); return null; } StringBuilder hostPortBuilder = new StringBuilder(); for (int i = 0; i < servers.size(); ++i) { String host = servers.get(i); if (i > 0) { hostPortBuilder.append(','); } hostPortBuilder.append(host); hostPortBuilder.append(':'); hostPortBuilder.append(clientPort); } return hostPortBuilder.toString(); } /** * Return the ZK Quorum servers string given the specified configuration. * * @param conf the configuration to be used to get ZK Quorum servers * @return Quorum servers */ public static String getZKQuorumServersString(Configuration conf) { return getZKQuorumServersString(makeZKProps(conf)); } public static class ShutdownableZooKeeperServerMain extends ZooKeeperServerMain { public void shutdownZookeeperMain() { this.shutdown(); } @Override protected void shutdown() { super.shutdown(); } } public static class ZookeeperTuple { public ShutdownableZooKeeperServerMain main; public ServerConfig conf; public ZookeeperTuple(ShutdownableZooKeeperServerMain main, ServerConfig conf) { super(); this.main = main; this.conf = conf; } } }