From 898cee122f567f14000427664f238a3da13c94d2 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Fri, 23 Mar 2012 11:02:47 -0700 Subject: [PATCH] Create CredentialEvent interface for generic credentials-related events. Implemented AuthenticationFailureEvent. --- .../net/event/AuthenticationFailureEvent.java | 34 +++++++++++++++++++ .../guacamole/net/event/CredentialEvent.java | 21 ++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/AuthenticationFailureEvent.java create mode 100644 guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/CredentialEvent.java diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/AuthenticationFailureEvent.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/AuthenticationFailureEvent.java new file mode 100644 index 000000000..46cf00a20 --- /dev/null +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/AuthenticationFailureEvent.java @@ -0,0 +1,34 @@ +package net.sourceforge.guacamole.net.event; + +import net.sourceforge.guacamole.net.auth.Credentials; + +/** + * An event which is triggered whenever a user's credentials fail to be + * authenticated. The credentials that failed to be authenticated are included + * within this event, and can be retrieved using getCredentials(). + * + * @author Michael Jumper + */ +public class AuthenticationFailureEvent implements CredentialEvent { + + /** + * The credentials which failed authentication + */ + private Credentials credentials; + + /** + * Creates a new AuthenticationFailureEvent which represents the failure + * to authenticate the given credentials. + * + * @param credentials The credentials which failed authentication. + */ + public AuthenticationFailureEvent(Credentials credentials) { + this.credentials = credentials; + } + + @Override + public Credentials getCredentials() { + return credentials; + } + +} diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/CredentialEvent.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/CredentialEvent.java new file mode 100644 index 000000000..0b5e5a04b --- /dev/null +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/CredentialEvent.java @@ -0,0 +1,21 @@ +package net.sourceforge.guacamole.net.event; + +import net.sourceforge.guacamole.net.auth.Credentials; + +/** + * Abstract basis for events which may have associated user credentials when + * triggered. + * + * @author Michael Jumper + */ +public interface CredentialEvent { + + /** + * Returns the current credentials of the user triggering the event, if any. + * + * @return The current credentials of the user triggering the event, if + * any, or null if no credentials are associated with the event. + */ + public Credentials getCredentials(); + +}