ParallelClient (io.parallec:parallec-core 0.10.6 API)

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

public class ParallelClient
extends Object

This is the starting point of starting a parallel client, which create a ParallelTaskBuilder after a prepareGet functions. The Parallel Task builder is to build a parallel task. This is more a wrapper class and does not hold object specific resources. You may create a single or multiple instances. Only call releaseExternalResources() before your app shutdown and when you no longer need to use it. Will mark as closed after it is closed isClosed Will auto reinitialize if is closed.

Maven Import

     <dependency>
         <groupId>io.parallec</groupId>
         <artifactId>parallec-core</artifactId>
         <version>0.9.0</version>
     </dependency>

Code Example

Here is a complete runnable code.

 import io.parallec.core.*;
 import java.util.Map;
 
 ParallelClient pc= new ParallelClient();
 pc.prepareHttpGet("/validateInternals.html")
     .setConcurrency(1000)
     .setTargetHostsFromString("www.parallec.io www.jeffpei.com www.restcommander.com")
     .execute(new ParallecResponseHandler() {
         public void onCompleted(ResponseOnSingleTask res,
                 Map<String, Object> responseContext) {
             String cpu = new FilterRegex(".*<td>CPU-Usage-Percent</td>\\s*<td>(.*?)</td>.*")
             .filter(res.getResponseContent());
             System.out.println("cpu:" + cpu + " host: " + res.getHost() );
         }
     });
 pc.releaseExternalResources();

Author:: Yuanteng (Jeff) Pei

Field Summary

Fields
Modifier and Type	Field and Description
`HttpClientStore`	`httpClientStore` The http client store.
`static AtomicBoolean`	`isClosed` The is closed is marked when all resources are released/not initialized.
`ParallelTaskManager`	`taskManager` The task manager.
`TcpUdpSshPingResourceStore`	`tcpSshPingResourceStore` The tcp client store.

Constructor Summary

Constructors
Constructor and Description

ParallelClient()
Instantiates a new parallel client.

