com.goldencode.p2j.main

Class ClientSpawner

java.lang.Object

com.goldencode.p2j.main.ClientSpawner

All Implemented Interfaces:

SpawnerListener

Direct Known Subclasses:

ProcessClientSpawner, WebClientSpawner

public abstract class ClientSpawner
extends java.lang.Object
implements SpawnerListener

This defines a way of spawning new P2J client processes. Temporary credentials are sent to the P2J client side, which, if used, will establish a P2J session with the P2J server and do some custom work (depending on the implementation).

Actual implementations of this class will need to provide the following info:

• A ClientBuilder instance, to spawn the P2J client process.
• A ClientBuilderParameters instance, to configure the P2J client.
• Implementation for the SpawnerListener.getTemporaryClient(String, String), with the work needed to be done after authenticating with the temporary credentials.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLIENT_STARTUP_TIMEOUT_SEC Timeout
private java.util.concurrent.CountDownLatch	clientStartupCountDown Synchronize
private static java.util.concurrent.ExecutorService	GENERIC_EXECUTOR Executor service for simple tasks that don't throw exceptions.
private static CentralLogger	LOG Logger.
private boolean	ready Flag indicating the P2J client has been started.

Constructor Summary

Constructors

Constructor and Description
ClientSpawner()

Method Summary

Modifier and Type	Method and Description
void	clientIsReady(java.lang.String data) Notify when the client has started.
protected abstract ClientBuilder	getBuilder() Get a ClientBuilder used to spawn P2J clients.
abstract ClientBuilderParameters	getBuildParams() Get ClientBuilderParameters used to spawn P2J clients.
void	spawn() Launch a P2J client local or remote.
int	spawn(WebClientAllocator allocator, java.lang.String[] requestParameters) Launch a P2J client local or remote.
private int	spawnLocal(java.util.Map<java.lang.String,java.lang.String> environmentMap, WebClientAllocator allocator, java.lang.String[] requestParameters, java.util.concurrent.atomic.AtomicBoolean isSpawnerRunning) Launch a new local P2J client.
private int	spawnRemote(Brokers brokers, java.util.Map<java.lang.String,java.lang.String> environmentMap, WebClientAllocator allocator, java.lang.String[] requestParameters) Launch a new remote P2J client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.main.SpawnerListener

getTemporaryClient, releaseClient

Field Detail

CLIENT_STARTUP_TIMEOUT_SEC

public static final int CLIENT_STARTUP_TIMEOUT_SEC

Timeout

See Also:

Constant Field Values

LOG

private static final CentralLogger LOG

Logger.

GENERIC_EXECUTOR

private static final java.util.concurrent.ExecutorService GENERIC_EXECUTOR

Executor service for simple tasks that don't throw exceptions.

clientStartupCountDown

private java.util.concurrent.CountDownLatch clientStartupCountDown

Synchronize

ready

private volatile boolean ready

Flag indicating the P2J client has been started.

Constructor Detail

ClientSpawner

public ClientSpawner()

Method Detail

getBuildParams

public abstract ClientBuilderParameters getBuildParams()

Get ClientBuilderParameters used to spawn P2J clients.

Returns:

See above.

getBuilder

protected abstract ClientBuilder getBuilder()

Get a ClientBuilder used to spawn P2J clients.

Returns:

See above.

spawn

public void spawn()

Launch a P2J client local or remote. Get a list of brokers available for this user. If no brokers are registered for this user the client is spawn local. If at least one broker is registered the client is spawn remote.

spawn

public int spawn(WebClientAllocator allocator,
                 java.lang.String[] requestParameters)

Launch a P2J client local or remote. Get a list of brokers available for this user. If no brokers are registered for this user the client is spawn local. If at least one broker is registered the client is spawn remote.

Parameters:

allocator - The web client allocator

requestParameters - The given requests parameters

Returns:

The exit code.

spawnLocal

private int spawnLocal(java.util.Map<java.lang.String,java.lang.String> environmentMap,
                       WebClientAllocator allocator,
                       java.lang.String[] requestParameters,
                       java.util.concurrent.atomic.AtomicBoolean isSpawnerRunning)
                throws java.io.IOException

Launch a new local P2J client.

Parameters:

environmentMap - Environment variables.

allocator - The web client allocator

requestParameters - The given requests parameters

isSpawnerRunning - The thread-safe boolean flag to notify the logger to stop listening for spawner msgs.

Returns:

The spawner exit code.

Throws:

java.io.IOException

spawnRemote

private int spawnRemote(Brokers brokers,
                        java.util.Map<java.lang.String,java.lang.String> environmentMap,
                        WebClientAllocator allocator,
                        java.lang.String[] requestParameters)

Launch a new remote P2J client.

Parameters:

brokers - Wrapper for list of available brokers.

environmentMap - Environment variables.

allocator - The web client allocator

requestParameters - The given requests parameters

Returns:

The spawner exit code.

clientIsReady

public void clientIsReady(java.lang.String data)

Notify when the client has started.

Specified by:

clientIsReady in interface SpawnerListener

Parameters:

data - Custom data sent by the P2J client back to the server.