Package org.apache.manifoldcf.agents.system

Class ManifoldCF

java.lang.Object

org.apache.manifoldcf.core.system.ManifoldCF

org.apache.manifoldcf.agents.system.ManifoldCF

Direct Known Subclasses:

ManifoldCF

public class ManifoldCF
extends ManifoldCF

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.manifoldcf.core.system.ManifoldCF

ManifoldCF.CachePoll, ManifoldCF.DatabaseConnectionReleaseThread, ManifoldCF.DatabaseShutdown, ManifoldCF.FileTrack, ManifoldCF.OverrideableManifoldCFConfiguration, ManifoldCF.ShutdownThread

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
static java.lang.String	agentShutdownSignal
protected static boolean	agentsInitialized
protected static java.lang.String	API_ERRORNODE
protected static java.lang.String	API_SERVICEINTERRUPTIONNODE

Fields inherited from class org.apache.manifoldcf.core.system.ManifoldCF

alreadyClosed, alreadyShutdown, applicationName, ATTRIBUTE_PATH, authImplementation, cleanupHooks, configSignalCommandProperty, databaseConnectionTrackingProperty, databaseHandleMaxcountProperty, databaseHandleTimeoutProperty, databaseImplementation, databaseQueryMaxTimeProperty, dbShutdown, fileResourcesProperty, initializeFlagLock, initializeLevel, IV_LENGTH, lcfConfigFileProperty, localConfiguration, lockManagerImplementation, logConfigFileProperty, maintenanceFileSignalProperty, masterDatabaseName, masterDatabaseNameProperty, masterDatabasePassword, masterDatabasePasswordProperty, masterDatabaseUsername, masterDatabaseUsernameProperty, mcfVersion, NODE_LIBDIR, pollingHooks, processID, processIDProperty, propertyFilelastMod, propertyFilePath, resourceLoader, saltProperty, shutdownThread, tracker, versionProperty, workingDirectory

Constructor Summary

Constructors

Constructor	Description
ManifoldCF()

Method Summary

Modifier and Type	Method	Description
static void	cleanUpEnvironment(IThreadContext threadContext)	Clean up environment.
static void	createErrorNode(Configuration output, java.lang.String errorMessage)	Create an error node with a general error message.
static void	createErrorNode(Configuration output, ManifoldCFException e)	Handle an exception, by converting it to an error node.
static void	createServiceInterruptionNode(Configuration output, ServiceInterruption e)	Handle a service interruption, by converting it to a serviceinterruption node.
static void	deinstallTables(IThreadContext threadcontext)	Uninstall all the crawler system tables.
static ConfigurationNode	findConfigurationNode(Configuration input, java.lang.String argumentName)	Find a configuration node given a name
static java.lang.String	getRootArgument(Configuration input, java.lang.String argumentName)	Find a configuration value given a name
static void	initializeEnvironment(IThreadContext threadContext)	Initialize environment.
static void	installTables(IThreadContext threadcontext)	Install the agent tables.
static void	localCleanup(IThreadContext threadContext)
static void	localInitialize(IThreadContext threadContext)
static java.lang.String	qualifyOutputActivityName(java.lang.String outputActivityName, java.lang.String outputConnectionName)	Qualify output activity name.
static java.lang.String	qualifyTransformationActivityName(java.lang.String transformationActivityName, java.lang.String transformationConnectionName)	Qualify transformation activity name.
static void	resetEnvironment(IThreadContext threadContext)	Reset the environment.
static void	signalOutputConnectionRedo(IThreadContext threadContext, java.lang.String connectionName)	Signal output connection needs redoing.
static void	signalOutputConnectionRemoved(IThreadContext threadContext, java.lang.String connectionName)	Signal output connection has been deleted.

Methods inherited from class org.apache.manifoldcf.core.system.ManifoldCF

addFile, addPollingHook, addShutdownHook, addToHash, checkMaintenanceUnderway, checkProperties, cleanUpEnvironment, createResourceLoader, createSystemDatabase, createTempDir, decrypt, deleteFile, deleteFolder, deobfuscate, dropSystemDatabase, encrypt, ensureFolder, findClass, getBooleanProperty, getChildDatabaseName, getCipher, getCipher, getConfiguration, getDoubleProperty, getFileProperty, getHashValue, getIntProperty, getLongProperty, getMasterDatabaseName, getMasterDatabasePassword, getMasterDatabaseUsername, getMcfVersion, getProcessID, getProperty, getSaltValue, getSecureRandom, getStringProperty, hash, initializeEnvironment, isFolder, noteConfigurationChange, obfuscate, pollAll, readByte, readByteArray, readBytes, readDword, readfloat, readLong, readNibble, readSdword, readString, readWord, recursiveDelete, registerConnectorServices, resetEnvironment, resolvePath, safeFileName, sleep, startHash, systemExit, writeByte, writeByteArray, writeBytes, writeDword, writefloat, writeLong, writeNibble, writeSdword, writeString, writeWord

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

