Ssh (rsync4j-core 3.1.2-14 API)

java.lang.Object
- com.github.fracpete.rsync4j.core.AbstractBinary
- - com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout
  - - com.github.fracpete.rsync4j.Ssh

```
public class Ssh
extends AbstractBinaryWithTimeout
```
Wrapper for the ssh binary.
NB: No interactive shell possible.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowRemoteConnect`
`protected boolean`	`background`
`protected java.lang.String`	`bindAddress`
`protected java.lang.String`	`cipherSpec`
`protected java.lang.String`	`command`
`protected boolean`	`compression`
`protected java.lang.String`	`configFile`
`protected java.lang.String`	`controlCommand`
`protected java.lang.String`	`controlSocket`
`protected java.lang.String`	`dynamicBindAddress`
`protected java.lang.String`	`escapeChar`
`protected java.lang.Boolean`	`forwardAgent`
`protected java.lang.String`	`forwardTo`
`protected java.lang.String`	`forwardTunnel`
`protected boolean`	`fromNull`
`protected java.lang.Boolean`	`gssapi`
`protected java.lang.String`	`hostname`
`protected java.lang.String`	`identifyFile`
`protected boolean`	`ipv4`
`protected boolean`	`ipv6`
`protected java.lang.String`	`local`
`protected java.lang.String`	`logFile`
`protected java.lang.String`	`loginName`
`protected java.lang.String`	`macSpec`
`protected boolean`	`masterMode`
`protected boolean`	`noRemoteExecute`
`protected java.util.List<java.lang.String>`	`option`
`protected java.lang.String`	`pkcs11`
`protected int`	`port`
`protected boolean`	`printConfig`
`protected java.lang.String`	`queryOption`
`protected boolean`	`quiet`
`protected java.lang.String`	`remote`
`protected boolean`	`subsystem`
`protected boolean`	`syslog`
`protected java.lang.Boolean`	`terminal`
`protected boolean`	`trustedX11`
`protected int`	`verbose`
`protected boolean`	`version`
`protected boolean`	`version1`
`protected boolean`	`version2`
`protected java.lang.Boolean`	`x11`

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout
max_time

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinary
logger, outputCommandline

Constructor Summary

Constructors
Constructor and Description

Ssh()

Constructors
Constructor and Description
`Ssh()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ssh`	`allowRemoteConnect(boolean value)`
`Ssh`	`background(boolean value)`
`Ssh`	`bindAddress(java.lang.String value)`
`Ssh`	`cipherSpec(java.lang.String value)`
`Ssh`	`command(java.lang.String value)`
`java.util.List<java.lang.String>`	`commandLineArgs()` Assembles the full command-line arguments.
`Ssh`	`compression(boolean value)`
`Ssh`	`configFile(java.lang.String value)`
`Ssh`	`controlCommand(java.lang.String value)`
`Ssh`	`controlSocket(java.lang.String value)`
`protected java.lang.String`	`description()` Returns a short description for the binary.
`Ssh`	`dynamicBindAddress(java.lang.String value)`
`Ssh`	`escapeChar(java.lang.String value)`
`Ssh`	`forwardAgent(java.lang.Boolean value)` Use null to set it to user/system default.
`Ssh`	`forwardTo(java.lang.String value)`
`Ssh`	`forwardTunnel(java.lang.String value)`
`Ssh`	`fromNull(boolean value)`
`boolean`	`getAllowRemoteConnect()`
`boolean`	`getBackground()`
`java.lang.String`	`getBindAddress()`
`java.lang.String`	`getCipherSpec()`
`java.lang.String`	`getCommand()`
`boolean`	`getCompression()`
`java.lang.String`	`getConfigFile()`
`java.lang.String`	`getControlCommand()`
`java.lang.String`	`getControlSocket()`
`java.lang.String`	`getDynamicBindAddress()`
`java.lang.String`	`getEscapeChar()`
`java.lang.Boolean`	`getForwardAgent()`
`java.lang.String`	`getForwardTo()`
`java.lang.String`	`getForwardTunnel()`
`boolean`	`getFromNull()`
`java.lang.Boolean`	`getGssapi()`
`java.lang.String`	`getHostname()`
`java.lang.String`	`getIdentifyFile()`
`boolean`	`getIpv4()`
`boolean`	`getIpv6()`
`java.lang.String`	`getLocal()`
`java.lang.String`	`getLogFile()`
`java.lang.String`	`getLoginName()`
`java.lang.String`	`getMacSpec()`
`boolean`	`getMasterMode()`
`boolean`	`getNoRemoteExecute()`
`java.util.List<java.lang.String>`	`getOption()`
`protected net.sourceforge.argparse4j.inf.ArgumentParser`	`getParser()` Configures and returns the commandline parser.
`java.lang.String`	`getPkcs11()`
`int`	`getPort()`
`boolean`	`getPrintConfig()`
`java.lang.String`	`getQueryOption()`
`boolean`	`getQuiet()`
`java.lang.String`	`getRemote()`
`boolean`	`getSubsystem()`
`boolean`	`getSyslog()`
`java.lang.Boolean`	`getTerminal()`
`boolean`	`getTrustedX11()`
`int`	`getVerbose()`
`boolean`	`getVersion()`
`boolean`	`getVersion1()`
`boolean`	`getVersion2()`
`java.lang.Boolean`	`getX11()`
`Ssh`	`gssapi(java.lang.Boolean value)` Use null to set it to user/system default.
`Ssh`	`hostname(java.lang.String value)`
`Ssh`	`identifyFile(java.lang.String value)`
`Ssh`	`ipv4(boolean value)`
`Ssh`	`ipv6(boolean value)`
`Ssh`	`local(java.lang.String value)`
`Ssh`	`logFile(java.lang.String value)`
`Ssh`	`loginName(java.lang.String value)`
`Ssh`	`macSpec(java.lang.String value)`
`static void`	`main(java.lang.String[] args)` For running from the command-line.
`Ssh`	`masterMode(boolean value)`
`Ssh`	`noRemoteExecute(boolean value)`
`Ssh`	`option(java.util.List<java.lang.String> value)`
`Ssh`	`option(java.lang.String... value)`
`java.util.List<java.lang.String>`	`options()` Assembles the arguments for the binary.
`Ssh`	`outputCommandline(boolean value)` Sets output commandline flag.
`Ssh`	`pkcs11(java.lang.String value)`
`Ssh`	`port(int value)`
`Ssh`	`printConfig(boolean value)`
`Ssh`	`queryOption(java.lang.String value)`
`Ssh`	`quiet(boolean value)`
`Ssh`	`remote(java.lang.String value)`
`void`	`reset()` Resets the members.
`protected boolean`	`setOptions(net.sourceforge.argparse4j.inf.Namespace ns)` Sets the parsed options.
`Ssh`	`subsystem(boolean value)`
`Ssh`	`syslog(boolean value)`
`Ssh`	`terminal(java.lang.Boolean value)` Use null to set it to user/system default.
`Ssh`	`trustedX11(boolean value)`
`Ssh`	`verbose(int value)`
`Ssh`	`version(boolean value)`
`Ssh`	`version1(boolean value)`
`Ssh`	`version2(boolean value)`
`Ssh`	`x11(java.lang.Boolean value)` Use null to set it to user/system default.

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout
execute, getMaxTime, maxTime

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinary
builder, getOutputCommandline, run, setOptions, start

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version1
```
protected boolean version1
```

version2
```
protected boolean version2
```

ipv4
```
protected boolean ipv4
```

ipv6
```
protected boolean ipv6
```

forwardAgent

protected java.lang.Boolean forwardAgent

bindAddress
```
protected java.lang.String bindAddress
```

compression
```
protected boolean compression
```

cipherSpec
```
protected java.lang.String cipherSpec
```

dynamicBindAddress

protected java.lang.String dynamicBindAddress

logFile
```
protected java.lang.String logFile
```

escapeChar
```
protected java.lang.String escapeChar
```

configFile
```
protected java.lang.String configFile
```

background
```
protected boolean background
```

printConfig
```
protected boolean printConfig
```

allowRemoteConnect
```
protected boolean allowRemoteConnect
```

pkcs11
```
protected java.lang.String pkcs11
```

identifyFile

protected java.lang.String identifyFile

gssapi
```
protected java.lang.Boolean gssapi
```

local
```
protected java.lang.String local
```

loginName
```
protected java.lang.String loginName
```

masterMode
```
protected boolean masterMode
```

macSpec
```
protected java.lang.String macSpec
```

noRemoteExecute
```
protected boolean noRemoteExecute
```

fromNull
```
protected boolean fromNull
```

controlCommand

protected java.lang.String controlCommand

option

protected java.util.List<java.lang.String> option

port
```
protected int port
```

queryOption
```
protected java.lang.String queryOption
```

quiet
```
protected boolean quiet
```

remote
```
protected java.lang.String remote
```

controlSocket

protected java.lang.String controlSocket

subsystem
```
protected boolean subsystem
```

terminal
```
protected java.lang.Boolean terminal
```

version
```
protected boolean version
```

verbose
```
protected int verbose
```

forwardTo
```
protected java.lang.String forwardTo
```

forwardTunnel

protected java.lang.String forwardTunnel

x11
```
protected java.lang.Boolean x11
```

trustedX11
```
protected boolean trustedX11
```

syslog
```
protected boolean syslog
```

hostname
```
protected java.lang.String hostname
```

command
```
protected java.lang.String command
```

Constructor Detail
- Ssh
```
public Ssh()
```

Method Detail

reset
```
public void reset()
```
Resets the members.

Overrides:

reset in class AbstractBinaryWithTimeout

outputCommandline
```
public Ssh outputCommandline(boolean value)
```
Sets output commandline flag.

Overrides:

outputCommandline in class AbstractBinary

Parameters:

value - true if to output commandline

Returns:

itself

version1
```
public Ssh version1(boolean value)
```

getVersion1
```
public boolean getVersion1()
```

version2
```
public Ssh version2(boolean value)
```

getVersion2
```
public boolean getVersion2()
```

ipv4
```
public Ssh ipv4(boolean value)
```

getIpv4
```
public boolean getIpv4()
```

ipv6
```
public Ssh ipv6(boolean value)
```

getIpv6
```
public boolean getIpv6()
```

forwardAgent
```
public Ssh forwardAgent(java.lang.Boolean value)
```
Use null to set it to user/system default. Other true/false to turn on/off.

Parameters:

value - the value, null for default

Returns:

itself

getForwardAgent

public java.lang.Boolean getForwardAgent()

bindAddress

public Ssh bindAddress(java.lang.String value)

getBindAddress

public java.lang.String getBindAddress()

compression

public Ssh compression(boolean value)

getCompression
```
public boolean getCompression()
```

cipherSpec

public Ssh cipherSpec(java.lang.String value)

getCipherSpec

public java.lang.String getCipherSpec()

dynamicBindAddress

public Ssh dynamicBindAddress(java.lang.String value)

getDynamicBindAddress

public java.lang.String getDynamicBindAddress()

logFile

public Ssh logFile(java.lang.String value)

getLogFile
```
public java.lang.String getLogFile()
```

escapeChar

public Ssh escapeChar(java.lang.String value)

getEscapeChar

public java.lang.String getEscapeChar()

configFile

public Ssh configFile(java.lang.String value)

getConfigFile

public java.lang.String getConfigFile()

background
```
public Ssh background(boolean value)
```

getBackground
```
public boolean getBackground()
```

printConfig

public Ssh printConfig(boolean value)

getPrintConfig
```
public boolean getPrintConfig()
```

allowRemoteConnect

public Ssh allowRemoteConnect(boolean value)

getAllowRemoteConnect

public boolean getAllowRemoteConnect()

pkcs11

public Ssh pkcs11(java.lang.String value)

getPkcs11
```
public java.lang.String getPkcs11()
```

identifyFile

public Ssh identifyFile(java.lang.String value)

getIdentifyFile

public java.lang.String getIdentifyFile()

gssapi
```
public Ssh gssapi(java.lang.Boolean value)
```
Use null to set it to user/system default. Other true/false to turn on/off.

Parameters:

value - the value, null for default

Returns:

itself

getGssapi
```
public java.lang.Boolean getGssapi()
```

local

public Ssh local(java.lang.String value)

getLocal
```
public java.lang.String getLocal()
```

loginName

public Ssh loginName(java.lang.String value)

getLoginName

public java.lang.String getLoginName()

masterMode
```
public Ssh masterMode(boolean value)
```

getMasterMode
```
public boolean getMasterMode()
```

macSpec

public Ssh macSpec(java.lang.String value)

getMacSpec
```
public java.lang.String getMacSpec()
```

noRemoteExecute

public Ssh noRemoteExecute(boolean value)

getNoRemoteExecute
```
public boolean getNoRemoteExecute()
```

fromNull
```
public Ssh fromNull(boolean value)
```

getFromNull
```
public boolean getFromNull()
```

controlCommand

public Ssh controlCommand(java.lang.String value)

getControlCommand

public java.lang.String getControlCommand()

option

public Ssh option(java.lang.String... value)

option

public Ssh option(java.util.List<java.lang.String> value)

getOption

public java.util.List<java.lang.String> getOption()

port
```
public Ssh port(int value)
```

getPort
```
public int getPort()
```

queryOption

public Ssh queryOption(java.lang.String value)

getQueryOption

public java.lang.String getQueryOption()

quiet
```
public Ssh quiet(boolean value)
```

getQuiet
```
public boolean getQuiet()
```

remote

public Ssh remote(java.lang.String value)

getRemote
```
public java.lang.String getRemote()
```

controlSocket

public Ssh controlSocket(java.lang.String value)

getControlSocket

public java.lang.String getControlSocket()

subsystem
```
public Ssh subsystem(boolean value)
```

getSubsystem
```
public boolean getSubsystem()
```

terminal
```
public Ssh terminal(java.lang.Boolean value)
```
Use null to set it to user/system default. Other true/false to turn on/off.

Parameters:

value - the value, null for default

Returns:

itself

getTerminal

public java.lang.Boolean getTerminal()

version
```
public Ssh version(boolean value)
```

getVersion
```
public boolean getVersion()
```

verbose
```
public Ssh verbose(int value)
```

getVerbose
```
public int getVerbose()
```

forwardTo

public Ssh forwardTo(java.lang.String value)

getForwardTo

public java.lang.String getForwardTo()

forwardTunnel

public Ssh forwardTunnel(java.lang.String value)

getForwardTunnel

public java.lang.String getForwardTunnel()

x11
```
public Ssh x11(java.lang.Boolean value)
```
Use null to set it to user/system default. Other true/false to turn on/off.

Parameters:

value - the value, null for default

Returns:

itself

getX11
```
public java.lang.Boolean getX11()
```

trustedX11
```
public Ssh trustedX11(boolean value)
```

getTrustedX11
```
public boolean getTrustedX11()
```

syslog
```
public Ssh syslog(boolean value)
```

getSyslog
```
public boolean getSyslog()
```

hostname

public Ssh hostname(java.lang.String value)

getHostname
```
public java.lang.String getHostname()
```

command

public Ssh command(java.lang.String value)

getCommand
```
public java.lang.String getCommand()
```

options
```
public java.util.List<java.lang.String> options()
                                         throws java.lang.Exception
