Magnolia 4.5 reached end of life on June 30, 2016. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

The Blossom module is the Spring integration for Magnolia. Blossom enables you to create editing components that display a high level of dynamic behavior. These components can be used by editors to create truly interactive web pages. For example, the Spring Framework application stack makes it easier to develop integrations with business systems, so that they fetch the information that you want to present in your pages. As Blossom is built on the Spring Web MVC, familiarity with this framework will ensure a smooth experience working with the module.

Key Blossom functionality

  • Annotation based API that builds on the Spring Web MVC. The Blossom API automatically detects annotated classes and registers them for use in Magnolia. To do this, simply add @Template to your controllers and they are ready to be used as building blocks by editors.
  • Exposes controllers as templates and components, allowing you to use the controller for building a model. Useful if you need to call a web service for information that you need to present or if you need to read information from a database.
  • Template based. Having templates (pages, areas and components) backed by an MVC framework has the benefit of providing natural web development business logic.
  • Enable the re-use of previously created controllers.
  • Allows you to create dialogs with code rather than configuration. This has many benefits:
    • you can populate the dialog at runtime with options detected at runtime:
    • you can obtain dialogs from the repository and place into your source control (CVS, SVN, GIT).
  • Dialog validation callbacks for custom validation of input.
  • Components are executed in front of Magnolia. This means that it can choose to do a redirect and skip page rendering. This is very useful, for instance, if you have a form that on post should either present an error message or do a redirect.

Versions and compatibility

With Magnolia 5.4 use Blossom 3.1, its documentation is available here
With Magnolia 5.1 to 5.3 use Blossom 3.0, its documentation is available here
With Magnolia 4.5 use Blossom 2.0
With Magnolia 4.1 to 4.4 use Blossom 1.2, its documentation is available here

 

Minimum Requirements

  • Blossom requires Magnolia 4.5 or later.
  • Needs at least Java 6.
  • Supports Spring Framework 2.5 or later.

Download

Download the Blossom module from Magnolia Store or Nexus Repository.

Installing

Blossom is a community module (4.1 and higher). The module is typically not installed and needs to be downloaded. To install see the general module installation instructions. Maven users can find the artifact in the magnolia maven repository. For instructions see Maven setup on the wiki.

<dependency>
    <groupId>info.magnolia</groupId>
    <artifactId>magnolia-module-blossom</artifactId>
    <version>2.0.8</version>
</dependency>

Uninstalling

See also the general module uninstalling instructions and advice.

Programming model

This is a brief example of how classes are automatically exposed in Magnolia

@Template(id = "myModule:components/text", title = "Text")
@Controller
public class TextComponent {

    @TabFactory("Content")
    public void addPropertiesTab(TabBuilder tab) {
        tab.addFckEditor("text", "Text", "").setRequired(true);
    }

    @TabFactory("Margins")
    public void addMarginTab(TabBuilder tab) {
    }

    @TabValidator("Margins")
    public void validateMargins() {
    }

    @RequestMapping("/text")
    public String handleRequest() {
        return "text.jsp";
    }
}

@Template(id = "myModule:components/main", title = "Main")
@Controller
public class MainTemplate {

    @DialogFactory("frontpage-properties")
    public void addDialog(DialogBuilder dialog) {
        TabBuilder tab = dialog.addTab("Properties");
        tab.addEdit("headline", "Headline", "The text to use as a headline");
    }

    @RequestMapping("/main")
    public String handleRequest() {
        return "mainTemplate.ftl";
    }

    @Area("Content")
    @AvailableComponentClasses(TextComponent.class)
    public static class ContentArea {

        @RequestMapping("/main/content")
        public String handleRequest() {
            return "contentArea.jsp";
        }
    }
}

@DialogFactory("main-properties")
public class MainDialogFactory {

    @TabFactory("Properties")
    public void addPropertiesTab(TabBuilder tab) {
    }

    @DialogValidator
    public void validate(Dialog dialog) {
    }
}

Getting Started

Running a sample

This sample is a complete web application based on Magnolia 4.5 and requires nothing more than a Maven installation.

  1. Clone the git repository, switch to the right branch, build the project and then run magnolia-blossom-sample-webapp using mvn jetty:run-war.
  2. When maven has downloaded the necessary artifacts and started the application point your browser to localhost:8080.
  3. Magnolia will now be in install mode and display a list of modules for install.
    Complete the installation wizard and then log in using superuser for both username and password.
git clone http://git.magnolia-cms.com/git/modules/blossom/samples.git
cd samples
git checkout magnolia-blossom-samples-2.0.x
mvn install
cd magnolia-blossom-sample-webapp
mvn jetty:run-war

Creating your module

Have your module class extend from BlossomModuleSupport and implement your start and stop methods to (a variation of):

public class BlossomSampleModule extends BlossomModuleSupport implements ModuleLifecycle {

    public void start(ModuleLifecycleContext moduleLifecycleContext) {
        initRootWebApplicationContext("classpath:/applicationContext.xml");
        initBlossomDispatcherServlet("blossom", "classpath:/blossom-servlet.xml");
    }

    public void stop(ModuleLifecycleContext moduleLifecycleContext) {
        destroyDispatcherServlets();
        closeRootWebApplicationContext();
    }
}

For details on creating your own module see Module Mechanism.

Configuration

Create a configuration file for your ApplicationContext. Although Blossom does not require particular configurations here, the module does provide a namespace with tags that can come in useful at a later stage. See sections Dependencies on Magnolia components and Configuring beans in the repository.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:blossom="http://www.magnolia-cms.com/schema/blossom"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.magnolia-cms.com/schema/blossom http://www.magnolia-cms.com/schema/blossom.xsd">

