org.apache.guacamole.net.auth

Interface ConnectionGroup

All Superinterfaces:

Connectable, Identifiable

All Known Implementing Classes:

AbstractConnectionGroup, SimpleConnectionGroup

public interface ConnectionGroup
extends Identifiable, Connectable

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 All legal types of connection group.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns all attributes associated with this connection group.
Set<String>	getConnectionGroupIdentifiers() Returns the identifiers of all readable connection groups that are children of this connection group.
Set<String>	getConnectionIdentifiers() Returns the identifiers of all readable connections that are children of this connection group.
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	setAttributes(Map<String,String> attributes) Sets the given attributes.
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.

Methods inherited from interface org.apache.guacamole.net.auth.Identifiable

getIdentifier, setIdentifier

Methods inherited from interface org.apache.guacamole.net.auth.Connectable

connect, getActiveConnections

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.

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.

getConnectionIdentifiers

Set<String> getConnectionIdentifiers()
                              throws org.apache.guacamole.GuacamoleException

Returns the identifiers of all readable connections that are children of this connection group.

Returns:

The set of identifiers of all readable connections that are children of this connection group.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the identifiers.

getConnectionGroupIdentifiers

Set<String> getConnectionGroupIdentifiers()
                                   throws org.apache.guacamole.GuacamoleException

Returns the identifiers of all readable connection groups that are children of this connection group.

Returns:

The set of identifiers of all readable connection groups that are children of this connection group.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the identifiers.

getAttributes

Map<String,String> getAttributes()

Returns all attributes associated with this connection group. The returned map may not be modifiable.

Returns:

A map of all attribute identifiers to their corresponding values, for all attributes associated with this connection group, which may not be modifiable.

setAttributes

void setAttributes(Map<String,String> attributes)

Sets the given attributes. If an attribute within the map is not supported, it will simply be dropped. Any attributes not within the given map will be left untouched.

Parameters:

attributes - A map of all attribute identifiers to their corresponding values.