From a0a5335c4d887c7e9586baf51d353809616db946 Mon Sep 17 00:00:00 2001
From: Michael Jumper <mjumper@apache.org>
Date: Wed, 5 Oct 2022 09:09:28 -0700
Subject: [PATCH] GUACAMOLE-1224: Further clarify DirectoryObjectEvent,
 renaming to IdentifiableObjectEvent.

---
 .../guacamole/net/event/DirectoryEvent.java   |  2 +-
 ...vent.java => IdentifiableObjectEvent.java} | 21 ++++++++++---------
 .../guacamole/event/AffectedObject.java       |  6 +++---
 3 files changed, 15 insertions(+), 14 deletions(-)
 rename guacamole-ext/src/main/java/org/apache/guacamole/net/event/{DirectoryObjectEvent.java => IdentifiableObjectEvent.java} (75%)

diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryEvent.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryEvent.java
index 725c75048..5e9116496 100644
--- a/guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryEvent.java
+++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryEvent.java
@@ -31,7 +31,7 @@ import org.apache.guacamole.net.auth.Identifiable;
  *     The type of object stored within the {@link Directory}.
  */
 public interface DirectoryEvent<ObjectType extends Identifiable>
-        extends DirectoryObjectEvent<ObjectType> {
+        extends IdentifiableObjectEvent<ObjectType> {
 
     /**
      * The types of directory operations that may be represented by a
diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryObjectEvent.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/event/IdentifiableObjectEvent.java
similarity index 75%
rename from guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryObjectEvent.java
rename to guacamole-ext/src/main/java/org/apache/guacamole/net/event/IdentifiableObjectEvent.java
index 62dc36a6f..69ecfeaa4 100644
--- a/guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryObjectEvent.java
+++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/event/IdentifiableObjectEvent.java
@@ -26,29 +26,30 @@ import org.apache.guacamole.net.auth.Identifiable;
 
 /**
  * Abstract basis for events which affect or directly relate to objects that
- * may be stored within a {@link Directory}.
+ * are {@link Identifiable} and may be stored within a {@link Directory}.
  *
  * @param <ObjectType>
- *     The type of object stored within the {@link Directory}.
+ *     The type of object affected or related to the event.
  */
-public interface DirectoryObjectEvent<ObjectType extends Identifiable>
+public interface IdentifiableObjectEvent<ObjectType extends Identifiable>
         extends AuthenticationProviderEvent, UserEvent {
 
     /**
      * {@inheritDoc}
      * <p>
-     * NOTE: For subclasses of {@link DirectoryObjectEvent}, this will be the
-     * AuthenticationProvider associated with the affected object. This is not
-     * necessarily the same as the AuthenticationProvider that authenticated
-     * the user performing the operation, which can be retrieved via
-     * {@link #getAuthenticatedUser()} and {@link AuthenticatedUser#getAuthenticationProvider()}.
+     * NOTE: For subclasses of {@link IdentifiableObjectEvent}, this will be the
+     * AuthenticationProvider associated with the affected, {@link Identifiable}
+     * object. This is not necessarily the same as the AuthenticationProvider
+     * that authenticated the user performing the operation, which can be
+     * retrieved via {@link #getAuthenticatedUser()} and
+     * {@link AuthenticatedUser#getAuthenticationProvider()}.
      */
     @Override
     AuthenticationProvider getAuthenticationProvider();
 
     /**
-     * Returns the type of {@link Directory} that contains the object affected
-     * by the operation.
+     * Returns the type of {@link Directory} that may contains the object
+     * affected by the operation.
      *
      * @return
      *     The type of objects stored within the {@link Directory}.
diff --git a/guacamole/src/main/java/org/apache/guacamole/event/AffectedObject.java b/guacamole/src/main/java/org/apache/guacamole/event/AffectedObject.java
index aec678be2..b95122bae 100644
--- a/guacamole/src/main/java/org/apache/guacamole/event/AffectedObject.java
+++ b/guacamole/src/main/java/org/apache/guacamole/event/AffectedObject.java
@@ -22,7 +22,7 @@ package org.apache.guacamole.event;
 import org.apache.guacamole.net.auth.Nameable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.apache.guacamole.net.event.DirectoryObjectEvent;
+import org.apache.guacamole.net.event.IdentifiableObjectEvent;
 
 /**
  * Loggable representation of the object affected by an operation.
@@ -37,7 +37,7 @@ public class AffectedObject implements LoggableDetail {
     /**
      * The event representing the requested operation.
      */
-    private final DirectoryObjectEvent<?> event;
+    private final IdentifiableObjectEvent<?> event;
 
     /**
      * Creates a new AffectedObject representing the object affected by the
@@ -46,7 +46,7 @@ public class AffectedObject implements LoggableDetail {
      * @param event
      *     The event representing the operation.
      */
-    public AffectedObject(DirectoryObjectEvent<?> event) {
+    public AffectedObject(IdentifiableObjectEvent<?> event) {
         this.event = event;
     }