org.apache.guacamole.properties

Class GuacamoleProperties

java.lang.Object

org.apache.guacamole.properties.GuacamoleProperties

Deprecated.

public class GuacamoleProperties
extends Object

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.

Author:

Michael Jumper

Field Summary

Fields

Modifier and Type	Field and Description
static StringGuacamoleProperty	GUACD_HOSTNAME Deprecated. The hostname of the server where guacd (the Guacamole proxy server) is running.
static IntegerGuacamoleProperty	GUACD_PORT Deprecated. The port that guacd (the Guacamole proxy server) is listening on.
static BooleanGuacamoleProperty	GUACD_SSL Deprecated. Whether guacd requires SSL/TLS on connections.

Method Summary

Modifier and Type	Method and Description
static <Type> Type	getProperty(GuacamoleProperty<Type> property) Deprecated. Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
static <Type> Type	getProperty(GuacamoleProperty<Type> property, Type defaultValue) Deprecated. Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
static <Type> Type	getRequiredProperty(GuacamoleProperty<Type> property) Deprecated. Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GUACD_HOSTNAME

public static final StringGuacamoleProperty GUACD_HOSTNAME

Deprecated.

The hostname of the server where guacd (the Guacamole proxy server) is running.

GUACD_PORT

public static final IntegerGuacamoleProperty GUACD_PORT

Deprecated.

The port that guacd (the Guacamole proxy server) is listening on.

GUACD_SSL

public static final BooleanGuacamoleProperty GUACD_SSL

Deprecated.

Whether guacd requires SSL/TLS on connections.

Method Detail

getProperty

public static <Type> Type getProperty(GuacamoleProperty<Type> property)
                               throws org.apache.guacamole.GuacamoleException

Deprecated.

Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.

Type Parameters:

Type - The type that the given property is parsed into.

Parameters:

property - The property to read from guacamole.properties.

Returns:

The parsed value of the property as read from guacamole.properties.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while parsing the value for the given property in guacamole.properties.

getProperty

public static <Type> Type getProperty(GuacamoleProperty<Type> property,
                                      Type defaultValue)
                               throws org.apache.guacamole.GuacamoleException

Deprecated.

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.

Type Parameters:

Type - The type that the given property is parsed into.

Parameters:

property - The property to read from guacamole.properties.

defaultValue - The value to return if no value was given in guacamole.properties.

Returns:

The parsed value of the property as read from guacamole.properties, or the provided default value if no value was found.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while parsing the value for the given property in guacamole.properties.

getRequiredProperty

public static <Type> Type getRequiredProperty(GuacamoleProperty<Type> property)
                                       throws org.apache.guacamole.GuacamoleException

Deprecated.

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.

Type Parameters:

Type - The type that the given property is parsed into.

Parameters:

property - The property to read from guacamole.properties.

Returns:

The parsed value of the property as read from guacamole.properties.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while parsing the value for the given property in guacamole.properties, or if the property is not specified.