Ticket #263: Clarified permissioning.

guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/permission/ConnectionGroupPermission.java

@@ -0,0 +1,121 @@
+
+package net.sourceforge.guacamole.net.auth.permission;
+
+/* ***** 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 ***** */
+
+
+/**
+ * A permission which controls operations that directly affect a specific
+ * ConnectionGroup. Note that this permission only refers to the
+ * ConnectionGroup by its identifier. The actual ConnectionGroup
+ * is not stored within.
+ *
+ * @author James Muehlner
+ */
+public class ConnectionGroupPermission
+    implements ObjectPermission<String> {
+
+    /**
+     * The identifier of the GuacamoleConfiguration associated with the
+     * operation affected by this permission.
+     */
+    private String identifier;
+
+    /**
+     * The type of operation affected by this permission.
+     */
+    private ObjectPermission.Type type;
+
+    /**
+     * Creates a new ConnectionGroupPermission having the given type
+     * and identifier. The identifier must be the unique identifier assigned
+     * to the ConnectionGroup by the AuthenticationProvider in use.
+     *
+     * @param type The type of operation affected by this permission.
+     * @param identifier The identifier of the ConnectionGroup associated
+     *                   with the operation affected by this permission.
+     */
+    public ConnectionGroupPermission(ObjectPermission.Type type, String identifier) {
+
+        this.identifier = identifier;
+        this.type = type;
+
+    }
+
+    @Override
+    public String getObjectIdentifier() {
+        return identifier;
+    }
+
+    @Override
+    public ObjectPermission.Type getType() {
+        return type;
+    }
+
+    @Override
+    public int hashCode() {
+        int hash = 5;
+        if (identifier != null) hash = 47 * hash + identifier.hashCode();
+        if (type != null)       hash = 47 * hash + type.hashCode();
+        return hash;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+
+        // Not equal if null or wrong type
+        if (obj == null) return false;
+        if (getClass() != obj.getClass()) return false;
+
+        final ConnectionGroupPermission other =
+                (ConnectionGroupPermission) obj;
+
+        // Not equal if different type
+        if (this.type != other.type)
+            return false;
+
+        // If null identifier, equality depends on whether other identifier
+        // is null
+        if (identifier == null)
+            return other.identifier == null;
+
+        // Otherwise, equality depends entirely on identifier
+        return identifier.equals(other.identifier);
+
+    }
+
+}