Package org.apache.guacamole.net.auth

Interface ConnectionRecord

All Superinterfaces:
ActivityRecord, ReadableAttributes
All Known Implementing Classes:
DelegatingConnectionRecord
public interface ConnectionRecord extends ActivityRecord
A logging record describing when a user started and ended usage of a particular connection.

  • Method Details

    • getConnectionIdentifier

      String getConnectionIdentifier()
      Returns the identifier of the connection associated with this connection record.
      Returns:
      The identifier of the connection associated with this connection record.

    • getConnectionName

      String getConnectionName()
      Returns the name of the connection associated with this connection record.
      Returns:
      The name of the connection associated with this connection record.

    • getSharingProfileIdentifier

      String getSharingProfileIdentifier()
      Returns the identifier of the sharing profile that was used to access the connection associated with this connection record. If the connection was accessed directly (without involving a sharing profile), this will be null.
      Returns:
      The identifier of the sharing profile used to access the connection associated with this connection record, or null if the connection was accessed directly.

    • getSharingProfileName

      String getSharingProfileName()
      Returns the name of the sharing profile that was used to access the connection associated with this connection record. If the connection was accessed directly (without involving a sharing profile), this will be null.
      Returns:
      The name of the sharing profile used to access the connection associated with this connection record, or null if the connection was accessed directly.

    • getUUID

      default UUID getUUID()
      Returns a UUID that uniquely identifies this record. If provided, this UUID MUST be deterministic and unique across all ActivityRecord objects within the same ActivityRecordSet, and SHOULD be unique across all ActivityRecord objects.

      If implemented, this UUID SHOULD be identical to the UUID of the GuacamoleTunnel originally returned when the connection was established to allow extensions and/or the web application to automatically associate connection information with corresponding history records, such as log messages and session recordings.

      Specified by:
      getUUID in interface ActivityRecord
      Returns:
      A UUID that uniquely identifies this record, or null if no such unique identifier exists.