jodd.madvoc

Class Madvoc

java.lang.Object

jodd.madvoc.Madvoc

public class Madvoc
extends java.lang.Object

Maintain the lifecycle of a Madvoc WebApp.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class	madvocConfiguratorClass
protected java.lang.String	madvocConfiguratorClassName
static java.lang.String	PARAM_MADVOC_CONFIGURATOR Madvoc configurator.
static java.lang.String	PARAM_MADVOC_PARAMS List of Madvoc params and properties files to be found on classpath.
static java.lang.String	PARAM_MADVOC_WEBAPP Web application.
protected java.lang.String[]	paramsFiles
protected javax.servlet.ServletContext	servletContext
protected WebApp	webapp
protected java.lang.Class	webAppClass
protected java.lang.String	webAppClassName

Constructor Summary

Constructors

Constructor and Description
Madvoc()

Method Summary

Modifier and Type	Method and Description
void	configureWith(javax.servlet.ServletContext servletContext) Configures Madvoc by reading context init parameters.
protected WebApp	createWebApplication() Creates WebApp.
static Madvoc	get(javax.servlet.ServletContext servletContext) Returns Madvoc instance from servlet context.
protected Props	loadMadvocParams(java.lang.String[] patterns) Loads Madvoc parameters.
protected void	resolveMadvocConfigClass() Loads Madvoc component that will be used for configuring the user actions.
void	setMadvocConfiguratorClass(java.lang.Class madvocConfiguratorClass) Sets class that will be used for configuring the user actions.
void	setMadvocConfiguratorClassName(java.lang.String madvocConfiguratorClassName) Sets the name of the class that is going to be used for configuration of user actions.
void	setParamsFiles(java.lang.String[] paramsFiles)
void	setWebAppClass(java.lang.Class webAppClass) Sets WebApp class.
void	setWebAppClassName(java.lang.String webAppClass) Sets WebApp class name.
WebApp	startWebApplication(javax.servlet.ServletContext servletContext) Creates and starts new Madvoc web application.
void	stopWebApplication() Stops Madvoc web application.
WebApp	webapp() Returns web application once it is started.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_MADVOC_WEBAPP

public static final java.lang.String PARAM_MADVOC_WEBAPP

Web application.

See Also:

Constant Field Values

PARAM_MADVOC_CONFIGURATOR

public static final java.lang.String PARAM_MADVOC_CONFIGURATOR

Madvoc configurator.

See Also:

Constant Field Values

PARAM_MADVOC_PARAMS

public static final java.lang.String PARAM_MADVOC_PARAMS

List of Madvoc params and properties files to be found on classpath.

See Also:

Constant Field Values

webAppClassName

protected java.lang.String webAppClassName

webAppClass

protected java.lang.Class webAppClass

paramsFiles

protected java.lang.String[] paramsFiles

madvocConfiguratorClassName

protected java.lang.String madvocConfiguratorClassName

madvocConfiguratorClass

protected java.lang.Class madvocConfiguratorClass

webapp

protected WebApp webapp

servletContext

protected javax.servlet.ServletContext servletContext

Constructor Detail

Madvoc

public Madvoc()

Method Detail

get

public static Madvoc get(javax.servlet.ServletContext servletContext)

Returns Madvoc instance from servlet context. May return null indicating Madvoc is not yet initialized.

setWebAppClassName

public void setWebAppClassName(java.lang.String webAppClass)

Sets WebApp class name.

setWebAppClass

public void setWebAppClass(java.lang.Class webAppClass)

Sets WebApp class.

setMadvocConfiguratorClassName

public void setMadvocConfiguratorClassName(java.lang.String madvocConfiguratorClassName)

Sets the name of the class that is going to be used for configuration of user actions.

setMadvocConfiguratorClass

public void setMadvocConfiguratorClass(java.lang.Class madvocConfiguratorClass)

Sets class that will be used for configuring the user actions.

setParamsFiles

public void setParamsFiles(java.lang.String[] paramsFiles)

configureWith

public void configureWith(javax.servlet.ServletContext servletContext)

Configures Madvoc by reading context init parameters.

webapp

public WebApp webapp()

Returns web application once it is started.

startWebApplication

public WebApp startWebApplication(javax.servlet.ServletContext servletContext)

Creates and starts new Madvoc web application. Madvoc instance is stored in servlet context. Important: servletContext may be null, when web application is run out from container.

stopWebApplication

public void stopWebApplication()

Stops Madvoc web application.

createWebApplication

protected WebApp createWebApplication()

Creates WebApp.

loadMadvocParams

protected Props loadMadvocParams(java.lang.String[] patterns)

Loads Madvoc parameters. New Props is created from the classpath.

resolveMadvocConfigClass

protected void resolveMadvocConfigClass()

Loads Madvoc component that will be used for configuring the user actions. If class name is null, default AutomagicMadvocConfigurator will be used.