GUACAMOLE-1224: Clarify context of getAuthenticationProvider() for DirectoryObjectEvents.

This commit is contained in:
Michael Jumper
2022-10-04 15:11:20 -07:00
parent 93e7422466
commit 9b7982a7f2

View File

@@ -19,6 +19,8 @@
package org.apache.guacamole.net.event;
import org.apache.guacamole.net.auth.AuthenticatedUser;
import org.apache.guacamole.net.auth.AuthenticationProvider;
import org.apache.guacamole.net.auth.Directory;
import org.apache.guacamole.net.auth.Identifiable;
@@ -32,6 +34,18 @@ import org.apache.guacamole.net.auth.Identifiable;
public interface DirectoryObjectEvent<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()}.
*/
@Override
AuthenticationProvider getAuthenticationProvider();
/**
* Returns the type of {@link Directory} that contains the object affected
* by the operation.