Author: tchemit Date: 2011-11-13 16:34:52 +0100 (Sun, 13 Nov 2011) New Revision: 133 Url: http://nuiton.org/repositories/revision/nuiton-web/133 Log: add documentation for TopiaFilter Added: trunk/nuiton-web/src/site/apt/TopiaFilter.apt.vm Modified: trunk/nuiton-web/src/site/site_fr.xml Added: trunk/nuiton-web/src/site/apt/TopiaFilter.apt.vm =================================================================== --- trunk/nuiton-web/src/site/apt/TopiaFilter.apt.vm (rev 0) +++ trunk/nuiton-web/src/site/apt/TopiaFilter.apt.vm 2011-11-13 15:34:52 UTC (rev 133) @@ -0,0 +1,72 @@ + +Topia Filter + +* Abstract + + The topia filter permits to manage the topia transaction inside a http servlet + request. + +* Usage + + * Implements the abstract filter. + +------------------------------------------------ +package fr.ifremer.echobase.ui; + +import org.nuiton.topia.TopiaContext; +import org.nuiton.topia.TopiaException; +import org.nuiton.topia.TopiaRuntimeException; +import org.nuiton.web.filter.TopiaTransactionFilter; + +/** + * EchoBase implementation of the {@link TopiaTransactionFilter}. + * + * @author tchemit <chemit@codelutin.com> + * @since 0.1 + */ +public class EchoBaseTopiaTransactionFilter extends TopiaTransactionFilter { + + @Override + protected TopiaContext beginTransaction() throws TopiaRuntimeException { + + TopiaContext rootContext = ... // obtain your root context; + TopiaContext transaction = null; + try { + transaction = rootContext.beginTransaction(); + } catch (TopiaException eee) { + throw new TopiaRuntimeException("Could not start transaction", eee); + } + return transaction; + } +} +------------------------------------------------ + + * Adds it in our <<web.xml>> : + +------------------------------------------------ + +<filter> + <filter-name>topiaTransaction</filter-name> + <filter-class>fr.ifremer.echobase.ui.EchoBaseTopiaTransactionFilter</filter-class> +</filter> + +... + +<filter-mapping> + <filter-name>topiaTransaction</filter-name> + <url-pattern>/*</url-pattern> +</filter-mapping> + + +------------------------------------------------ + + * Obtain transaction from the http requeststored in the attribute name given + by <<topiaTransaction>>. + There is also a usefull method to obtain it from TopiaTransactionFilter : + +------------------------------------------------ + + HttpServletRequest request = ...; + transaction = TopiaTransactionFilter.getTransaction(request); + +------------------------------------------------ \ No newline at end of file Property changes on: trunk/nuiton-web/src/site/apt/TopiaFilter.apt.vm ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: svn:eol-style + native Modified: trunk/nuiton-web/src/site/site_fr.xml =================================================================== --- trunk/nuiton-web/src/site/site_fr.xml 2011-11-09 15:54:16 UTC (rev 132) +++ trunk/nuiton-web/src/site/site_fr.xml 2011-11-13 15:34:52 UTC (rev 133) @@ -41,6 +41,7 @@ <menu name="Utilisateur"> <item name="Accueil" href="index.html"/> + <item name="Topia Filter" href="/TopiaFilter.html"/> <item name="War launcher" href="/Warlauncher.html"/> </menu>