com.github.fracpete.rsync4j.core

Class AbstractBinary

java.lang.Object

com.github.fracpete.rsync4j.core.AbstractBinary

Direct Known Subclasses:

AbstractBinaryWithTimeout, SshKeyGen

public abstract class AbstractBinary
extends java.lang.Object

Ancestor of wrappers for binaries.

Author:

fracpete (fracpete at gmail dot com)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger for logging.
protected boolean	outputCommandline whether to output the commandline.

Constructor Summary

Constructors

Constructor and Description
AbstractBinary() Initializes the object.

Method Summary

Modifier and Type	Method and Description
java.lang.ProcessBuilder	builder() Returns a configured ProcessBuilder to be used for executing the rsync process.
abstract java.util.List<java.lang.String>	commandLineArgs() Assembles the full command-line arguments.
protected abstract java.lang.String	description() Returns a short description for the binary.
com.github.fracpete.processoutput4j.output.CollectingProcessOutput	execute() Executes the rsync binary for the platform and waits for its completion.
boolean	getOutputCommandline() Returns output commandline flag.
protected net.sourceforge.argparse4j.inf.ArgumentParser	getParser() Configures and returns the commandline parser.
abstract java.util.List<java.lang.String>	options() Assembles the arguments for the rsync binary.
AbstractBinary	outputCommandline(boolean value) Sets output commandline flag.
void	reset() Resets the members.
static void	run(AbstractBinary binary, java.lang.String[] args) Runs the binary with the arguments.
protected boolean	setOptions(net.sourceforge.argparse4j.inf.Namespace ns) Sets the parsed options.
boolean	setOptions(java.lang.String[] options) Sets the commandline options.
java.lang.Process	start() Starts the rsync process for the platform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected java.util.logging.Logger logger

for logging.

outputCommandline

protected boolean outputCommandline

whether to output the commandline.

Constructor Detail

AbstractBinary

public AbstractBinary()

Initializes the object.

Method Detail

reset

public void reset()

Resets the members.

outputCommandline

public AbstractBinary outputCommandline(boolean value)

Sets output commandline flag.

Parameters:

value - true if to output commandline

Returns:

itself

getOutputCommandline

public boolean getOutputCommandline()

Returns output commandline flag.

Returns:

true if to output commandline

options

public abstract java.util.List<java.lang.String> options()
                                                  throws java.lang.Exception

Assembles the arguments for the rsync binary.

Returns:

the options

Throws:

java.lang.Exception - if failed to determine binary

commandLineArgs

public abstract java.util.List<java.lang.String> commandLineArgs()
                                                          throws java.lang.Exception

Assembles the full command-line arguments.

Returns:

the command-line arguments

Throws:

java.lang.Exception - if failed to determine binary

See Also:

options()

builder

public java.lang.ProcessBuilder builder()
                                 throws java.lang.Exception

Returns a configured ProcessBuilder to be used for executing the rsync process.

Returns:

the configured process builder

Throws:

java.lang.Exception - if execution fails or failed to determine binary

See Also:

commandLineArgs()

start

public java.lang.Process start()
                        throws java.lang.Exception

Starts the rsync process for the platform.
If you are not interested in an incremental progress output, then you can also use execute(), which waits for the process to finish while collecting stdout and stderr output.

Returns:

the process object

Throws:

java.lang.Exception - if execution fails or failed to determine binary

See Also:

builder()

execute

public com.github.fracpete.processoutput4j.output.CollectingProcessOutput execute()
                                                                           throws java.lang.Exception

Executes the rsync binary for the platform and waits for its completion. Collects stdout and stderr output in the result.
If you want an incremental output, you can use start() and monitor the output yourself.

Returns:

the process result object

Throws:

java.lang.Exception - if execution fails or failed to determine binary

See Also:

commandLineArgs()

description

protected abstract java.lang.String description()

Returns a short description for the binary.

Returns:

the description

getParser

protected net.sourceforge.argparse4j.inf.ArgumentParser getParser()

Configures and returns the commandline parser.

Returns:

the parser

setOptions

protected boolean setOptions(net.sourceforge.argparse4j.inf.Namespace ns)

Sets the parsed options.

Parameters:

ns - the parsed options

Returns:

if successfully set

setOptions

public boolean setOptions(java.lang.String[] options)
                   throws java.lang.Exception

Sets the commandline options.

Parameters:

options - the options to use

Returns:

true if successful

Throws:

java.lang.Exception - in case of an invalid option

run

public static void run(AbstractBinary binary,
                       java.lang.String[] args)
                throws java.lang.Exception

Runs the binary with the arguments.

Parameters:

args - the arguments

Throws:

java.lang.Exception