public interface ConnectionGroup
Modifier and Type | Interface and Description |
---|---|
static class |
ConnectionGroup.Type |
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.
|
String getName()
void setName(String name)
name
- The name to assign.String getIdentifier()
void setIdentifier(String identifier)
identifier
- The identifier to assign.String getParentIdentifier()
void setParentIdentifier(String parentIdentifier)
parentIdentifier
- The unique identifier of the parent
ConnectionGroup for this ConnectionGroup.void setType(ConnectionGroup.Type type)
type
- The type of this ConnectionGroup.ConnectionGroup.Type getType()
Directory<String,Connection> getConnectionDirectory() throws GuacamoleException
GuacamoleException
- If an error occurs while creating the
Directory.Directory<String,ConnectionGroup> getConnectionGroupDirectory() throws GuacamoleException
GuacamoleException
- If an error occurs while creating the
Directory.GuacamoleSocket connect(GuacamoleClientInformation info) throws GuacamoleException
info
- Information associated with the connecting client.GuacamoleException
- If an error occurs while connecting to guacd,
or if permission to connect is denied.Copyright © 2015. All rights reserved.