Package com.iizix.run.common
Interface ICommonJobs
- All Known Implementing Classes:
CommonJobs
public interface ICommonJobs
Interface used for common jobs.- Author:
- Christopher Mindus
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
destroyProcess()
Destroys a potentially executing process.void
downloadExtractArchive(java.io.File jarExe, java.io.File tempDir, java.lang.String url, java.io.File dest)
Creates a temporary folder and downloads and extracts an archive file that contains a single directory with some name.void
downloadFile(java.lang.String webFile, java.io.File destFile)
Download a file using HTTP.default int
exec(boolean showOutput, java.io.File dir, java.util.Map<java.lang.String,java.lang.String> env, java.lang.StringBuilder output, java.lang.String... commands)
Executes a short command, typically for testing.default int
exec(boolean showOutput, java.io.File dir, java.util.Map<java.lang.String,java.lang.String> env, java.lang.StringBuilder output, java.util.List<java.lang.String> commands)
Executes a short command, typically for testing.int
exec(boolean showOutput, java.lang.String echo, java.io.File dir, java.util.Map<java.lang.String,java.lang.String> env, java.lang.StringBuilder output, java.lang.String... commands)
Executes a short command, typically for testing.void
extractArchive(java.io.File jarExe, java.io.File archive, java.io.File dest, boolean deleteArchive)
Extracts an archive file.
Method Detail
destroyProcess
void destroyProcess()
Destroys a potentially executing process.
downloadFile
void downloadFile(java.lang.String webFile, java.io.File destFile) throws java.io.IOException, java.lang.InterruptedException
Download a file using HTTP.- Parameters:
webFile
- The web file using HTTP.destFile
- The local file system file where to place it.- Throws:
java.io.IOException
- For errors.java.lang.InterruptedException
- If the process is interrupted.
extractArchive
void extractArchive(java.io.File jarExe, java.io.File archive, java.io.File dest, boolean deleteArchive) throws java.io.IOException, java.lang.InterruptedException
Extracts an archive file.- Parameters:
jarExe
- The Jar executable.archive
- The file to extract.dest
- The directory to place the extracted files in.deleteArchive
- Flag to delete the archive.- Throws:
java.io.IOException
- For errors.java.lang.InterruptedException
- If the process is interrupted.
downloadExtractArchive
void downloadExtractArchive(java.io.File jarExe, java.io.File tempDir, java.lang.String url, java.io.File dest) throws java.io.IOException, java.lang.InterruptedException
Creates a temporary folder and downloads and extracts an archive file that contains a single directory with some name. This directory is then moved to the requested location and renamed.The extraction process is done using Java code and not with a Jar or other utility. Supported formats are ".zip", ".jar", ".tar", ".tar.gz".
- Parameters:
jarExe
- The Jar executable: if null, Java code will be used instead (also applies for ".tar" and ".tar.gz" file extensions.tempDir
- The temporary directory.url
- The archive file's URL to download.dest
- The destination directory.- Throws:
java.io.IOException
java.lang.InterruptedException
exec
default int exec(boolean showOutput, java.io.File dir, java.util.Map<java.lang.String,java.lang.String> env, java.lang.StringBuilder output, java.lang.String... commands) throws java.io.IOException, java.lang.InterruptedException
Executes a short command, typically for testing.- Parameters:
showOutput
- Shows the output of the process.dir
- Current directory for the process.env
- The environment to use, null for default.output
- The StringBuilder that is filled with the output from the process.commands
- Commands to execute.- Returns:
- The return value.
- Throws:
java.io.IOException
- For errors.java.lang.InterruptedException
- If the process is interrupted.
exec
default int exec(boolean showOutput, java.io.File dir, java.util.Map<java.lang.String,java.lang.String> env, java.lang.StringBuilder output, java.util.List<java.lang.String> commands) throws java.io.IOException, java.lang.InterruptedException
Executes a short command, typically for testing.- Parameters:
showOutput
- Shows the output of the process.dir
- Current directory for the process.env
- The environment to use, null for default.output
- The StringBuilder that is filled with the output from the process.commands
- Commands to execute.- Returns:
- The return value.
- Throws:
java.io.IOException
- For errors.java.lang.InterruptedException
- If the process is interrupted.
exec
int exec(boolean showOutput, java.lang.String echo, java.io.File dir, java.util.Map<java.lang.String,java.lang.String> env, java.lang.StringBuilder output, java.lang.String... commands) throws java.io.IOException, java.lang.InterruptedException
Executes a short command, typically for testing.- Parameters:
showOutput
- Shows the output of the process.echo
- If non-null, what is placed in the output stream.dir
- Current directory for the process.env
- The environment to use, null for default.output
- The StringBuilder that is filled with the output from the process.commands
- Commands to execute.- Returns:
- The return value.
- Throws:
java.io.IOException
- For errors.java.lang.InterruptedException
- If the process is interrupted.