com.github.ruediste.remoteJUnit.codeRunner

Class ClassLoadingCodeRunnerClient<TMessage>

java.lang.Object

com.github.ruediste.remoteJUnit.codeRunner.ClassLoadingCodeRunnerClient<TMessage>

public class ClassLoadingCodeRunnerClient<TMessage>
extends Object

Client to run MessageHandlingServerCode with a bi-directional message-channel and remote class loading on the server.

Message sending
After the ServerCode is started using the CodeRunnerClient, a thread is started which takes messages from a local queue and sends them to the server code. The thread which initiated the remote code execution enters a loop requesting messages from the server and handling them, until the remote code exited.

Server Code Exit
When the server code completes, a message is sent to the client which will confirm reception and return to the caller. Upon reception of the confirmation, the server code exits, too. This makes sure that all messages are exchanged between client and server before exit, since the messages are delivered in order.

Class Loading
When the ServerCode requires a class, the class loader first checks if the class can be found on the server. Otherwise it requests the corresponding class from the client using a ClassLoadingCodeRunnerClient.RequestResourceMessage. The class loader then enters a loop waiting for the resource to become available.

The client checks if the resource is part of a jar. In this case the whole jar is sent (ClassLoadingCodeRunnerClient.SendJarsMessage), otherwise only the requested resource (ClassLoadingCodeRunnerClient.SendResourceMessage). The message handling code on the server side adds the resource to the class loader. The class loader detects this, loads the class and returns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassLoadingCodeRunnerClient.CustomMessageWrapper
static class	ClassLoadingCodeRunnerClient.EmptyResponse
static class	ClassLoadingCodeRunnerClient.GetToClientMessagesRequest
static class	ClassLoadingCodeRunnerClient.MessageChannel<TMessage>
static interface	ClassLoadingCodeRunnerClient.MessageHandlingEnvironment<TMessage> Allows to send and receive messages from/to the client
static interface	ClassLoadingCodeRunnerClient.RemoteCodeRequest
static interface	ClassLoadingCodeRunnerClient.RemoteCodeResponse
static class	ClassLoadingCodeRunnerClient.RequestResourceMessage
static class	ClassLoadingCodeRunnerClient.SendJarsMessage
static class	ClassLoadingCodeRunnerClient.SendResourceMessage
static class	ClassLoadingCodeRunnerClient.SendToServerMessagesRequest
static class	ClassLoadingCodeRunnerClient.ServerCodeExited
static class	ClassLoadingCodeRunnerClient.ServerCodeExitReceived
static class	ClassLoadingCodeRunnerClient.ToClientMessagesResponse

Field Summary

Fields

Modifier and Type	Field and Description
HashMap<String,List<File>>	jarMap

Constructor Summary

Constructors

Constructor and Description
ClassLoadingCodeRunnerClient()

Method Summary

Modifier and Type	Method and Description
CodeRunnerClient	getClient()
ParentClassLoaderSupplier	getParentClassLoaderSupplier()
void	runCode(MessageHandlingServerCode<TMessage> code, BiConsumer<TMessage,Consumer<TMessage>> clientMessageHandler)
void	runCode(MessageHandlingServerCode<TMessage> code, BiConsumer<TMessage,Consumer<TMessage>> clientMessageHandler, CodeRunnerClient.ClassMapBuilder bootstrapClasses)
void	setParentClassLoaderSupplier(ParentClassLoaderSupplier parentClassLoaderSupplier)
void	setRunnerClient(CodeRunnerClient client)

Methods inherited from class java.lang.Object

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

Field Detail

jarMap

public HashMap<String,List<File>> jarMap

Constructor Detail

ClassLoadingCodeRunnerClient

public ClassLoadingCodeRunnerClient()

Method Detail

runCode

public void runCode(MessageHandlingServerCode<TMessage> code,
                    BiConsumer<TMessage,Consumer<TMessage>> clientMessageHandler)

runCode

public void runCode(MessageHandlingServerCode<TMessage> code,
                    BiConsumer<TMessage,Consumer<TMessage>> clientMessageHandler,
                    CodeRunnerClient.ClassMapBuilder bootstrapClasses)

Parameters:

code - code to be executed

clientMessageHandler - handler for messages sent from the server back to the client

bootstrapClasses - classes to be sent along with the code, used to deserialize the code

getParentClassLoaderSupplier

public ParentClassLoaderSupplier getParentClassLoaderSupplier()

setParentClassLoaderSupplier

public void setParentClassLoaderSupplier(ParentClassLoaderSupplier parentClassLoaderSupplier)

getClient

public CodeRunnerClient getClient()

setRunnerClient

public void setRunnerClient(CodeRunnerClient client)