org.glyptodon.guacamole.protocols

Class ProtocolInfo

java.lang.Object

org.glyptodon.guacamole.protocols.ProtocolInfo

public class ProtocolInfo
extends Object

Describes a protocol and all parameters associated with it, as required by a protocol plugin for guacd. This class allows known parameters for a protocol to be exposed to the user as friendly fields.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
ProtocolInfo()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the unique name of this protocol.
Collection<ProtocolParameter>	getParameters() Returns a mutable collection of the protocol parameters associated with this protocol.
String	getTitle() Returns the human-readable title associated with this protocol.
void	setName(String name) Sets the unique name of this protocol.
void	setTitle(String title) Sets the human-readable title associated with this protocol.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolInfo

public ProtocolInfo()

Method Detail

getTitle

public String getTitle()

Returns the human-readable title associated with this protocol.

Returns:

The human-readable title associated with this protocol.

setTitle

public void setTitle(String title)

Sets the human-readable title associated with this protocol.

Parameters:

title - The human-readable title to associate with this protocol.

getName

public String getName()

Returns the unique name of this protocol. The protocol name is the value required by the corresponding protocol plugin for guacd.

Returns:

The unique name of this protocol.

setName

public void setName(String name)

Sets the unique name of this protocol. The protocol name is the value required by the corresponding protocol plugin for guacd.

Parameters:

name - The unique name of this protocol.

getParameters

public Collection<ProtocolParameter> getParameters()

Returns a mutable collection of the protocol parameters associated with this protocol. Changes to this collection affect the parameters exposed to the user.

Returns:

A mutable collection of protocol parameters.