org.apache.maven.surefire.extensions

Class ForkChannel

java.lang.Object

org.apache.maven.surefire.extensions.ForkChannel

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class ForkChannel
extends Object
implements Closeable

It's a session object used only by a particular Thread in ForkStarter and dedicated forked JVM. It represents a server.

It connects with a client connectToClient(), provides a connection string getForkNodeConnectionString() needed by the client in the JVM, binds event handler and command reader.

Since:

3.0.0-M5

Author:

Tibor Digana (tibor17)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForkChannel(ForkNodeArguments arguments)

Method Summary

Modifier and Type	Method and Description
abstract CloseableDaemonThread	bindCommandReader(CommandReader commands, WritableByteChannel stdIn) Binds command handler to the channel.
abstract CloseableDaemonThread	bindEventHandler(EventHandler<Event> eventHandler, CountdownCloseable countdownCloseable, ReadableByteChannel stdOut)
abstract void	connectToClient()
protected ForkNodeArguments	getArguments()
abstract int	getCountdownCloseablePermits() the permits in CountdownCloseable.
abstract String	getForkNodeConnectionString() This is server related class, which if binds to a TCP port, determines the connection string for the client.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

ForkChannel

protected ForkChannel(@Nonnull
                      ForkNodeArguments arguments)

Parameters:

arguments - data necessary for command reader and event handler.

Method Detail

connectToClient

public abstract void connectToClient()
                              throws IOException

Throws:

IOException

getForkNodeConnectionString

public abstract String getForkNodeConnectionString()

This is server related class, which if binds to a TCP port, determines the connection string for the client.

Returns:

a connection string utilized by the client in the fork JVM

getCountdownCloseablePermits

public abstract int getCountdownCloseablePermits()

the permits in CountdownCloseable.

bindCommandReader

public abstract CloseableDaemonThread bindCommandReader(@Nonnull
                                                        CommandReader commands,
                                                        WritableByteChannel stdIn)
                                                 throws IOException

Binds command handler to the channel.

Parameters:

commands - command reader, see CommandReader.readNextCommand()

stdIn - optional standard input stream of the JVM to write the encoded commands into it

Returns:

the thread instance to start up in order to stream out the data

Throws:

IOException - if an error in the fork channel

bindEventHandler

public abstract CloseableDaemonThread bindEventHandler(@Nonnull
                                                       EventHandler<Event> eventHandler,
                                                       @Nonnull
                                                       CountdownCloseable countdownCloseable,
                                                       ReadableByteChannel stdOut)
                                                throws IOException

Parameters:

eventHandler - event eventHandler

countdownCloseable - count down of the final call of Closeable.close()

stdOut - optional standard output stream of the JVM

Returns:

the thread instance to start up in order to stream out the data

Throws:

IOException - if an error in the fork channel

getArguments

@Nonnull
protected ForkNodeArguments getArguments()