com.subgraph.orchid

Class Tor

java.lang.Object

com.subgraph.orchid.Tor

public class Tor
extends Object

The Tor class is a collection of static methods for instantiating various subsystem modules.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOTSTRAP_STATUS_CIRCUIT_CREATE
static int	BOOTSTRAP_STATUS_CONN_DIR
static int	BOOTSTRAP_STATUS_CONN_OR
static int	BOOTSTRAP_STATUS_DONE
static int	BOOTSTRAP_STATUS_HANDSHAKE_DIR
static int	BOOTSTRAP_STATUS_HANDSHAKE_OR
static int	BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
static int	BOOTSTRAP_STATUS_LOADING_KEYS
static int	BOOTSTRAP_STATUS_LOADING_STATUS
static int	BOOTSTRAP_STATUS_ONEHOP_CREATE
static int	BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
static int	BOOTSTRAP_STATUS_REQUESTING_KEYS
static int	BOOTSTRAP_STATUS_REQUESTING_STATUS
static int	BOOTSTRAP_STATUS_STARTING

Constructor Summary

Constructors

Constructor and Description
Tor()

Method Summary

Modifier and Type	Method and Description
static CircuitManager	createCircuitManager(TorConfig config, DirectoryDownloaderImpl directoryDownloader, Directory directory, ConnectionCache connectionCache, TorInitializationTracker tracker) Create and return a new CircuitManager instance.
static TorConfig	createConfig() Create and return a new TorConfig instance.
static ConnectionCache	createConnectionCache(TorConfig config, TorInitializationTracker tracker)
static Directory	createDirectory(TorConfig config, DirectoryStore customDirectoryStore) Create and return a new Directory instance.
static DirectoryDownloaderImpl	createDirectoryDownloader(TorConfig config, TorInitializationTracker initializationTracker) Create and return a new DirectoryDownloader instance.
static TorInitializationTracker	createInitalizationTracker()
static SocksPortListener	createSocksPortListener(TorConfig config, CircuitManager circuitManager) Create and return a new SocksPortListener instance.
static String	getBuildRevision()
static Charset	getDefaultCharset()
static String	getFullVersion()
static String	getImplementation()
static String	getVersion() Return a string describing the version of this software.
static boolean	isAndroidRuntime() Determine if running on Android by inspecting java.runtime.name property.

Methods inherited from class java.lang.Object

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

Field Detail

BOOTSTRAP_STATUS_STARTING

public static final int BOOTSTRAP_STATUS_STARTING

See Also:

Constant Field Values

BOOTSTRAP_STATUS_CONN_DIR

public static final int BOOTSTRAP_STATUS_CONN_DIR

See Also:

Constant Field Values

BOOTSTRAP_STATUS_HANDSHAKE_DIR

public static final int BOOTSTRAP_STATUS_HANDSHAKE_DIR

See Also:

Constant Field Values

BOOTSTRAP_STATUS_ONEHOP_CREATE

public static final int BOOTSTRAP_STATUS_ONEHOP_CREATE

See Also:

Constant Field Values

BOOTSTRAP_STATUS_REQUESTING_STATUS

public static final int BOOTSTRAP_STATUS_REQUESTING_STATUS

See Also:

Constant Field Values

BOOTSTRAP_STATUS_LOADING_STATUS

public static final int BOOTSTRAP_STATUS_LOADING_STATUS

See Also:

Constant Field Values

BOOTSTRAP_STATUS_REQUESTING_KEYS

public static final int BOOTSTRAP_STATUS_REQUESTING_KEYS

See Also:

Constant Field Values

BOOTSTRAP_STATUS_LOADING_KEYS

public static final int BOOTSTRAP_STATUS_LOADING_KEYS

See Also:

Constant Field Values

BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS

public static final int BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS

See Also:

Constant Field Values

BOOTSTRAP_STATUS_LOADING_DESCRIPTORS

public static final int BOOTSTRAP_STATUS_LOADING_DESCRIPTORS

See Also:

Constant Field Values

BOOTSTRAP_STATUS_CONN_OR

public static final int BOOTSTRAP_STATUS_CONN_OR

See Also:

Constant Field Values

BOOTSTRAP_STATUS_HANDSHAKE_OR

public static final int BOOTSTRAP_STATUS_HANDSHAKE_OR

See Also:

Constant Field Values

BOOTSTRAP_STATUS_CIRCUIT_CREATE

public static final int BOOTSTRAP_STATUS_CIRCUIT_CREATE

See Also:

Constant Field Values

BOOTSTRAP_STATUS_DONE

public static final int BOOTSTRAP_STATUS_DONE

See Also:

Constant Field Values

Constructor Detail

Tor

public Tor()

Method Detail

getDefaultCharset

public static Charset getDefaultCharset()

getBuildRevision

public static String getBuildRevision()

getImplementation

public static String getImplementation()

getFullVersion

public static String getFullVersion()

getVersion

public static String getVersion()

Return a string describing the version of this software.

Returns:

A string representation of the software version.

isAndroidRuntime

public static boolean isAndroidRuntime()

Determine if running on Android by inspecting java.runtime.name property.

Returns:

True if running on Android.

createConfig

public static TorConfig createConfig()

Create and return a new TorConfig instance.

Parameters:

logManager - This is a required dependency. You must create a LogManager before calling this method to create a TorConfig

Returns:

A new TorConfig instance.

See Also:

TorConfig

createInitalizationTracker

public static TorInitializationTracker createInitalizationTracker()

createDirectory

public static Directory createDirectory(TorConfig config,
                                        DirectoryStore customDirectoryStore)

Create and return a new Directory instance.

Parameters:

logManager - This is a required dependency. You must create a LogManager before creating a Directory.

config - This is a required dependency. You must create a TorConfig before calling this method to create a Directory

Returns:

A new Directory instance.

See Also:

Directory

createConnectionCache

public static ConnectionCache createConnectionCache(TorConfig config,
                                                    TorInitializationTracker tracker)

createCircuitManager

public static CircuitManager createCircuitManager(TorConfig config,
                                                  DirectoryDownloaderImpl directoryDownloader,
                                                  Directory directory,
                                                  ConnectionCache connectionCache,
                                                  TorInitializationTracker tracker)

Create and return a new CircuitManager instance.

Returns:

A new CircuitManager instance.

See Also:

CircuitManager

createSocksPortListener

public static SocksPortListener createSocksPortListener(TorConfig config,
                                                        CircuitManager circuitManager)

Create and return a new SocksPortListener instance.

Parameters:

logManager - This is a required dependency. You must create a LogManager before calling this method to create a SocksPortListener.

circuitManager - This is a required dependency. You must create a CircuitManager before calling this method to create a SocksPortListener.

Returns:

A new SocksPortListener instance.

See Also:

SocksPortListener

createDirectoryDownloader

public static DirectoryDownloaderImpl createDirectoryDownloader(TorConfig config,
                                                                TorInitializationTracker initializationTracker)

Create and return a new DirectoryDownloader instance.

Parameters:

logManager - This is a required dependency. You must create a LogManager before calling this method to create a DirectoryDownloader.

directory - This is a required dependency. You must create a Directory before calling this method to create a DirectoryDownloader

circuitManager - This is a required dependency. You must create a CircuitManager before calling this method to create a DirectoryDownloader.

Returns:

A new DirectoryDownloader instance.

See Also:

DirectoryDownloaderImpl