diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnection.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnection.java index df159183c..27bb7d263 100644 --- a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnection.java +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnection.java @@ -86,7 +86,7 @@ public abstract class AbstractConnection implements Connection { @Override public boolean equals(Object obj) { - // Not equal if null or not a User + // Not equal if null or not a Connection if (obj == null) return false; if (!(obj instanceof AbstractConnection)) return false; diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnectionGroup.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnectionGroup.java new file mode 100644 index 000000000..485979fd6 --- /dev/null +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/AbstractConnectionGroup.java @@ -0,0 +1,87 @@ + +package net.sourceforge.guacamole.net.auth; + +/* ***** BEGIN LICENSE BLOCK ***** + * Version: MPL 1.1/GPL 2.0/LGPL 2.1 + * + * The contents of this file are subject to the Mozilla Public License Version + * 1.1 (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.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the + * License. + * + * The Original Code is guacamole-ext. + * + * The Initial Developer of the Original Code is + * Michael Jumper. + * Portions created by the Initial Developer are Copyright (C) 2010 + * the Initial Developer. All Rights Reserved. + * + * Contributor(s): James Muehlner + * + * Alternatively, the contents of this file may be used under the terms of + * either the GNU General Public License Version 2 or later (the "GPL"), or + * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), + * in which case the provisions of the GPL or the LGPL are applicable instead + * of those above. If you wish to allow use of your version of this file only + * under the terms of either the GPL or the LGPL, and not to allow others to + * use your version of this file under the terms of the MPL, indicate your + * decision by deleting the provisions above and replace them with the notice + * and other provisions required by the GPL or the LGPL. If you do not delete + * the provisions above, a recipient may use your version of this file under + * the terms of any one of the MPL, the GPL or the LGPL. + * + * ***** END LICENSE BLOCK ***** */ + + +/** + * Basic implementation of a Guacamole connection group. + * + * @author James Muehlner + */ +public abstract class AbstractConnectionGroup implements ConnectionGroup { + + /** + * The unique identifier associated with this connection group. + */ + 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 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); + + } + +} diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/Connection.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/Connection.java index fdfea4577..5dbba52e4 100644 --- a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/Connection.java +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/Connection.java @@ -52,7 +52,7 @@ import net.sourceforge.guacamole.protocol.GuacamoleConfiguration; * * @author Michael Jumper */ -public interface Connection { +public interface Connection extends ConnectionGroupMember { /** * Returns the unique identifier assigned to this Connection. diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/ConnectionGroup.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/ConnectionGroup.java new file mode 100644 index 000000000..28f38efc3 --- /dev/null +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/ConnectionGroup.java @@ -0,0 +1,96 @@ + +package net.sourceforge.guacamole.net.auth; + +/* ***** BEGIN LICENSE BLOCK ***** + * Version: MPL 1.1/GPL 2.0/LGPL 2.1 + * + * The contents of this file are subject to the Mozilla Public License Version + * 1.1 (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.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the + * License. + * + * The Original Code is guacamole-ext. + * + * The Initial Developer of the Original Code is + * Michael Jumper. + * Portions created by the Initial Developer are Copyright (C) 2010 + * the Initial Developer. All Rights Reserved. + * + * Contributor(s): James Muehlner + * + * Alternatively, the contents of this file may be used under the terms of + * either the GNU General Public License Version 2 or later (the "GPL"), or + * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), + * in which case the provisions of the GPL or the LGPL are applicable instead + * of those above. If you wish to allow use of your version of this file only + * under the terms of either the GPL or the LGPL, and not to allow others to + * use your version of this file under the terms of the MPL, indicate your + * decision by deleting the provisions above and replace them with the notice + * and other provisions required by the GPL or the LGPL. If you do not delete + * the provisions above, a recipient may use your version of this file under + * the terms of any one of the MPL, the GPL or the LGPL. + * + * ***** END LICENSE BLOCK ***** */ + +import java.util.Collection; +import net.sourceforge.guacamole.GuacamoleException; +import net.sourceforge.guacamole.net.GuacamoleSocket; +import net.sourceforge.guacamole.protocol.GuacamoleClientInformation; + + +/** + * Represents a pairing of a GuacamoleConfiguration with a unique, + * human-readable identifier, and abstracts the connection process. The + * backing GuacamoleConfiguration may be intentionally obfuscated or tokenized + * to protect sensitive configuration information. + * + * @author James Muehlner + */ +public interface ConnectionGroup extends ConnectionGroupMember { + + /** + * Returns the unique identifier assigned to this ConnectionGroup. + * @return The unique identifier assigned to this ConnectionGroup. + */ + public String getIdentifier(); + + /** + * Sets the identifier assigned to this Connection group. + * + * @param identifier The identifier to assign. + */ + public void setIdentifier(String identifier); + + /** + * Returns all members of this ConnectionGroup. + * @return all members of this ConnectionGroup. + */ + public Collection getMembers(); + + /** + * Sets the new members for this ConnectionGroup. + * + * @param members The new members for this grouConnectionGroupp. + */ + public void setMembers(Collection members); + + /** + * Establishes a connection to guacd using a connection chosen from among + * the connections in this ConnectionGroup, and returns the resulting, + * connected GuacamoleSocket. + * + * @param info Information associated with the connecting client. + * @return A fully-established GuacamoleSocket. + * + * @throws GuacamoleException If an error occurs while connecting to guacd, + * or if permission to connect is denied. + */ + public GuacamoleSocket connect(GuacamoleClientInformation info) + throws GuacamoleException; + +} diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/ConnectionGroupMember.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/ConnectionGroupMember.java new file mode 100644 index 000000000..ad0df292b --- /dev/null +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/ConnectionGroupMember.java @@ -0,0 +1,46 @@ + +package net.sourceforge.guacamole.net.auth; + +/* ***** BEGIN LICENSE BLOCK ***** + * Version: MPL 1.1/GPL 2.0/LGPL 2.1 + * + * The contents of this file are subject to the Mozilla Public License Version + * 1.1 (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.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the + * License. + * + * The Original Code is guacamole-ext. + * + * The Initial Developer of the Original Code is + * Michael Jumper. + * Portions created by the Initial Developer are Copyright (C) 2010 + * the Initial Developer. All Rights Reserved. + * + * Contributor(s): James Muehlner + * + * Alternatively, the contents of this file may be used under the terms of + * either the GNU General Public License Version 2 or later (the "GPL"), or + * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), + * in which case the provisions of the GPL or the LGPL are applicable instead + * of those above. If you wish to allow use of your version of this file only + * under the terms of either the GPL or the LGPL, and not to allow others to + * use your version of this file under the terms of the MPL, indicate your + * decision by deleting the provisions above and replace them with the notice + * and other provisions required by the GPL or the LGPL. If you do not delete + * the provisions above, a recipient may use your version of this file under + * the terms of any one of the MPL, the GPL or the LGPL. + * + * ***** END LICENSE BLOCK ***** */ + + +/** + * Represents a constituent member of a ConnectionGroup. + * + * @author James Muehlner + */ +public interface ConnectionGroupMember {} diff --git a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/UserContext.java b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/UserContext.java index 26ef62398..e94b922ca 100644 --- a/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/UserContext.java +++ b/guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/UserContext.java @@ -21,7 +21,7 @@ package net.sourceforge.guacamole.net.auth; * Portions created by the Initial Developer are Copyright (C) 2010 * the Initial Developer. All Rights Reserved. * - * Contributor(s): + * Contributor(s): James Muehlner * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or @@ -83,4 +83,18 @@ public interface UserContext { Directory getConnectionDirectory() throws GuacamoleException; + /** + * Retrieves a Directory which can be used to view and manipulate + * connection groups and their members, but only as allowed by the + * permissions given to the user of this UserContext. + * + * @return A Directory whose operations are bound by the restrictions + * of this UserContext. + * + * @throws GuacamoleException If an error occurs while creating the + * Directory. + */ + Directory getConnectionGroupDirectory() + throws GuacamoleException; + }