jodd.madvoc

Class WebApp

java.lang.Object

jodd.madvoc.WebApp

Direct Known Subclasses:

PetiteWebApp

public class WebApp
extends java.lang.Object

Web application contains all configurations and holds all managers and controllers of one web application. Custom implementations may override this class to enhance several different functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected Consumers<MadvocContainer>	componentConfigs
protected MadvocContainer	madvocContainer
protected javax.servlet.ServletContext	servletContext

Constructor Summary

Constructors

Constructor and Description
WebApp()

Method Summary

Modifier and Type	Method and Description
WebApp	bindServletContext(javax.servlet.ServletContext servletContext) Defines servlet context.
protected void	configureDefaults() Configure defaults.
static WebApp	createWebApp()
static WebApp	get(javax.servlet.ServletContext servletContext) Returns WebApp instance from servlet context.
protected void	initialized() Called when Madvoc is initialized, at the end of the INIT phase.
MadvocContainer	madvocContainer() Returns Madvoc container that maintain all Madvoc components.
protected void	ready() Called when Madvoc is ready, at the end of the READY phase.
WebApp	registerComponent(java.lang.Class<?> madvocComponent) Registers additional Madvoc components after the registration of default components.
<T> WebApp	registerComponent(java.lang.Class<T> madvocComponent, java.util.function.Consumer<T> componentConsumer)
WebApp	registerComponent(java.lang.Object madvocComponent) Registers Madvoc component instance.
protected void	registerMadvocComponents() Registers default Madvoc components.
WebApp	router(java.util.function.Consumer<MadvocRouter> madvocAppConsumer) Defines a route manually using MadvocRouter.
void	shutdown() Shutdows the web application.
WebApp	start() Initializes and starts web application.
WebApp	start(java.util.function.Consumer<MadvocRouter> madvocRouterConsumer) Initializes and starts web application.
protected void	started() Called when Madvoc is started, at the end of the START phase.
<A extends ActionConfig> WebApp	withActionConfig(java.lang.Class<A> actionConfigType, java.util.function.Consumer<A> actionConfigConsumer) Configures the action configurations.
WebApp	withParams(java.util.Map<java.lang.String,java.lang.Object> params)
WebApp	withParams(Props props) Defines params to load.
<T> WebApp	withRegisteredComponent(java.lang.Class<T> madvocComponent, java.util.function.Consumer<T> componentConsumer) Configures a component.

Methods inherited from class java.lang.Object

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

Field Detail

servletContext

protected javax.servlet.ServletContext servletContext

madvocContainer

protected final MadvocContainer madvocContainer

componentConfigs

protected Consumers<MadvocContainer> componentConfigs

Constructor Detail

WebApp

public WebApp()

Method Detail

createWebApp

public static WebApp createWebApp()

get

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

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

withParams

public WebApp withParams(Props props)

Defines params to load.

withParams

public WebApp withParams(java.util.Map<java.lang.String,java.lang.Object> params)

bindServletContext

public WebApp bindServletContext(javax.servlet.ServletContext servletContext)

Defines servlet context. Must be called in the web environment.

registerComponent

public WebApp registerComponent(java.lang.Class<?> madvocComponent)

Registers additional Madvoc components after the registration of default components.

registerComponent

public <T> WebApp registerComponent(java.lang.Class<T> madvocComponent,
                                    java.util.function.Consumer<T> componentConsumer)

registerComponent

public WebApp registerComponent(java.lang.Object madvocComponent)

Registers Madvoc component instance. Use with caution, as injection of components registered after this will fail.

withActionConfig

public <A extends ActionConfig> WebApp withActionConfig(java.lang.Class<A> actionConfigType,
                                                        java.util.function.Consumer<A> actionConfigConsumer)

Configures the action configurations.

madvocContainer

public MadvocContainer madvocContainer()

Returns Madvoc container that maintain all Madvoc components.

withRegisteredComponent

public <T> WebApp withRegisteredComponent(java.lang.Class<T> madvocComponent,
                                          java.util.function.Consumer<T> componentConsumer)

Configures a component. While the signature is the same as for registerComponent(Class, Consumer) this method does not register component, just operates on an already registered one.

router

public WebApp router(java.util.function.Consumer<MadvocRouter> madvocAppConsumer)

Defines a route manually using MadvocRouter.

start

public WebApp start(java.util.function.Consumer<MadvocRouter> madvocRouterConsumer)

Initializes and starts web application.

start

public WebApp start()

Initializes and starts web application.

configureDefaults

protected void configureDefaults()

Configure defaults.

registerMadvocComponents

protected void registerMadvocComponents()

Registers default Madvoc components.

initialized

protected void initialized()

Called when Madvoc is initialized, at the end of the INIT phase.

See Also:

MadvocComponentLifecycle

started

protected void started()

Called when Madvoc is started, at the end of the START phase.

See Also:

MadvocComponentLifecycle

ready

protected void ready()

Called when Madvoc is ready, at the end of the READY phase.

See Also:

MadvocComponentLifecycle

shutdown

public void shutdown()

Shutdows the web application. Triggers the STOP event.

See Also:

MadvocComponentLifecycle