ProcessBuilderParameters.java
/*
** Module : ProcessBuilderParameters.java
** Abstract : store the process parameters.
**
** Copyright (c) 2014-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ------------------------------------Description-----------------------------------------
** 001 MAG 20140224 First version.
** 002 GES 20211004 Changed log file name timestamp replacement to be a sortable date instead of millis.
** 003 GBB 20230512 Logging methods replaced by CentralLogger/ConversionStatus.
** 004 GBB 20230602 Add default value for outputToFile and set /dev/null for appserver. Date consistent
** with other log files.
** 005 GBB 20240709 Making all fields immutable. Implement isPasswordAuthentication.
*/
/*
** 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 com.goldencode.p2j.net.*;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.logging.*;
import com.goldencode.p2j.security.SecurityManager;
/**
* This structure holds process parameters to create and spawn a P2J client process.
*/
public class ProcessBuilderParameters
extends ClientBuilderParameters
{
/** Default file name for the client output. */
private static final String DEFAULT_OUTPUT_TO_FILE = "client_stdout_%timestamp%_%userid%_%pid%.log";
/** Default options from directory */
private final ProcessBuilderOptions options;
/** Output file (optional) to redirect STDOUT */
private final String outputToFile;
/**
* Constructor.
*
* @param osUser
* The OS account username.
* @param osPass
* The OS account password.
* @param options
* A ProcessBuilderOptions instance.
*/
public ProcessBuilderParameters(String osUser, String osPass, ProcessBuilderOptions options)
{
super(osUser,
osPass,
SessionManager.get().config().getInt(ConfigItem.SERVER_SECURE_PORT, -1),
SecurityManager.getInstance().getServerAlias());
this.options = options;
String process = options.getProcess();
String appServer = SecurityManager.getInstance().getAppserverForProcess(process);
if (appServer != null)
{
this.outputToFile = "/dev/null";
}
else
{
String outputToFile = options.getOutputToFile();
if (outputToFile == null)
{
outputToFile = DEFAULT_OUTPUT_TO_FILE;
}
this.outputToFile = outputToFile.replace("%userid%", process)
.replace("%timestamp%", LoggingUtil.formatNow())
// left for backwards compatibility
.replace("_%appserver%", "")
.replace("%appserver%", "");
}
}
/**
* Returns the directory values to be used by the process builder.
*
* @return See above.
*/
@Override
public ProcessBuilderOptions getDirOptions()
{
return options;
}
/**
* Get the authentication mode for this spawner.
*
* @return {@code true} indicating that the user's password is required for authentication.
*/
@Override
public boolean isPasswordAuthentication()
{
return false;
}
/**
* Build a file name for outpuToFile option based on a template. The place holders {@code %userid%},
* {@code %timestamp%} and {@code %appserver%} are substituted with the process account name, a
* sortable date/time in milliseconds (for the current moment in time) and the application server
* name defined for this account (if configured).
*
* %return The configured file name with replaced place holders.
*/
public String getOutputToFile()
{
return outputToFile;
}
}