Examples of org.springframework.web.servlet.HandlerInterceptor

org.springframework.web.servlet.HandlerInterceptor
Workflow interface that allows for customized handler execution chains. Applications can register any number of existing or custom interceptors for certain groups of handlers, to add common preprocessing behavior without needing to modify each handler implementation.
A HandlerInterceptor gets called before the appropriate HandlerAdapter triggers the execution of the handler itself. This mechanism can be used for a large field of preprocessing aspects, e.g. for authorization checks, or common handler behavior like locale or theme changes. Its main purpose is to allow for factoring out repetitive handler code.
In an async processing scenario, the handler may be executed in a separate thread while the main thread exits without rendering or invoking the {@code postHandle} and {@code afterCompletion} callbacks. When concurrenthandler execution completes, the request is dispatched back in order to proceed with rendering the model and all methods of this contract are invoked again. For further options and details see {@code org.springframework.web.servlet.AsyncHandlerInterceptor}
Typically an interceptor chain is defined per HandlerMapping bean, sharing its granularity. To be able to apply a certain interceptor chain to a group of handlers, one needs to map the desired handlers via one HandlerMapping bean. The interceptors themselves are defined as beans in the application context, referenced by the mapping bean definition via its "interceptors" property (in XML: a <list> of <ref>).
HandlerInterceptor is basically similar to a Servlet 2.3 Filter, but in contrast to the latter it just allows custom pre-processing with the option of prohibiting the execution of the handler itself, and custom post-processing. Filters are more powerful, for example they allow for exchanging the request and response objects that are handed down the chain. Note that a filter gets configured in web.xml, a HandlerInterceptor in the application context.
As a basic guideline, fine-grained handler-related preprocessing tasks are candidates for HandlerInterceptor implementations, especially factored-out common handler code and authorization checks. On the other hand, a Filter is well-suited for request content and view content handling, like multipart forms and GZIP compression. This typically shows when one needs to map the filter to certain content types (e.g. images), or to all requests. @author Juergen Hoeller @since 20.06.2003 @see HandlerExecutionChain#getInterceptors @see org.springframework.web.servlet.handler.HandlerInterceptorAdapter @see org.springframework.web.servlet.handler.AbstractHandlerMapping#setInterceptors @see org.springframework.web.servlet.handler.UserRoleAuthorizationInterceptor @see org.springframework.web.servlet.i18n.LocaleChangeInterceptor @see org.springframework.web.servlet.theme.ThemeChangeInterceptor @see javax.servlet.Filter

    MockControl sessionControl = MockControl.createControl(Session.class);
    Session session = (Session) sessionControl.getMock();


    OpenSessionInViewInterceptor rawInterceptor = new OpenSessionInViewInterceptor();
    rawInterceptor.setSessionFactory(sf);
    HandlerInterceptor interceptor = new WebRequestHandlerInterceptorAdapter(rawInterceptor);


    MockServletContext sc = new MockServletContext();
    MockHttpServletRequest request = new MockHttpServletRequest(sc);
    MockHttpServletResponse response = new MockHttpServletResponse();


    sf.openSession();
    sfControl.setReturnValue(session, 1);
    session.getSessionFactory();
    sessionControl.setReturnValue(sf, 2);
    session.isOpen();
    sessionControl.setReturnValue(true, 1);
    session.setFlushMode(FlushMode.NEVER);
    sessionControl.setVoidCallable(1);
    sfControl.replay();
    sessionControl.replay();
    interceptor.preHandle(request, response, "handler");
    assertTrue(TransactionSynchronizationManager.hasResource(sf));


    // check that further invocations simply participate
    interceptor.preHandle(request, response, "handler");


    assertEquals(session, SessionFactoryUtils.getSession(sf, false));


    interceptor.preHandle(request, response, "handler");
    interceptor.postHandle(request, response, "handler", null);
    interceptor.afterCompletion(request, response, "handler", null);


    interceptor.postHandle(request, response, "handler", null);
    interceptor.afterCompletion(request, response, "handler", null);


    interceptor.preHandle(request, response, "handler");
    interceptor.postHandle(request, response, "handler", null);
    interceptor.afterCompletion(request, response, "handler", null);


    sfControl.verify();
    sessionControl.verify();


    sfControl.reset();
    sessionControl.reset();
    sfControl.replay();
    sessionControl.replay();
    interceptor.postHandle(request, response, "handler", null);
    assertTrue(TransactionSynchronizationManager.hasResource(sf));
    sfControl.verify();
    sessionControl.verify();


    sfControl.reset();
    sessionControl.reset();
    session.close();
    sessionControl.setReturnValue(null, 1);
    sfControl.replay();
    sessionControl.replay();
    interceptor.afterCompletion(request, response, "handler", null);
    assertFalse(TransactionSynchronizationManager.hasResource(sf));
    sfControl.verify();
    sessionControl.verify();
  }

View Full Code Here

    MockControl pmControl = MockControl.createControl(PersistenceManager.class);
    PersistenceManager pm = (PersistenceManager) pmControl.getMock();


    OpenPersistenceManagerInViewInterceptor rawInterceptor = new OpenPersistenceManagerInViewInterceptor();
    rawInterceptor.setPersistenceManagerFactory(pmf);
    HandlerInterceptor interceptor = new WebRequestHandlerInterceptorAdapter(rawInterceptor);


    MockServletContext sc = new MockServletContext();
    MockHttpServletRequest request = new MockHttpServletRequest(sc);
    MockHttpServletResponse response = new MockHttpServletResponse();


    pmf.getPersistenceManager();
    pmfControl.setReturnValue(pm, 1);
    pmfControl.replay();
    pmControl.replay();
    interceptor.preHandle(request, response, "handler");
    assertTrue(TransactionSynchronizationManager.hasResource(pmf));


    // check that further invocations simply participate
    interceptor.preHandle(request, response, "handler");


    interceptor.preHandle(request, response, "handler");
    interceptor.postHandle(request, response, "handler", null);
    interceptor.afterCompletion(request, response, "handler", null);


    interceptor.postHandle(request, response, "handler", null);
    interceptor.afterCompletion(request, response, "handler", null);


    interceptor.preHandle(request, response, "handler");
    interceptor.postHandle(request, response, "handler", null);
    interceptor.afterCompletion(request, response, "handler", null);


    pmfControl.verify();
    pmControl.verify();


    pmfControl.reset();
    pmControl.reset();
    pmfControl.replay();
    pmControl.replay();
    interceptor.postHandle(request, response, "handler", null);
    assertTrue(TransactionSynchronizationManager.hasResource(pmf));
    pmfControl.verify();
    pmControl.verify();


    pmfControl.reset();
    pmControl.reset();
    pm.close();
    pmControl.setVoidCallable(1);
    pmfControl.replay();
    pmControl.replay();
    interceptor.afterCompletion(request, response, "handler", null);
    assertFalse(TransactionSynchronizationManager.hasResource(pmf));
    pmfControl.verify();
    pmControl.verify();
  }

View Full Code Here

                        }
                    }
                });
            }


            HandlerInterceptor interceptor = new ConverterHandlerInterceptor(converter, returnTypeClass,
                    getResultsMethod, (setResultsMethod != null ? setResultsMethod : altSetResultsMethod.get()));


            MappedInterceptor mappedInterceptor = new MappedInterceptor(pathPatterns, interceptor);
            setInterceptors(new Object[]{ mappedInterceptor });

