jodd.madvoc.config

Class AutomagicMadvocConfigurator

java.lang.Object

jodd.io.findfile.ClassFinder

jodd.madvoc.config.AutomagicMadvocConfigurator

All Implemented Interfaces:

MadvocConfigurator

public class AutomagicMadvocConfigurator
extends jodd.io.findfile.ClassFinder
implements MadvocConfigurator

Default Madvoc configurator uses auto-magic to configure WebApplication. It searches the class path for all classes which names ends with 'Action' and 'Result' suffixes. Each such class will be loaded and introspected to determine if it represents valid Madvoc entity and then registered into the web application.

Action class is scanned for the MadvocAction. All public methods with Action are registered as Madvoc actions.

Nested Class Summary

Nested classes/interfaces inherited from class jodd.io.findfile.ClassFinder

jodd.io.findfile.ClassFinder.EntryData

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	actionClassSuffix
protected ActionsManager	actionsManager
protected long	elapsed
protected MadvocConfig	madvocConfig
protected java.lang.String	resultClassSuffix
protected ResultsManager	resultsManager

Fields inherited from class jodd.io.findfile.ClassFinder

ignoreException, includeResources, rulesEntries, rulesJars, systemJars

Constructor Summary

Constructors

Constructor and Description
AutomagicMadvocConfigurator()

Method Summary

Modifier and Type	Method and Description
boolean	checkClass(java.lang.Class clazz) Determines if class should be examined for Madvoc annotations.
void	configure() Configures web application from system classpath
void	configure(java.io.File[] classpath) Configures web application from specified classpath.
protected void	onActionClass(java.lang.String className) Builds action configuration on founded action class.
protected void	onEntry(jodd.io.findfile.ClassFinder.EntryData entryData) Parses class name that matches madvoc-related names.
protected void	onResultClass(java.lang.String className) Loads madvoc result from founded ActionResult instance.

Methods inherited from class jodd.io.findfile.ClassFinder

acceptEntry, acceptJar, createEntriesRules, createJarRules, getSystemJars, getTypeSignatureBytes, isIgnoreException, isIncludeResources, isTypeSignatureInUse, loadClass, prepareEntryName, scanClassFile, scanClassPath, scanEntry, scanJarFile, scanPath, scanPath, scanPaths, scanPaths, scanUrl, scanUrls, setExcludeAllEntries, setExcludeAllJars, setExcludedEntries, setExcludedJars, setIgnoreException, setIncludeAllEntries, setIncludeAllJars, setIncludedEntries, setIncludedJars, setIncludeResources

Methods inherited from class java.lang.Object

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

Field Detail

madvocConfig

@PetiteInject
protected MadvocConfig madvocConfig

actionsManager

@PetiteInject
protected ActionsManager actionsManager

resultsManager

@PetiteInject
protected ResultsManager resultsManager

actionClassSuffix

protected java.lang.String actionClassSuffix

resultClassSuffix

protected java.lang.String resultClassSuffix

elapsed

protected long elapsed

Constructor Detail

AutomagicMadvocConfigurator

public AutomagicMadvocConfigurator()

Method Detail

configure

public void configure()

Configures web application from system classpath

Specified by:

configure in interface MadvocConfigurator

See Also:

configure(java.io.File[])

configure

public void configure(java.io.File[] classpath)

Configures web application from specified classpath. The whole process is done in the following steps:

1. scanning web application classpath
2. invoking external configurations, if exist
3. applying defaults

See Also:

configure()

onEntry

protected void onEntry(jodd.io.findfile.ClassFinder.EntryData entryData)

Parses class name that matches madvoc-related names.

Specified by:

onEntry in class jodd.io.findfile.ClassFinder

checkClass

public boolean checkClass(java.lang.Class clazz)

Determines if class should be examined for Madvoc annotations. Array, anonymous, primitive, interfaces and so on should be ignored. Sometimes, checking may fail due to e.g. NoClassDefFoundError; we should continue searching anyway.

onActionClass

protected void onActionClass(java.lang.String className)
                      throws java.lang.ClassNotFoundException

Builds action configuration on founded action class. Action classes are annotated with MadvocAction annotation.

Throws:

java.lang.ClassNotFoundException

onResultClass

protected void onResultClass(java.lang.String className)
                      throws java.lang.ClassNotFoundException

Loads madvoc result from founded ActionResult instance.

Throws:

java.lang.ClassNotFoundException