org.apache.guacamole.net.auth

Interface Connectable

All Known Subinterfaces:

Connection, ConnectionGroup

All Known Implementing Classes:

AbstractConnection, AbstractConnectionGroup, SimpleConnection, SimpleConnectionGroup

public interface Connectable

An object which Guacamole can connect to.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
org.apache.guacamole.net.GuacamoleTunnel	connect(org.apache.guacamole.protocol.GuacamoleClientInformation info) Establishes a connection to guacd using the information associated with this object.
int	getActiveConnections() Returns the number of active connections associated with this object.

Method Detail

connect

org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info)
                                          throws org.apache.guacamole.GuacamoleException

Establishes a connection to guacd using the information associated with this object. The connection will be provided the given client information.

Parameters:

info - Information associated with the connecting client.

Returns:

A fully-established GuacamoleTunnel.

Throws:

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

getActiveConnections

int getActiveConnections()

Returns the number of active connections associated with this object. Implementations may simply return 0 if this value is not tracked.

Returns:

The number of active connections associated with this object.