freenet.node

Class NodeStarter

java.lang.Object

freenet.node.NodeStarter

All Implemented Interfaces:

org.tanukisoftware.wrapper.WrapperListener

public class NodeStarter
extends java.lang.Object
implements org.tanukisoftware.wrapper.WrapperListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeStarter.TestNodeParameters TODO FIXME: Someone who understands all the parameters please add sane defaults.

Field Summary

Fields

Modifier and Type	Field and Description
static int	extBuildNumber
static java.lang.String	extRevisionNumber

Method Summary

Modifier and Type	Method and Description
void	controlEvent(int event) Called whenever the native wrapper code traps a system control signal against the Java process.
static Node	createTestNode(int port, int opennetPort, java.lang.String testName, boolean disableProbabilisticHTLs, short maxHTL, int dropProb, RandomSource random, Executor executor, int threadLimit, long storeSize, boolean ramStore, boolean enableSwapping, boolean enableARKs, boolean enableULPRs, boolean enablePerNodeFailureTables, boolean enableSwapQueueing, boolean enablePacketCoalescing, int outputBandwidthLimit, boolean enableFOAF, boolean connectToSeednodes, boolean longPingTimes, boolean useSlashdotCache, java.lang.String ipAddressOverride) Deprecated. Use createTestNode(TestNodeParameters) instead
static Node	createTestNode(int port, int opennetPort, java.lang.String testName, boolean disableProbabilisticHTLs, short maxHTL, int dropProb, RandomSource random, Executor executor, int threadLimit, long storeSize, boolean ramStore, boolean enableSwapping, boolean enableARKs, boolean enableULPRs, boolean enablePerNodeFailureTables, boolean enableSwapQueueing, boolean enablePacketCoalescing, int outputBandwidthLimit, boolean enableFOAF, boolean connectToSeednodes, boolean longPingTimes, boolean useSlashdotCache, java.lang.String ipAddressOverride, boolean enableFCP) Deprecated. Use createTestNode(TestNodeParameters) instead
static Node	createTestNode(NodeStarter.TestNodeParameters params) Create a test node.
NodeStarter	get()
static java.security.SecureRandom	getGlobalSecureRandom()
static long	getMemoryLimitBytes() Get the memory limit in bytes.
static long	getMemoryLimitMB() Get the memory limit in MB.
static RandomSource	globalTestInit(java.io.File baseDirectory, boolean enablePlug, Logger.LogLevel logThreshold, java.lang.String details, boolean noDNS, RandomSource randomSource) VM-specific init.
static RandomSource	globalTestInit(java.lang.String testName, boolean enablePlug, Logger.LogLevel logThreshold, java.lang.String details, boolean noDNS) Deprecated. Instead use #globalTestInit(File, boolean, LogLevel, String, boolean, RandomSource).
static boolean	isSomething32bits() check whether the OS, JVM and wrapper are 64bits On Windows this will be always true (the wrapper we deploy is 32bits)
static boolean	isTestingVM() If false, this is some sort of multi-node testing VM
static void	main(java.lang.String[] args)
void	restart()
static void	start_osgi(java.lang.String[] args)
java.lang.Integer	start(java.lang.String[] args) The start method is called when the WrapperManager is signaled by the native wrapper code that it can start its application.
static void	stop_osgi(int exitCode)
int	stop(int exitCode) Called when the application is shutting down.

Methods inherited from class java.lang.Object

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

Field Detail

extBuildNumber

public static final int extBuildNumber

extRevisionNumber

public static final java.lang.String extRevisionNumber

Method Detail

isTestingVM

public static boolean isTestingVM()

If false, this is some sort of multi-node testing VM

get

public NodeStarter get()

start

public java.lang.Integer start(java.lang.String[] args)

The start method is called when the WrapperManager is signaled by the native wrapper code that it can start its application. This method call is expected to return, so a new thread should be launched if necessary.

Specified by:

start in interface org.tanukisoftware.wrapper.WrapperListener

Parameters:

args - List of arguments used to initialize the application.

Returns:

Any error code if the application should exit on completion of the start method. If there were no problems then this method should return null.

stop

public int stop(int exitCode)

Called when the application is shutting down. The Wrapper assumes that this method will return fairly quickly. If the shutdown code code could potentially take a long time, then WrapperManager.signalStopping() should be called to extend the timeout period. If for some reason, the stop method can not return, then it must call WrapperManager.stopped() to avoid warning messages from the Wrapper.

Specified by:

stop in interface org.tanukisoftware.wrapper.WrapperListener

Parameters:

exitCode - The suggested exit code that will be returned to the OS when the JVM exits.

Returns:

The exit code to actually return to the OS. In most cases, this should just be the value of exitCode, however the user code has the option of changing the exit code if there are any problems during shutdown.

restart

public void restart()

controlEvent

public void controlEvent(int event)

Called whenever the native wrapper code traps a system control signal against the Java process. It is up to the callback to take any actions necessary. Possible values are: WrapperManager.WRAPPER_CTRL_C_EVENT, WRAPPER_CTRL_CLOSE_EVENT, WRAPPER_CTRL_LOGOFF_EVENT, or WRAPPER_CTRL_SHUTDOWN_EVENT

