ParallelTask (io.parallec:parallec-core 0.10.0 API)

java.lang.Object
- io.parallec.core.ParallelTask

```
public class ParallelTask
extends Object
```
The key class represents a onetime execution on multiple requests. It contains all the task and request metadata, target hosts, configs, and the responses. A ParallelTask is the returned object from the ParallelTaskBuilder.execute(io.parallec.core.ParallecResponseHandler)
- The metadata on this whole task, including config, running state, progress, request count, task id.
- The results of the task: parallelTaskResult, which is a hashmap of each target host map with its response. There is also a received count
- Detailed request metadata on HTTP/SSH/PING/TCP. The async http client used for this task ( you may replace it with your own )
- Target host list
- The user defined response handler
- A actorRef pointer to the command manager so that you may use it to cancel the whole task or those requests that match a sublist of target host lists.
Author:

Yuanteng (Jeff) Pei

Field Summary

Fields
Modifier and Type Field and Description

akka.actor.ActorRef executionManager
The command manager.

Fields
Modifier and Type	Field and Description
`akka.actor.ActorRef`	`executionManager` The command manager.

Constructor Summary

Constructors
Constructor and Description
`ParallelTask()` Instantiates a new parallel task.
`ParallelTask(RequestProtocol requestProtocol, int concurrency, HttpMeta httpMeta, TargetHostMeta targetHostMeta, SshMeta sshMeta, TcpMeta tcpMeta, UdpMeta udpMeta, PingMeta pingMeta, ParallecResponseHandler handler, Map<String,Object> responseContext, Map<String,StrStrMap> replacementVarMapNodeSpecific, Map<String,String> replacementVarMap, RequestReplacementType requestReplacementType, ParallelTaskConfig config)` Instantiates a new parallel task.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel(boolean sync)` Cancel.
`boolean`	`cancelOnTargetHosts(List<String> targetHosts)` Cancel on target hosts.
`int`	`capacityUsed()` Capacity used.
`String`	`generateTaskId()` Gen job id.
`String`	`getAggregatedResultHumanStr()` Gets the aggregated result human str.
`Map<String,Integer>`	`getAggregateResultCountSummary()` Gets the aggregate result count summary.
`Map<String,SetAndCount>`	`getAggregateResultFullSummary()` Aggregate results to see the status code distribution with target hosts.
`Map<String,LinkedHashSet<String>>`	`getAggregateResultMap()` Gets the aggregate result map.
`com.ning.http.client.AsyncHttpClient`	`getAsyncHttpClient()` Gets the async http client.
`int`	`getConcurrency()` Gets the concurrency.
`ParallelTaskConfig`	`getConfig()` Gets the config.
`double`	`getDurationSec()` Gets the duration sec.
`long`	`getExecuteStartTime()` Gets the execute start time.
`long`	`getExecutionEndTime()` Gets the execution end time.
`ParallecResponseHandler`	`getHandler()` Gets the handler.
`HttpMeta`	`getHttpMeta()` Gets the command meta.
`Map<String,NodeReqResponse>`	`getParallelTaskResult()` Gets the parallel task result.
`PingMeta`	`getPingMeta()` Gets the ping meta.
`Double`	`getProgress()` Gets the progress.
`Map<String,String>`	`getReplacementVarMap()` Gets the replacement var map.
`Map<String,StrStrMap>`	`getReplacementVarMapNodeSpecific()` Gets the replacement var map node specific.
`int`	`getRequestNum()` Gets the request num.
`int`	`getRequestNumActual()` Gets the request num actual.
`RequestProtocol`	`getRequestProtocol()` Gets the request protocol.
`RequestReplacementType`	`getRequestReplacementType()` Gets the request replacement type.
`Map<String,Object>`	`getResponseContext()` Gets the response context.
`int`	`getResponsedNum()` Gets the responsed num.
`SshMeta`	`getSshMeta()` Gets the ssh meta.
`ParallelTaskState`	`getState()` Gets the state.
`long`	`getSubmitTime()` Gets the submit time.
`TargetHostMeta`	`getTargetHostMeta()` Gets the target host meta.
`List<TaskErrorMeta>`	`getTaskErrorMetas()` Gets the task error metas.
`String`	`getTaskId()` Gets the task id.
`TcpMeta`	`getTcpMeta()` Gets the tcp meta.
`UdpMeta`	`getUdpMeta()`
`boolean`	`isCompleted()` state==ParallelTaskState.COMPLETED_WITHOUT_ERROR \|\| state==ParallelTaskState.COMPLETED_WITH_ERROR;
`String`	`prettyPrintInfo()` Pretty print info.
`boolean`	`saveLogToLocal()` Save log to local.
`boolean`	`saveLogToLocal(String path)` Save log to local.
`void`	`setAsyncHttpClient(com.ning.http.client.AsyncHttpClient asyncHttpClient)` Sets the async http client.
`void`	`setConcurrency(int concurrency)` Sets the concurrency.
`void`	`setConfig(ParallelTaskConfig config)` Sets the config.
`void`	`setDurationSec(double durationSec)` Sets the duration sec.
`void`	`setExecuteStartTime(long executeStartTime)` Sets the execute start time.
`void`	`setExecutionEndTime(long executionEndTime)` Sets the execution end time.
`void`	`setHandler(ParallecResponseHandler handler)` Sets the handler.
`void`	`setHttpMeta(HttpMeta httpMeta)` Sets the command meta.
`void`	`setParallelTaskResult(Map<String,NodeReqResponse> parallelTaskResult)` Sets the parallel task result.
`void`	`setPingMeta(PingMeta pingMeta)` Sets the ping meta.
`void`	`setRequestNum(int requestNum)` Sets the request num.
`void`	`setRequestNumActual(int requestNumActual)` Sets the request num actual.
`void`	`setRequestProtocol(RequestProtocol requestProtocol)` Sets the request protocol.
`void`	`setRequestReplacementType(RequestReplacementType requestReplacementType)` Sets the request replacement type.
`void`	`setResponseContext(Map<String,Object> responseContext)` Sets the response context.
`void`	`setResponsedNum(int responsedNum)` Sets the responsed num.
`void`	`setSshMeta(SshMeta sshMeta)` Sets the ssh meta.
`void`	`setState(ParallelTaskState state)` Sets the state.
`void`	`setSubmitTime(long submitTime)` Sets the submit time.
`void`	`setTargetHostMeta(TargetHostMeta targetHostMeta)` Sets the target host meta.
`void`	`setTaskId(String taskId)` Sets the task id.
`void`	`setTcpMeta(TcpMeta tcpMeta)` Sets the tcp meta.
`void`	`setUdpMeta(UdpMeta udpMeta)`
`String`	`toString()`
`boolean`	`validateWithFillDefault()` will do validation.

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

- Field Detail
  - executionManager
```
public akka.actor.ActorRef executionManager
```
    The command manager. if private: getter/setter: openpojo unit test will fail.
- Constructor Detail
  - ParallelTask
```
public ParallelTask()
```
    Instantiates a new parallel task.
  - ParallelTask
```
public ParallelTask(RequestProtocol requestProtocol,
                    int concurrency,
                    HttpMeta httpMeta,
                    TargetHostMeta targetHostMeta,
                    SshMeta sshMeta,
                    TcpMeta tcpMeta,
                    UdpMeta udpMeta,
                    PingMeta pingMeta,
                    ParallecResponseHandler handler,
                    Map<String,Object> responseContext,
                    Map<String,StrStrMap> replacementVarMapNodeSpecific,
                    Map<String,String> replacementVarMap,
                    RequestReplacementType requestReplacementType,
                    ParallelTaskConfig config)
