flux
Interface SCPAction

All Superinterfaces:
flux.Action, Cloneable, flux.runtimedatamap.RuntimeDataMap, Serializable

public interface SCPAction
extends flux.Action

SCPAction that transfers files over an SSH connection or runs a remote command. If remote command is set, it takes precedence over transfer. If you don't already have ~/.ssh/id_rsa present, generate a key with the command 'ssh-keygen -t rsa -P '''. The null private key password allows for automated SSH connections.

Author:
arul@flux.ly

Nested Class Summary
static class SCPAction.SCPActionResult
          The response from SCPAction that executes a remote command.
 
Method Summary
 void setCompression(boolean compression)
          Set the compression flag.
 void setDownload(boolean download)
          Set the download flag.
 void setHost(String host)
          Set the Host.
 void setLocalPath(String localPath)
          Set the local path.
 void setPassword(String password)
          Set the password used to authenticate username using the "password" authentication method and as a fallback basic challenge-response authentication.
 void setPrivateKey(String privateKey)
          Set the fully qualified private key file name.
 void setRemoteCommand(String command)
          Set the remote command.
 void setRemotePath(String remotePath)
          Set the remote path.
 void setUsername(String username)
          Set the username.
 
Methods inherited from interface flux.Action
addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient
 
Methods inherited from interface flux.runtimedatamap.RuntimeDataMap
getRuntimeDataMap, setRuntimeDataMap
 

Method Detail

setCompression

void setCompression(boolean compression)
Set the compression flag. Defaults to false. Uses JZlib for compression.

Parameters:
compression - compression.

setDownload

void setDownload(boolean download)
Set the download flag. Defaults to true. For, upload set this to false.

Parameters:
download - download.

setHost

void setHost(String host)
Set the Host.

Parameters:
host - name of the host where broker is running.

setLocalPath

void setLocalPath(String localPath)
Set the local path.

Parameters:
localPath - Local path.

setPassword

void setPassword(String password)
Set the password used to authenticate username using the "password" authentication method and as a fallback basic challenge-response authentication.

Parameters:
password - password.

setPrivateKey

void setPrivateKey(String privateKey)
Set the fully qualified private key file name. If not set, it would look for private keys ~/.ssh/id_rsa and ~/.ssh/id_dsa. If none exists, an IllegalArgumentException is thrown.

Parameters:
privateKey - private key.
Throws:
IllegalArgumentException - If private key is null or not available.

setRemoteCommand

void setRemoteCommand(String command)
Set the remote command.

Parameters:
command - command.

setRemotePath

void setRemotePath(String remotePath)
Set the remote path.

Parameters:
remotePath - Remote path.

setUsername

void setUsername(String username)
Set the username.

Parameters:
username - username.


© 2012 Flux Corporation. All rights reserved.