SshPutTaskWrapper (Apache Brooklyn)

Apache Brooklyn

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- brooklyn.util.task.ssh.SshPutTaskStub
- - brooklyn.util.task.ssh.SshPutTaskWrapper

All Implemented Interfaces:

TaskAdaptable<java.lang.Void>, TaskWrapper<java.lang.Void>
```
@Beta
public class SshPutTaskWrapper
extends SshPutTaskStub
implements TaskWrapper<java.lang.Void>
```
As ProcessTaskWrapper, but putting a file on the remote machine

Method Summary

Methods
Modifier and Type	Method and Description
`Task<java.lang.Void>`	`asTask()`
`SshPutTaskWrapper`	`block()` blocks until the task completes; does not throw
`java.lang.Void`	`get()` blocks, throwing if there was an exception
`java.lang.Exception`	`getException()` returns any exception encountered in the operation
`java.lang.Integer`	`getExitCode()` returns the exit code from the copy, 0 on success; null if it has not completed or threw exception (not sure if this is ever a non-zero integer or if it is meaningful)
`Task<java.lang.Void>`	`getTask()`
`boolean`	`isDone()` true iff the ssh job has completed (with or without failure)
`boolean`	`isSuccessful()` true iff the scp has completed successfully; guaranteed to be set before `isDone()` or `block()` are satisfied
`java.lang.String`	`toString()`

Methods inherited from class brooklyn.util.task.ssh.SshPutTaskStub
getMachine, getRemoteFile, getSummary

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

- Method Detail
  - asTask
```
public Task<java.lang.Void> asTask()
```
    Specified by:
    
    asTask in interface TaskAdaptable<java.lang.Void>
  - getTask
```
public Task<java.lang.Void> getTask()
```
    Specified by:
    
    getTask in interface TaskWrapper<java.lang.Void>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - get
```
public java.lang.Void get()
```
    blocks, throwing if there was an exception
  - getExitCode
```
public java.lang.Integer getExitCode()
```
    returns the exit code from the copy, 0 on success; null if it has not completed or threw exception (not sure if this is ever a non-zero integer or if it is meaningful)
    most callers will want the simpler isSuccessful()
  - getException
```
public java.lang.Exception getException()
```
    returns any exception encountered in the operation
  - block
```
public SshPutTaskWrapper block()
```
    blocks until the task completes; does not throw
  - isDone
```
public boolean isDone()
```
    true iff the ssh job has completed (with or without failure)
  - isSuccessful
```
public boolean isSuccessful()
```
    true iff the scp has completed successfully; guaranteed to be set before isDone() or block() are satisfied

Apache Brooklyn - Multi-Cloud Application Management
brooklyn.io. Apache License. © 2015.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method