mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-11 07:27:42 +00:00
GUACAMOLE-224: Remove @author tags from codebase.
This commit is contained in:
Michael Jumper
@@ -25,8 +25,6 @@ import org.apache.guacamole.net.GuacamoleTunnel;
|
||||
/**
|
||||
* Base implementation of an ActiveConnection, providing storage and simply
|
||||
* getters/setters for its main properties.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class AbstractActiveConnection extends AbstractIdentifiable
|
||||
implements ActiveConnection {
|
||||
|
||||
@@ -23,8 +23,6 @@ package org.apache.guacamole.net.auth;
|
||||
/**
|
||||
* Basic implementation of an AuthenticatedUser which uses the username to
|
||||
* determine equality. Username comparison is case-sensitive.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class AbstractAuthenticatedUser extends AbstractIdentifiable
|
||||
implements AuthenticatedUser {
|
||||
|
||||
@@ -26,8 +26,6 @@ import org.apache.guacamole.protocol.GuacamoleConfiguration;
|
||||
|
||||
/**
|
||||
* Basic implementation of a Guacamole connection.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class AbstractConnection extends AbstractIdentifiable
|
||||
implements Connection {
|
||||
|
||||
@@ -21,8 +21,6 @@ package org.apache.guacamole.net.auth;
|
||||
|
||||
/**
|
||||
* Basic implementation of a Guacamole connection group.
|
||||
*
|
||||
* @author James Muehlner
|
||||
*/
|
||||
public abstract class AbstractConnectionGroup extends AbstractIdentifiable
|
||||
implements ConnectionGroup {
|
||||
|
||||
@@ -24,8 +24,6 @@ package org.apache.guacamole.net.auth;
|
||||
* Abstract implementation of Identifiable which provides equals() and
|
||||
* hashCode() implementations which use the identifier to determine equality.
|
||||
* The identifier comparison is case-sensitive.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class AbstractIdentifiable implements Identifiable {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import java.util.Map;
|
||||
/**
|
||||
* Base implementation of a sharing profile which can be used to share a
|
||||
* Guacamole connection.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class AbstractSharingProfile implements SharingProfile {
|
||||
|
||||
|
||||
@@ -23,8 +23,6 @@ package org.apache.guacamole.net.auth;
|
||||
/**
|
||||
* Basic implementation of a Guacamole user which uses the username to
|
||||
* determine equality. Username comparison is case-sensitive.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class AbstractUser extends AbstractIdentifiable
|
||||
implements User {
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.net.GuacamoleTunnel;
|
||||
/**
|
||||
* A pairing of username and GuacamoleTunnel representing an active usage of a
|
||||
* particular connection.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface ActiveConnection extends Identifiable, Shareable<SharingProfile> {
|
||||
|
||||
|
||||
@@ -23,8 +23,6 @@ package org.apache.guacamole.net.auth;
|
||||
/**
|
||||
* A user of the Guacamole web application who has been authenticated by an
|
||||
* AuthenticationProvider.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface AuthenticatedUser extends Identifiable {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
* Provides means of authorizing users and for accessing and managing data
|
||||
* associated with those users. Access to such data is limited according to the
|
||||
* AuthenticationProvider implementation.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface AuthenticationProvider {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.protocol.GuacamoleClientInformation;
|
||||
|
||||
/**
|
||||
* An object which Guacamole can connect to.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface Connectable {
|
||||
|
||||
|
||||
@@ -30,8 +30,6 @@ import org.apache.guacamole.protocol.GuacamoleConfiguration;
|
||||
* human-readable identifier, and abstracts the connection process. The
|
||||
* backing GuacamoleConfiguration may be intentionally obfuscated or tokenized
|
||||
* to protect sensitive configuration information.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface Connection extends Identifiable, Connectable {
|
||||
|
||||
|
||||
@@ -26,8 +26,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
/**
|
||||
* Represents a connection group, which can contain both other connection groups
|
||||
* as well as connections.
|
||||
*
|
||||
* @author James Muehlner
|
||||
*/
|
||||
public interface ConnectionGroup extends Identifiable, Connectable {
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ import java.util.Date;
|
||||
/**
|
||||
* A logging record describing when a user started and ended usage of a
|
||||
* particular connection.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface ConnectionRecord {
|
||||
|
||||
|
||||
@@ -24,9 +24,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
|
||||
/**
|
||||
* The set of all available connection records, or a subset of those records.
|
||||
*
|
||||
* @author James Muehlner
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface ConnectionRecordSet {
|
||||
|
||||
|
||||
@@ -31,8 +31,6 @@ import javax.servlet.http.HttpSession;
|
||||
*
|
||||
* This class is used along with AuthenticationProvider to provide arbitrary
|
||||
* HTTP-based authentication for Guacamole.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class Credentials implements Serializable {
|
||||
|
||||
|
||||
@@ -29,7 +29,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
* are not necessarily backed by the stored objects, thus updating an object
|
||||
* always requires calling the update() function.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
* @param <ObjectType>
|
||||
* The type of objects stored within this Directory.
|
||||
*/
|
||||
|
||||
@@ -22,8 +22,6 @@ package org.apache.guacamole.net.auth;
|
||||
/**
|
||||
* An object which has a deterministic, unique identifier, which may not be
|
||||
* null.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface Identifiable {
|
||||
|
||||
|
||||
@@ -30,8 +30,6 @@ import org.apache.guacamole.net.auth.credentials.UserCredentials;
|
||||
* @param <T>
|
||||
* The type of object which dictates the semantics/restrictions of shared
|
||||
* objects.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface Shareable<T> {
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ import java.util.Map;
|
||||
/**
|
||||
* Represents the semantics which apply to an existing connection when shared,
|
||||
* along with a human-readable name and unique identifier.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface SharingProfile extends Identifiable {
|
||||
|
||||
|
||||
@@ -27,8 +27,6 @@ import org.apache.guacamole.net.auth.permission.SystemPermissionSet;
|
||||
|
||||
/**
|
||||
* A user of the Guacamole web application.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface User extends Identifiable {
|
||||
|
||||
|
||||
@@ -26,8 +26,6 @@ import org.apache.guacamole.form.Form;
|
||||
/**
|
||||
* The context of an active user. The functions of this class enforce all
|
||||
* permissions and act only within the rights of the associated user.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface UserContext {
|
||||
|
||||
|
||||
@@ -28,8 +28,6 @@ import org.apache.guacamole.form.UsernameField;
|
||||
|
||||
/**
|
||||
* Information which describes a set of valid credentials.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class CredentialsInfo {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.GuacamoleUnauthorizedException;
|
||||
* A security-related exception thrown when access is denied to a user because
|
||||
* of a problem related to the provided credentials. Additional information
|
||||
* describing the form of valid credentials is provided.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class GuacamoleCredentialsException extends GuacamoleUnauthorizedException {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ package org.apache.guacamole.net.auth.credentials;
|
||||
* The validity or invalidity of the given credentials is not specified, and
|
||||
* more information is needed before a decision can be made. Additional
|
||||
* information describing the form of valid credentials is provided.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class GuacamoleInsufficientCredentialsException extends GuacamoleCredentialsException {
|
||||
|
||||
|
||||
@@ -23,8 +23,6 @@ package org.apache.guacamole.net.auth.credentials;
|
||||
* A security-related exception thrown when access is denied to a user because
|
||||
* the provided credentials are invalid. Additional information describing
|
||||
* the form of valid credentials is provided.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class GuacamoleInvalidCredentialsException extends GuacamoleCredentialsException {
|
||||
|
||||
|
||||
@@ -29,8 +29,6 @@ import org.apache.guacamole.form.Field;
|
||||
* this object should describe a full set of parameter name/value pairs which
|
||||
* can be used to authenticate successfully, even if that success depends on
|
||||
* factors not described by this object.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class UserCredentials extends CredentialsInfo {
|
||||
|
||||
|
||||
@@ -23,8 +23,6 @@ package org.apache.guacamole.net.auth.permission;
|
||||
/**
|
||||
* A permission which affects a specific object, rather than the system as a
|
||||
* whole.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class ObjectPermission implements Permission<ObjectPermission.Type> {
|
||||
|
||||
|
||||
@@ -27,8 +27,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
/**
|
||||
* A set of permissions which affect arbitrary objects, where each object has
|
||||
* an associated unique identifier.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface ObjectPermissionSet extends PermissionSet<ObjectPermission> {
|
||||
|
||||
|
||||
@@ -24,9 +24,9 @@ package org.apache.guacamole.net.auth.permission;
|
||||
* A permission which affects a specific type of operation, where all available
|
||||
* operation types are defined by an enumeration.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
* @param <Type> The enumeration of all available operation types that this
|
||||
* permission can affect.
|
||||
* @param <Type>
|
||||
* The enumeration of all available operation types that this permission
|
||||
* can affect.
|
||||
*/
|
||||
public interface Permission<Type extends Enum> {
|
||||
|
||||
|
||||
@@ -26,7 +26,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
/**
|
||||
* An arbitrary set of permissions.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
* @param <PermissionType>
|
||||
* The type of permission stored within this PermissionSet.
|
||||
*/
|
||||
|
||||
@@ -23,8 +23,6 @@ package org.apache.guacamole.net.auth.permission;
|
||||
/**
|
||||
* A permission which affects the system as a whole, rather than an individual
|
||||
* object.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SystemPermission implements Permission<SystemPermission.Type> {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.GuacamoleException;
|
||||
|
||||
/**
|
||||
* A set of permissions which affects the system as a whole.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface SystemPermissionSet extends PermissionSet<SystemPermission> {
|
||||
|
||||
|
||||
@@ -40,8 +40,6 @@ import org.apache.guacamole.token.TokenFilter;
|
||||
*
|
||||
* The interface provided by SimpleAuthenticationProvider is similar to that of
|
||||
* the AuthenticationProvider interface of older Guacamole releases.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public abstract class SimpleAuthenticationProvider
|
||||
implements AuthenticationProvider {
|
||||
@@ -65,8 +63,6 @@ public abstract class SimpleAuthenticationProvider
|
||||
/**
|
||||
* AuthenticatedUser which contains its own predefined set of authorized
|
||||
* configurations.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
private class SimpleAuthenticatedUser extends AbstractAuthenticatedUser {
|
||||
|
||||
|
||||
@@ -38,8 +38,6 @@ import org.apache.guacamole.protocol.GuacamoleConfiguration;
|
||||
|
||||
/**
|
||||
* An extremely basic Connection implementation.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleConnection extends AbstractConnection {
|
||||
|
||||
|
||||
@@ -28,8 +28,6 @@ import org.apache.guacamole.net.auth.Connection;
|
||||
* An extremely simple read-only implementation of a Directory of
|
||||
* GuacamoleConfigurations which provides access to a pre-defined Map of
|
||||
* GuacamoleConfigurations.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleConnectionDirectory extends SimpleDirectory<Connection> {
|
||||
|
||||
|
||||
@@ -35,8 +35,6 @@ import org.apache.guacamole.protocol.GuacamoleClientInformation;
|
||||
* An extremely simple read-only implementation of a ConnectionGroup which
|
||||
* returns the connection and connection group identifiers it was constructed
|
||||
* with. Load balancing across this connection group is not allowed.
|
||||
*
|
||||
* @author James Muehlner
|
||||
*/
|
||||
public class SimpleConnectionGroup extends AbstractConnectionGroup {
|
||||
|
||||
|
||||
@@ -28,8 +28,6 @@ import org.apache.guacamole.net.auth.ConnectionGroup;
|
||||
* An extremely simple read-only implementation of a Directory of
|
||||
* ConnectionGroup which provides which provides access to a pre-defined
|
||||
* Collection of ConnectionGroups.
|
||||
*
|
||||
* @author James Muehlner
|
||||
*/
|
||||
public class SimpleConnectionGroupDirectory
|
||||
extends SimpleDirectory<ConnectionGroup> {
|
||||
|
||||
@@ -27,8 +27,6 @@ import org.apache.guacamole.net.auth.ConnectionRecordSet;
|
||||
|
||||
/**
|
||||
* An immutable and empty ConnectionRecordSet.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleConnectionRecordSet implements ConnectionRecordSet {
|
||||
|
||||
|
||||
@@ -34,7 +34,6 @@ import org.apache.guacamole.net.auth.Identifiable;
|
||||
* access to a pre-defined Map of arbitrary objects. Any changes to the Map
|
||||
* will affect the available contents of this SimpleDirectory.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
* @param <ObjectType>
|
||||
* The type of objects stored within this SimpleDirectory.
|
||||
*/
|
||||
|
||||
@@ -31,8 +31,6 @@ import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
|
||||
/**
|
||||
* A read-only implementation of ObjectPermissionSet which uses a backing Set
|
||||
* of Permissions to determine which permissions are present.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleObjectPermissionSet implements ObjectPermissionSet {
|
||||
|
||||
|
||||
@@ -29,8 +29,6 @@ import org.apache.guacamole.net.auth.permission.SystemPermissionSet;
|
||||
/**
|
||||
* A read-only implementation of SystemPermissionSet which uses a backing Set
|
||||
* of Permissions to determine which permissions are present.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleSystemPermissionSet implements SystemPermissionSet {
|
||||
|
||||
|
||||
@@ -32,8 +32,6 @@ import org.apache.guacamole.net.auth.permission.SystemPermissionSet;
|
||||
|
||||
/**
|
||||
* An extremely basic User implementation.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleUser extends AbstractUser {
|
||||
|
||||
|
||||
@@ -41,8 +41,6 @@ import org.apache.guacamole.protocol.GuacamoleConfiguration;
|
||||
* An extremely simple UserContext implementation which provides access to
|
||||
* a defined and restricted set of GuacamoleConfigurations. Access to
|
||||
* querying or modifying either users or permissions is denied.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleUserContext implements UserContext {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.net.auth.User;
|
||||
/**
|
||||
* An extremely simple read-only implementation of a Directory of Users which
|
||||
* provides access to a single pre-defined User.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class SimpleUserDirectory extends SimpleDirectory<User> {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.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 {
|
||||
|
||||
|
||||
@@ -26,8 +26,6 @@ import org.apache.guacamole.net.auth.UserContext;
|
||||
* 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 UserEvent, CredentialEvent {
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ import org.apache.guacamole.net.auth.Credentials;
|
||||
/**
|
||||
* Abstract basis for events which may have associated user credentials when
|
||||
* triggered.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface CredentialEvent {
|
||||
|
||||
|
||||
@@ -28,8 +28,6 @@ import org.apache.guacamole.net.auth.UserContext;
|
||||
* being closed can be accessed through getTunnel(), and the UserContext
|
||||
* associated with the request which is closing the tunnel can be retrieved
|
||||
* with getUserContext().
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class TunnelCloseEvent implements UserEvent, CredentialEvent, TunnelEvent {
|
||||
|
||||
|
||||
@@ -28,8 +28,6 @@ import org.apache.guacamole.net.auth.UserContext;
|
||||
* being connected can be accessed through getTunnel(), and the UserContext
|
||||
* associated with the request which is connecting the tunnel can be retrieved
|
||||
* with getUserContext().
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public class TunnelConnectEvent implements UserEvent, CredentialEvent, TunnelEvent {
|
||||
|
||||
|
||||
@@ -23,8 +23,6 @@ import org.apache.guacamole.net.GuacamoleTunnel;
|
||||
|
||||
/**
|
||||
* Abstract basis for events associated with tunnels.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface TunnelEvent {
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ import org.apache.guacamole.net.auth.UserContext;
|
||||
/**
|
||||
* Abstract basis for events which may have an associated UserContext when
|
||||
* triggered.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface UserEvent {
|
||||
|
||||
|
||||
@@ -26,8 +26,6 @@ import org.apache.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 {
|
||||
|
||||
|
||||
@@ -27,8 +27,6 @@ import org.apache.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 {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.net.event.TunnelCloseEvent;
|
||||
/**
|
||||
* A listener whose tunnelClosed() hook will fire immediately after an
|
||||
* existing tunnel is closed.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface TunnelCloseListener {
|
||||
|
||||
|
||||
@@ -25,8 +25,6 @@ import org.apache.guacamole.net.event.TunnelConnectEvent;
|
||||
/**
|
||||
* A listener whose tunnelConnected() hook will fire immediately after a new
|
||||
* tunnel is connected.
|
||||
*
|
||||
* @author Michael Jumper
|
||||
*/
|
||||
public interface TunnelConnectListener {
|
||||
|
||||
|
||||
Reference in New Issue
Block a user