</beans>

Add blossom-servlet.xml. This example uses Spring 2.5 component-scan to find the annotated classes. This example includes view resolvers for both JSP and Freemarker and selects which to use based on the extension. If you are only using one view resolver in your project, you can reconfigure this and not have to return the extension from your controllers.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="
           http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
    <context:annotation-config/>
    <context:component-scan base-package="info.magnolia.module.blossom.sample" use-default-filters="false">
        <context:include-filter type="annotation" expression="info.magnolia.module.blossom.annotation.Template"/>
        <context:include-filter type="annotation" expression="info.magnolia.module.blossom.annotation.Area"/>
        <context:include-filter type="annotation" expression="info.magnolia.module.blossom.annotation.DialogFactory"/>
        <context:include-filter type="annotation" expression="info.magnolia.module.blossom.annotation.VirtualURIMapper"/>
    </context:component-scan>
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter" />
    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="customArgumentResolver">
            <bean class="info.magnolia.module.blossom.web.BlossomWebArgumentResolver" />
        </property>
    </bean>
    <bean class="info.magnolia.module.blossom.preexecution.BlossomHandlerMapping">
        <property name="targetHandlerMappings">
            <list>
                <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">
                    <property name="useDefaultSuffixPattern" value="false" />
                </bean>
                <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping" />
            </list>
        </property>
    </bean>
    <bean class="info.magnolia.module.blossom.view.UuidRedirectViewResolver">
        <property name="order" value="1" />
    </bean>
    <!-- JSP - renders all views that end with .jsp -->
    <bean class="info.magnolia.module.blossom.view.TemplateViewResolver">
        <property name="order" value="2"/>
        <property name="prefix" value="/WEB-INF/templates/"/>
        <property name="viewNames" value="*.jsp"/>
        <property name="viewRenderer">
            <bean class="info.magnolia.module.blossom.view.JspTemplateViewRenderer"/>
        </property>
    </bean>
    <!-- Renders all views that end with .ftl -->
    <bean class="info.magnolia.module.blossom.view.TemplateViewResolver">
        <property name="order" value="3"/>
        <property name="prefix" value="/WEB-INF/templates/"/>
        <property name="viewNames" value="*.ftl"/>
        <property name="viewRenderer">
            <bean class="info.magnolia.module.blossom.view.FreemarkerTemplateViewRenderer">
                <property name="contextAttributes">
                    <map>
                        <entry key="cms">
                            <bean class="info.magnolia.rendering.renderer.ContextAttributeConfiguration">
                                <property name="name" value="cms"/>
                                <property name="componentClass" value="info.magnolia.templating.freemarker.Directives"/>
                            </bean>
                        </entry>
                        <entry key="cmsfn">
                            <bean class="info.magnolia.rendering.renderer.ContextAttributeConfiguration">
                                <property name="name" value="cmsfn"/>
                                <property name="componentClass" value="info.magnolia.templating.functions.TemplatingFunctions"/>
                            </bean>
                        </entry>
                    </map>
                </property>
            </bean>
        </property>
    </bean>
</beans> 

Reference

This is the reference documentation for Blossom. The sample code in this section uses Spring 2.5+ annotated controllers. However, it is also possible to use Blossom with plain controllers.

Templates

Important note on templates

The naming convention for Blossom templates changed between versions 1.x and 2.0. For help on how to migrate your templates to the new naming convention, see Migrating content when upgrading to Blossom 2.

New naming conventions

In Magnolia 4.5 template IDs are in the format of <moduleName>:<path>. (See the Templates documentation.) As a consequence the Blossom convention was updated. You now need to specify the ID explicitly on your controller: @Template(id="myModule:pages/news", title="News").

Adding a controller to a template

To add a controller as a template, simply add @Template. For example:

@Template(id = "myModule:pages/section", title = "Section Template")
@Controller
public class SectionController {

    @RequestMapping("/section")
    public ModelAndView handleRequest() {
        ...
    }
}

This controller will be exposed in Magnolia, showing up as 'Section Template'. Note that the 'id' follows a convention used in Magnolia: module name, followed by a path. For templates that you want to use for pages, the path needs to start with pages.

Controlling where a template can be used

To limit the template pages available for editors to use, simply use @Available annotation. Use this on a method in your controller that must return boolean. It can receive as arguments an argument of type Node or Content, this is the page in the website for which to determine if the template is available. It can also accept an argument of type TemplateDefinition this is the internal definition used by Magnolia:

    @Available
    public boolean isAvailable(Node websiteNode) {
        // Replace this with logic for your specific use case
        return true;
    }

Areas

Areas are defined using nested classes (public static class) within a template or within an other area. Areas are standard Spring Web MVC controllers annotated with @Area. You can configure which components are available in an area by using the @AvailableComponents or @AvailableComponentClasses annotations. In addition Areas have their own dialog. An area can inherit components from areas of the same name in the page's parent pages. By default it will only inherit components marked for inheritance:

@Template(title = "Main", id = "myModule:pages/main")
@Controller
public class MainTemplate {

    @Area("Promos")
    @Inherits
    @AvailableComponentClasses({TextComponent.class})
    @Controller
    public static class PromosArea {

        @RequestMapping("/mainTemplate/promos")
        public String render() {
            return "areas/promos.jsp";
        }
    }

    // rest of the template excluded for brevity
}

Sometimes its helpful to limit the number of components an editor can add into an area. On the area annotation you can specify the limit your design requires.

@Area(name = "Promos", maxComponents = 5)

Components

