Package com.github.fracpete.rsync4j.core

Class AbstractBinaryWithTimeout

java.lang.Object

com.github.fracpete.rsync4j.core.AbstractBinary

com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout

Direct Known Subclasses:

RSync, Ssh

public abstract class AbstractBinaryWithTimeout
extends AbstractBinary

Ancestor for binary wrappers that have an in-built timeout for operations.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
protected int	max_time

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinary

logger, outputCommandline, outputSingleCommandline

Constructor Summary

Constructors

Constructor	Description
AbstractBinaryWithTimeout()

Method Summary

Modifier and Type	Method	Description
com.github.fracpete.processoutput4j.output.CollectingProcessOutput	execute()	Executes the rsync binary for the platform and waits for its completion.
int	getMaxTime()	Returns the maximum time in seconds for the rsync process to run.
protected net.sourceforge.argparse4j.inf.ArgumentParser	getParser()	Configures and returns the commandline parser.
AbstractBinaryWithTimeout	maxTime(int max_time)	Sets the maximum time in seconds for the rsync process to run.
void	reset()	Resets the members.
static void	run(AbstractBinaryWithTimeout binary, java.lang.String[] args)	Runs the binary with the arguments.
protected boolean	setOptions(net.sourceforge.argparse4j.inf.Namespace ns)	Sets the parsed options.

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinary

builder, commandLine, commandLineArgs, description, getOutputCommandline, getOutputSingleCommandline, options, outputCommandline, outputSingleCommandline, run, setOptions, start

Methods inherited from class java.lang.Object

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

Field Detail

max_time

protected int max_time

Constructor Detail

AbstractBinaryWithTimeout

public AbstractBinaryWithTimeout()

Method Detail

reset

public void reset()

Resets the members.

Overrides:

reset in class AbstractBinary

getMaxTime

public int getMaxTime()

Returns the maximum time in seconds for the rsync process to run.

Returns:

the maximum in seconds, ignored if less than 1

maxTime

public AbstractBinaryWithTimeout maxTime(int max_time)

Sets the maximum time in seconds for the rsync process to run.

Parameters:

max_time - the maximum time in seconds, ignored if less than 1

Returns:

itself

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 AbstractBinary.start() and monitor the output yourself.

Overrides:

execute in class AbstractBinary

Returns:

the process result object

Throws:

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

See Also:

AbstractBinary.commandLineArgs()

getParser

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

Configures and returns the commandline parser.

Overrides:

getParser in class AbstractBinary

Returns:

the parser

setOptions

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

Sets the parsed options.

Overrides:

setOptions in class AbstractBinary

Parameters:

ns - the parsed options

Returns:

if successfully set

run

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

Runs the binary with the arguments.

Parameters:

args - the arguments

Throws:

java.lang.Exception