EffectorTasks (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.effector.EffectorTasks

```
@Beta
public class EffectorTasks
extends java.lang.Object
```
Miscellaneous tasks which are useful in effectors.

Since:

0.6.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EffectorTasks.EffectorBodyTaskFactory<T>` wrapper for `EffectorBody` which simply runs that body on each invocation; the body must be thread safe and ideally stateless
`static interface`	`EffectorTasks.EffectorTaskFactory<T>`
`static class`	`EffectorTasks.ParameterTask<T>`

Constructor Summary

Constructors
Constructor and Description

EffectorTasks()

Constructors
Constructor and Description
`EffectorTasks()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <T> ConfigKey<T>`	`asConfigKey(ParameterType<T> t)`
`static Entity`	`findEntity()` Finds the entity where this task is running
`static <T extends Entity> T`	`findEntity(java.lang.Class<T> type)` Finds the entity where this task is running, casted to the given Entity subtype
`static SshMachineLocation`	`findSshMachine()` Finds a unique `SshMachineLocation` attached to the entity where this task is running
`static SshMachineLocation`	`getSshMachine(Entity entity)` Finds a unique `SshMachineLocation` attached to the supplied entity
`static WinRmMachineLocation`	`getWinRmMachine(Entity entity)` Finds a unique `WinRmMachineLocation` attached to the supplied entity
`static <T> EffectorTasks.EffectorTaskFactory<T>`	`of(Task<T> task)`
`static <T> EffectorTasks.ParameterTask<T>`	`parameter(java.lang.Class<T> type, java.lang.String name)`
`static <T> EffectorTasks.ParameterTask<T>`	`parameter(ConfigKey<T> p)`
`static <T> EffectorTasks.ParameterTask<T>`	`parameter(ParameterType<T> t)`

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

- Constructor Detail
  - EffectorTasks
```
public EffectorTasks()
```
- Method Detail
  - asConfigKey
```
public static <T> ConfigKey<T> asConfigKey(ParameterType<T> t)
```
  - parameter
```
public static <T> EffectorTasks.ParameterTask<T> parameter(ParameterType<T> t)
```
  - parameter
```
public static <T> EffectorTasks.ParameterTask<T> parameter(java.lang.Class<T> type,
                                           java.lang.String name)
```
  - parameter
```
public static <T> EffectorTasks.ParameterTask<T> parameter(ConfigKey<T> p)
```
  - of
```
public static <T> EffectorTasks.EffectorTaskFactory<T> of(Task<T> task)
```
  - findEntity
```
public static Entity findEntity()
```
    Finds the entity where this task is running
    
    Throws:
    
    java.lang.NullPointerException - if there is none (no task, or no context entity for that task)
  - findEntity
```
public static <T extends Entity> T findEntity(java.lang.Class<T> type)
```
    Finds the entity where this task is running, casted to the given Entity subtype
    
    Throws:
    
    java.lang.NullPointerException - if there is none
    
    java.lang.IllegalArgumentException - if it is not of the indicated type
  - findSshMachine
```
public static SshMachineLocation findSshMachine()
```
    Finds a unique SshMachineLocation attached to the entity where this task is running
    
    Throws:
    
    java.lang.NullPointerException - if findEntity() fails
    
    java.lang.IllegalStateException - if call to getSshMachine(Entity) fails
  - getSshMachine
```
public static SshMachineLocation getSshMachine(Entity entity)
```
    Finds a unique SshMachineLocation attached to the supplied entity
    
    Throws:
    
    java.lang.IllegalStateException - if there is not a unique such SshMachineLocation
  - getWinRmMachine
```
public static WinRmMachineLocation getWinRmMachine(Entity entity)
```
    Finds a unique WinRmMachineLocation attached to the supplied entity
    
    Throws:
    
    java.lang.IllegalStateException - if there is not a unique such WinRmMachineLocation

Class EffectorTasks

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EffectorTasks

Method Detail

asConfigKey

parameter

parameter

parameter

of

findEntity

findEntity

findSshMachine

getSshMachine

getWinRmMachine