org.apache.guacamole.protocols

Class ProtocolInfo

java.lang.Object

org.apache.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. Each parameter is described with a Form, which allows the parameters of a protocol to be exposed to the user as friendly groupings of fields.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
ProtocolInfo() Creates a new ProtocolInfo with no associated name or forms.
ProtocolInfo(String name) Creates a new ProtocolInfo having the given name, but without any forms.
ProtocolInfo(String name, Collection<Form> forms) Creates a new ProtocolInfo having the given name and forms.
ProtocolInfo(String name, Collection<Form> connectionForms, Collection<Form> sharingProfileForms) Creates a new ProtocolInfo having the given name and forms.

Method Summary

Modifier and Type	Method and Description
Collection<Form>	getConnectionForms() Returns a mutable collection of forms describing all known parameters for a connection using this protocol.
String	getName() Returns the unique name of this protocol.
Collection<Form>	getSharingProfileForms() Returns a mutable collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol.
void	setConnectionForms(Collection<Form> connectionForms) Sets the collection of forms describing all known parameters for a connection using this protocol.
void	setName(String name) Sets the unique name of this protocol.
void	setSharingProfileForms(Collection<Form> sharingProfileForms) Sets the collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses 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(String name,
                    Collection<Form> connectionForms,
                    Collection<Form> sharingProfileForms)

Creates a new ProtocolInfo having the given name and forms. The given collections of forms are used to describe the parameters for connections and sharing profiles respectively.

Parameters:

name - The unique name associated with the protocol.

connectionForms - A collection of forms describing all known parameters for a connection using this protocol.

sharingProfileForms - A collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol.

ProtocolInfo

public ProtocolInfo()

Creates a new ProtocolInfo with no associated name or forms.

ProtocolInfo

public ProtocolInfo(String name)

Creates a new ProtocolInfo having the given name, but without any forms.

Parameters:

name - The unique name associated with the protocol.

ProtocolInfo

public ProtocolInfo(String name,
                    Collection<Form> forms)

Creates a new ProtocolInfo having the given name and forms. The given forms are used to describe the parameters for both connections and sharing profiles.

Parameters:

name - The unique name associated with the protocol.

forms - A collection of forms describing all known parameters for this protocol, regardless of whether it is used in the context of a connection or a sharing profile.

Method Detail

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.

getConnectionForms

public Collection<Form> getConnectionForms()

Returns a mutable collection of forms describing all known parameters for a connection using this protocol. Changes to this collection affect the forms exposed to the user.

Returns:

A mutable collection of forms describing all known parameters for a connection using this protocol.

setConnectionForms

public void setConnectionForms(Collection<Form> connectionForms)

Sets the collection of forms describing all known parameters for a connection using this protocol. The provided collection must be mutable.

Parameters:

connectionForms - A mutable collection of forms describing all known parameters for a connection using this protocol.

getSharingProfileForms

public Collection<Form> getSharingProfileForms()

Returns a mutable collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol. Changes to this collection affect the forms exposed to the user.

Returns:

A mutable collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol.

setSharingProfileForms

public void setSharingProfileForms(Collection<Form> sharingProfileForms)

Sets the collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol. The provided collection must be mutable.

Parameters:

sharingProfileForms - A mutable collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol.