Examples of EnvironmentLoaderListener

org.apache.shiro.web.env.EnvironmentLoaderListener

Bootstrap listener to startup and shutdown the web application's Shiro {@link WebEnvironment} at ServletContext startup and shutdown respectively. This class exists only toimplement the {@link ServletContextListener} interface. All 'real' logic is done in the parent{@link EnvironmentLoader} class.

Usage

Define the following in {@code web.xml}:

 <listener> <listener-class>org.apache.shiro.web.env.EnvironmentLoaderListener</listener-class> </listener>

Configuration options, such as the {@code WebEnvironment} class to instantiate as well as Shiro configurationresource locations are specified as {@code ServletContext} {@code context-param}s and are documented in the {@link EnvironmentLoader} JavaDoc.

Shiro Filter

This listener is almost always defined in conjunction with the {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} to ensure security operations for web requests. Pleasesee the {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} JavaDoc for more. @see EnvironmentLoader @see org.apache.shiro.web.servlet.ShiroFilter ShiroFilter @since 1.2


  @Before
  public void setupTest() throws Exception {
    ServletContextHandler context = new ServletContextHandler( ServletContextHandler.SESSIONS );
    context.setContextPath( "/" );
    context.addEventListener( new EnvironmentLoaderListener() );


    // Add root ShiroFilter, all remaining filters and filter chains are defined in shiro.ini's [urls] section.
    FilterHolder filterHolder = new FilterHolder( new ShiroFilter() );
    ServletHolder servletHolder = new ServletHolder( new MockServlet() );


  @Before
  public void setupTest() throws Exception {
    ServletContextHandler context = new ServletContextHandler( ServletContextHandler.SESSIONS );
    context.setContextPath( "/" );
    context.addEventListener( new EnvironmentLoaderListener() );


    // Add root ShiroFilter, all remaining filters and filter chains are defined in shiro.ini's [urls] section.
    FilterHolder filterHolder = new FilterHolder( new ShiroFilter() );
    ServletHolder servletHolder = new ServletHolder( new MockServlet() );


            ServletContextHandler context = new ServletContextHandler();
            context.setContextPath( "/" );


            context.setInitParameter( "shiroConfigLocations", "classpath:web-shiro.ini" );
            context.addEventListener( new EnvironmentLoaderListener() );


            context.addFilter( ShiroFilter.class, "/*", EnumSet.of( REQUEST, FORWARD, INCLUDE, ERROR ) );


            server.setHandler( context );
            server.start();

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.