Package com.sshtools.client.tasks

Class CommandTask.CommandTaskBuilder

java.lang.Object

com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder<B,TT>

com.sshtools.client.tasks.AbstractSessionTask.AbstractSessionTaskBuilder<CommandTask.CommandTaskBuilder,SessionChannelNG,CommandTask>

com.sshtools.client.tasks.CommandTask.CommandTaskBuilder

Enclosing class:

CommandTask

public static final class CommandTask.CommandTaskBuilder
extends AbstractSessionTask.AbstractSessionTaskBuilder<CommandTask.CommandTaskBuilder,SessionChannelNG,CommandTask>

Builder for CommandTask.

Field Summary

Fields inherited from class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder

clientSupplier, connection

Method Summary

Modifier and Type	Method	Description
CommandTask	build()
static CommandTask.CommandTaskBuilder	create()	Create a new CommandTask.CommandTaskBuilder.
final CommandTask.CommandTaskBuilder	onBeforeExecute(CommandTask.CommandTaskEvent onBeforeExecute)	Set a callback to run before the command is executed.
final CommandTask.CommandTaskBuilder	onBeforeTask(CommandTask.CommandTaskEvent onOpen)	Set a callback to run when the command has been executed.
final CommandTask.CommandTaskBuilder	onClose(CommandTask.CommandTaskEvent onClose)	Set a callback to run when the command is closed.
final CommandTask.CommandTaskBuilder	onTask(CommandTask.CommandTaskEvent onExecute)	Set a callback to run when the command has been executed.
CommandTask.CommandTaskBuilder	withAutoConsume()	Set to auto-consume input.
CommandTask.CommandTaskBuilder	withAutoConsume(boolean autoConsume)	Set the whether to auto-consume input.
final CommandTask.CommandTaskBuilder	withColumns(int cols)	Set the terminal width in columns to use when allocating a PTY.
CommandTask.CommandTaskBuilder	withCommand(String command)	Set the command to run.
CommandTask.CommandTaskBuilder	withEncoding(String encoding)	Set the character encoding to use for transferring string content.
CommandTask.CommandTaskBuilder	withEncoding(Charset encoding)	Set the character encoding to use for transferring string content.
final CommandTask.CommandTaskBuilder	withModes(PseudoTerminalModes modes)	Set the terminal modes to use when allocating a PTY.
CommandTask.CommandTaskBuilder	withoutPty()	Do not to allocate a Pty.
CommandTask.CommandTaskBuilder	withPty(boolean withPty)	Set whether or not to allocate a Pty.
final CommandTask.CommandTaskBuilder	withRows(int rows)	Set the terminal height in rows to use when allocating a PTY.
final CommandTask.CommandTaskBuilder	withTermType(String termType)	Set the terminal type to use when allocating a PTY.
final CommandTask.CommandTaskBuilder	withTermType(Optional<String> termType)	Set the terminal type to use when allocating a PTY.

Methods inherited from class com.sshtools.client.tasks.AbstractSessionTask.AbstractSessionTaskBuilder

withFuture, withSession

Methods inherited from class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder

withClient, withClients, withConnection

Methods inherited from class java.lang.Object

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

Method Details

withAutoConsume

public CommandTask.CommandTaskBuilder withAutoConsume()

Set to auto-consume input. Will be ignored if AbstractSessionTask.AbstractSessionTaskBuilder.withSession(java.util.function.Function) has been used.

Returns:

this for chaining

withAutoConsume

public CommandTask.CommandTaskBuilder withAutoConsume(boolean autoConsume)

Set the whether to auto-consume input. Will be ignored if AbstractSessionTask.AbstractSessionTaskBuilder.withSession(java.util.function.Function) has been used.

Parameters:

autoConsume - auto consume

Returns:

this for chaining

withTermType

public final CommandTask.CommandTaskBuilder withTermType(String termType)

Set the terminal type to use when allocating a PTY. Note, this will have no effect if {withPty is set to false.

Parameters:

term - type

Returns:

builder for chaining

withTermType

public final CommandTask.CommandTaskBuilder withTermType(Optional<String> termType)

Set the terminal type to use when allocating a PTY. Note, this will have no effect if {withPty is set to false.

Parameters:

term - type

Returns:

builder for chaining

withColumns

public final CommandTask.CommandTaskBuilder withColumns(int cols)

Set the terminal width in columns to use when allocating a PTY. Note, this will have no effect if {withPty is set to false.

Parameters:

cols - cols

Returns:

builder for chaining

withRows

public final CommandTask.CommandTaskBuilder withRows(int rows)

Set the terminal height in rows to use when allocating a PTY. Note, this will have no effect if {withPty is set to false.

Parameters:

rows - row

Returns:

builder for chaining

withModes

public final CommandTask.CommandTaskBuilder withModes(PseudoTerminalModes modes)

Set the terminal modes to use when allocating a PTY. Note, this will have no effect if {withPty is set to false.

Parameters:

modes - modes

Returns:

builder for chaining

withPty

public CommandTask.CommandTaskBuilder withPty(boolean withPty)

Set whether or not to allocate a Pty. When set to true, other Pty characteristics can be set using builder methods such as withRows(int), withModes(PseudoTerminalModes) and others. By default a Pty is allocated.

Parameters:

withPty - whether to allocate a PTY.

Returns:

builder for chaining

withoutPty

public CommandTask.CommandTaskBuilder withoutPty()

Do not to allocate a Pty.

Parameters:

withPty - whether to allocate a PTY.

Returns:

builder for chaining

withCommand

public CommandTask.CommandTaskBuilder withCommand(String command)

Set the command to run. This is mandatory.

Parameters:

command - command

Returns:

this for chaining

withEncoding

public CommandTask.CommandTaskBuilder withEncoding(String encoding)

Set the character encoding to use for transferring string content.

Parameters:

encoding - encoding

Returns:

builder for chaining

withEncoding

public CommandTask.CommandTaskBuilder withEncoding(Charset encoding)

Set the character encoding to use for transferring string content.

Parameters:

encoding - encoding

Returns:

builder for chaining

create

public static CommandTask.CommandTaskBuilder create()

Create a new CommandTask.CommandTaskBuilder.

Returns:

builder

onBeforeExecute

public final CommandTask.CommandTaskBuilder onBeforeExecute(CommandTask.CommandTaskEvent onBeforeExecute)

Set a callback to run before the command is executed.

Parameters:

onBeforeExecute - on before execute callback

Returns:

builder for chaining

onClose

public final CommandTask.CommandTaskBuilder onClose(CommandTask.CommandTaskEvent onClose)

Set a callback to run when the command is closed.

Parameters:

onClose - on close callback

Returns:

builder for chaining

onBeforeTask

public final CommandTask.CommandTaskBuilder onBeforeTask(CommandTask.CommandTaskEvent onOpen)

Set a callback to run when the command has been executed. This should NOT block until the task is done.

Parameters:

onOpen - on session channel open

Returns:

builder for chaining

onTask

public final CommandTask.CommandTaskBuilder onTask(CommandTask.CommandTaskEvent onExecute)

Set a callback to run when the command has been executed. Here you can obtain I/O streams if required, and then block until the task is done. The channel backing this task will be closed when the callback exits. If you do not set this, AbstractSessionTask.close() should be called when the task is finished with.

Parameters:

onExecute - execute task

Returns:

builder for chaining

build

public CommandTask build()

Specified by:

build in class AbstractConnectionTask.AbstractConnectionTaskBuilder<CommandTask.CommandTaskBuilder,CommandTask>