org.apache.guacamole.environment

Interface Environment

All Known Implementing Classes:

LocalEnvironment

public interface Environment

The environment of an arbitrary Guacamole instance, describing available protocols, configuration parameters, and the GUACAMOLE_HOME directory.

Author:

Michael Jumper

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
File	getGuacamoleHome() Returns the Guacamole home directory as determined when this Environment object was created.
<Type> Type	getProperty(GuacamoleProperty<Type> property) Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
<Type> Type	getProperty(GuacamoleProperty<Type> property, Type defaultValue) Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
ProtocolInfo	getProtocol(String name) Returns the protocol having the given name.
Map<String,ProtocolInfo>	getProtocols() Returns a map of all available protocols, where each key is the name of that protocol as would be passed to guacd during connection.
<Type> Type	getRequiredProperty(GuacamoleProperty<Type> property) Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties.

Field Detail

GUACD_HOSTNAME

static final StringGuacamoleProperty GUACD_HOSTNAME

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

GUACD_PORT

static final IntegerGuacamoleProperty GUACD_PORT

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

GUACD_SSL

static final BooleanGuacamoleProperty GUACD_SSL

Whether guacd requires SSL/TLS on connections.

Method Detail

getGuacamoleHome

File getGuacamoleHome()

Returns the Guacamole home directory as determined when this Environment object was created. The Guacamole home directory is found 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.

Returns:

The File representing the Guacamole home directory, which may or may not exist, and may turn out to not be a directory.

getProtocols

Map<String,ProtocolInfo> getProtocols()

Returns a map of all available protocols, where each key is the name of that protocol as would be passed to guacd during connection.

Returns:

A map of all available protocols.

getProtocol

ProtocolInfo getProtocol(String name)

Returns the protocol having the given name. The name must be the protocol name as would be passed to guacd during connection.

Parameters:

name - The name of the protocol.

Returns:

The protocol having the given name, or null if no such protocol is registered.

getProperty

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

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

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

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

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

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.