Package org.chenile.owiz.config.impl

Class OrchConfiguratorBase<InputType>

java.lang.Object

org.chenile.owiz.config.impl.OrchConfiguratorBase<InputType>

Type Parameters:

InputType - .

All Implemented Interfaces:

OrchConfigurator<InputType>

Direct Known Subclasses:

XmlOrchConfigurator

public class OrchConfiguratorBase<InputType>
extends Object
implements OrchConfigurator<InputType>

A base implementation of OrchConfigurator that stores all the relevant information in internal variables and provides the services as expected by OrchConfigurator. Sub classes are expected to populate the information after reading it from various sources (such as a database or xml file)

Author:

rkollu

Field Summary

Fields

Modifier and Type	Field	Description
private BeanFactoryAdapter	beanFactoryAdapter
private FlowDescriptor<InputType>	defaultFlow
private Map<String,FlowDescriptor<InputType>>	flowCatalog

Constructor Summary

Constructors

Constructor	Description
OrchConfiguratorBase()

Method Summary

Modifier and Type	Method	Description
void	addFlow(FlowDescriptor<InputType> fd)
private void	attachCommandToParent(CommandDescriptor<InputType> cd, Map<String,CommandDescriptor<InputType>> commandCatalog)
BeanFactoryAdapter	getBeanFactoryAdapter()
protected Command<InputType>	lookupCommand(String componentName)	This method uses the bean factory adapter to look up various bean factories.
protected Command<InputType>	makeCommand(CommandDescriptor<InputType> cd)
Map<String,CommandDescriptor<InputType>>	obtainCommandCatalog(String flowId)
CommandDescriptor<InputType>	obtainCommandInfo(String commandId)
CommandDescriptor<InputType>	obtainCommandInfo(String flowId, String commandId)	This method is useful for insrumentation purposes.
Command<InputType>	obtainFirstCommand()
Command<InputType>	obtainFirstCommand(String flowId)	Obtain the first command for the given flow Id.
CommandDescriptor<InputType>	obtainFirstCommandInfo()
CommandDescriptor<InputType>	obtainFirstCommandInfo(String flowId)	This method is useful for insrumentation purposes.
FlowDescriptor<InputType>	obtainFlow(String flowId)
private void	processChain(Map<String,CommandDescriptor<InputType>> commandCatalog)
protected void	processFlows()
void	setBeanFactoryAdapter(BeanFactoryAdapter beanFactoryAdapter)
String	toXml()	Useful for debugging purposes.

Methods inherited from class java.lang.Object

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

Field Details

flowCatalog

private Map<String,FlowDescriptor<InputType>> flowCatalog

defaultFlow

private FlowDescriptor<InputType> defaultFlow

beanFactoryAdapter

private BeanFactoryAdapter beanFactoryAdapter

Constructor Details

OrchConfiguratorBase

public OrchConfiguratorBase()

Method Details

obtainFirstCommand

public Command<InputType> obtainFirstCommand(String flowId)

Description copied from interface: OrchConfigurator

Obtain the first command for the given flow Id. Then the execute method can be called to obtain the results.

Specified by:

obtainFirstCommand in interface OrchConfigurator<InputType>

Parameters:

flowId - is the name of the flow for which the first command is to be obtained

Returns:

the first command for the passed flow Id.

obtainCommandInfo

public CommandDescriptor<InputType> obtainCommandInfo(String flowId,
 String commandId)

Description copied from interface: OrchConfigurator

This method is useful for insrumentation purposes.

Specified by:

obtainCommandInfo in interface OrchConfigurator<InputType>

Parameters:

flowId - is the name of the flow to which the command belongs

commandId - is the name of the command for which the information is to be obtained

Returns:

the command configuration information for the combination of flow and command Ids.

obtainFirstCommandInfo

public CommandDescriptor<InputType> obtainFirstCommandInfo(String flowId)

Description copied from interface: OrchConfigurator

This method is useful for insrumentation purposes.

Specified by:

obtainFirstCommandInfo in interface OrchConfigurator<InputType>

Parameters:

flowId - is the name of the flow for which the first command info is to be obtained

Returns:

the meta data about the flow.

obtainCommandCatalog

public Map<String,CommandDescriptor<InputType>> obtainCommandCatalog(String flowId)

obtainFlow

public FlowDescriptor<InputType> obtainFlow(String flowId)

obtainCommandInfo

public CommandDescriptor<InputType> obtainCommandInfo(String commandId)

Specified by:

obtainCommandInfo in interface OrchConfigurator<InputType>

obtainFirstCommand

public Command<InputType> obtainFirstCommand()

Specified by:

obtainFirstCommand in interface OrchConfigurator<InputType>

obtainFirstCommandInfo

public CommandDescriptor<InputType> obtainFirstCommandInfo()

Specified by:

obtainFirstCommandInfo in interface OrchConfigurator<InputType>

addFlow

public void addFlow(FlowDescriptor<InputType> fd)

processFlows

protected void processFlows()
                     throws OwizConfigException

Throws:

OwizConfigException

processChain

private void processChain(Map<String,CommandDescriptor<InputType>> commandCatalog)
                   throws OwizConfigException

Throws:

OwizConfigException

attachCommandToParent

private void attachCommandToParent(CommandDescriptor<InputType> cd,
 Map<String,CommandDescriptor<InputType>> commandCatalog)
                            throws OwizConfigException

Throws:

OwizConfigException

makeCommand

protected Command<InputType> makeCommand(CommandDescriptor<InputType> cd)
                                  throws OwizConfigException

Throws:

OwizConfigException

lookupCommand

protected Command<InputType> lookupCommand(String componentName)
                                    throws OwizConfigException

This method uses the bean factory adapter to look up various bean factories. Hence over-riding this class would not be required. Instead provide a bean factory adapter that does the look up.

Parameters:

componentName - .

Returns:

Command .

Throws:

ClassNotFoundException

IllegalAccessException

InstantiationException

OwizConfigException - .

toXml

public String toXml()

Description copied from interface: OrchConfigurator

Useful for debugging purposes.

Specified by:

toXml in interface OrchConfigurator<InputType>

Returns:

an xml representation of the entire flow (or multiple flows if more than one are configured)

setBeanFactoryAdapter

public void setBeanFactoryAdapter(BeanFactoryAdapter beanFactoryAdapter)

getBeanFactoryAdapter

public BeanFactoryAdapter getBeanFactoryAdapter()