{"id":898,"date":"2011-05-09T10:38:35","date_gmt":"2011-05-09T08:38:35","guid":{"rendered":"http:\/\/touk.pl\/blog\/?p=898"},"modified":"2023-03-23T10:51:10","modified_gmt":"2023-03-23T09:51:10","slug":"virgo-snaps-with-apache-tiles-integration","status":"publish","type":"post","link":"https:\/\/touk.pl\/blog\/2011\/05\/09\/virgo-snaps-with-apache-tiles-integration\/","title":{"rendered":"Virgo Snaps with Apache Tiles integration"},"content":{"rendered":"

After smoke tests become time to try using Virgo Snaps<\/strong> in more practical way. In modular application it will be useful to run it with templating framework. According to animal-menu-bar sample<\/strong> it will be better if developer of snap will not know anything about layout of host application and snippets like:<\/p>\n

\r\n<jsp:include page="\/..\/top.jsp"\/>\r\n(...)\r\n<jsp:include page="\/..\/bottom.jsp"\/>\r\n<\/pre>\n
will be not necessary to put in snap pages. So lets modify a bit hosts jsps. Template page could look similar to old index.jsp<\/strong>:<\/p>\n
\r\n<%@ taglib prefix="tiles" uri="http:\/\/tiles.apache.org\/tags-tiles" %>\r\n<jsp:include page="top.jsp"\/>\r\n\r\n<tiles:insertAttribute name="body" \/>\r\n\r\n<jsp:include page="bottom.jsp"\/>\r\n<\/pre>\n
Now index.jsp<\/strong> should not have includes:<\/p>\n
 <p>\r\n The Snap Menu Bar sample is intended to showcase the ability to dynamically change the content of a menu bar using snaps. Each\r\n of the snaps that might be displayed in the menu bar includes a top and bottom JSP page and inherits it's styling from the host\r\n bundle.  Therefore, the snap bundle is only responsible for showing a small subset of content.\r\n <\/p>\r\n<\/pre>\n
Template definition should have one template without any attributes (it will be added dynamicly):<\/p>\n
<tiles-definitions>\r\n    <definition name="defaultTemplate" template="\/template.jsp">\r\n    <\/definition>\r\n<\/tiles-definitions><\/pre>\n
To dynamic adding this definitions we must implement our TilesView<\/strong>. I’ve used one which is a part of parancoe<\/strong> – Open Source Java Web Framework available on Google Code: http:\/\/code.google.com\/p\/parancoe\/source\/browse\/plugins\/parancoe-plugin-tiles\/src\/main\/java\/org\/parancoe\/plugin\/tiles\/CheapTilesView.java?r=f42be9c3c8e2df436d4970cfdaea1aff73d9cfdb and modify it a bit for our purposes. Most interesting part is:<\/p>\n
\r\n    protected void renderMergedOutputModel(Map model, HttpServletRequest request,\r\n            HttpServletResponse response)\r\n            throws Exception {\r\n\r\n        try {\r\n            super.renderMergedOutputModel(model, request, response);\r\n        } catch (TilesException te) {\r\n            lazyRegisterThanRender(request, response);\r\n        } catch (Exception ex) {\r\n            ex.printStackTrace();\r\n        }\r\n    }\r\n\r\n    private void lazyRegisterThanRender(HttpServletRequest request, HttpServletResponse response) throws IllegalStateException {\r\n        ServletContext servletContext = getServletContext();\r\n        MutableTilesContainer container = (MutableTilesContainer)\r\n                ServletUtil.getContainer(servletContext);;\r\n        Definition definition = new Definition();\r\n\r\n        String[] arr = parsePath(getUrl());\r\n        String subContextPart = arr[0];\r\n        String mainUrlPart    = arr[1];\r\n\r\n        definition.setName(getUrl());\r\n        definition.setExtends((String) getAttribute(KEY_DEFAULT_TEMPLATE,\r\n                DEFAULT_DEFAULT_TEMPLATE));\r\n        String attributeList = (String) getAttribute(KEY_DEFAULT_ATTRIBUTES,\r\n                DEFAULT_DEFAULT_ATTRIBUTES);\r\n\r\n        String[] attributes = attributeList.split(",");\r\n        if (attributes.length == 1) {\r\n            addAttributeWithPathValueToDefinition(attributes[0], subContextPart, mainUrlPart, definition);\r\n        } else {\r\n            for (String attribute : attributes) {\r\n                addAttributeWithPathValueToDefinition(attributes[0], subContextPart, mainUrlPart + "_" + attribute, definition);\r\n            }\r\n        }\r\n\r\n        container.register(definition, request, response);\r\n        container.render(getUrl(), new Object[]{request, response});\r\n    }\r\n<\/pre>\n
How can we see here, lazyRegisterThanRender<\/em> will be invoked if Tiles will have problems in our case in resolving view name. This method registering new template which extends default one. It also adds attributes taking its values from view name. parsePath<\/em> parsing path in form: view@snap<\/em> or only: view:<\/p>\n
private String[] parsePath(String path) {\r\n        String[] arr = new String[] {"", ""};\r\n        int indexOfAt = path.indexOf('@');\r\n        if (indexOfAt > 0) {\r\n            arr[0] = '\/' + path.substring(indexOfAt+1, path.length());\r\n            arr[1] = path.substring(0, indexOfAt);\r\n        } else {\r\n            arr[1] = path;\r\n        }\r\n        return arr;\r\n    }<\/pre>\n
In our case will be only body attribute.<\/p>\n
To use Tiles we should define tilesConfigurer<\/em> in spring context. But before this we must declare DispatcherServlet<\/em> in web.xml<\/strong> which will past requests to our controllers in web.xml<\/strong>:<\/p>\n
<servlet>\r\n    <servlet-name>snap<\/servlet-name>\r\n    <servlet-class>org.springframework.web.servlet.DispatcherServlet<\/servlet-class>\r\n    <load-on-startup>2<\/load-on-startup>\r\n<\/servlet>\r\n\r\n<servlet-mapping>\r\n    <servlet-name>snap<\/servlet-name>\r\n    <url-pattern>\/*<\/url-pattern>\r\n<\/servlet-mapping>\r\n<\/pre>\n
After this simply adding WEB-INF\/snap-servlet.xml context of application will be read:<\/p>\n
<?xml version="1.0" encoding="UTF-8"?>\r\n<beans xmlns="http:\/\/www.springframework.org\/schema\/beans"\r\n    xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\r\n    xmlns:p="http:\/\/www.springframework.org\/schema\/p"\r\n    xmlns:context="http:\/\/www.springframework.org\/schema\/context"\r\n    xsi:schemaLocation="\r\n      http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans.xsd\r\n      http:\/\/www.springframework.org\/schema\/context http:\/\/www.springframework.org\/schema\/context\/spring-context.xsd\r\n          http:\/\/www.springframework.org\/schema\/osgi http:\/\/www.springframework.org\/schema\/osgi\/spring-osgi.xsd"\r\n        default-autowire="byName">\r\n\r\n    <bean id="tilesConfigurer" class="org.springframework.web.servlet.view.tiles2.TilesConfigurer">\r\n        <property name="definitions">\r\n            <list>\r\n                <value>\/WEB-INF\/tiles.xml<\/value>\r\n            <\/list>\r\n        <\/property>\r\n        <property name="useMutableTilesContainer" value="true"\/>\r\n    <\/bean>\r\n\r\n    <bean id="tilesViewResolver" class="org.springframework.web.servlet.view.tiles2.TilesViewResolver">\r\n        <property name="attributesMap">\r\n            <map>\r\n                <entry key="CheapTilesView.DEFAULT_TEMPLATE" value="defaultTemplate"\/>\r\n                <entry key="CheapTilesView.DEFAULT_ATTRIBUTES" value="body"\/>\r\n            <\/map>\r\n        <\/property>\r\n        <property name="viewClass" value="CheapTilesView"\/>\r\n    <\/bean>\r\n\r\n    <bean class="MainController"\/>\r\n\r\n<\/beans><\/pre>\n
After this, we must to add templates definitions: lib\/tiles-jsp.tld<\/strong> and few entries in template.mf<\/strong>:<\/p>\n
Manifest-Version: 1\r\nBundle-SymbolicName: animal.menu.bar\r\nBundle-Version: 1.0\r\nBundle-ManifestVersion: 2\r\nBundle-Name: Multiple Styles Host\r\nWeb-ContextPath: \/animal-menu-bar\r\nImport-Library:\r\n org.springframework.spring;version="[3.0,3.1)"\r\nImport-Bundle:\r\n com.springsource.org.apache.taglibs.standard;version="[1.1.2,1.3)",\r\n com.springsource.javax.servlet.jsp.jstl;version="[1.1.2, 1.1.3)",\r\n org.eclipse.virgo.snaps.api;version="[1.0,2.0)",\r\n com.springsource.org.apache.tiles;version="2.1.3",\r\n org.apache.tiles.core;version="2.1.3",\r\n org.apache.tiles.servlet;version="2.1.3",\r\n org.apache.tiles.jsp;version="2.1.3"\r\nImport-Package:\r\n org.eclipse.virgo.snaps.core;version="[1.0,2.0)",\r\n javax.servlet;version="2.5",\r\n javax.servlet.http;version="2.5",\r\n javax.servlet.jsp;version="2.1",\r\n org.tuckey.web.filters.urlrewrite;version="[3.1.0,3.1.0]",\r\n org.springframework.js.resource;version="[2.0,2.1)",\r\n org.springframework.stereotype;version="[3.0,3.1)",\r\n org.springframework.web.bind.annotation;version="[3.0,3.1)",\r\n org.springframework.web.servlet;version="[3.0,3.1)",\r\n org.springframework.web.servlet.view.tiles2;version="[3.0,3.1)",\r\n org.apache.tiles;version="2.1.3",\r\n org.apache.tiles.context;version="2.1.3",\r\n org.apache.tiles.impl;version="2.1.3",\r\n org.apache.tiles.jsp.context;version="2.1.3",\r\n org.apache.tiles.mgmt;version="2.1.3",\r\n org.apache.tiles.renderer.impl;version="2.1.3",\r\n org.apache.tiles.servlet.context;version="2.1.3"\r\n<\/pre>\n
Our MainController will look like:<\/p>\n
@Controller\r\npublic class MainController {\r\n    @RequestMapping("\/")\r\n    public String rootHandler() {\r\n        return "index";\r\n    }\r\n    @RequestMapping("\/index.htm")\r\n    public String snapHandler(@RequestParam("snap") String snap) {\r\n        return "index@" + snap;\r\n    }\r\n}<\/pre>\n
So we must change top.jsp in host application:<\/p>\n
                <snaps:snaps var="snaps">\r\n                    <c:forEach var="snap" items="${snaps}">\r\n                        <li><a href="<c:url value="index.htm?snap=${snap.properties['link.path']}"\/>">\r\n                            ${snap.properties['link.text']}<\/a>\r\n                        <\/li>\r\n                    <\/c:forEach>\r\n                <\/snaps:snaps><\/pre>\n
And also in snap.properties<\/strong> of both snaps link.path so it should be equals to snap subcontext (e.g. cat<\/em>, dog<\/em>).<\/p>\n
After all of this we will have some troubles with resources handling so will be necessary to add urlrewrite filters<\/strong> like it was writed on Rob’s blog about Spring Slices<\/strong><\/a> – precursor of Snaps<\/strong>: <\/p>\n
Our repository\/usr<\/strong> should have:<\/p>\n
commons-beanutils-1.8.0.jar\r\ncommons-digester-1.8.1.jar\r\ncom.springsource.org.apache.commons.collections-3.2.1.jar\r\ncom.springsource.org.apache.tiles-2.1.3.jar\r\ncom.springsource.org.tuckey.web.filters.urlrewrite-3.1.0.jar\r\norg.eclipse.virgo.snaps.api.jar\r\norg.eclipse.virgo.snaps.core.jar\r\ntiles-core-2.1.3.jar\r\ntiles-jsp-2.1.3.jar\r\ntiles-servlet-2.1.3.jar<\/pre>\n
which we can copy from maven repository.<\/p>\n
Patch with these changes is available on github<\/p>\n","protected":false},"excerpt":{"rendered":"After smoke tests become time to try using Virgo Snaps in more practical way. In modular application it…\n","protected":false},"author":28,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11],"tags":[44],"class_list":{"0":"post-898","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-development-design","7":"tag-osgi"},"_links":{"self":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/898","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/comments?post=898"}],"version-history":[{"count":28,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/898\/revisions"}],"predecessor-version":[{"id":15559,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/898\/revisions\/15559"}],"wp:attachment":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/media?parent=898"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/categories?post=898"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/tags?post=898"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}