agentShutdownSignal

public static final java.lang.String agentShutdownSignal

See Also:

Constant Field Values

agentsInitialized

protected static boolean agentsInitialized

API_ERRORNODE

protected static final java.lang.String API_ERRORNODE

See Also:

Constant Field Values

API_SERVICEINTERRUPTIONNODE

protected static final java.lang.String API_SERVICEINTERRUPTIONNODE

See Also:

Constant Field Values

Constructor Detail

ManifoldCF

public ManifoldCF()

Method Detail

initializeEnvironment

public static void initializeEnvironment(IThreadContext threadContext)
                                  throws ManifoldCFException

Initialize environment.

Throws:

ManifoldCFException

cleanUpEnvironment

public static void cleanUpEnvironment(IThreadContext threadContext)

Clean up environment.

localInitialize

public static void localInitialize(IThreadContext threadContext)
                            throws ManifoldCFException

Throws:

ManifoldCFException

localCleanup

public static void localCleanup(IThreadContext threadContext)

resetEnvironment

public static void resetEnvironment(IThreadContext threadContext)

Reset the environment.

installTables

public static void installTables(IThreadContext threadcontext)
                          throws ManifoldCFException

Install the agent tables. This is also responsible for upgrading the existing tables!!!

Parameters:

threadcontext - is the thread context.

Throws:

ManifoldCFException

deinstallTables

public static void deinstallTables(IThreadContext threadcontext)
                            throws ManifoldCFException

Uninstall all the crawler system tables.

Parameters:

threadcontext - is the thread context.

Throws:

ManifoldCFException

signalOutputConnectionRedo

public static void signalOutputConnectionRedo(IThreadContext threadContext,
                                              java.lang.String connectionName)
                                       throws ManifoldCFException

Signal output connection needs redoing. This is called when something external changed on an output connection, and therefore all associated documents must be reindexed.

Parameters:

threadContext - is the thread context.

connectionName - is the connection name.

Throws:

ManifoldCFException

signalOutputConnectionRemoved

public static void signalOutputConnectionRemoved(IThreadContext threadContext,
                                                 java.lang.String connectionName)
                                          throws ManifoldCFException

Signal output connection has been deleted. This is called when the target of an output connection has been removed, therefore all associated documents were also already removed.

Parameters:

threadContext - is the thread context.

connectionName - is the connection name.

Throws:

ManifoldCFException

qualifyOutputActivityName

public static java.lang.String qualifyOutputActivityName(java.lang.String outputActivityName,
                                                         java.lang.String outputConnectionName)

Qualify output activity name.

Parameters:

outputActivityName - is the name of the output activity.

outputConnectionName - is the corresponding name of the output connection.

Returns:

the qualified (global) activity name.

qualifyTransformationActivityName

public static java.lang.String qualifyTransformationActivityName(java.lang.String transformationActivityName,
                                                                 java.lang.String transformationConnectionName)

Qualify transformation activity name.

Parameters:

transformationActivityName - is the name of the output activity.

transformationConnectionName - is the corresponding name of the transformation connection.

Returns:

the qualified (global) activity name.

findConfigurationNode

public static ConfigurationNode findConfigurationNode(Configuration input,
                                                      java.lang.String argumentName)

Find a configuration node given a name

getRootArgument

public static java.lang.String getRootArgument(Configuration input,
                                               java.lang.String argumentName)

Find a configuration value given a name

createErrorNode

public static void createErrorNode(Configuration output,
                                   java.lang.String errorMessage)
                            throws ManifoldCFException

Create an error node with a general error message.

Throws:

ManifoldCFException

createErrorNode

public static void createErrorNode(Configuration output,
                                   ManifoldCFException e)
                            throws ManifoldCFException

Handle an exception, by converting it to an error node.

Throws:

ManifoldCFException

createServiceInterruptionNode

public static void createServiceInterruptionNode(Configuration output,
                                                 ServiceInterruption e)

Handle a service interruption, by converting it to a serviceinterruption node.