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

Removed trailing whitespace.

Browse Source
This commit is contained in:
Michael Jumper
2012-08-09 11:42:29 -07:00
parent 548fe9e008
commit e911a615bc
12 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AuthenticationProvider.java
View File

@@ -44,7 +44,7 @@ import net.sourceforge.guacamole.protocol.GuacamoleConfiguration;
/** /**
* Provides means of retrieving a set of named GuacamoleConfigurations for a * Provides means of retrieving a set of named GuacamoleConfigurations for a
* given Credentials object. * given Credentials object.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface AuthenticationProvider { public interface AuthenticationProvider {
@@ -53,7 +53,7 @@ public interface AuthenticationProvider {
* Given an arbitrary credentials object, returns a Map containing all * Given an arbitrary credentials object, returns a Map containing all
* configurations authorized by those credentials. The keys of this Map * configurations authorized by those credentials. The keys of this Map
* are Strings which uniquely identify each configuration. * are Strings which uniquely identify each configuration.
* *
* @param credentials The credentials to use to retrieve authorized * @param credentials The credentials to use to retrieve authorized
* configurations. * configurations.
* @return A Map of all configurations authorized by the given credentials, * @return A Map of all configurations authorized by the given credentials,

6
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/Credentials.java
View File

@@ -44,10 +44,10 @@ import javax.servlet.http.HttpSession;
* Simple arbitrary set of credentials, including a username/password pair, * Simple arbitrary set of credentials, including a username/password pair,
* the HttpServletRequest associated with the request for authorization * the HttpServletRequest associated with the request for authorization
* (if any) and the HttpSession associated with that request. * (if any) and the HttpSession associated with that request.
* *
* This class is used along with AuthenticationProvider to provide arbitrary * This class is used along with AuthenticationProvider to provide arbitrary
* HTTP-based authentication for Guacamole. * HTTP-based authentication for Guacamole.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public class Credentials implements Serializable { public class Credentials implements Serializable {
@@ -73,7 +73,7 @@ public class Credentials implements Serializable {
* The HttpSession carrying additional credentials, if any. * The HttpSession carrying additional credentials, if any.
*/ */
private transient HttpSession session; private transient HttpSession session;
/** /**
* Returns the password associated with this set of credentials. * Returns the password associated with this set of credentials.
* @return The password associated with this username/password pair, or * @return The password associated with this username/password pair, or

10
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/AuthenticationFailureEvent.java
View File

@@ -6,11 +6,11 @@ import net.sourceforge.guacamole.net.auth.Credentials;
* An event which is triggered whenever a user's credentials fail to be * An event which is triggered whenever a user's credentials fail to be
* authenticated. The credentials that failed to be authenticated are included * authenticated. The credentials that failed to be authenticated are included
* within this event, and can be retrieved using getCredentials(). * within this event, and can be retrieved using getCredentials().
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public class AuthenticationFailureEvent implements CredentialEvent { public class AuthenticationFailureEvent implements CredentialEvent {
/** /**
* The credentials which failed authentication * The credentials which failed authentication
*/ */
@@ -19,16 +19,16 @@ public class AuthenticationFailureEvent implements CredentialEvent {
/** /**
* Creates a new AuthenticationFailureEvent which represents the failure * Creates a new AuthenticationFailureEvent which represents the failure
* to authenticate the given credentials. * to authenticate the given credentials.
* *
* @param credentials The credentials which failed authentication. * @param credentials The credentials which failed authentication.
*/ */
public AuthenticationFailureEvent(Credentials credentials) { public AuthenticationFailureEvent(Credentials credentials) {
this.credentials = credentials; this.credentials = credentials;
} }
@Override @Override
public Credentials getCredentials() { public Credentials getCredentials() {
return credentials; return credentials;
} }
} }

10
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/AuthenticationSuccessEvent.java
View File

