safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 05:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

GUACAMOLE-1224: Further clarify DirectoryObjectEvent, renaming to IdentifiableObjectEvent.

Browse Source
This commit is contained in:
Michael Jumper
2022-10-05 09:09:28 -07:00
parent 9b7982a7f2
commit a0a5335c4d
3 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryEvent.java
View File

@@ -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

21
guacamole-ext/src/main/java/org/apache/guacamole/net/event/DirectoryObjectEvent.java → guacamole-ext/src/main/java/org/apache/guacamole/net/event/IdentifiableObjectEvent.java
View File

@@ -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}.

6
guacamole/src/main/java/org/apache/guacamole/event/AffectedObject.java
View File

@@ -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;
}