Package org.apache.guacamole.net.auth

Class AbstractActiveConnection

java.lang.Object
org.apache.guacamole.net.auth.AbstractIdentifiable
org.apache.guacamole.net.auth.AbstractActiveConnection
All Implemented Interfaces:
ActiveConnection, Connectable, Identifiable, Shareable<SharingProfile>
public abstract class AbstractActiveConnection extends AbstractIdentifiable implements ActiveConnection
Base implementation of an ActiveConnection, providing storage and simply getters/setters for its main properties.

  • Constructor Details

    • AbstractActiveConnection

      public AbstractActiveConnection()

  • Method Details

    • getConnectionIdentifier

      public String getConnectionIdentifier()
      Description copied from interface: ActiveConnection
      Returns the identifier of the connection being actively used. Unlike the other information stored in this object, the connection identifier must be present and MAY NOT be null.
      Specified by:
      getConnectionIdentifier in interface ActiveConnection
      Returns:
      The identifier of the connection being actively used.

    • setConnectionIdentifier

      public void setConnectionIdentifier(String connnectionIdentifier)
      Description copied from interface: ActiveConnection
      Sets the identifier of the connection being actively used.
      Specified by:
      setConnectionIdentifier in interface ActiveConnection
      Parameters:
      connnectionIdentifier - The identifier of the connection being actively used.

    • getSharingProfileIdentifier

      public String getSharingProfileIdentifier()
      Description copied from interface: ActiveConnection
      Returns the identifier of the sharing profile being actively used. If the connection is being accessed directly, this will be null.
      Specified by:
      getSharingProfileIdentifier in interface ActiveConnection
      Returns:
      The identifier of the sharing profile being actively used.

    • setSharingProfileIdentifier

      public void setSharingProfileIdentifier(String sharingProfileIdentifier)
      Description copied from interface: ActiveConnection
      Sets the identifier of the sharing profile being actively used.
      Specified by:
      setSharingProfileIdentifier in interface ActiveConnection
      Parameters:
      sharingProfileIdentifier - The identifier of the sharing profile being actively used.

    • getStartDate

      public Date getStartDate()
      Description copied from interface: ActiveConnection
      Returns the date and time the connection began.
      Specified by:
      getStartDate in interface ActiveConnection
      Returns:
      The date and time the connection began, or null if this information is not available.

    • setStartDate

      public void setStartDate(Date startDate)
      Description copied from interface: ActiveConnection
      Sets the date and time the connection began.
      Specified by:
      setStartDate in interface ActiveConnection
      Parameters:
      startDate - The date and time the connection began, or null if this information is not available.

    • getRemoteHost

      public String getRemoteHost()
      Description copied from interface: ActiveConnection
      Returns the hostname or IP address of the remote host that initiated the connection, if known. If the hostname or IP address is not known, null is returned.
      Specified by:
      getRemoteHost in interface ActiveConnection
      Returns:
      The hostname or IP address of the remote host, or null if this information is not available.

    • setRemoteHost

      public void setRemoteHost(String remoteHost)
      Description copied from interface: ActiveConnection
      Sets the hostname or IP address of the remote host that initiated the connection.
      Specified by:
      setRemoteHost in interface ActiveConnection
      Parameters:
      remoteHost - The hostname or IP address of the remote host, or null if this information is not available.

    • getUsername

      public String getUsername()
      Description copied from interface: ActiveConnection
      Returns the name of the user who is using this connection.
      Specified by:
      getUsername in interface ActiveConnection
      Returns:
      The name of the user who is using this connection, or null if this information is not available.

    • setUsername

      public void setUsername(String username)
      Description copied from interface: ActiveConnection
      Sets the name of the user who is using this connection.
      Specified by:
      setUsername in interface ActiveConnection
      Parameters:
      username - The name of the user who is using this connection, or null if this information is not available.

    • getTunnel

      public org.apache.guacamole.net.GuacamoleTunnel getTunnel()
      Description copied from interface: ActiveConnection
      Returns the connected GuacamoleTunnel being used. This may be null if access to the underlying tunnel is denied.
      Specified by:
      getTunnel in interface ActiveConnection
      Returns:
      The connected GuacamoleTunnel, or null if permission is denied.

    • setTunnel

      public void setTunnel(org.apache.guacamole.net.GuacamoleTunnel tunnel)
      Description copied from interface: ActiveConnection
      Sets the connected GuacamoleTunnel being used.
      Specified by:
      setTunnel in interface ActiveConnection
      Parameters:
      tunnel - The connected GuacamoleTunnel, or null if permission is denied.