Specified by:

controlEvent in interface org.tanukisoftware.wrapper.WrapperListener

Parameters:

event - The system control signal.

main

public static void main(java.lang.String[] args)

globalTestInit

@Deprecated
public static RandomSource globalTestInit(java.lang.String testName,
                                                      boolean enablePlug,
                                                      Logger.LogLevel logThreshold,
                                                      java.lang.String details,
                                                      boolean noDNS)
                                               throws LoggerHook.InvalidThresholdException

Deprecated. Instead use #globalTestInit(File, boolean, LogLevel, String, boolean, RandomSource).

Throws:

LoggerHook.InvalidThresholdException

See Also:

#globalTestInit(File, boolean, LogLevel, String, boolean, RandomSource)

globalTestInit

public static RandomSource globalTestInit(java.io.File baseDirectory,
                                          boolean enablePlug,
                                          Logger.LogLevel logThreshold,
                                          java.lang.String details,
                                          boolean noDNS,
                                          RandomSource randomSource)
                                   throws LoggerHook.InvalidThresholdException

VM-specific init. Not Node-specific; many nodes may be created later.

Parameters:

baseDirectory - The directory in which the test data will be placed. Will be created automatically if it does not exist. You should use the same one in NodeStarter.TestNodeParameters.baseDirectory afterwards for each individual test node as long as it has a distinct port. See its JavaDoc.
The function will NOT fail if the directory exists already. You should make sure on your own to delete this before and after tests to ensure a clean state. Notice that JUnit provides a mechanism for automatic creation and deletion of test directories (TemporaryFolder).

RandomSource - The random number generator of the Node. Null for the default of Yarrow.
You might want to use a DummyRandomSource in unit tests:
- Unlike Yarrow, it won't block startup waiting for entropy.
- It allows you to specify a seed which you then can print to stdout so randomized unit tests are reproducible.
- It should be a lot faster than Yarrow.

Returns:

If you passed a RandomSource, the same one is returned. Otherwise, a new Yarrow is returned.

Throws:

LoggerHook.InvalidThresholdException

createTestNode

@Deprecated
public static Node createTestNode(int port,
                                              int opennetPort,
                                              java.lang.String testName,
                                              boolean disableProbabilisticHTLs,
                                              short maxHTL,
                                              int dropProb,
                                              RandomSource random,
                                              Executor executor,
                                              int threadLimit,
                                              long storeSize,
                                              boolean ramStore,
                                              boolean enableSwapping,
                                              boolean enableARKs,
                                              boolean enableULPRs,
                                              boolean enablePerNodeFailureTables,
                                              boolean enableSwapQueueing,
                                              boolean enablePacketCoalescing,
                                              int outputBandwidthLimit,
                                              boolean enableFOAF,
                                              boolean connectToSeednodes,
                                              boolean longPingTimes,
                                              boolean useSlashdotCache,
                                              java.lang.String ipAddressOverride)
                                       throws NodeInitException

Deprecated. Use createTestNode(TestNodeParameters) instead

Throws:

NodeInitException

createTestNode

@Deprecated
public static Node createTestNode(int port,
                                              int opennetPort,
                                              java.lang.String testName,
                                              boolean disableProbabilisticHTLs,
                                              short maxHTL,
                                              int dropProb,
                                              RandomSource random,
                                              Executor executor,
                                              int threadLimit,
                                              long storeSize,
                                              boolean ramStore,
                                              boolean enableSwapping,
                                              boolean enableARKs,
                                              boolean enableULPRs,
                                              boolean enablePerNodeFailureTables,
                                              boolean enableSwapQueueing,
                                              boolean enablePacketCoalescing,
                                              int outputBandwidthLimit,
                                              boolean enableFOAF,
                                              boolean connectToSeednodes,
                                              boolean longPingTimes,
                                              boolean useSlashdotCache,
                                              java.lang.String ipAddressOverride,
                                              boolean enableFCP)
                                       throws NodeInitException

Deprecated. Use createTestNode(TestNodeParameters) instead

Create a test node.

Parameters:

port - The node port number. Each test node must have a different port number.

testName - The test name.

Throws:

NodeInitException - If the node cannot start up for some reason, most likely a config problem.

createTestNode

public static Node createTestNode(NodeStarter.TestNodeParameters params)
                           throws NodeInitException

Create a test node.

Throws:

NodeInitException - If the node cannot start up for some reason, most likely a config problem.

start_osgi

public static void start_osgi(java.lang.String[] args)

stop_osgi

public static void stop_osgi(int exitCode)

getMemoryLimitMB

public static long getMemoryLimitMB()

Get the memory limit in MB. Return -1 if we don't know, -2 for unlimited.

getMemoryLimitBytes

public static long getMemoryLimitBytes()

Get the memory limit in bytes. Return -1 if we don't know. Compensate for odd JVMs' behaviour.

isSomething32bits

public static final boolean isSomething32bits()

check whether the OS, JVM and wrapper are 64bits On Windows this will be always true (the wrapper we deploy is 32bits)

getGlobalSecureRandom

public static java.security.SecureRandom getGlobalSecureRandom()