info.magnolia.module.blossom.module

Class BlossomModuleSupport

java.lang.Object

info.magnolia.module.blossom.module.BlossomModuleSupport

public class BlossomModuleSupport
extends Object

Intended to be used as a base class for Magnolia modules that use Blossom. Provides support for initializing the root WebApplicationContext and DispatcherServlets. Initializing them like this makes them participate properly at module install time. Servlets apart from BlossomDispatcherServlet should be configured in your module's definition file along with their url mappings.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
BlossomModuleSupport()

Method Summary

Modifier and Type	Method and Description
protected String[]	classNamesToArray(Class<?>... classes)
protected String	classNamesToString(Class<?>... classes)
void	closeRootWebApplicationContext() Closes the root web application context.
void	destroyDispatcherServlets() Destroys all previously initialized dispatcher servlets, including BlossomDispatcherServlets.
List<org.springframework.web.servlet.DispatcherServlet>	getDispatcherServlets()
javax.servlet.ServletContext	getServletContext()
void	initBlossomDispatcherServlet(String servletName, Class<?>... configurationClasses) Creates and initializes a BlossomDispatcherServlet using the provided configuration classes.
void	initBlossomDispatcherServlet(String servletName, String configLocation) Creates and initializes a BlossomDispatcherServlet using the provided configLocation.
void	initDispatcherServlet(org.springframework.web.servlet.DispatcherServlet dispatcherServlet, String servletName, String configLocation) Initializes a DispatcherServlet using the provided configuration classes.
void	initDispatcherServlet(String servletName, Class<?>... configClasses) Creates and initializes a DispatcherServlet using the provided configuration classes.
void	initDispatcherServlet(String servletName, String configLocation) Creates and initializes a DispatcherServlet using the provided configLocation.
void	initRootWebApplicationContext(Class<?>... configClasses) Creates and initializes a root web application context using the provided configuration classes.
void	initRootWebApplicationContext(org.springframework.web.context.ContextLoader contextLoader) Creates and initializes a root web application context using the provided ContextLoader.
void	initRootWebApplicationContext(String configLocation) Creates and initializes a root web application context using the provided configLocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlossomModuleSupport

public BlossomModuleSupport()

Method Detail

initRootWebApplicationContext

public void initRootWebApplicationContext(String configLocation)

Creates and initializes a root web application context using the provided configLocation. By default the implementation used is XmlWebApplicationContext.

initRootWebApplicationContext

public void initRootWebApplicationContext(Class<?>... configClasses)

Creates and initializes a root web application context using the provided configuration classes. The implementation used is AnnotationConfigWebApplicationContext.

initRootWebApplicationContext

public void initRootWebApplicationContext(org.springframework.web.context.ContextLoader contextLoader)

Creates and initializes a root web application context using the provided ContextLoader.

closeRootWebApplicationContext

public void closeRootWebApplicationContext()

Closes the root web application context.

initBlossomDispatcherServlet

public void initBlossomDispatcherServlet(String servletName,
                                         String configLocation)

Creates and initializes a BlossomDispatcherServlet using the provided configLocation. Its internal web application context is a XmlWebApplicationContext.

initBlossomDispatcherServlet

public void initBlossomDispatcherServlet(String servletName,
                                         Class<?>... configurationClasses)

Creates and initializes a BlossomDispatcherServlet using the provided configuration classes. Its internal web application context is a AnnotationConfigWebApplicationContext.

initDispatcherServlet

public void initDispatcherServlet(String servletName,
                                  String configLocation)

Creates and initializes a DispatcherServlet using the provided configLocation. Its internal web application context is a XmlWebApplicationContext.

initDispatcherServlet

public void initDispatcherServlet(String servletName,
                                  Class<?>... configClasses)

Creates and initializes a DispatcherServlet using the provided configuration classes. Its internal web application context is a AnnotationConfigWebApplicationContext.

initDispatcherServlet

public void initDispatcherServlet(org.springframework.web.servlet.DispatcherServlet dispatcherServlet,
                                  String servletName,
                                  String configLocation)

Initializes a DispatcherServlet using the provided configuration classes. Its internal web application context is by default a XmlWebApplicationContext.

destroyDispatcherServlets

public void destroyDispatcherServlets()

Destroys all previously initialized dispatcher servlets, including BlossomDispatcherServlets.

getDispatcherServlets

public List<org.springframework.web.servlet.DispatcherServlet> getDispatcherServlets()

getServletContext

public javax.servlet.ServletContext getServletContext()

classNamesToString

protected String classNamesToString(Class<?>... classes)

classNamesToArray

protected String[] classNamesToArray(Class<?>... classes)