Package org.apache.guacamole.net.auth

Interface ActivityRecord

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default Map<String,​String> getAttributes()
      Returns all attributes associated with this object.
      Date getEndDate()
      Returns the date and time the activity ended, if applicable.
      default String getIdentifier()
      Returns the unique identifier assigned to this record, if any.
      default Map<String,​ActivityLog> getLogs()
      Returns a Map of logs related to this record and accessible by the current user, such as Guacamole session recordings.
      String getRemoteHost()
      Returns the hostname or IP address of the remote host that performed the activity associated with this record, if known.
      Date getStartDate()
      Returns the date and time the activity began.
      String getUsername()
      Returns the name of the user who performed or is performing the activity at the times given by this record.
      default UUID getUUID()
      Returns a UUID that uniquely identifies this record.
      boolean isActive()
      Returns whether the activity associated with this record is still ongoing.

    • Method Detail

      • getStartDate

        Date getStartDate()
        Returns the date and time the activity began.
        Returns:
        The date and time the activity began.

      • getEndDate

        Date getEndDate()
        Returns the date and time the activity ended, if applicable.
        Returns:
        The date and time the activity ended, or null if the activity is still ongoing or if the end time is unknown.

      • getRemoteHost

        String getRemoteHost()
        Returns the hostname or IP address of the remote host that performed the activity associated with this record, if known. If the hostname or IP address is not known, null is returned.
        Returns:
        The hostname or IP address of the remote host, or null if this information is not available.

      • getUsername

        String getUsername()
        Returns the name of the user who performed or is performing the activity at the times given by this record.
        Returns:
        The name of the user who performed or is performing the associated activity.

      • isActive

        boolean isActive()
        Returns whether the activity associated with this record is still ongoing.
        Returns:
        true if the activity associated with this record is still ongoing, false otherwise.

      • getIdentifier

        default String getIdentifier()
        Returns the unique identifier assigned to this record, if any. If this record is not uniquely identifiable, this may be null. If provided, this unique identifier MUST be unique across all ActivityRecord objects within the same ActivityRecordSet.
        Returns:
        The unique identifier assigned to this record, or null if this record has no such identifier.

      • 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.
        Returns:
        A UUID that uniquely identifies this record, or null if no such unique identifier exists.

      • getLogs

        default Map<String,​ActivityLog> getLogs()
        Returns a Map of logs related to this record and accessible by the current user, such as Guacamole session recordings. Each log is associated with a corresponding, arbitrary, unique name. If the user does not have access to any logs, or if no logs are available, this may be an empty map.
        Returns:
        A Map of logs related to this record.

      • getAttributes

        default Map<String,​String> getAttributes()
        Description copied from interface: ReadableAttributes
        Returns all attributes associated with this object. The returned map may not be modifiable.
        Specified by:
        getAttributes in interface ReadableAttributes
        Returns:
        A map of all attribute identifiers to their corresponding values, for all attributes associated with this object, which may not be modifiable.