# AuthPlugin.java

    /*
    ** Module   : AuthPlugin.java
    ** Abstract : Container object which keeps information about a custom
    **            authentication plugin.
    **
    ** Copyright (c) 2010-2017, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ----------------Description-------------------------------
    ** 001 SVL 20100916 Created the initial version which keeps plugin class,
    **                  description and option.
    */
    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */
    package com.goldencode.p2j.security;

    import com.goldencode.p2j.admin.TaggedName;

    /**
     * Container object which keeps information about a custom authentication
     * plugin.
     */
    public class AuthPlugin
    {
       /** Plugin class as it is specified in the directory. */
       private String pluginClass;

       /** Plugin description. */
       private String description;

       /** Plugin "option" (specified in the directory). */
       private String option;

       /**
        * Creates an instance with the given parameters.
        *
        * @param  pluginClass
        *         Plugin class as it is specified in the directory.
        * @param  description
        *         Plugin description.
        * @param  option
        *         Plugin "option" (specified in the directory).
        */
       public AuthPlugin(String pluginClass, String description, String option)
       {
          this.pluginClass = pluginClass;
          this.description = description;
          this.option = option;
       }

       /**
        * Creates an instance from the tagged name object.
        *
        * @param  taggedName
        *         Tagged name object which contains auth plugin parameters.
        */
       public AuthPlugin(TaggedName taggedName)
       {
          pluginClass = (String) taggedName.getValueAt(0);
          description = (String) taggedName.getValueAt(1);
          option      = (String) taggedName.getValueAt(2);
       }

       /**
        * Get plugin class as it is specified in the directory.
        *
        * @return  See above.
        */
       public String getPluginClass()
       {
          return pluginClass;
       }

       /**
        * Get plugin description.
        *
        * @return  See above.
        */
       public String getDescription()
       {
          return description;
       }

       /**
        * Get plugin "option" (specified in the directory).
        *
        * @return  See above.
        */
       public String getOption()
       {
          return option;
       }

       /**
        * Stores auth plugin parameters into a tagged name object.
        *
        * @return  Tagged name object which contains auth plugin parameters.
        */
       public TaggedName toTaggedName()
       {
          return new TaggedName(pluginClass, description, option);
       }
    }