Main (Fulcrum's YAAFI 1.0.5 API)

java.lang.Object
- org.apache.fulcrum.yaafi.cli.Main

All Implemented Interfaces:

java.lang.Runnable, org.apache.avalon.framework.activity.Disposable
```
public class Main
extends java.lang.Object
implements java.lang.Runnable, org.apache.avalon.framework.activity.Disposable
```
An example of the embedding of a YAAFI kernel inside an arbitrary application.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION_CONFIG` parameter for the application container configuration file
`static java.lang.String`	`APPLICATION_HASSHUTDOWNHOOK` parameter for setting a shutdown hook
`static java.lang.String`	`APPLICATION_HOME` parameter for the application home directory
`static java.lang.String`	`APPLICATION_ISBLOCKING` parameter for blocking the main thread in Main.run()
`static java.lang.String`	`APPLICATION_NAME` parameter for the application name
`static java.lang.String`	`APPLICATION_TEMP` parameter for the application temporary directory

Constructor Summary

Constructors
Constructor and Description
`Main()` Constructor
`Main(java.lang.String[] args)` Constructor The following command line parameters are supported --yaafi.cli.applicationName name --yaafi.cli.applicationHome dir --yaafi.cli.tempHome dir --yaafi.cli.isBlocking [true\|false] --yaafi.cli.hasShutdownHook [true\|false] --yaafi.cli.config file

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dispose()` Dispose the YAAFI container
`java.lang.String`	`getApplicationHome()`
`java.lang.String`	`getApplicationName()`
`java.lang.String[]`	`getArgs()`
`java.lang.String`	`getContainerConfigValue()`
`org.apache.avalon.framework.logger.Logger`	`getLogger()`
`ServiceContainer`	`getServiceContainer()`
`org.apache.avalon.framework.service.ServiceManager`	`getServiceManager()`
`java.lang.String`	`getTempHome()`
`boolean`	`hasShutdownHook()`
`void`	`initialize()` Initialize the instance
`boolean`	`isBlocking()`
`boolean`	`isInitialized()`
`static void`	`main(java.lang.String[] args)` The main method.
`static java.io.File`	`makeAbsoluteFile(java.io.File baseDir, java.lang.String name)` Determines the file location of the given name.
`java.io.File`	`makeAbsoluteFile(java.lang.String fileName)` Locates the file for the given file name.
`java.lang.String`	`makeAbsolutePath(java.lang.String fileName)` Locates the file for the given file name.
`void`	`onWait()` Depending on the configuration this method might block the calling thread or return immediatly.
`void`	`run()` Runs the instance by initializing it and potentially blocking the invoking thread depending on the configuration.
`void`	`setApplicationHome(java.lang.String applicationHome)`
`void`	`setApplicationName(java.lang.String applicationName)`
`void`	`setArgs(java.lang.String[] args)`
`void`	`setContainerConfigValue(java.lang.String containerConfigValue)`
`void`	`setHasShutdownHook(boolean hasShutdownHook)`
`void`	`setHasShutdownHook(java.lang.Boolean hasShutdownHook)`
`void`	`setHasShutdownHook(java.lang.String hasShutdownHook)`
`protected void`	`setInitialized(boolean isInitialized)`
`void`	`setIsBlocking(boolean isBlocking)`
`void`	`setIsBlocking(java.lang.Boolean isBlocking)`
`void`	`setIsBlocking(java.lang.String isBlocking)`
`void`	`setLogger(org.apache.avalon.framework.logger.Logger logger)`
`void`	`setTempHome(java.lang.String tempHome)`
`protected void`	`shutdown()` Terminates the instance
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - APPLICATION_NAME
```
public static final java.lang.String APPLICATION_NAME
```
    parameter for the application name
    
    See Also:
    Constant Field Values
  - APPLICATION_HOME
```
public static final java.lang.String APPLICATION_HOME
```
    parameter for the application home directory
    
    See Also:
    Constant Field Values
  - APPLICATION_TEMP
```
public static final java.lang.String APPLICATION_TEMP
```
    parameter for the application temporary directory
    
    See Also:
    Constant Field Values
  - APPLICATION_CONFIG
```
public static final java.lang.String APPLICATION_CONFIG
```
    parameter for the application container configuration file
    
    See Also:
    Constant Field Values
  - APPLICATION_HASSHUTDOWNHOOK
```
public static final java.lang.String APPLICATION_HASSHUTDOWNHOOK
```
    parameter for setting a shutdown hook
    
    See Also:
    Constant Field Values
  - APPLICATION_ISBLOCKING
```
public static final java.lang.String APPLICATION_ISBLOCKING
```
    parameter for blocking the main thread in Main.run()
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Main
```
public Main()
```
    Constructor
  - Main
```
public Main(java.lang.String[] args)
```
    Constructor The following command line parameters are supported
    - --yaafi.cli.applicationName name
    - --yaafi.cli.applicationHome dir
    - --yaafi.cli.tempHome dir
    - --yaafi.cli.isBlocking [true|false]
    - --yaafi.cli.hasShutdownHook [true|false]
    - --yaafi.cli.config file
    Parameters:
    args - the command line arguments
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    The main method.
    
    Parameters:
    args - Command line arguments
    
    Throws:
    
    java.lang.Exception - the execution failed
  - makeAbsoluteFile
```
public static java.io.File makeAbsoluteFile(java.io.File baseDir,
                            java.lang.String name)
```
    Determines the file location of the given name. If the name denotes a relative file location it will be rsolved using the application home directory.
    
    Parameters:
    baseDir - the base directory
    name - the filename
    
    Returns:
    the file
  - dispose
```
public void dispose()
```
    Dispose the YAAFI container
    
    Specified by:
    
    dispose in interface org.apache.avalon.framework.activity.Disposable
  - run
```
public void run()
```
    Runs the instance by initializing it and potentially blocking the invoking thread depending on the configuration.
    
    Specified by:
    
    run in interface java.lang.Runnable
    
    See Also:
    Runnable.run()
  - onWait
```
public void onWait()
```
    Depending on the configuration this method might block the calling thread or return immediatly. We currently poll a volatile variable which is not the most elegant solution.
  - makeAbsoluteFile
```
public java.io.File makeAbsoluteFile(java.lang.String fileName)
```
    Locates the file for the given file name.
    
    Parameters:
    fileName - the filename
    
    Returns:
    an absolute file
  - makeAbsolutePath
```
public java.lang.String makeAbsolutePath(java.lang.String fileName)
```
    Locates the file for the given file name.
    
    Parameters:
    fileName - the filename
    
    Returns:
    an absolute path
  - getServiceContainer
```
public ServiceContainer getServiceContainer()
```
    Returns:
    Returns the ServiceContainer interface
  - getServiceManager
```
public org.apache.avalon.framework.service.ServiceManager getServiceManager()
```
    Returns:
    Returns the ServiceManager interface
  - getApplicationHome
```
public java.lang.String getApplicationHome()
```
    Returns:
    Returns the applicationHome.
  - setApplicationHome
```
public void setApplicationHome(java.lang.String applicationHome)
```
    Parameters:
    applicationHome - The applicationHome to set.
  - getContainerConfigValue
```
public java.lang.String getContainerConfigValue()
```
    Returns:
    Returns the containerConfigValue.
  - setContainerConfigValue
```
public void setContainerConfigValue(java.lang.String containerConfigValue)
```
    Parameters:
    containerConfigValue - The containerConfigValue to set.
  - isBlocking
```
public boolean isBlocking()
```
    Returns:
    Returns the isBlocking.
  - setIsBlocking
```
public void setIsBlocking(boolean isBlocking)
```
    Parameters:
    isBlocking - The isBlocking to set.
  - setIsBlocking
```
public void setIsBlocking(java.lang.Boolean isBlocking)
```
    Parameters:
    isBlocking - The isBlocking to set.
  - setIsBlocking
```
public void setIsBlocking(java.lang.String isBlocking)
```
    Parameters:
    isBlocking - The isBlocking to set.
  - getTempHome
```
public java.lang.String getTempHome()
```
    Returns:
    Returns the tempHome.
  - setTempHome
```
public void setTempHome(java.lang.String tempHome)
```
    Parameters:
    tempHome - The tempHome to set.
  - getLogger
```
public org.apache.avalon.framework.logger.Logger getLogger()
```
    Returns:
    Returns the logger.
  - setLogger
```
public void setLogger(org.apache.avalon.framework.logger.Logger logger)
```
    Parameters:
    logger - The logger to set.
  - getApplicationName
```
public java.lang.String getApplicationName()
```
    Returns:
    Returns the applicationName.
  - setApplicationName
```
public void setApplicationName(java.lang.String applicationName)
```
    Parameters:
    applicationName - The applicationName to set.
  - getArgs
```
public java.lang.String[] getArgs()
```
    Returns:
    Returns the args.
  - setArgs
```
public void setArgs(java.lang.String[] args)
```
    Parameters:
    args - The args to set.
  - hasShutdownHook
```
public boolean hasShutdownHook()
```
    Returns:
    Returns the hasShutdownHook.
  - setHasShutdownHook
```
public void setHasShutdownHook(boolean hasShutdownHook)
```
    Parameters:
    hasShutdownHook - The hasShutdownHook to set.
  - setHasShutdownHook
```
public void setHasShutdownHook(java.lang.Boolean hasShutdownHook)
```
    Parameters:
    hasShutdownHook - The hasShutdownHook to set.
  - setHasShutdownHook
```
public void setHasShutdownHook(java.lang.String hasShutdownHook)
```
    Parameters:
    hasShutdownHook - The hasShutdownHook to set.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    Object.toString()
  - isInitialized
```
public boolean isInitialized()
```
    Returns:
    Returns the isInitialized.
  - setInitialized
```
protected void setInitialized(boolean isInitialized)
```
    Parameters:
    isInitialized - The isInitialized to set.
  - initialize
```
public void initialize()
                throws java.lang.Exception
```
    Initialize the instance
    
    Throws:
    
    java.lang.Exception - the initialization failed
  - shutdown
```
protected void shutdown()
```
    Terminates the instance

Class Main

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPLICATION_NAME

APPLICATION_HOME

APPLICATION_TEMP

APPLICATION_CONFIG

APPLICATION_HASSHUTDOWNHOOK

APPLICATION_ISBLOCKING

Constructor Detail

Main

Main

Method Detail

main

makeAbsoluteFile

dispose

run

onWait

makeAbsoluteFile

makeAbsolutePath

getServiceContainer

getServiceManager

getApplicationHome

setApplicationHome

getContainerConfigValue

setContainerConfigValue

isBlocking

setIsBlocking

setIsBlocking

setIsBlocking

getTempHome

setTempHome

getLogger

setLogger

getApplicationName

setApplicationName

getArgs

setArgs

hasShutdownHook

setHasShutdownHook

setHasShutdownHook

setHasShutdownHook

toString

isInitialized

setInitialized

initialize

shutdown