Components are controllers annotated with @Template and having an id in the format moduleName:components/*.

@Template(id = "myModule:components/textAndImage", title="Text and Image")
@TemplateDescription("Adds a text section with an image")
@Controller
public class TextAndImageController {

    @RequestMapping("/textAndImage")
    public ModelAndView handleRequest() {
        ...
    }
}

This controller will be visible as the Text and Image component. The description set using @TemplateDescription is shown when you choose component to add in the page editor.

Dialogs

Blossom allows you to create dialogs using code. One of the benefits of this is that when the controller fetches data from a web service you can populate your dialog with options retrieved from that web service. See also Dialogs.

For example, if the controller displays a list of the best selling books in a category of books you could call the web service to find out what categories are available and use them to populate a select control. Another benefit is that you get your dialogs out of the repository and into version control. You get to version your dialogs together with your controllers.

You can easily change your dialog code in your IDE, compile and hot swap the new code into an instance of Magnolia running in debug mode. This makes developing dialogs extremely fast.

Dialog factories

Dialog factories create dialogs. Although the dialogs are automatically exposed in Magnolia, you need to configure them as beans in Spring. The easiest way to do this is to use Spring 2.5+ component scan, however manual configuration in XML will works. For example:

@DialogFactory("front-page-dialog")
@TabOrder({"Content", "Margins"})
public class FrontPageDialog {

    @TabFactory("Margins")
    public void margins(TabBuilder tab) {
        tab.addStatic("Margins around the side of the front page");
        tab.addEdit("leftMargin", "Left Margin", "Left margin in pixels");
        tab.addEdit("rightMargin", "Right Margin", "Right margin in pixels");
    }

    @TabFactory("Content")
    public void content(TabBuilder tab) {
        tab.addTitle("title", "Title", "The title of this page");
    }
}

A dialog registers in Magnolia with the name front-page-dialog. It has two tabs, Content and Margins. The order that the dialogs appear in has been set using the @TabOrder annotation. Methods annotated with @TabFactory in superclasses will be called. If there are many dialogs that look the same you can create an abstract base class for them.

Templates create their own dialog

A template always has a dialog so you don't have to create a dialog factory and link them with a name. Instead your controller will act as its own dialog factory. You can use the same annotations inside your controller that you can for dialog factories. (See above.) If you want your template to use a dialog that is created by a dialog factory or configured in the repository, it's possible to override this behavior and specify which dialog should be used:

@Template(dialog="my-dialog")

Templates can contain dialog factories

Because templates are often designed for use with few dialogs, Blossom allows you to create these within your template class for ease of location. The concept is similar to dialog factories but here everything is done in a single method.

@Template(id = "product-template", title="Product Template")
public class ProductController {

    @DialogFactory("product-dialog")
    public void productDialog(DialogBuilder dialog) {
        TabBuilder settings = dialog.addTab("Settings");
        settings.addEdit("title", "Title", "");
        TabBuilder properties = dialog.addTab("Properties");
        properties.addEdit("headline", "Headline", "");
    }
}

Validating dialog input

As an extra bonus of creating dialogs programmatically Blossom is able to provide you with a callback where you can validate the input that the editor has entered. This is done using the @TabValidator and @DialogValidator annotations. Validation messages are set using Magnolia's AlertUtil class:

@TabValidator("Content")
public void validateContent(DialogTab tab) {
    DialogEdit title = (DialogEdit) tab.getSub("title");
    if (StringUtils.isEmpty(title.getValue())) {
        AlertUtil.setMessage("You need to enter a title!");
    }
}

@DialogValidator
public void validateDialog(Dialog dialog) {
    ...
}

Adding validators in dialog factories that are nested inside templates:

@DialogFactory("main-properties")
public void createDialog(Dialog dialog, DialogCreationContext context) {
    context.addValidator(new ValidationCallback() {
        public void validate(Dialog dialog) {
            ...
        }
    });
}

Customizing how a dialog is saved

Sometimes it is necessary to do post processing before a dialog is saved. It may even be necessary to completely replace the built-in behavior with a custom solution. By annotating a method with the @InitSaveHandler annotation the method becomes responsible for creating and initializing a SaveHandler that will be used to save the dialog:

@InitSaveHandler
public SaveHandler initSaveHandler() {
    return new CustomSaveHandler();
}

TabBuilder

The TabBuilder has methods for adding all the standard controls included in Magnolia. To add custom built controls, use the DialogCreationContext which you can declare as an argument on your method and have passed to you. See also Controls.

Note that is also possible to extend the dialog creation mechanism in Blossom and replace TabBuilder with a class of your own, with methods for adding your custom or third-party controls. The article Extending the Blossom TabBuilder on the wiki explains how this is done in detail.

Accessing content in controllers

In controllers you can have the content object passed directly to your method. In templates this is the content object for the page, in components it's the content object for the component within the page. If you declare two arguments of type Content or Node the first one will be the content of the page and the second will be the content of the component. Other arguments supported are AggregationState, Context, WebContext, User and MgnlUser:

@RequestMapping("/book")
public String handleRequest(@RequestParam("id") int id, Node pageNode, Node componentNode) {
    ...
} 

To do this, configure the BlossomWebArgumentResolver on your AnnotationMethodHandlerAdapter. This is included in the configuration example above.

View rendering

View rendering with Blossom is performed by Spring. Blossom comes with support for using the rendering chain in Magnolia both for JSPs and Freemarker. It works by having view resolvers that return views that call into Magnolia. As a result you'll have access to all the objects that Magnolia provides to template scripts.

Blossom also provides a convenient way of returning redirects to content. By adding the UuidRedirectViewResolver you can return the uuid to redirect to directly from your controller. This example returns a redirect to a page:

    return "website:" + content.getUUID();

This example returns a redirect for a resource in the documents repository:

    return "dms:" + content.getUUID();

Redirecting to the page currently being rendered is a very common case and Blossom has a shortcut syntax that does exactly this without requiring the uuid.

    return "magnolia-redirect:main-content";

It's also possible to redirect to the current content being rendered when executing further down the content hierarchy.

    return "magnolia-redirect:current-content";

Substituting Blossom view resolvers with custom resolvers

If you substitute or combine the Blossom view resolvers with your own implementations, be aware that the GZip filter included in Magnolia wraps the response object and gives it some non-standard semantics. It will tell you that the response is not committed even though it has been written to. It will also allow you to do redirects even though the response has been written to.

Be aware that if you write controllers that exploit the GZip filter, you are creating a dependency and you will need to have the GZip filter active. Certain framework code, such as the JSP view rendering in Spring and WebFlow will test if the response is committed to detect if redirects are possible and sometimes to choose between doing a forward or an include.

Pre-execution of components

Pre-execution allows you to write components that can take care of the entire page rendering. This is necessary if you want to do redirects. Another scenario is if you want to have your controller rendering a form into the page on GET requests and write an XML document or a PDF on POST requests.

Note that this feature is enabled by default from version 1.1 and disabled by default in 0.5. To enable it you need to change a flag in the repository. Navigate to config:/server/filters/blossom in AdminCentral and change the property enabled from 'false to 'true'.

In order for pre-execution to work you need to use the BlossomHandlerMapping. See section on this page on Handler Mapping.

Pre-execution is performed by a filter that will intercept requests and look for a request parameter that contains the UUID of the component that is to be pre-executed. The request parameter is named _pecid. Blossom provides a taglib to make it easier to include this request parameter.

The blossom taglib has two tags, <blossom:pecid-input /> that will output <input type="hidden" name="_pecid" value="<component uuid>" />. This tag is also available under the alias <blossom:pecidInput />, this is necessary for use in Freemarker templates.

<%@ taglib uri="blossom-taglib" prefix="blossom" %>
<form action="?" method="POST">
    <blossom:pecid-input />
    <input type="text" name="q" />
    <input type="submit" value="Search" />
</form>

It is possible to use <blossom:pecid var="pecid" /> to set the UUID of the component as a variable, in this example named pecid. The var attribute is optional. If it's not specified the component UUID is written directly into the page.

<a href="/news/new-website-launched.html?_pecid=<blossom:pecid />"

When you have multiple forms on the same page it can be helpful to distinguish which one is supposed to handle a POST request by testing in a controller if it is being pre-executed.

if (request.getMethod().equals("POST") &amp;&amp; PreexecutionUtils.isPreexecuting() {
    processFormSubmit(request);
} else {
    showForm(request);
}

At the end of this article you'll find a full example of how to use pre-execution.

Handler Mapping

Spring uses HandlerMappings to map a request to a handler (usually a controller). Blossom interrogates the HandlerMappings to find out how you have mapped your handlers. Your HandlerMapping needs to be a class inherited from AbstractUrlHandlerMapping. This is usually the case, both Spring 2.5+ annotated controllers and BeanNameUrlHandlerMapping inherit from AbstractUrlHandlerMapping.

If you want support for pre-execution (see below) you will need to have BlossomHandlerMapping delegate to your HandlerMapping. This is necessary because this is where pre-execution is taken care of. The configuration example above shows how to do this.

Note, you have to explicitly declare your HandlerMapping in XML. Although Spring will supply you with defaults even if you do not use XML, it is not possible for Blossom ot get a reference to the defaults and therefore will not take part in the rendering.

Localization

Using @I18nBasename you can set the name of the resource bundle you want to use. This can be used on templates, areas and components and in dialog factories. Blossom provides you with a LocaleResolver to enable Spring to pick up the locale that Magnolia has selected for the current request:

info.magnolia.module.blossom.context.MagnoliaLocaleResolver

To bridge Magnolia i18n into Spring, use the following MessageSource implementation:

info.magnolia.module.blossom.context.MagnoliaMessageSource

If the content of a tab field should be translatable then it can be made i18n aware by setting the i18n config value.

@TabFactory("Content")
public void addDialog(TabBuilder tab) {
    tab.addEdit("heading", "Heading", "").setConfig("i18n", "true");
}

Multipart Requests

Because Magnolia handles multipart requests, Blossom provides a MultipartResolver implementation. Add this snippet to your beans XML. In the example above this would be blossom-servlet.xml.

  <bean id="multipartResolver" class="info.magnolia.module.blossom.multipart.BlossomMultipartResolver" />

Virtual URI Mappings

Any bean implementing VirtualUriMapping that is configured with Spring is automatically detected and exposed in Magnolia. This means that you don not need to configure them in the repository as you normally would.

In addition, Blossom supports writing virtual URI mappings by annotating a class with @VirtualURIMapper. Instances of this class, when configured as a bean in Spring, will be scanned for methods that can be used for URI mapping. Any method that return String or MappingResult and accepts as arguments a String that is the incoming URI or a HttpServletRequest is used.

The returned string from a Virtual URI mapping is the new URI that Magnolia will use to look up the page in the repository that is to be rendered. The returned URI can also be prefixed with "redirect:", "permanent:" or "forward:" to trigger either a temporary redirect, a permanent redirect or a forward respectively. For redirects the URI can be absolute or relative within the web application (the context path is added automatically).

@VirtualURIMapper
public class SampleURIMapper {

    public String about(String uri, HttpServletRequest request) {
        if (uri.equals("/about"))
            return "/sections/about";
        return null;
    }

    public String news(String uri, HttpServletRequest request) {
        if (uri.equals("/news"))
            return "forward:/dispatcher/news.do";
        return null;
    }
}

For more details the reference documentation on Virtual URI mapping.

Dependencies on Magnolia components

Magnolia is not based on Spring, but rather uses a container internally that manages components. It is possible to pull these components in as beans in the ApplicationContext. Here they are made available for declaring dependencies on them and as candidates for autowiring. This is an example that exposes the ModuleManager as a bean with id 'moduleManager':

<blossom:component id="moduleManager" type="info.magnolia.module.ModuleManager" />

Configuring beans in the repository

Besides for storing content for web pages, the JCR repository is also widely used for configuration. One benefit of this is that configuration is easy to change while the application is running.

To read this configuration Magnolia uses a mechanism called Content2Bean to transform the configuration into plain Java beans. The process is based on reflection. Blossom provides an extension to this mechanism which, during initialization of the bean, applies post processing on it using the Spring ApplicationContext.

This makes it possible to have dependencies in the bean that should be autowired by the ApplicationContext. Note that the bean will also receive all the standard life cycle callbacks that a bean managed by Spring can use. These include:

  • InitializingBean,
  • ServletContextAware,
  • ApplicationContextAware
  • and many more.
    It can also use @PostConstruct and it will be subject for having AOP aspects applied.

The Content2Bean mechanism by default calls a method named with the signature public void init() on the beans it creates if it exists. The extension provided by Blossom does not support this. Instead use @PostConstruct.

With Blossom it is possible to use this mechanism directly in Spring beans xml files. The bean is proxied and is transparently replaced if changes are made in the repository.

This is an example for a book store web site that has a discount service configured in the repository:

<blossom:configured-bean id="discountService" path="/modules/book-store-module/beans/discountService" />

This example is identical to the one above except that the configuration is observed for any changes being made. When it changes the bean is reloaded making it easy to change the discounts while the system is running:

<blossom:observed-bean id="discountService" path="/modules/book-store-module/beans/discountService" />

By default the proxy is created using JDK dynamic proxies, this proxies on an interface level. If you require proxying on the class you can specify proxy-target-class="true" and the proxy will instead be a cglib class proxy. This is analogous to the way Spring AOP uses proxies.

Using Spring WebFlow inside Magnolia

It is possible to include a webflow as a component and embed it into a page. The example below is a controller that exposes a booking flow:

@Controller
@Template(id="myModule:components/bookingFlow", title = "Booking Flow")
public class BookingFlowController extends FlowController {

    @Override
    @Autowired
    public void setFlowExecutor(FlowExecutor flowExecutor) {
        super.setFlowExecutor(flowExecutor);
    }

    @Override
    @RequestMapping("/booking")
    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        return super.handleRequest(request, response);
    }
}

Note that you need to turn off the redirectOnPause behavior since it's not usable when the flow is embedded in a page. Also, you might want to customize the handling of NoSuchFlowException.

Examples

Using pre-execution

This is a simple controller that displays a form:

@Controller
@RequestMapping("/search")
@Template(id = "myModule:components/searchForm", title = "Search form")
@TemplateDescription("Adds a customizable search form")
public class SearchController {

    @RequestMapping(method = RequestMethod.GET)
    public ModelAndView form() {
        return new ModelAndView("searchForm");
    }

    @RequestMapping(method = RequestMethod.POST)
    public ModelAndView search(@RequestParam("q") String q) {
        if (StringUtils.isBlank(q))
            return new ModelAndView("searchForm", "errorMessage", RepositoryUtils.getLocalNodeData("errorMessage"));
        String searchUrl = RepositoryUtils.getLocalNodeData("searchUrl");
        return new ModelAndView(new RedirectView(searchUrl + q));
    }

    @TabFactory("Settings")
    public void createDialog(TabBuilder builder) {
        builder.addEdit("title", "Title", "");
        builder.addEdit("bodyText", "Text", "");
        builder.addEdit("searchUrl", "Search engine URL", "For instance: http://www.google.com/search?q=");
        builder.addEdit("errorMessage", "Error message", "For instance: You need to enter a query");
    }

    @TabValidator("Settings")
    public void validate(DialogTab dialogTab) {
        DialogEdit title = (DialogEdit) dialogTab.getSub("title");
        if (StringUtils.isEmpty(title.getValue())) {
            AlertUtil.setMessage("You need to enter a title!");
        }
    }
}

Note that the title and description that will appear in the GUI have been set using annotations.

Using JSP

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="cms-taglib" prefix="cms" %>
<%@ taglib uri="blossom-taglib" prefix="blossom" %>
<cms:editBar />
<h1>${content.title}</h2. 
<p><cms:out nodeDataName="bodyText" /></p>
<c:if test="${not empty errorMessage}">
<p style="color:red;">${errorMessage}</p>
</c:if>
<form action="?" method="POST">
    <blossom:pecid-input />
    <input type="text" name="q" />
    <input type="submit" value="Search" />
</form>

Version Repository

Version 2.0.8

Javadoc
Source cross-reference
Source repository

Version 2.0.7

Javadoc
Source cross-reference
Source repository

Version 2.0.6

Javadoc
Source cross-reference
Source repository

Version 2.0.5

Javadoc
Source cross-reference
Source repository

Version 2.0.4

Javadoc
Source cross-reference
Source repository

Version 2.0.3

Javadoc
Source cross-reference
Source repository

Version 2.0.2

Javadoc
Source cross-reference
Source repository

Version 2.0.1

Javadoc
Source cross-reference
Source repository

Version 2.0

Javadoc
Source cross-reference
Source repository

Version 1.2.4

Javadoc
Source cross-reference
Source repository

Version 1.2.3

Javadoc
Source cross-reference
Source repository

Version 1.2.2

Javadoc
Source cross-reference
Source repository

Version 1.2.1

Javadoc
Source cross-reference
Source repository

Version 1.2

Javadoc
Source cross-reference
Source repository

Version 1.1.1

Javadoc
Source cross-reference
Source repository

Release Notes

Version 2.0.8

Minor update that opens the tab ordering logic to extension.

Improvements:

  • BLOSSOM-202 Customize tab sorting

We'd like to thank everyone that has invested time in testing and providing feedback. Special thanks goes out to
Frank Sommer.

Version 2.0.7

Adds a way of checking if handler is invoked during pre-execution, and performance improvements which should be
especially notable when using Freemarker or Thymeleaf.

Improvements:

  • BLOSSOM-195 Performance improvements for forward and include wrappers

Added features:

  • BLOSSOM-178 Add exposeModelAttributes property on UuidRedirectViewResolver
  • BLOSSOM-182 Support short-hand syntax for redirecting to the current content

Version 2.0.6

Adds a short-hand syntax for redirecting to the current content and adds a flag for exposing model attributes when doing
uuid redirects.

Added features:

  • BLOSSOM-178 Add exposeModelAttributes property on UuidRedirectViewResolver
  • BLOSSOM-182 Support short-hand syntax for redirecting to the current content

Version 2.0.5

Small feature release adding support for inheriting areas from super class and a shortcut for redirecting to the current
page.

Added features:

  • BLOSSOM-104 Support for inheriting areas from super class
  • BLOSSOM-176 Placeholder for redirecting to the current page

Improvements:

  • BLOSSOM-175 MagnoliaMessageSource should have configurable basenames

Version 2.0.4

Small feature release adding support for limiting the number of components in an area.

Added features:

  • BLOSSOM-147 Support for specifying maximum components in an area

Version 2.0.3

Maintenance release for a regression in version 2.0.2.

Regressions:

  • BLOSSOM-159 NPE when opening a dialog

Thanks to Jean-Charles for reporting this.

Version 2.0.2

Maintenance release fixing a number of reported issues.

Added features:

  • BLOSSOM-112 Template and area definitions should be available for arguments to mvc handler methods

Improvements:

  • BLOSSOM-2 Expose spring macro helper and the model as request attributes in freemarker templates
  • BLOSSOM-96 Exception thrown when trying to export template without required Template annotation should include the class
  • BLOSSOM-101 TemplateDefinitionBuilder#resolveTemplateId throws IllegalStateException (with empty error string) when class is missing Template annotation
  • BLOSSOM-102 Configuration nodes for autodetected templates should be removed when updating from 1.x
  • BLOSSOM-108 UUID redirects are not resolved in pre-execution
  • BLOSSOM-130 Nesting the same JSP + Performance impact
  • BLOSSOM-152 DialogCreationContext now have methods for accessing the JCR Node directly

Thanks to everyone who has reported issues and provided feedback. Special thanks goes out to Tomas Brimor, TLN and Francisco J. Giner.

Version 2.0.1

Small feature release adding support for finding annotations on proxies and a message on update about migration.

Improvements:

  • BLOSSOM-88 Annotations are not found when using cglib proxies
  • BLOSSOM-94 Added message about migration from 1.2.x

Version 2.0

Major update for Magnolia 4.5 and its new rendering engine, page editor and templating concepts. With Magnolia 4.5
areas are explicit entities rather than implicit as node collections. The term paragraph is replaced with component.
Components and templates have been streamlined and are internally identical, the only real difference is that they
have different id formats which in turn controls where they're applicable.

@Paragraph has been deprecated and removed. Instead use @Template and set an id of the form <moduleName>:components/*

@ParagraphDescription has been renamed to @TemplateDescription

Templates now have a dialog, use the dialog annotations in the same way as you did for paragraphs.

Ids for templates and components are no longer generated from their @RequestMapping paths. As of this version they need
to be specified on the @Template annotation explicitly.

Paragraphs used to require a dialog even if there was nothing to set. This is no longer the case, a component or
template that doesn't use any of the annotations used to create a dialog will simply not have a dialog. A component is
added to the page immediately without a dialog being shown.

Areas are defined using nested classes (public static class) within a template or another area in which it belongs. They
are normal Spring Web MVC controllers the same as templates and you annotate them with @Area. You can configure which
components are available in them using the @AvailableComponents or @AvailableComponentClasses annotations. Areas have
their own dialog.

An area can inherit components from areas of the same name in the page's parent pages. By default it will only inherit
components marked for inheritance.

The content API, centered on info.magnolia.cms.core.Content, has been deprecated. It's still around and fully backwards
compatible and will be for some time. Instead we favour using the JCR API directly. Therefore in all the places where
Blossom was giving you a Content object you can now instead choose to receive a javax.jcr.Node object. This includes all
the methods you've annotated with blossom annotations as well as your @RequestMapping methods.

No longer necessary to use the ServletContextExposingContextListener as the functionality it provided is now part
of Magnolia itself. The class has been removed, you need to update your web.xml.

The <blossom:configuration> that was previously required in your applicationContext.xml is no longer required and need
to be removed.

Added features:

  • BLOSSOM-65 Templates are dialog factories for their own dialog
  • BLOSSOM-71 @TemplateDescription replaces @ParagraphDescription
  • BLOSSOM-72 @Paragraph is replaced with @Template
  • BLOSSOM-74 Templates are identified with id
  • BLOSSOM-78 Area configuration using nested classes
  • BLOSSOM-82 Areas can have available components set using the classes defining the components
  • BLOSSOM-87 @Available methods can receive the TemplateDefinition for the template

Improvements:

  • BLOSSOM-59 FactoryBeans for beans configured in JCR use JCR API
  • BLOSSOM-61 BlossomWebArgumentResolver supports passing object being rendered as JCR Node instances
  • BLOSSOM-79 ServletContextExposingContextListener is dropped
  • BLOSSOM-81 Empty dialogs are not displayed
  • BLOSSOM-83 Template ids needs to be set explicitly, generation from @RequestMapping is dropped
  • BLOSSOM-84 Template title is set with title field instead of value field

Behind the scenes:

  • BLOSSOM-58 Update for Java 6 and JCR 2.0
  • BLOSSOM-60 upgraded test to JUnit 4
  • BLOSSOM-62 UuidRedirectView and resolver use JCR terminology (workspace instead of repository)
  • BLOSSOM-63 MagnoliaComponentFactoryBean uses Components instead of FactoryUtil
  • BLOSSOM-64 Templates are registered in Magnolia using providers
  • BLOSSOM-67 Update rendering for Magnolia 4.5
  • BLOSSOM-69 TemplateExporter is customizable in beans xml and have full control of the created definition
  • BLOSSOM-70 DialogExporter is customizable in beans xml and have full control the the created definition
  • BLOSSOM-73 Dialog registry is a magnolia component
  • BLOSSOM-75 Dialogs are registered in Magnolia using providers
  • BLOSSOM-76 Update template availability callbacks for Magnolia 4.5

Version 1.2.4

Small feature release adding support for finding annotations on proxies.

Improvements:

  • BLOSSOM-88 Annotations are not found when using cglib proxies

Version 1.2.3

Extends the feature set of TabBuilder for adding multi select controls and introduces additional getters. Also makes it
possible to directly add dialog descriptions to the dialog registry. This makes it possible to have new strategies for
dialogs which is required by the new module magnolia-module-blossom-extension-data that adds support for using blossom
dialogs with node types in the data module.

Added features:

  • BLOSSOM-43 Adds TabBuilder.addMultiSelect() addInclude() and addControl()
  • BLOSSOM-50 Adds TabBuilder.getContext()
  • BLOSSOM-53 Adds TabBuilder.getDialog()

Behind the scenes:

  • BLOSSOM-51 Dialog registry accepts dialog descriptions directly and DialogDescriptionBuilder is more open to extension

Version 1.2.2

Adds an enhancement to BlossomWebArgumentResolver that allows the content objects for both page and paragraph to be
used as argument on annotated controllers. Also fixes two reported bugs.

Added features:

  • BLOSSOM-36 Support both page and paragraph content as arguments on controllers

Bug fixes:

  • BLOSSOM-37 Empty dialog when editing version 0.5 content or using Magnolia before 4.3.2
  • BLOSSOM-40 Model not emptied after rendering of paragraph completes

Version 1.2.1

Bug fix release. Fixes two issues related to context path and bridging from content rendering into Spring's DispatcherServlet and an issue with context path and uuid redirects.

Bug fixes:

  • BLOSSOM-33 - Simulated forwards should use the webapps context path
  • BLOSSOM-34 - Simulated forward attributes are not visible after an include
  • BLOSSOM-35 - Redirects based on uuid should include contextPath

Version 1.2

Big enhancements to the feature set and fixes two important bugs. Most notably added support for having beans that are
configured in the repository with support for reloading them transparently when their configuration changes. The feature
builds on an extension to Content2Bean that allows dependency injection, lifecycle events and applying AOP proxies using
the ApplicationContext. As for the ApplicationContext there's a new feature that brings in singletons from Magnolia so
that they can be specified as dependencies in bean definitions or used for autowiring. Also new in this release is a
number of enhancements for working with content in controllers even easier.

Added features:

  • BLOSSOM-14 Make possible to set a SaveHandler for a dialog
  • BLOSSOM-19 Support for DI and AOP in Content2Bean
  • BLOSSOM-20 FactoryBeans for creating beans configured in repository with support for observed reloading
  • BLOSSOM-23 WebArgumentResolver for Content, User, MgnlUser, AggregationState and Context
  • BLOSSOM-24 FactoryBean that exposes magnolia singletons in ApplicationContext
  • BLOSSOM-29 ViewResolver for sending redirects based on uuid
  • BLOSSOM-30 Support for filter and servlet proxies that defer initialization until Magnolia has finished update/install phase
  • BLOSSOM-31 @Available should be overridable in subclasses

Bug fixes:

  • BLOSSOM-16 BlossomDispatcherServlet fails to render when handlerPath is a subset of the requestURI
  • BLOSSOM-18 Multipart support doesn't work with Spring 3

Behind the scenes:

  • BLOSSOM-22 Move BlossomFilter deeper into filter chain to make sure that AggregationState is properly filled in during pre execution
  • BLOSSOM-28 Upgrade to parent pom version 19
  • BLOSSOM-32 Anonymous dialogs for paragraphs should be registered in repository like normal dialogs

Version 1.1.1

Small feature and bug fix release. The javadoc documentation has been greatly improved and extended. You can now
annotate a method in your templates to control where the template is available. Blossom now also support multipart
requests by exposing Magnolias built in support through the Spring APIs. VirtualURIMappings are now discovered
and automatically exported. There's also support for declaring them using an annotation @VirtualURIMapper. Also, if
you've done customizations to add more argument types to methods for creating and validating dialogs and tabs you'll
be pleased to see that this extension point is now more comprehensible and easy to use.

Added features:

  • BLOSSOM-1 Support for @Available to control where a template can be used
  • BLOSSOM-4 Support for exposing VirtualURIMappings and classes using @VirtualURIMapper
  • BLOSSOM-11 Support for multipart requests, bridges Springs abstraction onto Magnolia multipart processing

Bug fixes:

  • BLOSSOM-5 NPE while detecting dialog factories and encounters abstract bean
  • BLOSSOM-7 ContextLoader is not released correctly on module reload
  • BLOSSOM-12 The autodetected node is created only when needed so it won't be considered as a dialog when its empty
  • BLOSSOM-13 Use of configNode when creating dialogs

Behind the scenes:

  • BLOSSOM-8 Upgrade POM expand javadoc and pass checkstyle tests
  • BLOSSOM-9 Improve package structuring and extract detection of templates, paragraphs and dialogs to separate classes

We'd like to thank everyone that has invested time in testing and providing feedback. Special thanks goes out to Danilo Ghirardelli, Thomas Duffey, Thomas Kalmar and Åke Argéus.

Version 1.1

Blossom is now maintained and supported by Magnolia International Ltd. Package names and XML
namespace URIs change to reflect this. The Maven artifact is also changed to info.magnolia. Apart from this the release is a minor release with an important bug fix that prevented dialogs from working in Magnolia 4.3.2. Also adds support for initializing Spring within modules, adding radio button controls to dialogs and setting visibility on templates.

Added features:

  • Support for properly getting Spring initialization within module install and startup
  • Added radio button control to TabBuilder
  • Added support for visibility on templates

Bug fixes:

  • Fix for Magnolia 4.3.2, the paragraph edit dialog was broken due to changes in Magnolia
  • TabBuilder.addFile no longer throws RepositoryException
  • Methods in TemplateDescriptionBuilder changed from private to protected
  • Tabs added to dialogs have their name set to match their label

API Changes:

  • Maven artifact groupId is now info.magnolia
  • Package names changed from se.issi.magnolia. to info.magnolia.
  • Spring namespace changed from http://www.issi.se/schema/blossom to http://www.magnolia-cms.com/schema/blossom

Behind the scenes:

  • Custom paragraph select dialog is removed
  • Blossom pre-execution filter enabled by default on install

Version 1.0

As of version 1.0 Blossom gives you a much bigger feature set and some of the functionality in the previous version has matured. Unfortunately this means that some changes have to be made when upgrading. But don't worry, your content does not have to be touched.

Added features:

  • Support for exposing controllers as Templates
  • Support for creating all types of dialogs with code
  • Localization support for paragraphs, dialogs and templates
  • Rendering of views is performed using the Magnolia render chain, supports both JSP and Freemarker
  • Ordering of dialog tabs is customizable with @TabOrder
  • The locale used by Magnolia can be made visible to Spring using MagnoliaLocaleResolver
  • Magnolia's localization mechanism can be bridged into Spring using MagnoliaMessageSource
  • JSP tag pecid-input is now also available as pecidInput

Behind the scenes:

  • Blossom now exposes controllers are normal paragraphs instead of using a placeholder paragraph
    that delegates rendering to the controller. This is a much cleaner design and allows migration
    of existing content and paragraphs into Blossom.
  • Customization of the paragraph select dialog is no longer necessary.

API Changes:

  • Paragraphs are no longer named after the handlerPath they're mapped to. That is, a controller mapped to /text that was previously referred to in templates as /text is now simply text. This had to be done in order to support migration of existing configured paragraphs into Blossom. Using a forward slash / in a paragraph name was never a good idea in the first place. You don't have to specify a name on your paragraph, it will automatically use the handlerPath stripped from any slashes as its name.
  • @ParagraphTitle is renamed to @Paragraph and moves to se.issi.magnolia.module.blossom.annotation
  • @ParagraphDescription moves to se.issi.magnolia.module.blossom.annotation
  • DialogTabBuilder is renamed to TabBuilder
  • DialogTabBuilder.addText changes to TabBuilder.addEdit
  • Methods in DialogTabBuilder no longer throw RepositoryException
  • Methods in DialogTabBuilder now return the control they create
  • @DialogTabFactory is renamed to @TabFactory and moves to se.issi.magnolia.module.blossom.annotation
  • Ordering of tabs in dialogs are now set using the @TabOrder annotation
  • <blossom:handler-mapping /> is deprecated and removed
  • <blossom:paragraph-registry /> is renamed to <blossom:configuration />
  • Extension hooks in DefaultBlossomParagraphRegistry have new arguments
  • ValidatingParagraph is removed and replaced with @DialogValidator
  • Interface DialogCreator has changed and DefaultDialogCreator changes accordingly.

Version 0.5

Initial release.

Resources

Wiki - Blossom examples and articles

Blog - Tobias Mattsson

Tutorial - Spring Framework and Magnolia: Creating Complex Java-based Websites

Conference talk - Integrating Magnolia with Spring Framework using Blossom at Magnolia Conference 2010

Webinar - US Navy Integrates Spring Applications with Flying Colors Thanks to Web CMS

3 Comments

  1. Hi,

    Can you make an example of a multi step form (not using a Spring webflow)?

    Thank you

  2. Hi Federico,

    I would do that with a component that returns different views based on which step is submitted. I would keep the data collected in a session attribute until the last step is completed. You'll want the controller to have a single @RequestMapping annotated method and then in this method you'd check which step you're transitioning to.

    The MultiActionController might come in handy there if you don't want to write the check yourself. You'll want to stay away from classes such as AbstractWizardFormController and SimpleFormController though, these are outdated and definitly not best practice anymore.

    Hope that helps, Tobias

    1. Ok, perfect, you confirm the way I'm doing