Examples of org.apache.commons.chain.web.ChainListener

org.apache.commons.chain.web.ChainListener
ServletContextListener that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a {@link Catalog} under aspecified servlet context attribute. The following context init parameters are utilized:
- org.apache.commons.chain.CONFIG_CLASS_RESOURCE - comma-delimited list of chain configuration resources to be loaded via ClassLoader.getResource() calls. If not specified, no class loader resources will be loaded.
- org.apache.commons.chain.CONFIG_WEB_RESOURCE - comma-delimited list of chain configuration webapp resources to be loaded. If not specified, no web application resources will be loaded.
- org.apache.commons.chain.CONFIG_ATTR - Name of the servlet context attribute under which the resulting {@link Catalog} will be created or updated.If not specified, it is expected that parsed resources will contain <catalog> elements (which will cause registration of the created {@link Catalog}s into the {@link CatalogFactory} for this application, and noservet context attribute will be created. NOTE - This parameter is deprecated.
- org.apache.commons.chain.RULE_SET - Fully qualified class name of a Digester RuleSet implementation to use for parsing configuration resources (this class must have a public zero-args constructor). If not defined, the standard RuleSet implementation will be used.
When a web application that has configured this listener is started, it will acquire the {@link Catalog} under the specified servletcontext attribute key, creating a new one if there is none already there. This {@link Catalog} will then be populated by scanning configurationresources from the following sources (loaded in this order):
- Resources loaded from any META-INF/chain-config.xml resource found in a JAR file in /WEB-INF/lib.
- Resources loaded from specified resource paths from the webapp's class loader (via ClassLoader.getResource()).
- Resources loaded from specified resource paths in the web application archive (via ServetContext.getResource()).
If no attribute key is specified, on the other hand, parsed configuration resources are expected to contain <catalog> elements, and the catalogs will be registered with the {@link CatalogFactory}for this web application.

This class requires Servlet 2.3 or later. If you are running on Servlet 2.2 system, consider using {@link ChainServlet} instead.Note that {@link ChainServlet} uses parameters of thesame names, but they are servlet init parameters instead of context init parameters. Because of this, you can use both facilities in the same application, if desired.
@author Craig R. McClanahan @author Ted Husted @version $Revision: 1.7 $ $Date: 2004/11/30 05:52:23 $

      //contains a widget in the xmlns:acme="http://www.acme.org/widgets" namespace
        loadConfigFiles("/org/apache/shale/clay/config/altns-config.xml", null);
        
        // simulate invoking the common chains context listener
        servletContext.addInitParameter("org.apache.commons.chain.CONFIG_WEB_RESOURCE", "/org/apache/shale/clay/config/chain-config.xml");        
        ServletContextListener chainsListener = new ChainListener();
        ServletContextEvent servletContextEvent = new ServletContextEvent(servletContext);
        chainsListener.contextInitialized(servletContextEvent);
        
        // find the config bean definition in the commons XML config file
        ComponentBean configBean = standardConfigBean.getElement("acme:city");
        assertNotNull("acme:city exists", configBean);
        assertEquals("id", "city", configBean.getId());
        
        AttributeBean size = configBean.getAttribute("size");
        assertNotNull("size", size);
        assertEquals("size", "20", size.getValue());
        
        AttributeBean value = configBean.getAttribute("value");
        assertNotNull("value", value);
        assertEquals("value", "#{@managed-bean-name.city}", value.getValue());
        
        AttributeBean maxlength = configBean.getAttribute("maxlength");
        assertNotNull("maxlength", maxlength);
        assertEquals("maxlength", "30", maxlength.getValue());
        
        AttributeBean required = configBean.getAttribute("required");
        assertNotNull("required", required);
        assertEquals("required", "true", required.getValue());
       


        // load a template that points/extends the acme:city widget
        ComponentBean templateRoot = htmlTemplateConfigBean.getElement("/org/apache/shale/clay/config/altns.html");
        assertNotNull("/org/apache/shale/clay/config/altns.html",  templateRoot);
        
        // config bean after extend by the html template
        ComponentBean cityConfigBean = findForId(configBean.getId(), templateRoot);
        assertNotNull("city from html template", cityConfigBean);
        
        // inherit from acme:city
        assertEquals("id", "city", cityConfigBean.getId());
        
        // html override
        size = cityConfigBean.getAttribute("size");
        assertNotNull("size", size);
        assertEquals("size", "10", size.getValue());
        
        // inherit from acme:city
        value = cityConfigBean.getAttribute("value");
        assertNotNull("value", value);
        assertEquals("value", "#{@managed-bean-name.city}", value.getValue());
        
        // html override
        maxlength = cityConfigBean.getAttribute("maxlength");
        assertNotNull("maxlength", maxlength);
        assertEquals("maxlength", "100", maxlength.getValue());
        
        // html override
        required = cityConfigBean.getAttribute("required");
        assertNotNull("required", required);
        assertEquals("required", "false", required.getValue());
        
        // just because we can
        chainsListener.contextDestroyed(servletContextEvent);
    }

View Full Code Here

TOP

Related Classes of org.apache.commons.chain.web.ChainListener

org.apache.commons.chain.Catalog

org.apache.commons.chain.config.ConfigParser

org.apache.commons.chain.impl.CatalogBase

org.apache.commons.logging.Log

org.apache.shale.clay.config.ConfigAltNsTestCase

java.io.InputStream

javax.servlet.ServletContext

java.util.Set

java.net.URL

java.util.Iterator

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.