Constructors
Constructor and Description
`ParallelClient()` Instantiates a new parallel client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanInprogressJobMap()` Clean inprogress job map.
`void`	`cleanWaitTaskQueue()` Clean wait task queue.
`HttpClientStore`	`getHttpClientStore()` Gets the http client store.
`int`	`getRunningJobCount()` Gets the running job count.
`void`	`initialize()` Initialize.
`String`	`logHealth()` Log memory health.
`ParallelTaskBuilder`	`prepareHttpDelete(String url)` Prepare a parallel HTTP DELETE Task.
`ParallelTaskBuilder`	`prepareHttpGet(String url)` Prepare a parallel HTTP GET Task.
`ParallelTaskBuilder`	`prepareHttpHead(String url)` Prepare a parallel HTTP HEAD Task.
`ParallelTaskBuilder`	`prepareHttpOptions(String url)` Prepare a parallel HTTP OPTION Task.
`ParallelTaskBuilder`	`prepareHttpPost(String url)` Prepare a parallel HTTP POST Task.
`ParallelTaskBuilder`	`prepareHttpPut(String url)` Prepare a parallel HTTP PUT Task.
`ParallelTaskBuilder`	`preparePing()` Prepare a parallel PING Task.
`ParallelTaskBuilder`	`prepareSsh()` Prepare a parallel SSH Task.
`ParallelTaskBuilder`	`prepareTcp(String command)` Prepare a parallel TCP Task.
`ParallelTaskBuilder`	`prepareUdp(String command)` Prepare a parallel UDP Task.
`void`	`reinitHttpClients()` Reinit http clients.
`void`	`reinitIfClosed()` Auto re-initialize external resourced if resources have been already released.
`void`	`releaseExternalResources()` Releases the external resources that this object depends on.
`void`	`setCustomClientFast(com.ning.http.client.AsyncHttpClient client)` Sets the custom fast client in the httpClientStore.
`void`	`setCustomClientSlow(com.ning.http.client.AsyncHttpClient client)` Sets the custom fast client in the httpClientStore.
`void`	`setHttpClientTypeCurrentDefault(HttpClientType type)` Sets the default client type that the httpClientStore.

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

- Field Detail
  - taskManager
```
public ParallelTaskManager taskManager
```
    The task manager.
  - httpClientStore
```
public HttpClientStore httpClientStore
```
    The http client store.
  - tcpSshPingResourceStore
```
public TcpUdpSshPingResourceStore tcpSshPingResourceStore
```
    The tcp client store.
  - isClosed
```
public static AtomicBoolean isClosed
```
    The is closed is marked when all resources are released/not initialized.
- Constructor Detail
  - ParallelClient
```
public ParallelClient()
```
    Instantiates a new parallel client. call initialize();
- Method Detail
  - initialize
```
public void initialize()
```
    Initialize. create the httpClientStore, tcpClientStore
  - releaseExternalResources
```
public void releaseExternalResources()
```
    Releases the external resources that this object depends on. You should not call this method if you still want to use the external resources (e.g. akka system, async http client store, thread pool for SSH/TCP) are in use by other objects.
  - reinitIfClosed
```
public void reinitIfClosed()
```
    Auto re-initialize external resourced if resources have been already released.
  - prepareSsh
```
public ParallelTaskBuilder prepareSsh()
```
    Prepare a parallel SSH Task.
    
    Returns:
    
    the parallel task builder
  - preparePing
```
public ParallelTaskBuilder preparePing()
```
    Prepare a parallel PING Task.
    
    Returns:
    
    the parallel task builder
  - prepareTcp
```
public ParallelTaskBuilder prepareTcp(String command)
```
    Prepare a parallel TCP Task.
    
    Parameters:
    
    command - the command
    
    Returns:
    
    the parallel task builder
  - prepareUdp
```
public ParallelTaskBuilder prepareUdp(String command)
```
    Prepare a parallel UDP Task.
    
    Parameters:
    
    command - the command
    
    Returns:
    
    the parallel task builder
  - prepareHttpGet
```
public ParallelTaskBuilder prepareHttpGet(String url)
```
    Prepare a parallel HTTP GET Task.
    
    Parameters:
    
    url - the UrlPostfix: e.g. in http://localhost:8080/index.html.,the url is "/index.html"
    
    Returns:
    
    the parallel task builder
  - prepareHttpPost
```
public ParallelTaskBuilder prepareHttpPost(String url)
```
    Prepare a parallel HTTP POST Task.
    
    Parameters:
    
    url - the UrlPostfix: e.g. in http://localhost:8080/index.html.,the url is "/index.html"
    
    Returns:
    
    the parallel task builder
  - prepareHttpDelete
```
public ParallelTaskBuilder prepareHttpDelete(String url)
```
    Prepare a parallel HTTP DELETE Task.
    
    Parameters:
    
    url - the UrlPostfix: e.g. in http://localhost:8080/index.html.,the url is "/index.html"
    
    Returns:
    
    the parallel task builder
  - prepareHttpPut
```
public ParallelTaskBuilder prepareHttpPut(String url)
```
    Prepare a parallel HTTP PUT Task.
    
    Parameters:
    
    url - the UrlPostfix: e.g. in http://localhost:8080/index.html.,the url is "/index.html"
    
    Returns:
    
    the parallel task builder
  - prepareHttpHead
```
public ParallelTaskBuilder prepareHttpHead(String url)
```
    Prepare a parallel HTTP HEAD Task.
    
    Parameters:
    
    url - the UrlPostfix: e.g. in http://localhost:8080/index.html.,the url is "/index.html"
    
    Returns:
    
    the parallel task builder
  - prepareHttpOptions
```
public ParallelTaskBuilder prepareHttpOptions(String url)
```
    Prepare a parallel HTTP OPTION Task.
    
    Parameters:
    
    url - the UrlPostfix: e.g. in http://localhost:8080/index.html.,the url is "/index.html"
    
    Returns:
    
    the parallel task builder
  - setCustomClientFast
```
public void setCustomClientFast(com.ning.http.client.AsyncHttpClient client)
```
    Sets the custom fast client in the httpClientStore.
    
    Parameters:
    
    client - the new custom client fast
  - setCustomClientSlow
```
public void setCustomClientSlow(com.ning.http.client.AsyncHttpClient client)
```
    Sets the custom fast client in the httpClientStore.
    
    Parameters:
    
    client - the new custom client slow
  - setHttpClientTypeCurrentDefault
```
public void setHttpClientTypeCurrentDefault(HttpClientType type)
```
    Sets the default client type that the httpClientStore.
    
    Parameters:
    
    type - the new http client type current default
  - reinitHttpClients
```
public void reinitHttpClients()
```
    Reinit http clients.
  - cleanInprogressJobMap
```
public void cleanInprogressJobMap()
```
    Clean inprogress job map.
  - cleanWaitTaskQueue
```
public void cleanWaitTaskQueue()
```
    Clean wait task queue.
  - getHttpClientStore
```
public HttpClientStore getHttpClientStore()
```
    Gets the http client store.
    
    Returns:
    
    the http client store
  - logHealth
```
public String logHealth()
```
    Log memory health. MonitorProvider} class (singleton) provider JVM memory, thread information. You may directly call MonitorProvider.getInstance() to access JVM memory / thread objects
    
    Returns:
    
    the string
  - getRunningJobCount
```
public int getRunningJobCount()
```
    Gets the running job count.
    
    Returns:
    
    the running job count

Class ParallelClient

Maven Import

Code Example

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

taskManager

httpClientStore

tcpSshPingResourceStore

isClosed

Constructor Detail

ParallelClient

Method Detail

initialize

releaseExternalResources

reinitIfClosed

prepareSsh

preparePing

prepareTcp

prepareUdp

prepareHttpGet

prepareHttpPost

prepareHttpDelete

prepareHttpPut

prepareHttpHead

prepareHttpOptions

setCustomClientFast

setCustomClientSlow

setHttpClientTypeCurrentDefault

reinitHttpClients

cleanInprogressJobMap

cleanWaitTaskQueue

getHttpClientStore

logHealth

getRunningJobCount