com.createtank.elemenope
Class ElemenopeStandardConfiguration

java.lang.Object
  com.createtank.elemenope.ElemenopeStandardConfiguration

All Implemented Interfaces:

ElemenopeConfiguration, java.lang.Runnable

public class ElemenopeStandardConfiguration
extends java.lang.Object
implements ElemenopeConfiguration, java.lang.Runnable

Standard implementation of ElemenopeConfiguration class.

This fully qualified class name may be passed to elemenope on the commandline, and will be instantiated by Elemenope to handle configuration.

Author:

John Joseph Roets [joe@createtank.com]

Constructor Summary

ElemenopeStandardConfiguration()
Creates a new instance of ElemenopeStandardConfiguration

Method Summary

ElemenopeInitializationGroupHandler	getInitializationGroupHandler() Provides availability to the resultant initialized elemenope components.
void	init() Standard configuration of elemenope framework takes place here.
void	init(java.lang.String initializationGroup) Standard configuration of elemenope framework takes place here.
org.springframework.beans.factory.BeanFactory	initSpring(java.lang.String initializationGroup) Standard usage of Spring Framework for user configuration within elemenope Framework.
void	maintain() general maintenance routine
void	run()
void	setDefaultInitializationGroup(java.lang.String initializationGroup) Set the initializationGroup node from which to read the configuration.
void	setInitializationGroupHandler(ElemenopeInitializationGroupHandler eigh) Sets the initialized elemenope components.
void	setXMLConfiguration(com.createtank.util.configuration.XMLConfiguration xc) set the XMLConfiguration object (already built) with which the ElemenopeConfiguration class will setup the framework.
void	shutdown() Should be called upon shutdown of framework in order for configuration implementation to clean up components.
void	shutdown(java.lang.String initializationGroup) Should be called upon shutdown of framework in order for configuration implementation to clean up components.
java.util.Map	userInit() Configuration of user specific components takes place here.
java.util.Map	userInit(java.lang.String initializationGroup) Configuration of user specific components takes place here.
void	userShutdown() Called upon shutdown of framework in order for user configuration implementation to clean up components.
void	userShutdown(java.lang.String initializationGroup) Should be called upon shutdown of framework in order for configuration implementation to clean up components.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElemenopeStandardConfiguration

public ElemenopeStandardConfiguration()

Creates a new instance of ElemenopeStandardConfiguration

Method Detail

init

public void init()

Standard configuration of elemenope framework takes place here.

Specified by:

init in interface ElemenopeConfiguration

init

public void init(java.lang.String initializationGroup)

Standard configuration of elemenope framework takes place here.

Specified by:

init in interface ElemenopeConfiguration

setDefaultInitializationGroup

public void setDefaultInitializationGroup(java.lang.String initializationGroup)

Set the initializationGroup node from which to read the configuration.

Specified by:

setDefaultInitializationGroup in interface ElemenopeConfiguration

Parameters:

initializationGroup - The initializationGroup requested by the user from the command line

setXMLConfiguration

public void setXMLConfiguration(com.createtank.util.configuration.XMLConfiguration xc)

set the XMLConfiguration object (already built) with which the ElemenopeConfiguration class will setup the framework.

Specified by:

setXMLConfiguration in interface ElemenopeConfiguration

Parameters:

xc - XMLConfiguration utility object

shutdown

public void shutdown()
              throws ElemenopeException,
                     ElemenopeConnectionException

Description copied from interface: ElemenopeConfiguration

Should be called upon shutdown of framework in order for configuration implementation to clean up components.

Default initialization group will be shutdown.

Specified by:

shutdown in interface ElemenopeConfiguration

Throws:

ElemenopeException

ElemenopeConnectionException

shutdown

public void shutdown(java.lang.String initializationGroup)
              throws ElemenopeException,
                     ElemenopeConnectionException

Description copied from interface: ElemenopeConfiguration

Should be called upon shutdown of framework in order for configuration implementation to clean up components.

Specified by:

shutdown in interface ElemenopeConfiguration

Parameters:

initializationGroup - Group to shutdown.

Throws:

ElemenopeException

ElemenopeConnectionException

userInit

public java.util.Map userInit()

Description copied from interface: ElemenopeConfiguration

Configuration of user specific components takes place here.

Default initialization group will be initialized.

Specified by:

userInit in interface ElemenopeConfiguration

userInit

public java.util.Map userInit(java.lang.String initializationGroup)

Description copied from interface: ElemenopeConfiguration

Configuration of user specific components takes place here.

Specified by:

userInit in interface ElemenopeConfiguration

Parameters:

initializationGroup - initializationGroup to be initialized.

initSpring

public org.springframework.beans.factory.BeanFactory initSpring(java.lang.String initializationGroup)

Standard usage of Spring Framework for user configuration within elemenope Framework. May be overridden for specialized Spring Framework capabilities By default, utilizes FileSystemXmlApplicationContext

Specified by:

initSpring in interface ElemenopeConfiguration

Parameters:

initializationGroup -

Returns:

userShutdown

public void userShutdown()

Description copied from interface: ElemenopeConfiguration

Called upon shutdown of framework in order for user configuration implementation to clean up components.

Default initialization group will be shutdown.

Specified by:

userShutdown in interface ElemenopeConfiguration

userShutdown

public void userShutdown(java.lang.String initializationGroup)

Description copied from interface: ElemenopeConfiguration

Should be called upon shutdown of framework in order for configuration implementation to clean up components.

Specified by:

userShutdown in interface ElemenopeConfiguration

Parameters:

initializationGroup - initializationGroup to be shutdown.

getInitializationGroupHandler

public ElemenopeInitializationGroupHandler getInitializationGroupHandler()

Description copied from interface: ElemenopeConfiguration

Provides availability to the resultant initialized elemenope components.

Specified by:

getInitializationGroupHandler in interface ElemenopeConfiguration

run

public void run()

Specified by:

run in interface java.lang.Runnable

setInitializationGroupHandler

public void setInitializationGroupHandler(ElemenopeInitializationGroupHandler eigh)

Description copied from interface: ElemenopeConfiguration

Sets the initialized elemenope components.

Specified by:

setInitializationGroupHandler in interface ElemenopeConfiguration

maintain

public void maintain()

general maintenance routine

Specified by:

maintain in interface ElemenopeConfiguration