com.createtank.elemenope
Interface ElemenopeConfiguration

All Known Implementing Classes:

ElemenopeStandardConfiguration

public interface ElemenopeConfiguration

Configuration interface for the elemenope framework.

Central point for management of initialization groups.

Author:

John Joseph Roets [joe@createtank.com]

Method Summary

ElemenopeInitializationGroupHandler	getInitializationGroupHandler() Provides availability to the resultant initialized elemenope components.
void	init() actual configuration of LMNOP takes place here.
void	init(java.lang.String initializationGroup) actual configuration of LMNOP 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	setDefaultInitializationGroup(java.lang.String initializationGroup) Set the default 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.

Method Detail

init

void init()

actual configuration of LMNOP takes place here.

init

void init(java.lang.String initializationGroup)

actual configuration of LMNOP takes place here.

shutdown

void shutdown()
              throws ElemenopeException,
                     ElemenopeConnectionException

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

Default initialization group will be shutdown.

Throws:

ElemenopeException

ElemenopeConnectionException

shutdown

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

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

Parameters:

initializationGroup - Group to shutdown.

Throws:

ElemenopeException

ElemenopeConnectionException

userInit

java.util.Map userInit()

Configuration of user specific components takes place here.

Default initialization group will be initialized.

userInit

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

Configuration of user specific components takes place here.

Parameters:

initializationGroup - initializationGroup to be initialized.

userShutdown

void userShutdown()

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

Default initialization group will be shutdown.

userShutdown

void userShutdown(java.lang.String initializationGroup)

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

Parameters:

initializationGroup - initializationGroup to be shutdown.

maintain

void maintain()

General maintenance routine.

May be overridden by user.

setXMLConfiguration

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

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

Parameters:

xc - XMLConfiguration utility object

setDefaultInitializationGroup

void setDefaultInitializationGroup(java.lang.String initializationGroup)

Set the default initializationGroup node from which to read the configuration.

Parameters:

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

getInitializationGroupHandler

ElemenopeInitializationGroupHandler getInitializationGroupHandler()

Provides availability to the resultant initialized elemenope components.

setInitializationGroupHandler

void setInitializationGroupHandler(ElemenopeInitializationGroupHandler eigh)

Sets the initialized elemenope components.

initSpring

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

Parameters:

initializationGroup -

Returns: