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

GUACAMOLE-5: Move common identifier equals() / hashCode() of abstract Identifiable implementations to common base class.

Browse Source
This commit is contained in:
Michael Jumper
2016-07-16 01:14:09 -07:00
parent 37e9de6dfe
commit 4e7f086f83
6 changed files with 92 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractActiveConnection.java
View File

@@ -22,12 +22,14 @@ package org.apache.guacamole.net.auth;
import java.util.Date;
import org.apache.guacamole.net.GuacamoleTunnel;
public abstract class AbstractActiveConnection implements ActiveConnection {
/**
* The identifier of this active connection.
*/
private String identifier;
/**
* 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 {
/**
* The identifier of the associated connection.
@@ -54,16 +56,6 @@ public abstract class AbstractActiveConnection implements ActiveConnection {
*/
private GuacamoleTunnel tunnel;
@Override
public String getIdentifier() {
return identifier;
}
@Override
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
@Override
public String getConnectionIdentifier() {
return connectionIdentifier;

42
guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractAuthenticatedUser.java
View File

@@ -26,45 +26,9 @@ package org.apache.guacamole.net.auth;
*
* @author Michael Jumper
*/
public abstract class AbstractAuthenticatedUser implements AuthenticatedUser {
public abstract class AbstractAuthenticatedUser extends AbstractIdentifiable
implements AuthenticatedUser {
/**
* The name of this user.
*/
private String username;
@Override
public String getIdentifier() {
return username;
}
@Override
public void setIdentifier(String username) {
this.username = username;
}
@Override
public int hashCode() {
if (username == null) return 0;
return username.hashCode();
}
@Override
public boolean equals(Object obj) {
// Not equal if null or not a User
if (obj == null) return false;
if (!(obj instanceof AbstractAuthenticatedUser)) return false;
// Get username
String objUsername = ((AbstractAuthenticatedUser) obj).username;
// If null, equal only if this username is null
if (objUsername == null) return username == null;
// Otherwise, equal only if strings are identical
return objUsername.equals(username);
}
// Prior functionality now resides within AbstractIdentifiable
}

41
guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractConnection.java
View File

@@ -26,17 +26,14 @@ import org.apache.guacamole.protocol.GuacamoleConfiguration;
*
* @author Michael Jumper
*/
public abstract class AbstractConnection implements Connection {
public abstract class AbstractConnection extends AbstractIdentifiable
implements Connection {
/**
* The name associated with this connection.
*/
private String name;
/**
* The unique identifier associated with this connection.
*/
private String identifier;
/**
* The unique identifier of the parent ConnectionGroup for
@@ -59,16 +56,6 @@ public abstract class AbstractConnection implements Connection {
this.name = name;
}
@Override
public String getIdentifier() {
return identifier;
}
@Override
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
@Override
public String getParentIdentifier() {
return parentIdentifier;
@@ -89,28 +76,4 @@ public abstract class AbstractConnection implements Connection {
this.configuration = configuration;
}
@Override
public int hashCode() {
if (identifier == null) return 0;
return identifier.hashCode();
}
@Override
public boolean equals(Object obj) {
// Not equal if null or not a Connection
if (obj == null) return false;
if (!(obj instanceof AbstractConnection)) return false;
// Get identifier
String objIdentifier = ((AbstractConnection) obj).identifier;
// If null, equal only if this identifier is null
if (objIdentifier == null) return identifier == null;
// Otherwise, equal only if strings are identical
return objIdentifier.equals(identifier);
}
}

42
guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractConnectionGroup.java
View File

@@ -24,18 +24,14 @@ package org.apache.guacamole.net.auth;
*
* @author James Muehlner
*/
public abstract class AbstractConnectionGroup implements ConnectionGroup {
public abstract class AbstractConnectionGroup extends AbstractIdentifiable
implements ConnectionGroup {
/**
* The name associated with this connection group.
*/
private String name;
/**
* The unique identifier associated with this connection group.
*/
private String identifier;
/**
* The unique identifier of the parent connection group for
* this connection group.
@@ -57,16 +53,6 @@ public abstract class AbstractConnectionGroup implements ConnectionGroup {
this.name = name;
}
@Override
public String getIdentifier() {
return identifier;
}
@Override
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
@Override
public String getParentIdentifier() {
return parentIdentifier;
@@ -87,28 +73,4 @@ public abstract class AbstractConnectionGroup implements ConnectionGroup {
this.type = type;
}
@Override
public int hashCode() {
if (identifier == null) return 0;
return identifier.hashCode();
}
@Override
public boolean equals(Object obj) {
// Not equal if null or not a ConnectionGroup
if (obj == null) return false;
if (!(obj instanceof AbstractConnectionGroup)) return false;
// Get identifier
String objIdentifier = ((AbstractConnectionGroup) obj).identifier;
// If null, equal only if this identifier is null
if (objIdentifier == null) return identifier == null;
// Otherwise, equal only if strings are identical
return objIdentifier.equals(identifier);
}
}

75
guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractIdentifiable.java Normal file
View File

@@ -0,0 +1,75 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
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 {
/**
* The unique string which identifies this object.
*/
private String identifier;
@Override
public String getIdentifier() {
return identifier;
}
@Override
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
@Override
public int hashCode() {
if (identifier == null)
return 0;
return identifier.hashCode();
}
@Override
public boolean equals(Object other) {
// Not equal if null or not the same type of object
if (other == null || getClass() != other.getClass())
return false;
// Get identifier of other object
String otherIdentifier = ((AbstractIdentifiable) other).getIdentifier();
// If null, equal only if this identifier is null
if (otherIdentifier == null)
return identifier == null;
// Otherwise, equal only if strings are identical
return otherIdentifier.equals(identifier);
}
}

42
guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractUser.java
View File

@@ -26,12 +26,8 @@ package org.apache.guacamole.net.auth;
*
* @author Michael Jumper
*/
public abstract class AbstractUser implements User {
/**
* The name of this user.
*/
private String username;
public abstract class AbstractUser extends AbstractIdentifiable
implements User {
/**
* This user's password. Note that while this provides a means for the
@@ -40,16 +36,6 @@ public abstract class AbstractUser implements User {
*/
private String password;
@Override
public String getIdentifier() {
return username;
}
@Override
public void setIdentifier(String username) {
this.username = username;
}
@Override
public String getPassword() {
return password;
@@ -60,28 +46,4 @@ public abstract class AbstractUser implements User {
this.password = password;
}
@Override
public int hashCode() {
if (username == null) return 0;
return username.hashCode();
}
@Override
public boolean equals(Object obj) {
// Not equal if null or not a User
if (obj == null) return false;
if (!(obj instanceof AbstractUser)) return false;
// Get username
String objUsername = ((AbstractUser) obj).username;
// If null, equal only if this username is null
if (objUsername == null) return username == null;
// Otherwise, equal only if strings are identical
return objUsername.equals(username);
}
}