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.zeppelin.conf; import java.net.URL; import java.util.*; import org.apache.commons.configuration.ConfigurationException; import org.apache.commons.configuration.XMLConfiguration; import org.apache.commons.configuration.tree.ConfigurationNode; import org.apache.zeppelin.notebook.repo.S3NotebookRepo; import org.apache.zeppelin.notebook.repo.VFSNotebookRepo; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Zeppelin configuration. * * @author Leemoonsoo * */ public class ZeppelinConfiguration extends XMLConfiguration { private static final String ZEPPELIN_SITE_XML = "zeppelin-site.xml"; private static final long serialVersionUID = 4749305895693848035L; private static final Logger LOG = LoggerFactory.getLogger(ZeppelinConfiguration.class); private static ZeppelinConfiguration conf; public ZeppelinConfiguration(URL url) throws ConfigurationException { setDelimiterParsingDisabled(true); load(url); } public ZeppelinConfiguration() { ConfVars[] vars = ConfVars.values(); for (ConfVars v : vars) { if (v.getType() == ConfVars.VarType.BOOLEAN) { this.setProperty(v.getVarName(), v.getBooleanValue()); } else if (v.getType() == ConfVars.VarType.LONG) { this.setProperty(v.getVarName(), v.getLongValue()); } else if (v.getType() == ConfVars.VarType.INT) { this.setProperty(v.getVarName(), v.getIntValue()); } else if (v.getType() == ConfVars.VarType.FLOAT) { this.setProperty(v.getVarName(), v.getFloatValue()); } else if (v.getType() == ConfVars.VarType.STRING) { this.setProperty(v.getVarName(), v.getStringValue()); } else { throw new RuntimeException("Unsupported VarType"); } } } /** * Load from resource. *url = ZeppelinConfiguration.class.getResource(ZEPPELIN_SITE_XML); * @throws ConfigurationException */ public static ZeppelinConfiguration create() { if (conf != null) { return conf; } ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); URL url; url = ZeppelinConfiguration.class.getResource(ZEPPELIN_SITE_XML); if (url == null) { ClassLoader cl = ZeppelinConfiguration.class.getClassLoader(); if (cl != null) { url = cl.getResource(ZEPPELIN_SITE_XML); } } if (url == null) { url = classLoader.getResource(ZEPPELIN_SITE_XML); } if (url == null) { LOG.warn("Failed to load configuration, proceeding with a default"); conf = new ZeppelinConfiguration(); } else { try { LOG.info("Load configuration from " + url); conf = new ZeppelinConfiguration(url); } catch (ConfigurationException e) { LOG.warn("Failed to load configuration from " + url + " proceeding with a default", e); conf = new ZeppelinConfiguration(); } } return conf; } private String getStringValue(String name, String d) { List<ConfigurationNode> properties = getRootNode().getChildren(); if (properties == null || properties.size() == 0) { return d; } for (ConfigurationNode p : properties) { if (p.getChildren("name") != null && p.getChildren("name").size() > 0 && name.equals(p.getChildren("name").get(0).getValue())) { return (String) p.getChildren("value").get(0).getValue(); } } return d; } private int getIntValue(String name, int d) { List<ConfigurationNode> properties = getRootNode().getChildren(); if (properties == null || properties.size() == 0) { return d; } for (ConfigurationNode p : properties) { if (p.getChildren("name") != null && p.getChildren("name").size() > 0 && name.equals(p.getChildren("name").get(0).getValue())) { return Integer.parseInt((String) p.getChildren("value").get(0).getValue()); } } return d; } private long getLongValue(String name, long d) { List<ConfigurationNode> properties = getRootNode().getChildren(); if (properties == null || properties.size() == 0) { return d; } for (ConfigurationNode p : properties) { if (p.getChildren("name") != null && p.getChildren("name").size() > 0 && name.equals(p.getChildren("name").get(0).getValue())) { return Long.parseLong((String) p.getChildren("value").get(0).getValue()); } } return d; } private float getFloatValue(String name, float d) { List<ConfigurationNode> properties = getRootNode().getChildren(); if (properties == null || properties.size() == 0) { return d; } for (ConfigurationNode p : properties) { if (p.getChildren("name") != null && p.getChildren("name").size() > 0 && name.equals(p.getChildren("name").get(0).getValue())) { return Float.parseFloat((String) p.getChildren("value").get(0).getValue()); } } return d; } private boolean getBooleanValue(String name, boolean d) { List<ConfigurationNode> properties = getRootNode().getChildren(); if (properties == null || properties.size() == 0) { return d; } for (ConfigurationNode p : properties) { if (p.getChildren("name") != null && p.getChildren("name").size() > 0 && name.equals(p.getChildren("name").get(0).getValue())) { return Boolean.parseBoolean((String) p.getChildren("value").get(0).getValue()); } } return d; } public String getString(ConfVars c) { return getString(c.name(), c.getVarName(), c.getStringValue()); } public String getString(String envName, String propertyName, String defaultValue) { if (System.getenv(envName) != null) { return System.getenv(envName); } if (System.getProperty(propertyName) != null) { return System.getProperty(propertyName); } return getStringValue(propertyName, defaultValue); } public int getInt(ConfVars c) { return getInt(c.name(), c.getVarName(), c.getIntValue()); } public int getInt(String envName, String propertyName, int defaultValue) { if (System.getenv(envName) != null) { return Integer.parseInt(System.getenv(envName)); } if (System.getProperty(propertyName) != null) { return Integer.parseInt(System.getProperty(propertyName)); } return getIntValue(propertyName, defaultValue); } public long getLong(ConfVars c) { return getLong(c.name(), c.getVarName(), c.getLongValue()); } public long getLong(String envName, String propertyName, long defaultValue) { if (System.getenv(envName) != null) { return Long.parseLong(System.getenv(envName)); } if (System.getProperty(propertyName) != null) { return Long.parseLong(System.getProperty(propertyName)); } return getLongValue(propertyName, defaultValue); } public float getFloat(ConfVars c) { return getFloat(c.name(), c.getVarName(), c.getFloatValue()); } public float getFloat(String envName, String propertyName, float defaultValue) { if (System.getenv(envName) != null) { return Float.parseFloat(System.getenv(envName)); } if (System.getProperty(propertyName) != null) { return Float.parseFloat(System.getProperty(propertyName)); } return getFloatValue(propertyName, defaultValue); } public boolean getBoolean(ConfVars c) { return getBoolean(c.name(), c.getVarName(), c.getBooleanValue()); } public boolean getBoolean(String envName, String propertyName, boolean defaultValue) { if (System.getenv(envName) != null) { return Boolean.parseBoolean(System.getenv(envName)); } if (System.getProperty(propertyName) != null) { return Boolean.parseBoolean(System.getProperty(propertyName)); } return getBooleanValue(propertyName, defaultValue); } public boolean useSsl() { return getBoolean(ConfVars.ZEPPELIN_SSL); } public boolean useClientAuth() { return getBoolean(ConfVars.ZEPPELIN_SSL_CLIENT_AUTH); } public String getServerAddress() { return getString(ConfVars.ZEPPELIN_ADDR); } public int getServerPort() { return getInt(ConfVars.ZEPPELIN_PORT); } public String getKeyStorePath() { return getRelativeDir(String.format("%s/%s", getConfDir(), getString(ConfVars.ZEPPELIN_SSL_KEYSTORE_PATH))); } public String getKeyStoreType() { return getString(ConfVars.ZEPPELIN_SSL_KEYSTORE_TYPE); } public String getKeyStorePassword() { return getString(ConfVars.ZEPPELIN_SSL_KEYSTORE_PASSWORD); } public String getKeyManagerPassword() { String password = getString(ConfVars.ZEPPELIN_SSL_KEY_MANAGER_PASSWORD); if (password == null) { return getKeyStorePassword(); } else { return password; } } public String getTrustStorePath() { String path = getString(ConfVars.ZEPPELIN_SSL_TRUSTSTORE_PATH); if (path == null) { return getKeyStorePath(); } else { return getRelativeDir(path); } } public String getTrustStoreType() { String type = getString(ConfVars.ZEPPELIN_SSL_TRUSTSTORE_TYPE); if (type == null) { return getKeyStoreType(); } else { return type; } } public String getTrustStorePassword() { String password = getString(ConfVars.ZEPPELIN_SSL_TRUSTSTORE_PASSWORD); if (password == null) { return getKeyStorePassword(); } else { return password; } } public String getNotebookDir() { return getString(ConfVars.ZEPPELIN_NOTEBOOK_DIR); } public String getUser() { return getString(ConfVars.ZEPPELIN_NOTEBOOK_S3_USER); } public String getBucketName() { return getString(ConfVars.ZEPPELIN_NOTEBOOK_S3_BUCKET); } public String getInterpreterDir() { return getRelativeDir(ConfVars.ZEPPELIN_INTERPRETER_DIR); } public String getInterpreterSettingPath() { return getRelativeDir(String.format("%s/interpreter.json", getConfDir())); } public String getInterpreterRemoteRunnerPath() { return getRelativeDir(ConfVars.ZEPPELIN_INTERPRETER_REMOTE_RUNNER); } public String getRelativeDir(ConfVars c) { return getRelativeDir(getString(c)); } public String getRelativeDir(String path) { if (path != null && path.startsWith("/") || isWindowsPath(path)) { return path; } else { return getString(ConfVars.ZEPPELIN_HOME) + "/" + path; } } public boolean isWindowsPath(String path) { return path.matches("^[A-Za-z]:\\\\.*"); } public String getConfDir() { return getString(ConfVars.ZEPPELIN_CONF_DIR); } public List<String> getAllowedOrigins() { if (getString(ConfVars.ZEPPELIN_ALLOWED_ORIGINS).isEmpty()) { return Arrays.asList(new String[0]); } return Arrays.asList(getString(ConfVars.ZEPPELIN_ALLOWED_ORIGINS).toLowerCase().split(",")); } /** * Wrapper class. * * @author Leemoonsoo * */ public static enum ConfVars { ZEPPELIN_HOME("zeppelin.home", "../"), ZEPPELIN_ADDR("zeppelin.server.addr", "0.0.0.0"), ZEPPELIN_PORT( "zeppelin.server.port", 8080), ZEPPELIN_SSL("zeppelin.ssl", false), ZEPPELIN_SSL_CLIENT_AUTH( "zeppelin.ssl.client.auth", false), ZEPPELIN_SSL_KEYSTORE_PATH("zeppelin.ssl.keystore.path", "keystore"), ZEPPELIN_SSL_KEYSTORE_TYPE("zeppelin.ssl.keystore.type", "JKS"), ZEPPELIN_SSL_KEYSTORE_PASSWORD("zeppelin.ssl.keystore.password", ""), ZEPPELIN_SSL_KEY_MANAGER_PASSWORD( "zeppelin.ssl.key.manager.password", null), ZEPPELIN_SSL_TRUSTSTORE_PATH( "zeppelin.ssl.truststore.path", null), ZEPPELIN_SSL_TRUSTSTORE_TYPE( "zeppelin.ssl.truststore.type", null), ZEPPELIN_SSL_TRUSTSTORE_PASSWORD( "zeppelin.ssl.truststore.password", null), ZEPPELIN_WAR("zeppelin.war", "../zeppelin-web/dist"), ZEPPELIN_INTERPRETERS( "zeppelin.interpreters", "org.apache.zeppelin.spark.SparkInterpreter," + "org.apache.zeppelin.spark.PySparkInterpreter," + "org.apache.zeppelin.spark.SparkSqlInterpreter," + "org.apache.zeppelin.spark.DepInterpreter," + "org.apache.zeppelin.markdown.Markdown," + "org.apache.zeppelin.angular.AngularInterpreter," + "org.apache.zeppelin.shell.ShellInterpreter," + "org.apache.zeppelin.hive.HiveInterpreter," + "org.apache.zeppelin.phoenix.PhoenixInterpreter," + "org.apache.zeppelin.tajo.TajoInterpreter," + "org.apache.zeppelin.flink.FlinkInterpreter," + "org.apache.zeppelin.ignite.IgniteInterpreter," + "org.apache.zeppelin.ignite.IgniteSqlInterpreter," + "org.apache.zeppelin.lens.LensInterpreter," + "org.apache.zeppelin.cassandra.CassandraInterpreter," + "org.apache.zeppelin.geode.GeodeOqlInterpreter," + "org.apache.zeppelin.postgresql.PostgreSqlInterpreter," + "org.apache.zeppelin.kylin.KylinInterpreter"), ZEPPELIN_INTERPRETER_DIR( "zeppelin.interpreter.dir", "interpreter"), ZEPPELIN_INTERPRETER_CONNECT_TIMEOUT( "zeppelin.interpreter.connect.timeout", 30000), ZEPPELIN_ENCODING( "zeppelin.encoding", "UTF-8"), ZEPPELIN_NOTEBOOK_DIR( "zeppelin.notebook.dir", "notebook"), // use specified notebook (id) as homescreen ZEPPELIN_NOTEBOOK_HOMESCREEN("zeppelin.notebook.homescreen", null), // whether homescreen notebook will be hidden from notebook list or not ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE("zeppelin.notebook.homescreen.hide", false), ZEPPELIN_NOTEBOOK_S3_BUCKET( "zeppelin.notebook.s3.bucket", "zeppelin"), ZEPPELIN_NOTEBOOK_S3_USER("zeppelin.notebook.s3.user", "user"), ZEPPELIN_NOTEBOOK_STORAGE("zeppelin.notebook.storage", VFSNotebookRepo.class.getName()), // Notebook list and contents will be always loaded from repository if set true. // If set false, modified notebooks or new notebooks added on file system level // won't be reflected on Zeppelin till user restarts Zeppelin. ZEPPELIN_NOTEBOOK_RELOAD_FROM_STORAGE("zeppelin.notebook.reloadAllNotesFromStorage", false), ZEPPELIN_INTERPRETER_REMOTE_RUNNER("zeppelin.interpreter.remoterunner", "bin/interpreter.sh"), // Decide when new note is created, interpreter settings will be binded automatically or not. ZEPPELIN_NOTEBOOK_AUTO_INTERPRETER_BINDING("zeppelin.notebook.autoInterpreterBinding", true), ZEPPELIN_CONF_DIR("zeppelin.conf.dir", "conf"), // Allows a way to specify a ',' separated list of allowed origins for rest and websockets // i.e. http://localhost:8080 ZEPPELIN_ALLOWED_ORIGINS("zeppelin.server.allowed.origins", "*"); private String varName; @SuppressWarnings("rawtypes") private Class varClass; private String stringValue; private VarType type; private int intValue; private float floatValue; private boolean booleanValue; private long longValue; ConfVars(String varName, String varValue) { this.varName = varName; this.varClass = String.class; this.stringValue = varValue; this.intValue = -1; this.floatValue = -1; this.longValue = -1; this.booleanValue = false; this.type = VarType.STRING; } ConfVars(String varName, int intValue) { this.varName = varName; this.varClass = Integer.class; this.stringValue = null; this.intValue = intValue; this.floatValue = -1; this.longValue = -1; this.booleanValue = false; this.type = VarType.INT; } ConfVars(String varName, long longValue) { this.varName = varName; this.varClass = Integer.class; this.stringValue = null; this.intValue = -1; this.floatValue = -1; this.longValue = longValue; this.booleanValue = false; this.type = VarType.LONG; } ConfVars(String varName, float floatValue) { this.varName = varName; this.varClass = Float.class; this.stringValue = null; this.intValue = -1; this.longValue = -1; this.floatValue = floatValue; this.booleanValue = false; this.type = VarType.FLOAT; } ConfVars(String varName, boolean booleanValue) { this.varName = varName; this.varClass = Boolean.class; this.stringValue = null; this.intValue = -1; this.longValue = -1; this.floatValue = -1; this.booleanValue = booleanValue; this.type = VarType.BOOLEAN; } public String getVarName() { return varName; } @SuppressWarnings("rawtypes") public Class getVarClass() { return varClass; } public int getIntValue() { return intValue; } public long getLongValue() { return longValue; } public float getFloatValue() { return floatValue; } public String getStringValue() { return stringValue; } public boolean getBooleanValue() { return booleanValue; } public VarType getType() { return type; } enum VarType { STRING { @Override void checkType(String value) throws Exception { } }, INT { @Override void checkType(String value) throws Exception { Integer.valueOf(value); } }, LONG { @Override void checkType(String value) throws Exception { Long.valueOf(value); } }, FLOAT { @Override void checkType(String value) throws Exception { Float.valueOf(value); } }, BOOLEAN { @Override void checkType(String value) throws Exception { Boolean.valueOf(value); } }; boolean isType(String value) { try { checkType(value); } catch (Exception e) { return false; } return true; } String typeString() { return name().toUpperCase(); } abstract void checkType(String value) throws Exception; } } }