public interface Connection extends Identifiable, Connectable, Attributes
Modifier and Type | Method and Description |
---|---|
org.apache.guacamole.protocol.GuacamoleConfiguration |
getConfiguration()
Returns the GuacamoleConfiguration associated with this Connection.
|
default ActivityRecordSet<ConnectionRecord> |
getConnectionHistory()
Returns an ActivityRecordSet containing ConnectionRecords that
represent the usage history of this Connection, including any active
users.
|
default List<? extends ConnectionRecord> |
getHistory()
Deprecated.
This function has been deprecated in favor of
getConnectionHistory , which returns the connection history
as an ActivityRecordSet that can be easily sorted and filtered.
While the getHistory() method is provided for API compatibility,
new implementations should avoid use of this method and, instead,
implement the getConnectionHistory() method. |
Date |
getLastActive()
Returns the date and time that this connection was last used.
|
String |
getName()
Returns the name assigned to this Connection.
|
String |
getParentIdentifier()
Returns the unique identifier of the parent ConnectionGroup for
this Connection.
|
Set<String> |
getSharingProfileIdentifiers()
Returns identifiers of all readable sharing profiles that can be used to
join this connection when it is active.
|
void |
setConfiguration(org.apache.guacamole.protocol.GuacamoleConfiguration config)
Sets the GuacamoleConfiguration associated with this Connection.
|
void |
setName(String name)
Sets the name assigned to this Connection.
|
void |
setParentIdentifier(String parentIdentifier)
Sets the unique identifier of the parent ConnectionGroup for
this Connection.
|
getIdentifier, setIdentifier
connect, connect, getActiveConnections
getAttributes, setAttributes
String getName()
void setName(String name)
name
- The name to assign.String getParentIdentifier()
void setParentIdentifier(String parentIdentifier)
parentIdentifier
- The unique identifier of the parent
ConnectionGroup for this Connection.org.apache.guacamole.protocol.GuacamoleConfiguration getConfiguration()
void setConfiguration(org.apache.guacamole.protocol.GuacamoleConfiguration config)
config
- The GuacamoleConfiguration to associate with this
Connection.Date getLastActive()
@Deprecated default List<? extends ConnectionRecord> getHistory() throws org.apache.guacamole.GuacamoleException
getConnectionHistory
, which returns the connection history
as an ActivityRecordSet that can be easily sorted and filtered.
While the getHistory() method is provided for API compatibility,
new implementations should avoid use of this method and, instead,
implement the getConnectionHistory() method.org.apache.guacamole.GuacamoleException
- If history tracking is not implemented, if an error occurs while
reading the history of this connection, or if permission is
denied.default ActivityRecordSet<ConnectionRecord> getConnectionHistory() throws org.apache.guacamole.GuacamoleException
getHistory
method, this function should throw
GuacamoleUnsupportedExpcetion.org.apache.guacamole.GuacamoleException
- If history tracking is not implemented, if an error occurs while
reading the history of this connection, or if permission is
denied.Set<String> getSharingProfileIdentifiers() throws org.apache.guacamole.GuacamoleException
org.apache.guacamole.GuacamoleException
- If an error occurs while fetching the sharing profiles for this
connection.Copyright © 2020. All rights reserved.