GUACAMOLE-1: Refactor org.glyptodon package/groupId to org.apache.

guacamole-ext/src/main/java/org/apache/guacamole/protocols/ProtocolInfo.java

@@ -0,0 +1,122 @@
+/*
+ * Copyright (C) 2013 Glyptodon LLC
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.apache.guacamole.protocols;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import org.apache.guacamole.form.Form;
+
+/**
+ * Describes a protocol and all forms associated with it, as required by
+ * a protocol plugin for guacd. This class allows known forms for a
+ * protocol to be exposed to the user as friendly fields.
+ *
+ * @author Michael Jumper
+ */
+public class ProtocolInfo {
+
+    /**
+     * The unique name associated with this protocol.
+     */
+    private String name;
+
+    /**
+     * A collection of all associated protocol forms.
+     */
+    private Collection<Form> forms;
+
+    /**
+     * Creates a new ProtocolInfo with no associated name or forms.
+     */
+    public ProtocolInfo() {
+        this.forms = new ArrayList<Form>();
+    }
+
+    /**
+     * Creates a new ProtocolInfo having the given name, but without any forms.
+     *
+     * @param name
+     *     The unique name associated with the protocol.
+     */
+    public ProtocolInfo(String name) {
+        this.name  = name;
+        this.forms = new ArrayList<Form>();
+    }
+
+    /**
+     * Creates a new ProtocolInfo having the given name and forms.
+     *
+     * @param name
+     *     The unique name associated with the protocol.
+     *
+     * @param forms
+     *     The forms to associate with the protocol.
+     */
+    public ProtocolInfo(String name, Collection<Form> forms) {
+        this.name  = name;
+        this.forms = forms;
+    }
+
+    /**
+     * Returns the unique name of this protocol. The protocol name is the
+     * value required by the corresponding protocol plugin for guacd.
+     *
+     * @return The unique name of this protocol.
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the unique name of this protocol. The protocol name is the value
+     * required by the corresponding protocol plugin for guacd.
+     *
+     * @param name The unique name of this protocol.
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * Returns a mutable collection of the protocol forms associated with
+     * this protocol. Changes to this collection affect the forms exposed
+     * to the user.
+     *
+     * @return A mutable collection of protocol forms.
+     */
+    public Collection<Form> getForms() {
+        return forms;
+    }
+
+    /**
+     * Sets the collection of protocol forms associated with this
+     * protocol.
+     *
+     * @param forms
+     *     The collection of forms to associate with this protocol.
+     */
+    public void setForms(Collection<Form> forms) {
+        this.forms = forms;
+    }
+    
+}