From 3d761ea7946423feb0a11980e8b613f41f0163a2 Mon Sep 17 00:00:00 2001 From: Virtually Nick Date: Sun, 23 Aug 2020 15:05:00 -0400 Subject: [PATCH] GUACAMOLE-1123: Deprecate getHistory() method. --- .../guacamole/auth/jdbc/connection/ModeledConnection.java | 1 + .../auth/jdbc/sharing/connection/SharedConnection.java | 1 + .../apache/guacamole/auth/jdbc/sharing/user/SharedUser.java | 1 + .../java/org/apache/guacamole/auth/jdbc/user/ModeledUser.java | 1 + .../main/java/org/apache/guacamole/net/auth/AbstractUser.java | 1 + .../main/java/org/apache/guacamole/net/auth/Connection.java | 3 +++ .../org/apache/guacamole/net/auth/DelegatingConnection.java | 1 + .../java/org/apache/guacamole/net/auth/DelegatingUser.java | 1 + .../src/main/java/org/apache/guacamole/net/auth/User.java | 4 ++++ .../apache/guacamole/net/auth/simple/SimpleConnection.java | 1 + .../guacamole/rest/connection/APIConnectionWrapper.java | 1 + .../java/org/apache/guacamole/rest/user/APIUserWrapper.java | 1 + 12 files changed, 17 insertions(+) diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java index 0e69d007c..441940cf7 100644 --- a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java +++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java @@ -260,6 +260,7 @@ public class ModeledConnection extends ModeledChildDirectoryObject getHistory() throws GuacamoleException { return connectionService.retrieveHistory(getCurrentUser(), this); diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/connection/SharedConnection.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/connection/SharedConnection.java index b1cf4a52a..b43405e00 100644 --- a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/connection/SharedConnection.java +++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/connection/SharedConnection.java @@ -154,6 +154,7 @@ public class SharedConnection implements Connection { return null; } + @Deprecated @Override public List getHistory() throws GuacamoleException { diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/user/SharedUser.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/user/SharedUser.java index dbf520567..085393689 100644 --- a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/user/SharedUser.java +++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharing/user/SharedUser.java @@ -101,6 +101,7 @@ public class SharedUser implements User { } + @Deprecated @Override public List getHistory() throws GuacamoleException { diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/user/ModeledUser.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/user/ModeledUser.java index bc0395c23..edbe12a52 100644 --- a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/user/ModeledUser.java +++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/user/ModeledUser.java @@ -754,6 +754,7 @@ public class ModeledUser extends ModeledPermissions implements User { return getModel().getLastActive(); } + @Deprecated @Override public List getHistory() throws GuacamoleException { return userService.retrieveHistory(getCurrentUser(), this); diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractUser.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractUser.java index cf333725d..aad3bc57d 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractUser.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractUser.java @@ -93,6 +93,7 @@ public abstract class AbstractUser extends AbstractIdentifiable *

This implementation simply an immutable, empty list. Implementations * that wish to expose user login history should override this function. */ + @Deprecated @Override public List getHistory() throws GuacamoleException { return Collections.emptyList(); diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Connection.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Connection.java index 8643ccc5a..fae7f3d25 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Connection.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Connection.java @@ -106,7 +106,10 @@ public interface Connection extends Identifiable, Connectable, Attributes { * @throws GuacamoleException If an error occurs while reading the history * of this connection, or if permission is * denied. + * + * @deprecated Use {@link getConnectionHistory} instead. */ + @Deprecated public List getHistory() throws GuacamoleException; /** diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingConnection.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingConnection.java index 6b9e96451..cc99baaff 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingConnection.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingConnection.java @@ -134,6 +134,7 @@ public class DelegatingConnection implements Connection { return connection.getLastActive(); } + @Deprecated @Override public List getHistory() throws GuacamoleException { diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingUser.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingUser.java index 0fbdf0e6b..9da0fb561 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingUser.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/DelegatingUser.java @@ -93,6 +93,7 @@ public class DelegatingUser implements User { return user.getLastActive(); } + @Deprecated @Override public List getHistory() throws GuacamoleException { diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/User.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/User.java index 6ceceabb6..9d4eae84b 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/User.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/User.java @@ -102,7 +102,11 @@ public interface User extends Identifiable, Attributes, Permissions { * @throws GuacamoleException * If an error occurs while reading the history of this user, or if * permission is denied. + * + * @deprecated + * Use {@link getUserHistory} instead. */ + @Deprecated List getHistory() throws GuacamoleException; /** diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleConnection.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleConnection.java index d1c01291c..7c388e102 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleConnection.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleConnection.java @@ -285,6 +285,7 @@ public class SimpleConnection extends AbstractConnection { return null; } + @Deprecated @Override public List getHistory() throws GuacamoleException { return Collections.emptyList(); diff --git a/guacamole/src/main/java/org/apache/guacamole/rest/connection/APIConnectionWrapper.java b/guacamole/src/main/java/org/apache/guacamole/rest/connection/APIConnectionWrapper.java index 52a7d0808..f331dda78 100644 --- a/guacamole/src/main/java/org/apache/guacamole/rest/connection/APIConnectionWrapper.java +++ b/guacamole/src/main/java/org/apache/guacamole/rest/connection/APIConnectionWrapper.java @@ -140,6 +140,7 @@ public class APIConnectionWrapper implements Connection { return null; } + @Deprecated @Override public List getHistory() throws GuacamoleException { return Collections.emptyList(); diff --git a/guacamole/src/main/java/org/apache/guacamole/rest/user/APIUserWrapper.java b/guacamole/src/main/java/org/apache/guacamole/rest/user/APIUserWrapper.java index b252a70c9..366bbb19e 100644 --- a/guacamole/src/main/java/org/apache/guacamole/rest/user/APIUserWrapper.java +++ b/guacamole/src/main/java/org/apache/guacamole/rest/user/APIUserWrapper.java @@ -140,6 +140,7 @@ public class APIUserWrapper implements User { return null; } + @Deprecated @Override public List getHistory() throws GuacamoleException { return Collections.emptyList();