ProcessLaunchTask.java

/*
** Module   : ProcessLaunchTask.java
** Abstract : Launcher for jobs targeting a P2J process.
**
** Copyright (c) 2014-2019, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 CA  20140206 First version.
** 002 CA  20191211 When spawning a Java process programmatically, allow the caller to pass 
**                  environment options specific to that call (beside any jvmArgs configured in 
**                  the directory).
*/
/*
** 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.scheduler;

import java.util.*;

import com.goldencode.p2j.main.*;
import com.goldencode.p2j.util.*;

/**
 * Implementation for launching a P2J process; this class must be executed under the server's
 * context.  If the P2J process is linked with an appserver, it will delegate the launching to
 * {@link AppServerLauncher#launch}.  Else, it will use the {@link ProcessClientSpawner 
 * spawner} infrastructure to start a P2J client.
 */
class ProcessLaunchTask
implements Runnable
{
   /** The P2J process subject ID. */
   private final String process;
   
   /** The environment properties. */
   private final Map<String, String> env;

   /**
    * Create a new launcher task for the given process.
    * 
    * @param    process
    *           The process subject ID.
    */
   public ProcessLaunchTask(String process)
   {
      this.process = process;
      this.env = null;
   }

   /**
    * Create a new launcher task for the given process.
    * 
    * @param    process
    *           The process subject ID.
    * @param    env
    *           Map of additional environment properties, in the <code>key=value</code> form.
    */
   public ProcessLaunchTask(String process, Map<String, String> env)
   {
      this.process = process;
      this.env = env;
   }
   
   /**
    * Calls {@link ProcessClientSpawner#launch(String)} to launch this P2J {@link #process}.
    */
   @Override
   public void run()
   {
      ProcessClientSpawner.launch(process, env);
   }
   
   /**
    * Get the string representation of this runner.
    */
   @Override
   public String toString()
   {
      return String.format("Launcher for process '%s'.", process);
   }
}