GUACAMOLE-1123: Fixes to comments, method scope, and minor code tweaks.

This commit is contained in:
Virtually Nick
2020-10-15 14:25:57 -04:00
parent 3d761ea794
commit 0430d5510a
11 changed files with 51 additions and 20 deletions

View File

@@ -46,7 +46,8 @@ public class ConnectionRecordSet extends ModeledActivityRecordSet<ConnectionReco
/**
* The identifier of the connection to which this record set should be
* limited, if any.
* limited, if any. If null, the set should contain all records readable
* by the user making the request.
*/
private String identifier = null;
@@ -58,7 +59,9 @@ public class ConnectionRecordSet extends ModeledActivityRecordSet<ConnectionReco
* The user that created or retrieved this object.
*
* @param identifier
* The connection identifier to which this record set should be limited.
* The connection identifier to which this record set should be limited,
* or null if the record set should contain all records readable by the
* currentUser.
*/
protected void init(ModeledAuthenticatedUser currentUser, String identifier) {
super.init(currentUser);

View File

@@ -158,7 +158,7 @@ public class SharedConnection implements Connection {
@Override
public List<? extends ConnectionRecord> getHistory()
throws GuacamoleException {
return Collections.<ConnectionRecord>emptyList();
throw new GuacamoleUnsupportedException("SharedConnection objects do not provide history.");
}
@Override

View File

@@ -104,10 +104,7 @@ public class SharedUser implements User {
@Deprecated
@Override
public List<ActivityRecord> getHistory() throws GuacamoleException {
// History is not recorded for shared users
return Collections.<ActivityRecord>emptyList();
throw new GuacamoleUnsupportedException("SharedUser objects do not provide login history.");
}
@Override

View File

@@ -44,8 +44,26 @@ public class UserRecordSet extends ModeledActivityRecordSet<ActivityRecord> {
@Inject
private UserService userService;
/**
* The identifier that indicates which user object these records should be
* limited to, if any. If null is specified (the default) then all records
* that are readable by the current user will be retrieved.
*/
private String identifier = null;
/**
* Initialize this UserRecordSet with currentUser requesting the login
* records, and, optionally, the identifier of the user to which records
* should be limited.
*
* @param currentUser
* The user requesting login history.
*
* @param identifier
* The identifier of the user whose login history should be contained
* in this record set, or null if the record set should contain all
* records readable by the currentUser.
*/
protected void init(ModeledAuthenticatedUser currentUser, String identifier) {
super.init(currentUser);
this.identifier = identifier;