org.glyptodon.guacamole.protocol

Class GuacamoleConfiguration

java.lang.Object

org.glyptodon.guacamole.protocol.GuacamoleConfiguration

All Implemented Interfaces:

Serializable

public class GuacamoleConfiguration
extends Object
implements Serializable

All information necessary to complete the initial protocol handshake of a Guacamole session.

Author:

Michael Jumper

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuacamoleConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getParameter(String name) Returns the value set for the parameter with the given name, if any.
Set<String>	getParameterNames() Returns a set of all currently defined parameter names.
String	getProtocol() Returns the name of the protocol to be used.
void	setParameter(String name, String value) Sets the value for the parameter with the given name.
void	setProtocol(String protocol) Sets the name of the protocol to be used.
void	unsetParameter(String name) Removes the value set for the parameter with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuacamoleConfiguration

public GuacamoleConfiguration()

Method Detail

getProtocol

public String getProtocol()

Returns the name of the protocol to be used.

Returns:

The name of the protocol to be used.

setProtocol

public void setProtocol(String protocol)

Sets the name of the protocol to be used.

Parameters:

protocol - The name of the protocol to be used.

getParameter

public String getParameter(String name)

Returns the value set for the parameter with the given name, if any.

Parameters:

name - The name of the parameter to return the value for.

Returns:

The value of the parameter with the given name, or null if that parameter has not been set.

setParameter

public void setParameter(String name,
                String value)

Sets the value for the parameter with the given name.

Parameters:

name - The name of the parameter to set the value for.

value - The value to set for the parameter with the given name.

unsetParameter

public void unsetParameter(String name)

Removes the value set for the parameter with the given name.

Parameters:

name - The name of the parameter to remove the value of.

getParameterNames

public Set<String> getParameterNames()

Returns a set of all currently defined parameter names. Each name corresponds to a parameter that has a value set on this GuacamoleConfiguration via setParameter().

Returns:

A set of all currently defined parameter names.