public interface ActiveConnection extends Identifiable, Connectable, Shareable<SharingProfile>
Modifier and Type | Method and Description |
---|---|
default org.apache.guacamole.net.GuacamoleTunnel |
connect(org.apache.guacamole.protocol.GuacamoleClientInformation info,
Map<String,String> tokens)
Establishes a connection to guacd using the information associated with
this object.
|
default int |
getActiveConnections()
Returns the number of active connections associated with this object.
|
String |
getConnectionIdentifier()
Returns the identifier of the connection being actively used.
|
String |
getRemoteHost()
Returns the hostname or IP address of the remote host that initiated the
connection, if known.
|
String |
getSharingProfileIdentifier()
Returns the identifier of the sharing profile being actively used.
|
Date |
getStartDate()
Returns the date and time the connection began.
|
org.apache.guacamole.net.GuacamoleTunnel |
getTunnel()
Returns the connected GuacamoleTunnel being used.
|
String |
getUsername()
Returns the name of the user who is using this connection.
|
default boolean |
isConnectable()
Returns whether this ActiveConnection may be joined through a call to
connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map)
by the user that retrieved this ActiveConnection. |
void |
setConnectionIdentifier(String connnectionIdentifier)
Sets the identifier of the connection being actively used.
|
void |
setRemoteHost(String remoteHost)
Sets the hostname or IP address of the remote host that initiated the
connection.
|
void |
setSharingProfileIdentifier(String sharingProfileIdentifier)
Sets the identifier of the sharing profile being actively used.
|
void |
setStartDate(Date startDate)
Sets the date and time the connection began.
|
void |
setTunnel(org.apache.guacamole.net.GuacamoleTunnel tunnel)
Sets the connected GuacamoleTunnel being used.
|
void |
setUsername(String username)
Sets the name of the user who is using this connection.
|
getIdentifier, setIdentifier
connect
getSharingCredentials
String getConnectionIdentifier()
void setConnectionIdentifier(String connnectionIdentifier)
connnectionIdentifier
- The identifier of the connection being actively used.String getSharingProfileIdentifier()
void setSharingProfileIdentifier(String sharingProfileIdentifier)
sharingProfileIdentifier
- The identifier of the sharing profile being actively used.Date getStartDate()
void setStartDate(Date startDate)
startDate
- The date and time the connection began, or null if this
information is not available.String getRemoteHost()
void setRemoteHost(String remoteHost)
remoteHost
- The hostname or IP address of the remote host, or null if this
information is not available.String getUsername()
void setUsername(String username)
username
- The name of the user who is using this connection, or null if this
information is not available.org.apache.guacamole.net.GuacamoleTunnel getTunnel()
void setTunnel(org.apache.guacamole.net.GuacamoleTunnel tunnel)
tunnel
- The connected GuacamoleTunnel, or null if permission is denied.default boolean isConnectable()
connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map)
by the user that retrieved this ActiveConnection.connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map)
,
false otherwise.default org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info, Map<String,String> tokens) throws org.apache.guacamole.GuacamoleException
Connectable
TokenFilter
.connect
in interface Connectable
info
- Information associated with the connecting client.tokens
- A Map containing the token names and corresponding values to be
applied as parameter tokens when establishing the connection. If the
implementation does not support parameter tokens, this Map may be
ignored.org.apache.guacamole.GuacamoleException
- If an error occurs while connecting to guacd, or if permission to
connect is denied.default int getActiveConnections()
Connectable
getActiveConnections
in interface Connectable
Copyright © 2020. All rights reserved.