```
Assembles the arguments for the binary.

Specified by:

options in class AbstractBinary

Returns:

the options

Throws:

java.lang.Exception - if failed to determine binary

commandLineArgs
```
public java.util.List<java.lang.String> commandLineArgs()
                                                 throws java.lang.Exception
```
Assembles the full command-line arguments.

Specified by:

commandLineArgs in class AbstractBinary

Returns:

the command-line arguments

Throws:

java.lang.Exception - if failed to determine binary

See Also:

options()

description
```
protected java.lang.String description()
```
Returns a short description for the binary.

Specified by:

description in class AbstractBinary

Returns:

the description

getParser
```
protected net.sourceforge.argparse4j.inf.ArgumentParser getParser()
```
Configures and returns the commandline parser.

Overrides:

getParser in class AbstractBinaryWithTimeout

Returns:

the parser

setOptions
```
protected boolean setOptions(net.sourceforge.argparse4j.inf.Namespace ns)
```
Sets the parsed options.

Overrides:

setOptions in class AbstractBinaryWithTimeout

Parameters:

ns - the parsed options

Returns:

if successfully set

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

For running from the command-line.

Parameters:: args - the arguments
Throws:: java.lang.Exception

Class Ssh

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

version1

version2

ipv4

ipv6

forwardAgent

bindAddress

compression

cipherSpec

dynamicBindAddress

logFile

escapeChar

configFile

background

printConfig

allowRemoteConnect

pkcs11

identifyFile

gssapi

local

loginName

masterMode

macSpec

noRemoteExecute

fromNull

controlCommand

option

port

queryOption

quiet

remote

controlSocket

subsystem

terminal

version

verbose

forwardTo

forwardTunnel

x11

trustedX11

syslog

hostname

command

Constructor Detail

Ssh

Method Detail

reset

outputCommandline

version1

getVersion1

version2

getVersion2

ipv4

getIpv4

ipv6

getIpv6

forwardAgent

getForwardAgent

bindAddress

getBindAddress

compression

getCompression

cipherSpec

getCipherSpec

dynamicBindAddress

getDynamicBindAddress

logFile

getLogFile

escapeChar

getEscapeChar

configFile