Spring first in Magnolia CMS - Spring I/O 2015
2 likes3,796 views
The document discusses using the Spring framework with a content management system (CMS) like Magnolia. It provides overviews of CMS features and Spring capabilities. It then details how Spring and Blossom, a Spring module, can integrate with Magnolia to enable using Spring MVC for page controllers and templates while leveraging the Magnolia CMS for content authoring, storage, and retrieval. Areas, pages, and components are modeled with Spring controllers and templates. Content is accessed and passed to views via the node API.
![Rendering
an
area
FreeMarker
[@cms.area
name="main"
/]
JSP
<cms:area
name="main"
/>](https://image.slidesharecdn.com/springio2015presentation-150505135553-conversion-gate01/85/Spring-first-in-Magnolia-CMS-Spring-I-O-2015-20-320.jpg)
![Rendering
components
in
an
area
FreeMarker
[#list
components
as
component]
[@cms.component
content=component
/]
[/#list]
JSP
<c:forEach
items="${components}"
var="component">
<cms:component
content="${component}"
/>
</c:forEach>](https://image.slidesharecdn.com/springio2015presentation-150505135553-conversion-gate01/85/Spring-first-in-Magnolia-CMS-Spring-I-O-2015-22-320.jpg)
Spring first in Magnolia CMS - Spring I/O 2015
- 1. Tobias Mattsson @sigget Spring first in Magnolia CMS
- 2. USE SPRING OR USE A CMS?
- 3. CMS • CONTENT AUTHORING • IMAGE MANIPULATION • MULTI-‐LINGUAL • USER INTERFACE • CONTENT VERSIONING
- 4. SPRING • SPRING MVC • DEPENDENCY INJECTION • DECLARATIVE SERVICES • INTEGRATIONS • AOP
- 5. CMS IN FRONTAPP IN FRONT ORApp CMS CMS App
- 6. CMS IN FRONTAPP IN FRONT ORApp CMS CMS App
- 7. CMS IN FRONTAPP IN FRONT App CMS CMS App OR
- 8. Presentation layer Service layer SPRING AND CMS CMS App
- 9. Credit: Simplicity of Spring by ladydragonflyherworld Licensed under the CreaOve Commons APribuOon License v2.0 hPps://www.flickr.com/photos/ladydragonflyherworld/7009032119 MAGNOLIA CMS + SPRING = BLOSSOM
- 11. Credit: UnOtled by mwichary Licensed under the CreaOve Commons APribuOon License v2.0 hPps://www.flickr.com/photos/mwichary/13660842584 @Template
- 13. CMS with Blossom TEMPLATEREQUEST CONTENT CONTROLLER MODEL VIEW
- 14. @Controller @Template(id="myModule:pages/main", title="Main") public class MainTemplate { @RequestMapping("/main") public String render(ModelMap model) { return "pages/main"; } } @Template
- 15. Page, area, component model PAGE
- 16. Page, area, component model AREA A R E A AREA
- 17. Page, area, component model COMPONENT COMPONENT Etiam porta sem malesuada magna mollis euismod. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. COMPONENT Etiam porta sem malesuada magna mollis euismod. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Aenean lacinia bibendum nulla sed consectetur. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed posuere consectetur est at lobortis. C O M P O N E N T
- 18. Rendering sequence C M V Page Area Component ComponentComponent C M V C M V C M V C M V
- 19. Area template @Controller @Template(id="myModule:pages/main", title="Main Template") public class MainTemplate { @Controller @Area("main") public static class MainArea { @RequestMapping("/main/mainArea") public String render() { return "areas/main"; } … }
- 20. Rendering an area FreeMarker [@cms.area name="main" /] JSP <cms:area name="main" />
- 21. Component template @Controller @Template(id="myModule:components/shoppingCart", title="Shopping Cart") public class ShoppingCartComponent { @RequestMapping("/shoppingCart") public String handleRequest() { return "components/shoppingCart"; } ...
- 22. Rendering components in an area FreeMarker [#list components as component] [@cms.component content=component /] [/#list] JSP <c:forEach items="${components}" var="component"> <cms:component content="${component}" /> </c:forEach>
- 23. Available components @Controller @Area("promos") @AvailableComponentClasses({TextComponent.class, ShoppingCartComponent.class}) public static class PromosArea { @RequestMapping("/main/promos") public String render() { return "areas/promos"; } }
- 24. Component categories @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @ComponentCategory public @interface Promo { } @Controller @Template(title = "Text", id = "myModule:components/text") @Promo public class TextComponent { … }
- 25. Component categories @Controller @Area("promos") @AvailableComponentClasses(Promo.class) public static class PromosArea { @RequestMapping("/main/promos") public String render() { return "areas/promos"; } }
- 26. Credit: Hard Disk by Jeff Kubina Licensed under the CreaOve Commons APribuOon License v2.0 hPps://www.flickr.com/photos/kubina/326629411 PERSISTENCE
- 27. JCR Magnolia JCR API Persistence Manager Jackrabbit Hierarchical content repository In memoryDatabaseFile system or or “… defines an abstract model and a Java API for data storage and related services commonly used by content-‐oriented applications.” – JSR-‐283
- 28. Content structure Component template=…/textComponent header=Company news Component template=…/videoComponent header=Buy more soda! Page template=myModule:pages/pageTemplate title=About Area name=main border=1 Area name=banners
- 29. Accessing content in controllers @Controller @Template(id="myModule:components/text", title="Text") public class TextComponent { @RequestMapping("/text") public String render(ModelMap model, Node node) { String text = node.getProperty("text").getString(); model.addAttribute("text", text); return "components/text"; } }
- 30. HandlerMethodArgumentResolver @Override public boolean supportsParameter(MethodParameter parameter) { Class<?> parameterType = parameter.getParameterType(); return parameterType.isAssignableFrom(Node.class); } @Override public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception { return renderingContext.getCurrentContent(); }
- 31. Credit: Apple Keyboard by DeclanTM Licensed under the CreaOve Commons APribuOon License v2.0 hPps://www.flickr.com/photos/declanjewell/2687934126 DIALOGS
- 32. Fluent builder style API @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields( cfg.fields.text("heading").label("Heading"), cfg.fields.richText("body").label("Text body"), cfg.fields.websiteLink("categoryLink").label("Link"), cfg.fields.basicUpload("image").label("Image"), cfg.fields.checkbox("inlineImage").label("Inline Image") ); }
- 33. @Controller @Template(id="myModule:pages/article", title="Article") public class ArticleTemplate { @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("title").label("Title")); } } Page template with dialog
- 34. @Controller @Template(id="myModule:pages/article", title="Article") public class ArticleTemplate { @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("title").label("Title")); } } Page template with dialog
- 35. @Controller @Template(id="myModule:pages/article", title="Article") public class ArticleTemplate { @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("title").label("Title")); } } Page template with dialog <title>${content.title}<title>
- 36. @Controller @Template(id="myModule:pages/article", title="Article") public class ArticleTemplate { @Area("main") @Controller public static class MainArea { @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("heading").label("Heading"), cfg.fields.text("border").label("Border width")); } } Area with dialog
- 37. @Controller @Template(id="myModule:pages/article", title="Article") public class ArticleTemplate { @Area("main") @Controller public static class MainArea { @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("heading").label("Heading"), cfg.fields.text("border").label("Border width")); } } Area with dialog
- 38. @Controller @Template(id="myModule:components/text", title="Text") public class TextComponent { @RequestMapping("/text") public String render() { return "components/text"; } @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("heading").label("Heading"), cfg.fields.richText("body").label("Text body”)); } Component template with dialog
- 39. @Controller @Template(id="myModule:components/text", title="Text") public class TextComponent { @RequestMapping("/text") public String render() { return "components/text"; } @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("heading").label("Heading"), cfg.fields.richText("body").label("Text body”)); } Component template with dialog
- 40. @Controller @Template(id="myModule:components/youtube", title="YouTube") public class YoutubeComponent { @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { tab.fields(cfg.fields.text("videoId").label("Video Id”)); } @RequestMapping(“/youtube") public String render(Node node, ModelMap model) { model.put("videoId", node.getProperty(“videoId").getString()); return “components/youtube"; } } Youtube video component
- 41. Dynamic dialog @Autowired private SalesApplicationWebService service; @TabFactory("Content") public void contentTab(UiConfig cfg, TabBuilder tab) { Collection<String> categories = service.getBookCategories(); tab.fields( cfg.fields.select(“category").label("Category").options(categories)); } } @RequestMapping("/bookcategory") public String render(ModelMap model, Node content) { String category = content.getProperty(“category").getString(); model.put("books", service.getBooksInCategory(category)); return "components/bookCategory"; }
- 42. Dialogs and class hierarchies public abstract class BasePageTemplate { @TabFactory("Meta") public void metaTab(UiConfig cfg, TabBuilder tab) { tab.fields( cfg.fields.text("metaAuthor").label("Author"), cfg.fields.text("metaKeywords").label("Keywords"), cfg.fields.text("metaDescription").label("Description") ); } }
- 43. Dialogs and class hierarchies public abstract class BasePageTemplate { @TabFactory("Meta") public void metaTab(UiConfig cfg, TabBuilder tab) { tab.fields( cfg.fields.text("metaAuthor").label("Author"), cfg.fields.text("metaKeywords").label("Keywords"), cfg.fields.text("metaDescription").label("Description") ); } }
- 44. Dialog factories @DialogFactory("front-‐page-‐dialog") public class FrontPageDialog { @TabFactory("Margins") public void marginsTab(UiConfig cfg, TabBuilder tab) { tab.fields( cfg.fields.text("leftMargin").label("Left Margin"), cfg.fields.text("rightMargin").label("Right Margin")); } } @Controller @Template(id="myModule:pages/main", title=“Main", dialog="front-‐page-‐dialog") public class MainTemplate {
- 45. DEMO
- 46. Credit: NASA www.nasa.gov/vision/space/features/apollo_lor.html HOW IT WORKS
- 47. BeanPostProcessor @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { return bean; } @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { if (bean instanceof RequestMappingInfoHandlerMapping) { RequestMappingInfoHandlerMapping m = (RequestMappingInfoHandlerMapping) bean; Map<RequestMappingInfo,HandlerMethod> methods = m.getHandlerMethods(); for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : methods.entrySet()) { Object handler = handlerMethod.createWithResolvedBean().getBean(); if (handlerClass.isAnnotationPresent(Template.class)) { … } } } } return bean; }
- 48. Rendering integration Handler Adapter Controller Handler Mapping View Resolver View Dispatcher Servlet Rendering EngineFilter Chain Blossom Renderer fake wrappers
- 49. Forms and redirects @RequestMapping(value="/contact", method=RequestMethod.GET) public String viewForm(@ModelAttribute ContactForm form) { return "components/contactForm"; } @RequestMapping(value="/contact", method=RequestMethod.POST) public String handleSubmit(@Valid ContactForm form, BindingResult result) { if (result.hasErrors()) return “components/contactForm"; return "redirect:/contact/thankyou.html"; }
- 50. Redirects C M V Page Area Component ComponentComponent C M V C M V C M VC M V X
- 51. Controller pre-‐execution C M V Page Area Component Component C M V Component C C M V C M V C M V
- 52. Pre-‐execution in view In JSP <form> <blossom:pecid-‐input /> <input type="text" name="email" /> HTML Output <form> <input type="hidden" name="_pecid" value="ff6cefa6-‐d958-‐47b1-‐af70-‐c82a414f17e1" /> <input type="text" name="email" />
- 53. SPRING WEB MVC with CONTENT
- 54. QUESTIONS?
- 55. THANK YOU!