View Full Code Here

  }


  @Test
  public void mappedInterceptors() throws Exception {
    String path = "/foo";
    HandlerInterceptor interceptor = new HandlerInterceptorAdapter() {};
    MappedInterceptor mappedInterceptor = new MappedInterceptor(new String[] {path}, interceptor);


    TestRequestMappingInfoHandlerMapping hm = new TestRequestMappingInfoHandlerMapping();
    hm.registerHandler(new TestController());
    hm.setInterceptors(new Object[] { mappedInterceptor });

View Full Code Here

                try {
                    //excute the pre handler step
                    Collection interceptors = 
                        GeoServerExtensions.extensions(HandlerInterceptor.class, applicationContext );
                    for ( Iterator i = interceptors.iterator(); i.hasNext(); ) {
                        HandlerInterceptor interceptor = (HandlerInterceptor) i.next();
                        interceptor.preHandle( request, response, dispatcher );
                    }
                    
                    //execute 
                    //dispatcher.handleRequest( request, response );
                    dispatcher.service(request, response);
                    
                    //execute the post handler step
                    for ( Iterator i = interceptors.iterator(); i.hasNext(); ) {
                        HandlerInterceptor interceptor = (HandlerInterceptor) i.next();
                        interceptor.postHandle( request, response, dispatcher, null );
                    }
                } catch(RuntimeException e) {
                    throw e;
                } catch(IOException e) {
                    throw e;

View Full Code Here

  /**
   * Obtain the {@link FacesHandlerInterceptor} by searching all mapped interceptors.
   * @return the interceptor
   */
  protected HandlerInterceptor findFacesHandlerInterceptor() {
    HandlerInterceptor interceptor = null;
    Map<String, MappedInterceptor> mappedInterceptors = BeanFactoryUtils.beansOfTypeIncludingAncestors(
        getApplicationContext(), MappedInterceptor.class, true, false);
    for (MappedInterceptor mappedInterceptor : mappedInterceptors.values()) {
      if (mappedInterceptor.getInterceptor() instanceof FacesHandlerInterceptor) {
        Assert.state(interceptor == null, "Multiple " + FacesHandlerInterceptor.class.getSimpleName()

View Full Code Here

                try {
                    //excute the pre handler step
                    Collection interceptors = 
                        GeoServerExtensions.extensions(HandlerInterceptor.class, applicationContext );
                    for ( Iterator i = interceptors.iterator(); i.hasNext(); ) {
                        HandlerInterceptor interceptor = (HandlerInterceptor) i.next();
                        interceptor.preHandle( request, response, dispatcher );
                    }
                    
                    //execute 
                    //dispatcher.handleRequest( request, response );
                    dispatcher.service(request, response);
                    
                    //execute the post handler step
                    for ( Iterator i = interceptors.iterator(); i.hasNext(); ) {
                        HandlerInterceptor interceptor = (HandlerInterceptor) i.next();
                        interceptor.postHandle( request, response, dispatcher, null );
                    }
                } catch(RuntimeException e) {
                    throw e;
                } catch(IOException e) {
                    throw e;

View Full Code Here

                try {
                    //excute the pre handler step
                    Collection interceptors = 
                        GeoServerExtensions.extensions(HandlerInterceptor.class, applicationContext );
                    for ( Iterator i = interceptors.iterator(); i.hasNext(); ) {
                        HandlerInterceptor interceptor = (HandlerInterceptor) i.next();
                        interceptor.preHandle( request, response, dispatcher );
                    }
                    
                    //execute 
                    //dispatcher.handleRequest( request, response );
                    dispatcher.service(request, response);
                    
                    //execute the post handler step
                    for ( Iterator i = interceptors.iterator(); i.hasNext(); ) {
                        HandlerInterceptor interceptor = (HandlerInterceptor) i.next();
                        interceptor.postHandle( request, response, dispatcher, null );
                    }
                } catch(RuntimeException e) {
                    throw e;
                } catch(IOException e) {
                    throw e;

View Full Code Here

0 1

TOP

Related Classes of org.springframework.web.servlet.HandlerInterceptor

com.serotonin.m2m2.dojo.InterceptorDefinition

org.geoserver.test.GeoServerAbstractTestSupport

org.geoserver.test.GeoServerSystemTestSupport

org.osforce.spring4me.web.dispatcher.DispatcherServlet

org.springbyexample.mvc.method.annotation.ServiceHandlerMapping

org.springframework.orm.hibernate3.support.OpenSessionInViewTests

org.springframework.orm.jdo.support.OpenPersistenceManagerInViewTests

org.springframework.orm.jpa.support.OpenEntityManagerInViewTests

org.springframework.springfaces.mvc.servlet.FacesPostbackHandler

org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMappingTests

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.