Package org.apache.guacamole.net.auth

Class DelegatingActivityRecordSet<RecordType extends ActivityRecord>

  • Type Parameters:
    RecordType - The type of ActivityRecord contained within this set.
    All Implemented Interfaces:
    ActivityRecordSet<RecordType>
    Direct Known Subclasses:
    DecoratingActivityRecordSet
    public class DelegatingActivityRecordSet<RecordType extends ActivityRecord>
extends Object
implements ActivityRecordSet<RecordType>
    ActivityRecordSet implementation which simply delegates all function calls to an underlying ActivityRecordSet.

    • Constructor Detail

      • DelegatingActivityRecordSet

        public DelegatingActivityRecordSet​(ActivityRecordSet<RecordType> recordSet)
        Wraps the given ActivityRecordSet such that all function calls against this DelegatingActivityRecordSet will be delegated to it.
        Parameters:
        recordSet - The ActivityRecordSet to wrap.

    • Method Detail

      • getDelegateActivityRecordSet

        protected ActivityRecordSet<RecordType> getDelegateActivityRecordSet()
        Returns the underlying ActivityRecordSet wrapped by this DelegatingActivityRecordSet.
        Returns:
        The ActivityRecordSet wrapped by this DelegatingActivityRecordSet.

      • get

        public RecordType get​(String identifier)
               throws org.apache.guacamole.GuacamoleException
        Description copied from interface: ActivityRecordSet
        Returns the record having the given unique identifier, if records within this set have unique identifiers. If records within this set do not have defined unique identifiers, this function has no effect.
        Specified by:
        get in interface ActivityRecordSet<RecordType extends ActivityRecord>
        Parameters:
        identifier - The unique identifier of the record to retrieve.
        Returns:
        The record having the given unique identifier, or null if there is no such record.
        Throws:
        org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the record.

      • asCollection

        public Collection<RecordType> asCollection()
                                    throws org.apache.guacamole.GuacamoleException
        Description copied from interface: ActivityRecordSet
        Returns all records within this set as a standard Collection.
        Specified by:
        asCollection in interface ActivityRecordSet<RecordType extends ActivityRecord>
        Returns:
        A collection containing all records within this set.
        Throws:
        org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the records within this set.

      • contains

        public ActivityRecordSet<RecordType> contains​(String value)
                                       throws org.apache.guacamole.GuacamoleException
        Description copied from interface: ActivityRecordSet
        Returns the subset of records which contain the given value. The properties and semantics involved with determining whether a particular record "contains" the given value is implementation dependent. This function may affect the contents of the current ActivityRecordSet. The contents of the current ActivityRecordSet should NOT be relied upon after this function is called.
        Specified by:
        contains in interface ActivityRecordSet<RecordType extends ActivityRecord>
        Parameters:
        value - The value which all records within the resulting subset should contain.
        Returns:
        The subset of records which contain the specified value.
        Throws:
        org.apache.guacamole.GuacamoleException - If an error occurs while restricting the current subset.

      • limit

        public ActivityRecordSet<RecordType> limit​(int limit)
                                    throws org.apache.guacamole.GuacamoleException
        Description copied from interface: ActivityRecordSet
        Returns the subset of records containing only the first limit records. If the subset has fewer than limit records, then this function has no effect. This function may also affect the contents of the current ActivityRecordSet. The contents of the current ActivityRecordSet should NOT be relied upon after this function is called.
        Specified by:
        limit in interface ActivityRecordSet<RecordType extends ActivityRecord>
        Parameters:
        limit - The maximum number of records that the new subset should contain.
        Returns:
        The subset of records that containing only the first limit records.
        Throws:
        org.apache.guacamole.GuacamoleException - If an error occurs while limiting the current subset.

      • sort

        public ActivityRecordSet<RecordType> sort​(ActivityRecordSet.SortableProperty property,
                                          boolean desc)
                                   throws org.apache.guacamole.GuacamoleException
        Description copied from interface: ActivityRecordSet
        Returns a ActivityRecordSet containing identically the records within this set, sorted according to the specified criteria. The sort operation performed is guaranteed to be stable with respect to any past call to sort(). This function may also affect the contents of the current ActivityRecordSet. The contents of the current ActivityRecordSet should NOT be relied upon after this function is called.
        Specified by:
        sort in interface ActivityRecordSet<RecordType extends ActivityRecord>
        Parameters:
        property - The property by which the records within the resulting set should be sorted.
        desc - Whether the records should be sorted according to the specified property in descending order. If false, records will be sorted according to the specified property in ascending order.
        Returns:
        The ActivityRecordSet, sorted according to the specified criteria.
        Throws:
        org.apache.guacamole.GuacamoleException - If an error occurs while sorting the current subset, or if the given property is not supported by the implementation.