
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):
 *
 * 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;


/**
 * A template which describes legal parameters and their values such that
 * a new configuration for a Guacamole connection can be created. A
 * GuacamoleConfigurationTemplate would normally be used to construct a
 * meaningful interface for a user, such that creating a new configuration
 * does not require reading the low-level documentation for a protocol.
 * 
 * @author Michael Jumper
 */
public interface GuacamoleConfigurationTemplate {

    /**
     * A field corresponding to a parameter of a GuacamoleConfiguration.
     */
    public interface Field {

        /**
         * The type of a field, dictating the data accepted and possibly the
         * manner of that field's presentation.
         */
        public enum Type {

            /**
             * A field whose values are arbitrary strings.
             */
            TEXT,

            /**
             * A field whose legal values are either "true" or "false".
             */
            BOOLEAN,

            /**
             * A field which can only have numeric values.
             */
            NUMERIC,

            /**
             * A field whose values are arbitrary, sensitive strings.
             */
            PASSWORD
            
        }

        /**
         * Returns the type of this field.
         * @return The type of this field.
         */
        Type getType();

        /**
         * Returns a human-readable description of the field.
         * @return A human-readable description of the field.
         */
        String getDescription();

        /**
         * Returns the set of all possible legal values for this field.
         * @return The set of all possible legal values for this field, or null
         *         if this field can have any value.
         */
        Collection<String> getDefaultValues();

    }
    
    /**
     * Returns the protocol that will be used by any configuration created
     * using this template.
     * 
     * @return The protocol that will be used by any configuration created
     *         using this template.
     */
    String getProtocol();
    
    /**
     * Returns the set of all available fields.
     * 
     * @return The set of all available fields.
     */
    Collection<Field> getFields();
    
}

@@ -3568,15 +3568,16 @@
  get
-Default
+Possible
 Valu

Rename field value function reasonably.