net.yacy

Class yacy

java.lang.Object

net.yacy.yacy

public final class yacy
extends java.lang.Object

This is the main class of YaCy. Several threads are started from here:

• one single instance of the plasmaSwitchboard is generated, which itself starts a thread with a plasmaHTMLCache object. This object simply counts files sizes in the cache and terminates them. It also generates a plasmaCrawlerLoader object, which may itself start some more httpc-calling threads to load web pages. They terminate automatically when a page has loaded.
• one serverCore - thread is started, which implements a multi-threaded server. The process may start itself many more processes that handle connections.lo
• finally, all idle-dependent processes are written in a queue in plasmaSwitchboard which are worked off inside an idle-sensitive loop of the main process. (here)

On termination, the following must be done:

• stop feeding of the crawling process because it otherwise fills the indexing queue.
• say goodbye to connected peers and disable new connections. Don't wait for success.
• first terminate the serverCore thread. This prevents that new cache objects are queued.
• wait that the plasmaHTMLCache terminates (it should be normal that this process already has terminated).
• then wait for termination of all loader process of the plasmaCrawlerLoader.
• work off the indexing and cache storage queue. These values are inside a RAM cache and would be lost otherwise.
• write all settings.
• terminate.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	copyright
static java.lang.String	hline
static java.io.File	htDocsPath
private static Switchboard	sb a reference to the Switchboard created by the yacy#startup(String, long, long) method.
static java.io.File	shareDefaultPath
static java.io.File	shareDumpDefaultPath
static java.util.concurrent.Semaphore	shutdownSemaphore
static java.lang.String	vDATE
static java.lang.String	vString

Constructor Summary

Constructors

Constructor and Description
yacy()

Method Summary

Methods

Modifier and Type	Method and Description
private static java.util.Properties	configuration(java.lang.String mes, java.io.File homePath) Loads the configuration from the data-folder.
private static void	delete(java.io.File f)
static void	main(java.lang.String[] args) Main-method which is started by java.
private static void	mkdirIfNeseccary(java.io.File path)
static void	mkdirsIfNeseccary(java.io.File path)
private static void	preReadSavedConfigandInit(java.io.File dataHome) read saved config file and perform action which need to be done before main task starts - like check on system alrady running etc.
static void	shutdown(java.io.File homePath) Call the shutdown-page of YaCy to tell it to shut down.
private static void	startup(java.io.File dataHome, java.io.File appHome, long startupMemFree, long startupMemTotal, boolean gui) Starts up the whole application.
private static void	submitURL(java.io.File homePath, java.lang.String path, java.lang.String processdescription)
static void	update(java.io.File homePath)

Methods inherited from class java.lang.Object

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

Field Detail

vString

public static final java.lang.String vString

vDATE

public static final java.lang.String vDATE

copyright

public static final java.lang.String copyright

hline

public static final java.lang.String hline

See Also:

Constant Field Values

shutdownSemaphore

public static final java.util.concurrent.Semaphore shutdownSemaphore

htDocsPath

public static java.io.File htDocsPath

shareDefaultPath

public static java.io.File shareDefaultPath

shareDumpDefaultPath

public static java.io.File shareDumpDefaultPath

sb

private static Switchboard sb

a reference to the Switchboard created by the yacy#startup(String, long, long) method.

Constructor Detail

yacy

public yacy()

Method Detail

startup

private static void startup(java.io.File dataHome,
           java.io.File appHome,
           long startupMemFree,
           long startupMemTotal,
           boolean gui)

Starts up the whole application. Sets up all datastructures and starts the main threads.

Parameters:

homePath - Root-path where all information is to be found.

startupFree - free memory at startup time, to be used later for statistics

delete

private static void delete(java.io.File f)

Parameters:

f -

mkdirIfNeseccary

private static void mkdirIfNeseccary(java.io.File path)

Parameters:

path -

See Also:

File.mkdir()

mkdirsIfNeseccary

public static void mkdirsIfNeseccary(java.io.File path)

Parameters:

path -

See Also:

File.mkdirs()

configuration

private static java.util.Properties configuration(java.lang.String mes,
                                 java.io.File homePath)

Loads the configuration from the data-folder. FIXME: Why is this called over and over again from every method, instead of setting the configurationdata once for this class in main?

Parameters:

mes - Where are we called from, so that the errormessages can be more descriptive.

homePath - Root-path where all the information is to be found.

Returns:

Properties read from the configurationfile.

shutdown

public static void shutdown(java.io.File homePath)

Call the shutdown-page of YaCy to tell it to shut down. This method is called if you start yacy with the argument -shutdown.

Parameters:

homePath - Root-path where all the information is to be found.

update

public static void update(java.io.File homePath)

submitURL

private static void submitURL(java.io.File homePath,
             java.lang.String path,
             java.lang.String processdescription)

preReadSavedConfigandInit

private static void preReadSavedConfigandInit(java.io.File dataHome)

read saved config file and perform action which need to be done before main task starts - like check on system alrady running etc.

Parameters:

dataHome - data directory

main

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

Main-method which is started by java. Checks for special arguments or starts up the application.

Parameters:

args - Given arguments from the command line.