@@ -6,11 +6,11 @@ import net.sourceforge.guacamole.net.auth.Credentials;
* An event which is triggered whenever a user's credentials pass * An event which is triggered whenever a user's credentials pass
* authentication. The credentials that passed authentication are included * authentication. The credentials that passed authentication are included
* within this event, and can be retrieved using getCredentials(). * within this event, and can be retrieved using getCredentials().
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public class AuthenticationSuccessEvent implements CredentialEvent { public class AuthenticationSuccessEvent implements CredentialEvent {
/** /**
* The credentials which passed authentication * The credentials which passed authentication
*/ */
@@ -19,16 +19,16 @@ public class AuthenticationSuccessEvent implements CredentialEvent {
/** /**
* Creates a new AuthenticationSuccessEvent which represents a successful * Creates a new AuthenticationSuccessEvent which represents a successful
* authentication attempt with the given credentials. * authentication attempt with the given credentials.
* *
* @param credentials The credentials which passed authentication. * @param credentials The credentials which passed authentication.
*/ */
public AuthenticationSuccessEvent(Credentials credentials) { public AuthenticationSuccessEvent(Credentials credentials) {
this.credentials = credentials; this.credentials = credentials;
} }
@Override @Override
public Credentials getCredentials() { public Credentials getCredentials() {
return credentials; return credentials;
} }
} }

6
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/CredentialEvent.java
View File

@@ -5,14 +5,14 @@ import net.sourceforge.guacamole.net.auth.Credentials;
/** /**
* Abstract basis for events which may have associated user credentials when * Abstract basis for events which may have associated user credentials when
* triggered. * triggered.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface CredentialEvent { public interface CredentialEvent {
/** /**
* Returns the current credentials of the user triggering the event, if any. * Returns the current credentials of the user triggering the event, if any.
* *
* @return The current credentials of the user triggering the event, if * @return The current credentials of the user triggering the event, if
* any, or null if no credentials are associated with the event. * any, or null if no credentials are associated with the event.
*/ */

4
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/TunnelCloseEvent.java
View File

@@ -8,7 +8,7 @@ import net.sourceforge.guacamole.net.auth.Credentials;
* being closed can be accessed through getTunnel(), and the set of all * being closed can be accessed through getTunnel(), and the set of all
* credentials available from the request which is closing the tunnel can be * credentials available from the request which is closing the tunnel can be
* retrieved using getCredentials(). * retrieved using getCredentials().
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public class TunnelCloseEvent implements CredentialEvent, TunnelEvent { 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 * Creates a new TunnelCloseEvent which represents the closing of the
* given tunnel via a request associated with the given credentials. * given tunnel via a request associated with the given credentials.
* *
* @param credentials The credentials associated with the request * @param credentials The credentials associated with the request
* closing the tunnel. * closing the tunnel.
* @param tunnel The tunnel being closed. * @param tunnel The tunnel being closed.

6
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/TunnelConnectEvent.java
View File

@@ -8,11 +8,11 @@ import net.sourceforge.guacamole.net.auth.Credentials;
* being connected can be accessed through getTunnel(), and the set of all * being connected can be accessed through getTunnel(), and the set of all
* credentials available from the request which is connecting the tunnel can be * credentials available from the request which is connecting the tunnel can be
* retrieved using getCredentials(). * retrieved using getCredentials().
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public class TunnelConnectEvent implements CredentialEvent, TunnelEvent { public class TunnelConnectEvent implements CredentialEvent, TunnelEvent {
/** /**
* The credentials associated with the request that is connecting the * The credentials associated with the request that is connecting the
* tunnel, if any. * tunnel, if any.
@@ -27,7 +27,7 @@ public class TunnelConnectEvent implements CredentialEvent, TunnelEvent {
/** /**
* Creates a new TunnelConnectEvent which represents the connecting of the * Creates a new TunnelConnectEvent which represents the connecting of the
* given tunnel via a request associated with the given credentials. * given tunnel via a request associated with the given credentials.
* *
* @param credentials The credentials associated with the request * @param credentials The credentials associated with the request
* connecting the tunnel. * connecting the tunnel.
* @param tunnel The tunnel being connected. * @param tunnel The tunnel being connected.

6
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/TunnelEvent.java
View File

@@ -4,14 +4,14 @@ import net.sourceforge.guacamole.net.GuacamoleTunnel;
/** /**
* Abstract basis for events associated with tunnels. * Abstract basis for events associated with tunnels.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface TunnelEvent { public interface TunnelEvent {
/** /**
* Returns the tunnel associated with this event, if any. * Returns the tunnel associated with this event, if any.
* *
* @return The tunnel associated with this event, if any, or null if no * @return The tunnel associated with this event, if any, or null if no
* tunnel is associated with this event. * tunnel is associated with this event.
*/ */

8
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/listener/AuthenticationFailureListener.java
View File

@@ -7,15 +7,15 @@ import net.sourceforge.guacamole.net.event.AuthenticationFailureEvent;
* A listener whose authenticationFailed() hook will fire immediately * A listener whose authenticationFailed() hook will fire immediately
* after a user's authentication attempt fails. Note that this hook cannot * after a user's authentication attempt fails. Note that this hook cannot
* be used to cancel the authentication failure. * be used to cancel the authentication failure.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface AuthenticationFailureListener { public interface AuthenticationFailureListener {
/** /**
* Event hook which fires immediately after a user's authentication attempt * Event hook which fires immediately after a user's authentication attempt
* fails. * fails.
* *
* @param e The AuthenticationFailureEvent describing the authentication * @param e The AuthenticationFailureEvent describing the authentication
* failure that just occurred. * failure that just occurred.
* @throws GuacamoleException If an error occurs while handling the * @throws GuacamoleException If an error occurs while handling the
@@ -25,5 +25,5 @@ public interface AuthenticationFailureListener {
*/ */
public void authenticationFailed(AuthenticationFailureEvent e) public void authenticationFailed(AuthenticationFailureEvent e)
throws GuacamoleException; throws GuacamoleException;
} }

6
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/listener/AuthenticationSuccessListener.java
View File

@@ -8,16 +8,16 @@ import net.sourceforge.guacamole.net.event.AuthenticationSuccessEvent;
* authentication attempt succeeds. If a user successfully authenticates, * authentication attempt succeeds. If a user successfully authenticates,
* the authenticationSucceeded() hook has the opportunity to cancel the * the authenticationSucceeded() hook has the opportunity to cancel the
* authentication and force it to fail. * authentication and force it to fail.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface AuthenticationSuccessListener { public interface AuthenticationSuccessListener {
/** /**
* Event hook which fires immediately after a user's authentication attempt * Event hook which fires immediately after a user's authentication attempt
* succeeds. The return value of this hook dictates whether the * succeeds. The return value of this hook dictates whether the
* successful authentication attempt is canceled. * successful authentication attempt is canceled.
* *
* @param e The AuthenticationFailureEvent describing the authentication * @param e The AuthenticationFailureEvent describing the authentication
* failure that just occurred. * failure that just occurred.
* @return true if the successful authentication attempt should be * @return true if the successful authentication attempt should be

6
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/listener/TunnelCloseListener.java
View File

@@ -6,16 +6,16 @@ import net.sourceforge.guacamole.net.event.TunnelCloseEvent;
/** /**
* A listener whose tunnelClosed() hook will fire immediately after an * A listener whose tunnelClosed() hook will fire immediately after an
* existing tunnel is closed. * existing tunnel is closed.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface TunnelCloseListener { public interface TunnelCloseListener {
/** /**
* Event hook which fires immediately after an existing tunnel is closed. * Event hook which fires immediately after an existing tunnel is closed.
* The return value of this hook dictates whether the tunnel is allowed to * The return value of this hook dictates whether the tunnel is allowed to
* be closed. * be closed.
* *
* @param e The TunnelCloseEvent describing the tunnel being closed and * @param e The TunnelCloseEvent describing the tunnel being closed and
* any associated credentials. * any associated credentials.
* @return true if the tunnel should be allowed to be closed, or false * @return true if the tunnel should be allowed to be closed, or false

4
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/event/listener/TunnelConnectListener.java
View File

@@ -6,7 +6,7 @@ import net.sourceforge.guacamole.net.event.TunnelConnectEvent;
/** /**
* A listener whose tunnelConnected() hook will fire immediately after a new * A listener whose tunnelConnected() hook will fire immediately after a new
* tunnel is connected. * tunnel is connected.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
public interface TunnelConnectListener { public interface TunnelConnectListener {
@@ -15,7 +15,7 @@ public interface TunnelConnectListener {
* Event hook which fires immediately after a new tunnel is connected. * Event hook which fires immediately after a new tunnel is connected.
* The return value of this hook dictates whether the tunnel is made visible * The return value of this hook dictates whether the tunnel is made visible
* to the session. * to the session.
* *
* @param e The TunnelConnectEvent describing the tunnel being connected and * @param e The TunnelConnectEvent describing the tunnel being connected and
* any associated credentials. * any associated credentials.
* @return true if the tunnel should be allowed to be connected, or false * @return true if the tunnel should be allowed to be connected, or false