net.lenni0451.commons.network

Class TorProxy

java.lang.Object

net.lenni0451.commons.network.TorProxy

public class TorProxy
extends java.lang.Object

Start and manage a Tor proxy instance.
The proxy has to be provided by the user.

Constructor Summary

Constructors

Constructor and Description
TorProxy(java.io.File torPath) Create a new Tor proxy instance.
TorProxy(java.io.File torPath, int port) Create a new Tor proxy instance.
TorProxy(java.io.File torPath, int port, int controlPort) Create a new Tor proxy instance.

Method Summary

Modifier and Type	Method and Description
int	getControlPort()
int	getPort()
int	getStartProgress()
java.io.File	getTorPath()
boolean	isRunning()
boolean	isStarted()
void	kill() Kill the Tor process.
boolean	reconnect() Reconnect to the Tor network.
void	start() Start the Tor process.
void	stop() Stop the Tor process.

Methods inherited from class java.lang.Object

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

Constructor Detail

TorProxy

public TorProxy(java.io.File torPath)

Create a new Tor proxy instance.

Parameters:

torPath - Path to the Tor executable

TorProxy

public TorProxy(java.io.File torPath,
                int port)

Create a new Tor proxy instance.

Parameters:

torPath - Path to the Tor executable

port - The port the proxy should listen on

TorProxy

public TorProxy(java.io.File torPath,
                int port,
                int controlPort)

Create a new Tor proxy instance.

Parameters:

torPath - Path to the Tor executable

port - The port the proxy should listen on

controlPort - The port the control server should listen on

Method Detail

getTorPath

public java.io.File getTorPath()

Returns:

The Tor executable path

getPort

public int getPort()

Returns:

The port the proxy is listening on

getControlPort

public int getControlPort()

Returns:

The port the control server is listening on

getStartProgress

public int getStartProgress()

Returns:

The current start progress of the Tor process

isRunning

public boolean isRunning()

Returns:

If the Tor process is running

isStarted

public boolean isStarted()

Returns:

If the Tor process is fully started

start

public void start()
           throws java.io.IOException

Start the Tor process.
A new thread will be started to listen for the start progress.

Throws:

java.lang.IllegalStateException - If the Tor process is already running

java.io.IOException - If the Tor process could not be started

stop

public void stop()

Stop the Tor process.

Throws:

java.lang.IllegalStateException - If the Tor process is not running

kill

public void kill()

Kill the Tor process.
This does nothing if the Tor process is not running.

reconnect

public boolean reconnect()
                  throws java.io.IOException

Reconnect to the Tor network.
This will change the external IP address of the proxy.

Returns:

If the reconnect was successful

Throws:

java.io.IOException - If the control communication failed