```
    Instantiates a new parallel task.
    
    Parameters:
    
    requestProtocol - the request protocol
    
    concurrency - the concurrency
    
    httpMeta - the http meta
    
    targetHostMeta - the target host meta
    
    sshMeta - the ssh meta
    
    tcpMeta - the tcp meta
    
    udpMeta - the udp meta
    
    pingMeta - the ping meta
    
    handler - the handler
    
    responseContext - the response context
    
    replacementVarMapNodeSpecific - the replacement var map node specific
    
    replacementVarMap - the replacement var map
    
    requestReplacementType - the request replacement type
    
    config - the config
- Method Detail
  - cancelOnTargetHosts
```
public boolean cancelOnTargetHosts(List<String> targetHosts)
```
    Cancel on target hosts.
    
    Parameters:
    
    targetHosts - the target hosts
    
    Returns:
    
    true, if successful
  - cancel
```
public boolean cancel(boolean sync)
```
    Cancel.
    
    Parameters:
    
    sync - the sync
    
    Returns:
    
    true, if successful
  - capacityUsed
```
public int capacityUsed()
```
    Capacity used.
    
    Returns:
    
    the int
  - validateWithFillDefault
```
public boolean validateWithFillDefault()
                                throws ParallelTaskInvalidException
```
    will do validation. for empty will either throw exception or fill with default values
    
    Returns:
    
    true, if successful
    
    Throws:
    
    ParallelTaskInvalidException - the parallel task invalid exception
  - generateTaskId
```
public String generateTaskId()
```
    Gen job id.
    
    Returns:
    
    the string
  - getProgress
```
public Double getProgress()
```
    Gets the progress.
    
    Returns:
    
    the progress
  - isCompleted
```
public boolean isCompleted()
```
    state==ParallelTaskState.COMPLETED_WITHOUT_ERROR || state==ParallelTaskState.COMPLETED_WITH_ERROR;
    
    Returns:
    
    true, if is completed
  - getAsyncHttpClient
```
public com.ning.http.client.AsyncHttpClient getAsyncHttpClient()
```
    Gets the async http client.
    
    Returns:
    
    the async http client
  - setAsyncHttpClient
```
public void setAsyncHttpClient(com.ning.http.client.AsyncHttpClient asyncHttpClient)
```
    Sets the async http client.
    
    Parameters:
    
    asyncHttpClient - the new async http client
  - getParallelTaskResult
```
public Map<String,NodeReqResponse> getParallelTaskResult()
```
    Gets the parallel task result.
    
    Returns:
    
    the parallel task result
  - setParallelTaskResult
```
public void setParallelTaskResult(Map<String,NodeReqResponse> parallelTaskResult)
```
    Sets the parallel task result.
    
    Parameters:
    
    parallelTaskResult - the parallel task result
  - getReplacementVarMapNodeSpecific
```
public Map<String,StrStrMap> getReplacementVarMapNodeSpecific()
```
    Gets the replacement var map node specific.
    
    Returns:
    
    the replacement var map node specific
  - getReplacementVarMap
```
public Map<String,String> getReplacementVarMap()
```
    Gets the replacement var map.
    
    Returns:
    
    the replacement var map
  - getRequestReplacementType
```
public RequestReplacementType getRequestReplacementType()
```
    Gets the request replacement type.
    
    Returns:
    
    the request replacement type
  - setRequestReplacementType
```
public void setRequestReplacementType(RequestReplacementType requestReplacementType)
```
    Sets the request replacement type.
    
    Parameters:
    
    requestReplacementType - the new request replacement type
  - getTaskErrorMetas
```
public List<TaskErrorMeta> getTaskErrorMetas()
```
    Gets the task error metas.
    
    Returns:
    
    the task error metas
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSshMeta
```
public SshMeta getSshMeta()
```
    Gets the ssh meta.
    
    Returns:
    
    the ssh meta
  - setSshMeta
```
public void setSshMeta(SshMeta sshMeta)
```
    Sets the ssh meta.
    
    Parameters:
    
    sshMeta - the new ssh meta
  - getResponseContext
```
public Map<String,Object> getResponseContext()
```
    Gets the response context.
    
    Returns:
    
    the response context
  - getTargetHostMeta
```
public TargetHostMeta getTargetHostMeta()
```
    Gets the target host meta.
    
    Returns:
    
    the target host meta
  - setTargetHostMeta
```
public void setTargetHostMeta(TargetHostMeta targetHostMeta)
```
    Sets the target host meta.
    
    Parameters:
    
    targetHostMeta - the new target host meta
  - getHttpMeta
```
public HttpMeta getHttpMeta()
```
    Gets the command meta.
    
    Returns:
    
    the command meta
  - setHttpMeta
```
public void setHttpMeta(HttpMeta httpMeta)
```
    Sets the command meta.
    
    Parameters:
    
    httpMeta - the new http meta
  - getTaskId
```
public String getTaskId()
```
    Gets the task id.
    
    Returns:
    
    the task id
  - setTaskId
```
public void setTaskId(String taskId)
```
    Sets the task id.
    
    Parameters:
    
    taskId - the new task id
  - setResponseContext
```
public void setResponseContext(Map<String,Object> responseContext)
```
    Sets the response context.
    
    Parameters:
    
    responseContext - the response context
  - getConfig
```
public ParallelTaskConfig getConfig()
```
    Gets the config.
    
    Returns:
    
    the config
  - setConfig
```
public void setConfig(ParallelTaskConfig config)
```
    Sets the config.
    
    Parameters:
    
    config - the new config
  - prettyPrintInfo
```
public String prettyPrintInfo()
```
    Pretty print info.
    
    Returns:
    
    the string
  - saveLogToLocal
```
public boolean saveLogToLocal(String path)
```
    Save log to local.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    true, if successful
  - saveLogToLocal
```
public boolean saveLogToLocal()
```
    Save log to local.
    
    Returns:
    
    true, if successful
  - getExecutionEndTime
```
public long getExecutionEndTime()
```
    Gets the execution end time.
    
    Returns:
    
    the execution end time
  - setExecutionEndTime
```
public void setExecutionEndTime(long executionEndTime)
```
    Sets the execution end time.
    
    Parameters:
    
    executionEndTime - the new execution end time
  - getAggregateResultFullSummary
```
public Map<String,SetAndCount> getAggregateResultFullSummary()
```
    Aggregate results to see the status code distribution with target hosts.
    
    Returns:
    
    the aggregateResultMap
  - getAggregatedResultHumanStr
```
public String getAggregatedResultHumanStr()
```
    Gets the aggregated result human str.
    
    Returns:
    
    the aggregated result human str
  - getAggregateResultCountSummary
```
public Map<String,Integer> getAggregateResultCountSummary()
```
    Gets the aggregate result count summary. only list the counts for brief understanding
    
    Returns:
    
    the aggregate result count summary
  - getAggregateResultMap
```
public Map<String,LinkedHashSet<String>> getAggregateResultMap()
```
    Gets the aggregate result map.
    
    Returns:
    
    the aggregate result map
  - getDurationSec
```
public double getDurationSec()
```
    Gets the duration sec.
    
    Returns:
    
    the duration sec
  - setDurationSec
```
public void setDurationSec(double durationSec)
```
    Sets the duration sec.
    
    Parameters:
    
    durationSec - the new duration sec
  - getTcpMeta
```
public TcpMeta getTcpMeta()
```
    Gets the tcp meta.
    
    Returns:
    
    the tcp meta
  - setTcpMeta
```
public void setTcpMeta(TcpMeta tcpMeta)
```
    Sets the tcp meta.
    
    Parameters:
    
    tcpMeta - the new tcp meta
  - getRequestProtocol
```
public RequestProtocol getRequestProtocol()
```
    Gets the request protocol.
    
    Returns:
    
    the request protocol
  - setRequestProtocol
```
public void setRequestProtocol(RequestProtocol requestProtocol)
```
    Sets the request protocol.
    
    Parameters:
    
    requestProtocol - the new request protocol
  - getConcurrency
```
public int getConcurrency()
```
    Gets the concurrency.
    
    Returns:
    
    the concurrency
  - setConcurrency
```
public void setConcurrency(int concurrency)
```
    Sets the concurrency.
    
    Parameters:
    
    concurrency - the new concurrency
  - getSubmitTime
```
public long getSubmitTime()
```
    Gets the submit time.
    
    Returns:
    
    the submit time
  - setSubmitTime
```
public void setSubmitTime(long submitTime)
```
    Sets the submit time.
    
    Parameters:
    
    submitTime - the new submit time
  - getExecuteStartTime
```
public long getExecuteStartTime()
```
    Gets the execute start time.
    
    Returns:
    
    the execute start time
  - setExecuteStartTime
```
public void setExecuteStartTime(long executeStartTime)
```
    Sets the execute start time.
    
    Parameters:
    
    executeStartTime - the new execute start time
  - getRequestNum
```
public int getRequestNum()
```
    Gets the request num.
    
    Returns:
    
    the request num
  - setRequestNum
```
public void setRequestNum(int requestNum)
```
    Sets the request num.
    
    Parameters:
    
    requestNum - the new request num
  - getRequestNumActual
```
public int getRequestNumActual()
```
    Gets the request num actual.
    
    Returns:
    
    the request num actual
  - setRequestNumActual
```
public void setRequestNumActual(int requestNumActual)
```
    Sets the request num actual.
    
    Parameters:
    
    requestNumActual - the new request num actual
  - getResponsedNum
```
public int getResponsedNum()
```
    Gets the responsed num.
    
    Returns:
    
    the responsed num
  - setResponsedNum
```
public void setResponsedNum(int responsedNum)
```
    Sets the responsed num.
    
    Parameters:
    
    responsedNum - the new responsed num
  - getState
```
public ParallelTaskState getState()
```
    Gets the state.
    
    Returns:
    
    the state
  - setState
```
public void setState(ParallelTaskState state)
```
    Sets the state.
    
    Parameters:
    
    state - the new state
  - getHandler
```
public ParallecResponseHandler getHandler()
```
    Gets the handler.
    
    Returns:
    
    the handler
  - setHandler
```
public void setHandler(ParallecResponseHandler handler)
```
    Sets the handler.
    
    Parameters:
    
    handler - the new handler
  - getPingMeta
```
public PingMeta getPingMeta()
```
    Gets the ping meta.
    
    Returns:
    
    the ping meta
  - setPingMeta
```
public void setPingMeta(PingMeta pingMeta)
```
    Sets the ping meta.
    
    Parameters:
    
    pingMeta - the new ping meta
  - getUdpMeta
```
public UdpMeta getUdpMeta()
```
  - setUdpMeta
```
public void setUdpMeta(UdpMeta udpMeta)
```

Class ParallelTask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

executionManager

Constructor Detail

ParallelTask

ParallelTask

Method Detail

cancelOnTargetHosts

cancel

capacityUsed

validateWithFillDefault

generateTaskId

getProgress

isCompleted

getAsyncHttpClient

setAsyncHttpClient

getParallelTaskResult

setParallelTaskResult

getReplacementVarMapNodeSpecific

getReplacementVarMap

getRequestReplacementType

setRequestReplacementType

getTaskErrorMetas

toString

getSshMeta

setSshMeta

getResponseContext

getTargetHostMeta

setTargetHostMeta

getHttpMeta

setHttpMeta

getTaskId

setTaskId

setResponseContext

getConfig

setConfig

prettyPrintInfo

saveLogToLocal

saveLogToLocal

getExecutionEndTime

setExecutionEndTime

getAggregateResultFullSummary

getAggregatedResultHumanStr

getAggregateResultCountSummary

getAggregateResultMap

getDurationSec

setDurationSec

getTcpMeta

setTcpMeta

getRequestProtocol

setRequestProtocol

getConcurrency

setConcurrency

getSubmitTime

setSubmitTime

getExecuteStartTime

setExecuteStartTime

getRequestNum

setRequestNum

getRequestNumActual

setRequestNumActual

getResponsedNum

setResponsedNum

getState

setState

getHandler

setHandler

getPingMeta

setPingMeta

getUdpMeta

setUdpMeta