# BrokerSpawnParameters.java

    /*
    ** Module   : BrokerSpawnParameters.java
    ** Abstract : remote launch parameters.
    **
    ** Copyright (c) 2014-2020, Golden Code Development Corporation.

    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 MAG 20140707 Implements remote launcher (broker).
    ** 002 IAS 20200914 Re-work (de)serialization
    */
    /*
    ** 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.main;

    import static com.goldencode.util.NativeTypeSerializer.*;
    import java.io.*;
    import java.util.*;

    import com.goldencode.util.*;

    /**
     * This class holds the spawn command line parameters.
     */
    public class BrokerSpawnParameters
    implements Externalizable
    {
       /** Password require for authentication */
       private boolean passwordAuthentication = false;

       /** Password used to authenticate */
       private String password;

       /** A Map of environment variables */
       private Map<String, String> environment;

       /** A collection of command line tokens */
       private List<String> command = new LinkedList<String>();

       /**
        * Default constructor
        */
       public BrokerSpawnParameters()
       {
          super();
       }
       /**
        * Check if password require for authentication.
        *
        * @return  <code>true</code> if password is required.
        */
       public boolean isPasswordAuthentication()
       {
          return passwordAuthentication;
       }

       /**
        * Set if password is required for authentication.
        *
        * @param   passwordAuthentication
        *          <code>true</code> if password is required.
        */
       public void setPasswordAuthentication(boolean passwordAuthentication)
       {
          this.passwordAuthentication = passwordAuthentication;
       }

       /**
        * Get password for authentication.
        *
        * @return  Password string.
        */
       public String getPassword()
       {
          return password;
       }

       /**
        * Set password for authentication.
        *
        * @param   password
        *          Password string.
        */
       public void setPassword(String password)
       {
          this.password = password;
       }

       /**
        * Get environment variables.
        *
        * @return  Environment variables.
        */
       public Map<String, String> getEnvironment()
       {
          return environment;
       }

       /**
        * Set environment variables.
        *
        * @param   environment
        *          Environment variables.
        */
       public void setEnvironment(Map<String, String> environment)
       {
          this.environment = environment;
       }

       /**
        * Get command arguments.
        *
        * @return  Command arguments list.
        */
       public List<String> getCommand()
       {
          return command;
       }

       /**
        * Set command arguments.
        *
        * @param   command
        *          Command arguments list.
        */
       public void setCommand(List<String> command)
       {
          this.command = command;
       }

       /**
        * Replacement for the default object writing method.
        *
        * @param    out
        *           The output destination to which fields will be saved.
        *
        * @throws   IOException
        *           In case of I/O errors.
        */
       @Override
       public void writeExternal(ObjectOutput out) throws IOException
       {
          out.writeBoolean(passwordAuthentication);
          writeString(out, password);
          writeMap(out, environment, ObjectOutput::writeUTF, ObjectOutput::writeUTF);
          writeList(out, NativeTypeSerializer::writeString, command);
       }

       /**
        * Replacement for the default object reading method.
        *
        * @param    in
        *           Input source from which fields will be restored.
        *
        * @throws   IOException
        *           In case of I/O errors.
        * @throws   ClassNotFoundException
        *           If payload can't be instantiated.
        */
       @Override
       public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
       {
          passwordAuthentication = in.readBoolean();
          password = readString(in);
          environment   = readMap(in, HashMap::new, ObjectInput::readUTF, ObjectInput::readUTF);
          command = readList(in, n -> new LinkedList<>(), NativeTypeSerializer::readString);
       }
    }