Package org.apache.hop.core

Class HopEnvironment

java.lang.Object

org.apache.hop.core.HopEnvironment

public class HopEnvironment
extends Object

The HopEnvironment class contains settings and properties for all of Hop. Initialization of the environment is done by calling the init() method, which reads in properties file(s), registers plugins, etc. Initialization should be performed once at application startup; for example, HopUi's main() method calls HopEnvironment.init() in order to prepare the environment for usage by HopUi.

Constructor Summary

Constructors

Constructor	Description
HopEnvironment()

Method Summary

Modifier and Type	Method	Description
static List<IPluginType>	getStandardPluginTypes()
static void	init()	Initializes the Hop environment.
static void	init(List<IPluginType> pluginTypes)
static boolean	isInitialized()	Checks if the Hop environment has been initialized.
void	loadPluginRegistry()	Loads the plugin registry.
static void	reset()
static void	setExecutionInformation(IExecutor executor)	Sets the executor's user and Server information
static void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

HopEnvironment

public HopEnvironment()

Method Detail

init

public static void init()
                 throws HopException

Initializes the Hop environment. This method performs the following operations:

- Creates a Hop "home" directory if it does not already exist - Reads in the hop.properties file - Initializes the logging back-end - Sets the console log level to debug - If specified by parameter, configures - Initializes the Lifecycle listeners

Throws:

HopException - Any errors that occur during initialization will throw a HopException.

getStandardPluginTypes

public static List<IPluginType> getStandardPluginTypes()

init

public static void init(List<IPluginType> pluginTypes)
                 throws HopException

Throws:

HopException

shutdown

public static void shutdown()

isInitialized

public static boolean isInitialized()

Checks if the Hop environment has been initialized.

Returns:

true if initialized, false otherwise

loadPluginRegistry

public void loadPluginRegistry()
                        throws HopPluginException

Loads the plugin registry.

Throws:

HopPluginException - if any errors are encountered while loading the plugin registry.

setExecutionInformation

public static void setExecutionInformation(IExecutor executor)

Sets the executor's user and Server information

reset

public static void reset()