Package org.apache.guacamole.net.auth

Interface Connectable

All Known Subinterfaces:
ActiveConnection, Connection, ConnectionGroup
All Known Implementing Classes:
AbstractActiveConnection, AbstractConnection, AbstractConnectionGroup, DelegatingConnection, DelegatingConnectionGroup, SimpleConnection, SimpleConnectionGroup, TokenInjectingConnection, TokenInjectingConnectionGroup
public interface Connectable
An object which Guacamole can connect to.

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.apache.guacamole.net.GuacamoleTunnel
    connect(org.apache.guacamole.protocol.GuacamoleClientInformation info)
    Deprecated.
    This function has been deprecated in favor of connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map), which allows for connection parameter tokens to be injected and applied by cooperating extensions, replacing the functionality previously provided through the StandardTokens class.
    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.
    int
    getActiveConnections()
    Returns the number of active connections associated with this object.

  • Method Details

    • connect

      @Deprecated default org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info) throws org.apache.guacamole.GuacamoleException
      Deprecated.
      This function has been deprecated in favor of connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map), which allows for connection parameter tokens to be injected and applied by cooperating extensions, replacing the functionality previously provided through the StandardTokens class. It continues to be defined on this interface for compatibility. New implementations should instead implement connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map).
      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.

    • connect

      org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info, Map<String,String> tokens) 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. Implementations which support parameter tokens should apply the given tokens when configuring the connection, such as with a TokenFilter.
      Parameters:
      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.
      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.
      See Also:

    • 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.