mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-06 05:07:41 +00:00
Removed trailing whitespace.
This commit is contained in:
@@ -44,7 +44,7 @@ import net.sourceforge.guacamole.protocol.GuacamoleConfiguration;
|
||||
/**
|
||||
* Provides means of retrieving a set of named GuacamoleConfigurations for a
|
||||
* given Credentials object.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface AuthenticationProvider {
|
||||
@@ -53,7 +53,7 @@ public interface AuthenticationProvider {
|
||||
* Given an arbitrary credentials object, returns a Map containing all
|
||||
* configurations authorized by those credentials. The keys of this Map
|
||||
* are Strings which uniquely identify each configuration.
|
||||
*
|
||||
*
|
||||
* @param credentials The credentials to use to retrieve authorized
|
||||
* configurations.
|
||||
* @return A Map of all configurations authorized by the given credentials,
|
||||
|
@@ -44,10 +44,10 @@ import javax.servlet.http.HttpSession;
|
||||
* Simple arbitrary set of credentials, including a username/password pair,
|
||||
* the HttpServletRequest associated with the request for authorization
|
||||
* (if any) and the HttpSession associated with that request.
|
||||
*
|
||||
*
|
||||
* This class is used along with AuthenticationProvider to provide arbitrary
|
||||
* HTTP-based authentication for Guacamole.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class Credentials implements Serializable {
|
||||
@@ -73,7 +73,7 @@ public class Credentials implements Serializable {
|
||||
* The HttpSession carrying additional credentials, if any.
|
||||
*/
|
||||
private transient HttpSession session;
|
||||
|
||||
|
||||
/**
|
||||
* Returns the password associated with this set of credentials.
|
||||
* @return The password associated with this username/password pair, or
|
||||
|
@@ -6,11 +6,11 @@ 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
|
||||
*/
|
||||
@@ -19,16 +19,16 @@ public class AuthenticationFailureEvent implements CredentialEvent {
|
||||
/**
|
||||
* 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;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
@@ -6,11 +6,11 @@ import net.sourceforge.guacamole.net.auth.Credentials;
|
||||
* An event which is triggered whenever a user's credentials pass
|
||||
* authentication. The credentials that passed authentication are included
|
||||
* within this event, and can be retrieved using getCredentials().
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class AuthenticationSuccessEvent implements CredentialEvent {
|
||||
|
||||
|
||||
/**
|
||||
* The credentials which passed authentication
|
||||
*/
|
||||
@@ -19,16 +19,16 @@ public class AuthenticationSuccessEvent implements CredentialEvent {
|
||||
/**
|
||||
* Creates a new AuthenticationSuccessEvent which represents a successful
|
||||
* authentication attempt with the given credentials.
|
||||
*
|
||||
*
|
||||
* @param credentials The credentials which passed authentication.
|
||||
*/
|
||||
public AuthenticationSuccessEvent(Credentials credentials) {
|
||||
this.credentials = credentials;
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public Credentials getCredentials() {
|
||||
return credentials;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
@@ -5,14 +5,14 @@ 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.
|
||||
*/
|
||||
|
@@ -8,7 +8,7 @@ import net.sourceforge.guacamole.net.auth.Credentials;
|
||||
* being closed can be accessed through getTunnel(), and the set of all
|
||||
* credentials available from the request which is closing the tunnel can be
|
||||
* retrieved using getCredentials().
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class TunnelCloseEvent implements CredentialEvent, TunnelEvent {
|
||||
@@ -27,7 +27,7 @@ public class TunnelCloseEvent implements CredentialEvent, TunnelEvent {
|
||||
/**
|
||||
* Creates a new TunnelCloseEvent which represents the closing of the
|
||||
* given tunnel via a request associated with the given credentials.
|
||||
*
|
||||
*
|
||||
* @param credentials The credentials associated with the request
|
||||
* closing the tunnel.
|
||||
* @param tunnel The tunnel being closed.
|
||||
|
@@ -8,11 +8,11 @@ import net.sourceforge.guacamole.net.auth.Credentials;
|
||||
* being connected can be accessed through getTunnel(), and the set of all
|
||||
* credentials available from the request which is connecting the tunnel can be
|
||||
* retrieved using getCredentials().
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class TunnelConnectEvent implements CredentialEvent, TunnelEvent {
|
||||
|
||||
|
||||
/**
|
||||
* The credentials associated with the request that is connecting the
|
||||
* tunnel, if any.
|
||||
@@ -27,7 +27,7 @@ public class TunnelConnectEvent implements CredentialEvent, TunnelEvent {
|
||||
/**
|
||||
* Creates a new TunnelConnectEvent which represents the connecting of the
|
||||
* given tunnel via a request associated with the given credentials.
|
||||
*
|
||||
*
|
||||
* @param credentials The credentials associated with the request
|
||||
* connecting the tunnel.
|
||||
* @param tunnel The tunnel being connected.
|
||||
|
@@ -4,14 +4,14 @@ import net.sourceforge.guacamole.net.GuacamoleTunnel;
|
||||
|
||||
/**
|
||||
* Abstract basis for events associated with tunnels.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface TunnelEvent {
|
||||
|
||||
|
||||
/**
|
||||
* Returns the tunnel associated with this event, if any.
|
||||
*
|
||||
*
|
||||
* @return The tunnel associated with this event, if any, or null if no
|
||||
* tunnel is associated with this event.
|
||||
*/
|
||||
|
@@ -7,15 +7,15 @@ import net.sourceforge.guacamole.net.event.AuthenticationFailureEvent;
|
||||
* A listener whose authenticationFailed() hook will fire immediately
|
||||
* after a user's authentication attempt fails. Note that this hook cannot
|
||||
* be used to cancel the authentication failure.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface AuthenticationFailureListener {
|
||||
|
||||
|
||||
/**
|
||||
* Event hook which fires immediately after a user's authentication attempt
|
||||
* fails.
|
||||
*
|
||||
*
|
||||
* @param e The AuthenticationFailureEvent describing the authentication
|
||||
* failure that just occurred.
|
||||
* @throws GuacamoleException If an error occurs while handling the
|
||||
@@ -25,5 +25,5 @@ public interface AuthenticationFailureListener {
|
||||
*/
|
||||
public void authenticationFailed(AuthenticationFailureEvent e)
|
||||
throws GuacamoleException;
|
||||
|
||||
|
||||
}
|
||||
|
@@ -8,16 +8,16 @@ import net.sourceforge.guacamole.net.event.AuthenticationSuccessEvent;
|
||||
* authentication attempt succeeds. If a user successfully authenticates,
|
||||
* the authenticationSucceeded() hook has the opportunity to cancel the
|
||||
* authentication and force it to fail.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface AuthenticationSuccessListener {
|
||||
|
||||
|
||||
/**
|
||||
* Event hook which fires immediately after a user's authentication attempt
|
||||
* succeeds. The return value of this hook dictates whether the
|
||||
* successful authentication attempt is canceled.
|
||||
*
|
||||
*
|
||||
* @param e The AuthenticationFailureEvent describing the authentication
|
||||
* failure that just occurred.
|
||||
* @return true if the successful authentication attempt should be
|
||||
|
@@ -6,16 +6,16 @@ import net.sourceforge.guacamole.net.event.TunnelCloseEvent;
|
||||
/**
|
||||
* A listener whose tunnelClosed() hook will fire immediately after an
|
||||
* existing tunnel is closed.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface TunnelCloseListener {
|
||||
|
||||
|
||||
/**
|
||||
* Event hook which fires immediately after an existing tunnel is closed.
|
||||
* The return value of this hook dictates whether the tunnel is allowed to
|
||||
* be closed.
|
||||
*
|
||||
*
|
||||
* @param e The TunnelCloseEvent describing the tunnel being closed and
|
||||
* any associated credentials.
|
||||
* @return true if the tunnel should be allowed to be closed, or false
|
||||
|
@@ -6,7 +6,7 @@ import net.sourceforge.guacamole.net.event.TunnelConnectEvent;
|
||||
/**
|
||||
* A listener whose tunnelConnected() hook will fire immediately after a new
|
||||
* tunnel is connected.
|
||||
*
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface TunnelConnectListener {
|
||||
@@ -15,7 +15,7 @@ public interface TunnelConnectListener {
|
||||
* Event hook which fires immediately after a new tunnel is connected.
|
||||
* The return value of this hook dictates whether the tunnel is made visible
|
||||
* to the session.
|
||||
*
|
||||
*
|
||||
* @param e The TunnelConnectEvent describing the tunnel being connected and
|
||||
* any associated credentials.
|
||||
* @return true if the tunnel should be allowed to be connected, or false
|
||||
|
Reference in New Issue
Block a user