org.apache.guacamole.net.auth

Interface ConnectionRecordSet

All Known Implementing Classes:

SimpleConnectionRecordSet

public interface ConnectionRecordSet

The set of all available connection records, or a subset of those records.

Author:

James Muehlner, Michael Jumper

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectionRecordSet.SortableProperty All properties of connection records which can be used as sorting criteria.

Method Summary

Modifier and Type	Method and Description
Collection<ConnectionRecord>	asCollection() Returns all connection records within this set as a standard Collection.
ConnectionRecordSet	contains(String value) Returns the subset of connection records to only those where the connection name, user identifier, or any associated date field contain the given value.
ConnectionRecordSet	limit(int limit) Returns the subset of connection history records containing only the first limit records.
ConnectionRecordSet	sort(ConnectionRecordSet.SortableProperty property, boolean desc) Returns a ConnectionRecordSet containing identically the records within this set, sorted according to the specified criteria.

Method Detail

asCollection

Collection<ConnectionRecord> asCollection()
                                   throws org.apache.guacamole.GuacamoleException

Returns all connection records within this set as a standard Collection.

Returns:

A collection containing all connection records within this set.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the connection records within this set.

contains

ConnectionRecordSet contains(String value)
                      throws org.apache.guacamole.GuacamoleException

Returns the subset of connection records to only those where the connection name, user identifier, or any associated date field contain the given value. This function may also affect the contents of the current ConnectionRecordSet. The contents of the current ConnectionRecordSet should NOT be relied upon after this function is called.

Parameters:

value - The value which all connection records within the resulting subset should contain within their associated connection name or user identifier.

Returns:

The subset of connection history records which contain the specified value within their associated connection name or user identifier.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while restricting the current subset.

limit

ConnectionRecordSet limit(int limit)
                   throws org.apache.guacamole.GuacamoleException

Returns the subset of connection history 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 ConnectionRecordSet. The contents of the current ConnectionRecordSet should NOT be relied upon after this function is called.

Parameters:

limit - The maximum number of records that the new subset should contain.

Returns:

The subset of connection history records that containing only the first limit records.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while limiting the current subset.

sort

ConnectionRecordSet sort(ConnectionRecordSet.SortableProperty property,
                         boolean desc)
                  throws org.apache.guacamole.GuacamoleException

Returns a ConnectionRecordSet 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 ConnectionRecordSet. The contents of the current ConnectionRecordSet should NOT be relied upon after this function is called.

Parameters:

property - The property by which the connection 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 ConnnectionRecordSet, sorted according to the specified criteria.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while sorting the current subset.