com.goldencode.p2j.main

Class ProcessClientSpawner

java.lang.Object

com.goldencode.p2j.main.ClientSpawner

com.goldencode.p2j.main.ProcessClientSpawner

All Implemented Interfaces:

SpawnerListener

public class ProcessClientSpawner
extends ClientSpawner

Class used to spawn a new P2J client which will authenticate as a P2J process.

This class is tricky to understand because the main part of it runs on the server while the TemporaryClientTask inner class is serialized and sent down to execute on the client side. That client side code then calls methods which are implemented as a remote object with the Spawner interface, which the server portions of this class implement.

The spawner process will connect to the server using a secure socket and temporary credentials to establish a secure session. If that works, it will lookup the credentials to use for spawning the client based on a unique UUID for this spawning session. Using those credentials it will start the client and notify the server about success or failure.

This notification must not be treated as the client process authenticated successfully; it needs to be interpreted as a signal that the temporary connection has finished successfully.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ProcessClientSpawner.TemporaryClientTask On P2J client side, it will do custom work after authenticating using the temporary credentials.

Field Summary

Fields

Modifier and Type	Field and Description
private ProcessClientBuilder	cb The ClientBuilder used to spawn the P2J client process.
private java.lang.String	process The P2J process ID being spawned by this instance.

Fields inherited from class com.goldencode.p2j.main.ClientSpawner

CLIENT_STARTUP_TIMEOUT_SEC

Constructor Summary

Constructors

Constructor and Description
ProcessClientSpawner(java.lang.String process, java.lang.String osUser, java.lang.String osPass, java.util.Map<java.lang.String,java.lang.String> env) Create a new spawner for P2J processes.

Method Summary

Modifier and Type	Method and Description
protected ProcessClientBuilder	getBuilder() Get a ProcessClientBuilder used to spawn P2J clients for the target process.
ProcessBuilderParameters	getBuildParams() Get ProcessBuilderParameters used to spawn P2J clients.
private java.util.Map<java.lang.String,java.lang.Object>	getServerData() Get a map containing the P2J process secure credentials: the serialized process keystore and trust store and other details, like target aliases in the keystore and truststore.
TemporaryClient	getTemporaryClient(java.lang.String uuid, java.lang.String projectToken) Get a TemporaryClient worker which will do the work after authenticating on the P2J server using the temporary credentials.
static void	launch(java.lang.String batchProcess) Launch the specified batch process.
static void	launch(java.lang.String batchProcess, java.util.Map<java.lang.String,java.lang.String> env) Launch the specified batch process.
void	releaseClient() Releases the system resources for this spawned client.

Methods inherited from class com.goldencode.p2j.main.ClientSpawner

clientIsReady, spawn, spawn

Methods inherited from class java.lang.Object

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

Field Detail

cb

private final ProcessClientBuilder cb

The ClientBuilder used to spawn the P2J client process.

process

private java.lang.String process

The P2J process ID being spawned by this instance.

Constructor Detail

ProcessClientSpawner

public ProcessClientSpawner(java.lang.String process,
                            java.lang.String osUser,
                            java.lang.String osPass,
                            java.util.Map<java.lang.String,java.lang.String> env)

Create a new spawner for P2J processes.

Parameters:

process - The P2J process ID.

env - Map of additional environment properties, in the key=value form.

Method Detail

getBuildParams

public ProcessBuilderParameters getBuildParams()

Get ProcessBuilderParameters used to spawn P2J clients.

Specified by:

getBuildParams in class ClientSpawner

Returns:

See above.

launch

public static void launch(java.lang.String batchProcess)

Launch the specified batch process.

If the P2J process is linked with an appserver, it will delegate the launching to AppServerLauncher.launch(String). Else, it will use the spawner infrastructure to start a P2J client.

Parameters:

batchProcess - The name of the batch process to be launched.

launch

public static void launch(java.lang.String batchProcess,
                          java.util.Map<java.lang.String,java.lang.String> env)

Launch the specified batch process.

If the P2J process is linked with an appserver, it will delegate the launching to AppServerLauncher.launch(String). Else, it will use the spawner infrastructure to start a P2J client.

Parameters:

batchProcess - The name of the batch process to be launched.

env - Map of additional environment properties, in the key=value form.

getServerData

private java.util.Map<java.lang.String,java.lang.Object> getServerData()

Get a map containing the P2J process secure credentials: the serialized process keystore and trust store and other details, like target aliases in the keystore and truststore.

Returns:

Map of security configs key : value.

getBuilder

protected ProcessClientBuilder getBuilder()

Get a ProcessClientBuilder used to spawn P2J clients for the target process.

Specified by:

getBuilder in class ClientSpawner

Returns:

See above.

getTemporaryClient

public TemporaryClient getTemporaryClient(java.lang.String uuid,
                                          java.lang.String projectToken)

Get a TemporaryClient worker which will do the work after authenticating on the P2J server using the temporary credentials.

Parameters:

uuid - The client identifier uuid.

projectToken - The project token to be set for the temporary session.

Returns:

See above.

releaseClient

public void releaseClient()

Description copied from interface: SpawnerListener

Releases the system resources for this spawned client.