org.hidetake.groovy.ssh.operation.CommandSettings.groovy Maven / Gradle / Ivy
package org.hidetake.groovy.ssh.operation
import groovy.transform.EqualsAndHashCode
import org.hidetake.groovy.ssh.core.settings.LoggingMethod
import org.hidetake.groovy.ssh.core.settings.SettingsHelper
import org.hidetake.groovy.ssh.core.settings.ToStringProperties
/**
* Settings for {@link Command}.
*
* @author Hidetake Iwata
*/
trait CommandSettings {
/**
* Ignores the exit status of the command or shell.
*/
Boolean ignoreError
/**
* PTY allocation flag.
* If true, PTY will be allocated on command execution.
*/
Boolean pty
/**
* Use agentForwarding flag.
* If true, agent will be forwarded to remote host.
*/
Boolean agentForwarding
/**
* A logging method of the remote command or shell.
*/
LoggingMethod logging
/**
* An input stream to send to the standard input.
* This should be a {@link InputStream}, {@code byte[]}, {@link String} or {@link File}.
*/
def inputStream
/**
* An output stream to receive from the standard output.
*/
OutputStream outputStream
/**
* An output stream to receive from the standard error.
*/
OutputStream errorStream
/**
* Encoding of input and output stream.
*/
String encoding
/**
* Stream interaction.
* @see org.hidetake.groovy.ssh.interaction.InteractionHandler
*/
Closure interaction
/**
* Timeout for the command channel to be connected in seconds.
* @see org.hidetake.groovy.ssh.connection.ConnectionSettings#timeoutSec
*/
Integer timeoutSec
@EqualsAndHashCode
static class With implements CommandSettings, ToStringProperties {
def With() {}
def With(CommandSettings... sources) {
SettingsHelper.mergeProperties(this, sources)
}
static final CommandSettings DEFAULT = new CommandSettings.With(
ignoreError: false,
pty: false,
agentForwarding: false,
logging: LoggingMethod.slf4j,
encoding: 'UTF-8',
timeoutSec: 0,
)
}
}