/*
    * This file is part of Waarp Project (named also Waarp or GG).
    *
    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
    * individual contributors.
    *
    *  All Waarp Project is free software: you can redistribute it and/or
    * modify it under the terms of the GNU General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or (at your
   * option) any later version.
   *
   * Waarp 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 General Public License for more details.
   *
   *  You should have received a copy of the GNU General Public License along with
   * Waarp . If not, see <http://www.gnu.org/licenses/>.
   */
  
  package org.waarp.openr66.protocol.http.restv2.utils;
  
  import org.waarp.common.role.RoleDefault;
  import org.waarp.openr66.database.data.DbTaskRunner;
  import org.waarp.openr66.pojo.Host;
  import org.waarp.openr66.pojo.Rule;
  import org.waarp.openr66.pojo.RuleTask;
  import org.waarp.openr66.pojo.Transfer;
  
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlElementWrapper;
  import javax.xml.bind.annotation.XmlList;
  import javax.xml.bind.annotation.XmlRootElement;
  import javax.xml.bind.annotation.XmlType;
  import java.util.ArrayList;
  import java.util.List;
  
  import static org.waarp.openr66.configuration.FileBasedElements.*;
  import static org.waarp.openr66.configuration.RuleFileBasedConfiguration.*;
  import static org.waarp.openr66.database.data.DbHostConfiguration.*;
  
  /**
   * An interface for POJOs used in XML (de)serialization.
   * <p>
   * Classes implementing this interface, as well as their fields' classes *MUST*
   * be annotated with the required
   * JAXB annotations to allow the objects to be marshalled and unmarshalled using
   * JAXB.
   *
   * @see javax.xml.bind.Marshaller
   * @see javax.xml.bind.Unmarshaller
   */
  @SuppressWarnings("CanBeFinal")
  @XmlRootElement
  @XmlAccessorType(XmlAccessType.NONE)
  public interface XmlSerializable {
  
    /**
     * A POJO representing a list of business ids for XML (de)serialisation
     * purposes.
     */
    @XmlRootElement(name = XML_BUSINESS)
    final class Businesses implements XmlSerializable {
      /**
       * The list of host names.
       */
      @XmlElement(name = XML_BUSINESSID)
      public List<String> business = new ArrayList<String>();
    }
  
    /**
     * A container for a list of roles for XML (de)serialisation purposes.
     */
    @XmlRootElement(name = XML_ROLES)
    final class Roles implements XmlSerializable {
      /**
       * The list of roles.
       */
      @XmlElement(name = XML_ROLE)
      public List<RoleEntry> roles = new ArrayList<RoleEntry>();
  
      public Roles() {
      }
  
      public Roles(final List<RoleEntry> roles) {
        this.roles = roles;
      }
  
      /**
       * A POJO representing a role entry for XML (de)serialisation purposes.
       */
      @XmlType
      public static final class RoleEntry {
        /**
         * The host's id.
         */
        @XmlElement(name = XML_ROLEID)
       public String hostName;
 
       /**
        * The list of allowed actions on the server.
        */
       @XmlElement(name = XML_ROLESET)
       @XmlList
       public List<RoleDefault.ROLE> roleList =
           new ArrayList<RoleDefault.ROLE>();
     }
   }
 
   /**
    * A container for a list of aliases for XML (de)serialisation purposes.
    */
   @XmlRootElement(name = XML_ALIASES)
   final class Aliases implements XmlSerializable {
     /**
      * The list of aliases.
      */
     @XmlElement(name = XML_ALIAS)
     public List<AliasEntry> aliases = new ArrayList<AliasEntry>();
 
     public Aliases() {
     }
 
     public Aliases(final List<AliasEntry> aliases) {
       this.aliases = aliases;
     }
 
     /**
      * A POJO representing an alias entry for XML (de)serialisation
      * purposes.
      */
     @XmlType
     public static final class AliasEntry {
       /**
        * The host's id.
        */
       @XmlElement(name = XML_REALID)
       public String hostName;
 
       /**
        * The list of the server's known aliases.
        */
       @XmlElement(name = XML_ALIASID)
       @XmlList
       public List<String> aliasList = new ArrayList<String>();
     }
   }
 
   /**
    * A container for a list of hosts for XML (de)serialisation purposes.
    */
   @XmlRootElement(name = XML_AUTHENTICATION_ROOT)
   final class Hosts implements XmlSerializable {
     /**
      * The list of {@link Host}.
      */
     @XmlElement(name = XML_AUTHENTICATION_ENTRY)
     public List<Host> hosts = new ArrayList<Host>();
 
     public Hosts() {
     }
 
     public Hosts(final List<Host> hosts) {
       this.hosts = hosts;
     }
   }
 
   /**
    * A container for a list of rules for XML (de)serialisation purposes.
    */
   @XmlRootElement(name = MULTIPLEROOT)
   final class Rules implements XmlSerializable {
     /**
      * The list of rules.
      */
     @XmlElement(name = ROOT)
     public List<Rule> rules = new ArrayList<Rule>();
 
     public Rules() {
     }
 
     public Rules(final List<Rule> rules) {
       this.rules = rules;
     }
 
     /**
      * A POJO representing a list of tasks for XML (de)serialisation
      * purposes.
      */
     @XmlType(name = XTASKS)
     public static final class Tasks {
       /**
        * The list of tasks.
        */
       @XmlElementWrapper(name = XTASKS)
       @XmlElement(name = XTASK)
       public List<RuleTask> tasks;
 
       public Tasks() {
       }
 
       public Tasks(final List<RuleTask> tasks) {
         this.tasks = tasks;
       }
     }
   }
 
   /**
    * container for a list of transfers for XML (de)serialisation purposes.
    */
   @XmlRootElement(name = DbTaskRunner.XMLRUNNERS)
   class Transfers implements XmlSerializable {
     @XmlElement(name = DbTaskRunner.XMLRUNNER)
     public List<Transfer> transfers = new ArrayList<Transfer>();
 
     public Transfers() {
     }
 
     public Transfers(final List<Transfer> transfers) {
       this.transfers = transfers;
     }
   }
 }