org.glyptodon.guacamole.net.auth

Interface ConnectionGroup

All Known Implementing Classes:

AbstractConnectionGroup, SimpleConnectionGroup

public interface ConnectionGroup

Represents a connection group, which can contain both other connection groups as well as connections.

Author:

James Muehlner

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectionGroup.Type

Method Summary

Methods

Modifier and Type	Method and Description
GuacamoleSocket	connect(GuacamoleClientInformation info) Establishes a connection to guacd using a connection chosen from among the connections in this ConnectionGroup, and returns the resulting, connected GuacamoleSocket.
Directory<String,Connection>	getConnectionDirectory() Retrieves a Directory which can be used to view and manipulate connections and their configurations, but only as allowed by the permissions given to the user.
Directory<String,ConnectionGroup>	getConnectionGroupDirectory() Retrieves a Directory which can be used to view and manipulate connection groups and their members, but only as allowed by the permissions given to the user.
String	getIdentifier() Returns the unique identifier assigned to this ConnectionGroup.
String	getName() Returns the name assigned to this ConnectionGroup.
String	getParentIdentifier() Returns the unique identifier of the parent ConnectionGroup for this ConnectionGroup.
ConnectionGroup.Type	getType() Returns the type of this connection.
void	setIdentifier(String identifier) Sets the identifier assigned to this ConnectionGroup.
void	setName(String name) Sets the name assigned to this ConnectionGroup.
void	setParentIdentifier(String parentIdentifier) Sets the unique identifier of the parent ConnectionGroup for this ConnectionGroup.
void	setType(ConnectionGroup.Type type) Set the type of this ConnectionGroup.

Method Detail

getName

String getName()

Returns the name assigned to this ConnectionGroup.

Returns:

The name assigned to this ConnectionGroup.

setName

void setName(String name)

Sets the name assigned to this ConnectionGroup.

Parameters:

name - The name to assign.

getIdentifier

String getIdentifier()

Returns the unique identifier assigned to this ConnectionGroup. All connection groups must have a deterministic, unique identifier which may not be null.

Returns:

The unique identifier assigned to this ConnectionGroup, which may not be null.

setIdentifier

void setIdentifier(String identifier)

Sets the identifier assigned to this ConnectionGroup.

Parameters:

identifier - The identifier to assign.

getParentIdentifier

String getParentIdentifier()

Returns the unique identifier of the parent ConnectionGroup for this ConnectionGroup.

Returns:

The unique identifier of the parent ConnectionGroup for this ConnectionGroup.

setParentIdentifier

void setParentIdentifier(String parentIdentifier)

Sets the unique identifier of the parent ConnectionGroup for this ConnectionGroup.

Parameters:

parentIdentifier - The unique identifier of the parent ConnectionGroup for this ConnectionGroup.

setType

void setType(ConnectionGroup.Type type)

Set the type of this ConnectionGroup.

Parameters:

type - The type of this ConnectionGroup.

getType

ConnectionGroup.Type getType()

Returns the type of this connection.

Returns:

the type of this connection.

getConnectionDirectory

Directory<String,Connection> getConnectionDirectory()
                                                    throws GuacamoleException

Retrieves a Directory which can be used to view and manipulate connections and their configurations, but only as allowed by the permissions given to the user.

Returns:

A Directory whose operations are bound by the permissions of the user.

Throws:

GuacamoleException - If an error occurs while creating the Directory.

getConnectionGroupDirectory

Directory<String,ConnectionGroup> getConnectionGroupDirectory()
                                                              throws GuacamoleException

Retrieves a Directory which can be used to view and manipulate connection groups and their members, but only as allowed by the permissions given to the user.

Returns:

A Directory whose operations are bound by the permissions of the user.

Throws:

GuacamoleException - If an error occurs while creating the Directory.

connect

GuacamoleSocket connect(GuacamoleClientInformation info)
                        throws GuacamoleException

Establishes a connection to guacd using a connection chosen from among the connections in this ConnectionGroup, and returns the resulting, connected GuacamoleSocket.

Parameters:

info - Information associated with the connecting client.

Returns:

A fully-established GuacamoleSocket.

Throws:

GuacamoleException - If an error occurs while connecting to guacd, or if permission to connect is denied.