GUACAMOLE-495: Remove guacamole-ext's GuacamoleHome and GuacamoleProperties classes, deprecated since 0.9.4 (ff28626).
Project: http://git-wip-us.apache.org/repos/asf/guacamole-client/repo Commit: http://git-wip-us.apache.org/repos/asf/guacamole-client/commit/17f6862d Tree: http://git-wip-us.apache.org/repos/asf/guacamole-client/tree/17f6862d Diff: http://git-wip-us.apache.org/repos/asf/guacamole-client/diff/17f6862d Branch: refs/heads/master Commit: 17f6862d17e126c3ad4014cbe5fe7f777638aa4d Parents: 3d9310d Author: Michael Jumper <mjum...@apache.org> Authored: Thu Feb 1 22:30:23 2018 -0800 Committer: Michael Jumper <mjum...@apache.org> Committed: Thu Feb 1 22:30:23 2018 -0800 ---------------------------------------------------------------------- .../guacamole/properties/GuacamoleHome.java | 81 ------- .../properties/GuacamoleProperties.java | 214 ------------------- 2 files changed, 295 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/17f6862d/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleHome.java ---------------------------------------------------------------------- diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleHome.java b/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleHome.java deleted file mode 100644 index a26c1e0..0000000 --- a/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleHome.java +++ /dev/null @@ -1,81 +0,0 @@ -/* - * 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.guacamole.properties; - -import java.io.File; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Abstract representation of the Guacamole configuration directory. - * - * @deprecated - */ -public class GuacamoleHome { - - /** - * Logger for this class. - */ - private static final Logger logger = LoggerFactory.getLogger(GuacamoleHome.class); - - static { - // Warn about deprecation - logger.warn("GuacamoleHome is deprecated. Please use Environment instead."); - } - - /** - * GuacamoleHome is a utility class and cannot be instantiated. - */ - private GuacamoleHome() {} - - /** - * Returns the Guacamole home directory by checking, in order: - * the guacamole.home system property, the GUACAMOLE_HOME environment - * variable, and finally the .guacamole directory in the home directory of - * the user running the servlet container. - * - * @return The File representing the Guacamole home directory, which may - * or may not exist, and may turn out to not be a directory. - */ - public static File getDirectory() { - - // Attempt to find Guacamole home - File guacHome; - - // Use system property by default - String desiredDir = System.getProperty("guacamole.home"); - - // Failing that, try the GUACAMOLE_HOME environment variable - if (desiredDir == null) desiredDir = System.getenv("GUACAMOLE_HOME"); - - // If successful, use explicitly specified directory - if (desiredDir != null) - guacHome = new File(desiredDir); - - // If not explicitly specified, use ~/.guacamole - else - guacHome = new File(System.getProperty("user.home"), ".guacamole"); - - // Return discovered directory - return guacHome; - - } - -} http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/17f6862d/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleProperties.java ---------------------------------------------------------------------- diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleProperties.java b/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleProperties.java deleted file mode 100644 index a3eb7d1..0000000 --- a/guacamole-ext/src/main/java/org/apache/guacamole/properties/GuacamoleProperties.java +++ /dev/null @@ -1,214 +0,0 @@ -/* - * 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.guacamole.properties; - -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.util.Properties; -import org.apache.guacamole.GuacamoleException; -import org.apache.guacamole.GuacamoleServerException; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Simple utility class for reading properties from the guacamole.properties - * file. The guacamole.properties file is preferably located in the servlet - * container's user's home directory, in a subdirectory called .guacamole, or - * in the directory set by the system property: guacamole.home. - * - * If none of those locations are possible, guacamole.properties will also - * be read from the root of the classpath. - * - * @deprecated - */ -public class GuacamoleProperties { - - /** - * Logger for this class. - */ - private static final Logger logger = LoggerFactory.getLogger(GuacamoleProperties.class); - - static { - // Warn about deprecation - logger.warn("GuacamoleProperties is deprecated. Please use Environment instead."); - } - - /** - * GuacamoleProperties is a utility class and cannot be instantiated. - */ - private GuacamoleProperties() {} - - /** - * The hostname of the server where guacd (the Guacamole proxy server) is - * running. - */ - public static final StringGuacamoleProperty GUACD_HOSTNAME = new StringGuacamoleProperty() { - - @Override - public String getName() { return "guacd-hostname"; } - - }; - - /** - * The port that guacd (the Guacamole proxy server) is listening on. - */ - public static final IntegerGuacamoleProperty GUACD_PORT = new IntegerGuacamoleProperty() { - - @Override - public String getName() { return "guacd-port"; } - - }; - - /** - * Whether guacd requires SSL/TLS on connections. - */ - public static final BooleanGuacamoleProperty GUACD_SSL = new BooleanGuacamoleProperty() { - - @Override - public String getName() { return "guacd-ssl"; } - - }; - - /** - * All properties read from guacamole.properties when this class was first - * used. - */ - private static final Properties properties; - - /** - * Any error encountered when reading guacamole.properties was last - * attempted. - */ - private static GuacamoleException exception; - - static { - - properties = new Properties(); - - try { - - // Attempt to find Guacamole home - File guacHome = GuacamoleHome.getDirectory(); - - InputStream stream; - - // If not a directory, load from classpath - if (!guacHome.isDirectory()) { - - // Read from classpath - stream = GuacamoleProperties.class.getResourceAsStream("/guacamole.properties"); - if (stream == null) - throw new IOException( - "guacamole.properties not loaded from " + guacHome - + " (not a directory), and guacamole.properties could" - + " not be found as a resource in the classpath."); - - } - - // Otherwise, try to load from file - else - stream = new FileInputStream(new File(guacHome, "guacamole.properties")); - - // Load properties, always close stream - try { properties.load(stream); } - finally { stream.close(); } - - } - catch (IOException e) { - exception = new GuacamoleServerException("Error reading guacamole.properties", e); - } - - } - - /** - * Given a GuacamoleProperty, parses and returns the value set for that - * property in guacamole.properties, if any. - * - * @param <Type> The type that the given property is parsed into. - * @param property The property to read from guacamole.properties. - * @return The parsed value of the property as read from - * guacamole.properties. - * @throws GuacamoleException If an error occurs while parsing the value - * for the given property in - * guacamole.properties. - */ - public static <Type> Type getProperty(GuacamoleProperty<Type> property) throws GuacamoleException { - - if (exception != null) - throw exception; - - return property.parseValue(properties.getProperty(property.getName())); - - } - - /** - * Given a GuacamoleProperty, parses and returns the value set for that - * property in guacamole.properties, if any. If no value is found, the - * provided default value is returned. - * - * @param <Type> The type that the given property is parsed into. - * @param property The property to read from guacamole.properties. - * @param defaultValue The value to return if no value was given in - * guacamole.properties. - * @return The parsed value of the property as read from - * guacamole.properties, or the provided default value if no value - * was found. - * @throws GuacamoleException If an error occurs while parsing the value - * for the given property in - * guacamole.properties. - */ - public static <Type> Type getProperty(GuacamoleProperty<Type> property, - Type defaultValue) throws GuacamoleException { - - Type value = getProperty(property); - if (value == null) - return defaultValue; - - return value; - - } - - /** - * Given a GuacamoleProperty, parses and returns the value set for that - * property in guacamole.properties. An exception is thrown if the value - * is not provided. - * - * @param <Type> The type that the given property is parsed into. - * @param property The property to read from guacamole.properties. - * @return The parsed value of the property as read from - * guacamole.properties. - * @throws GuacamoleException If an error occurs while parsing the value - * for the given property in - * guacamole.properties, or if the property is - * not specified. - */ - public static <Type> Type getRequiredProperty(GuacamoleProperty<Type> property) - throws GuacamoleException { - - Type value = getProperty(property); - if (value == null) - throw new GuacamoleServerException("Property " + property.getName() + " is required."); - - return value; - - } -}