Examples of org.springframework.web.servlet.mvc.Controller

Package org.springframework.web.servlet.mvc

Examples of org.springframework.web.servlet.mvc.Controller

org.springframework.web.servlet.mvc.Controller
Base Controller interface, representing a component that receives HttpServletRequest and HttpServletResponse instances just like a HttpServlet but is able to participate in an MVC workflow. Controllers are comparable to the notion of a Struts Action.
Any implementation of the Controller interface should be a reusable, thread-safe class, capable of handling multiple HTTP requests throughout the lifecycle of an application. To be able to configure a Controller easily, Controller implementations are encouraged to be (and usually are) JavaBeans.

Workflow

After a DispatcherServlet has received a request and has done its work to resolve locales, themes and suchlike, it then tries to resolve a Controller, using a {@link org.springframework.web.servlet.HandlerMapping HandlerMapping}. When a Controller has been found to handle the request, the {@link #handleRequest(HttpServletRequest,HttpServletResponse) handleRequest}method of the located Controller will be invoked; the located Controller is then responsible for handling the actual request and - if applicable - returning an appropriate {@link org.springframework.web.servlet.ModelAndView ModelAndView}. So actually, this method is the main entrypoint for the {@link org.springframework.web.servlet.DispatcherServlet DispatcherServlet}which delegates requests to controllers. This method - and also this interface - should preferrably not be implemented by custom controllers directly, since abstract controller also provided by this package already provide a lot of functionality for typical use cases in web applications. A few examples of those controllers: {@link AbstractController AbstractController}, {@link AbstractCommandController AbstractCommandController}, {@link SimpleFormController SimpleFormController}.

So basically any direct implementation of the Controller interface just handles HttpServletRequests and should return a ModelAndView, to be further interpreted by the DispatcherServlet. Any additional functionality such as optional validation, form handling, etc should be obtained through extending one of the abstract controller classes mentioned above.

Notes on design and testing

The Controller interface is explicitly designed to operate on HttpServletRequest and HttpServletResponse objects, just like an HttpServlet. It does not aim to decouple itself from the Servlet API, in contrast to, for example, WebWork, JSF or Tapestry. Instead, the full power of the Servlet API is available, allowing Controllers to be general-purpose: a Controller is able to not only handle web user interface requests but also to process remoting protocols or to generate reports on demand.

Controllers can easily be tested by passing in mock objects for the HttpServletRequest and HttpServletResponse objects as parameters to the {@link #handleRequest(HttpServletRequest,HttpServletResponse) handleRequest}method. As a convenience, Spring ships with a set of Servlet API mocks that are suitable for testing any kind of web components, but are particularly suitable for testing Spring web controllers. In contrast to a Struts Action, there is no need to mock the ActionServlet or any other infrastructure; HttpServletRequest and HttpServletResponse are sufficient.

If Controllers need to be aware of specific environment references, they can choose to implement specific awareness interfaces, just like any other bean in a Spring (web) application context can do, for example:
- org.springframework.context.ApplicationContextAware
- org.springframework.context.ResourceLoaderAware
- org.springframework.web.context.ServletContextAware
Such environment references can easily be passed in testing environments, through the corresponding setters defined in the respective awareness interfaces. In general, it is recommended to keep the dependencies as minimal as possible: for example, if all you need is resource loading, implement ResourceLoaderAware only. Alternatively, derive from the WebApplicationObjectSupport base class, which gives you all those references through convenient accessors - but requires an ApplicationContext reference on initialization.
Controllers can optionally implement the LastModified interface. @author Rod Johnson @author Juergen Hoeller @see LastModified @see SimpleControllerHandlerAdapter @see AbstractController @see AbstractCommandController @see SimpleFormController @see org.springframework.mock.web.MockHttpServletRequest @see org.springframework.mock.web.MockHttpServletResponse @see org.springframework.context.ApplicationContextAware @see org.springframework.context.ResourceLoaderAware @see org.springframework.web.context.ServletContextAware @see org.springframework.web.context.support.WebApplicationObjectSupport


    protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) throws Exception {
        String path = request.getServletPath();
        String internalPath = path.replaceAll(xmlMarker, "");


        Controller controller = (Controller) getApplicationContext().getBean(internalPath);
        if (controller != null) {
                ModelAndView modelAndView = controller.handleRequest(request, response);
                if (modelAndView.getModel() != null) {
                    TransportableModel tm = new TransportableModel();
                    tm.putAll(modelAndView.getModel());
                    XStream x = new XStream();
                    x.toXML(tm, response.getWriter());

View Full Code Here

    parameterSeparator = "_";
    nameValueSeparator = "-";
    setAdapterProperties();
    
    HttpServletRequest request = new MockHttpServletRequest(GET, "/foo~a-1_b-2.html");
    adapter.handle(request, new MockHttpServletResponse(), new Controller() {


      public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        assertEquals("a is not 1", "1", request.getParameter("a"));
        assertEquals("b is not 2", "2", request.getParameter("b"));
        assertEquals("not two parameters", 2, request.getParameterMap().size());

View Full Code Here

    parameterSeparator = ".am.";
    nameValueSeparator = ".eq.";
    setAdapterProperties();
    
    HttpServletRequest request = new MockHttpServletRequest(GET, "/foo.qm.a.eq.1.am.b.eq.2.html");
    adapter.handle(request, new MockHttpServletResponse(), new Controller() {


      public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        assertEquals("a is not 1", "1", request.getParameter("a"));
        assertEquals("b is not 2", "2", request.getParameter("b"));
        assertEquals("not two parameters", 2, request.getParameterMap().size());

View Full Code Here

   */
  public void testOtherSuffix() throws Exception {
    setAdapterProperties();
    
    HttpServletRequest request = new MockHttpServletRequest(GET, "/foo~a-1_b-2.gif");
    adapter.handle(request, new MockHttpServletResponse(), new Controller() {


      public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        assertEquals("The uri should be /foo~a-1_b-2.gif", "/foo~a-1_b-2.gif", request.getRequestURI());
        assertEquals("there are parameters", 0, request.getParameterMap().size());
        return null;

View Full Code Here

   */
  public void testMultipleValues() throws Exception {
    setAdapterProperties();
    
    HttpServletRequest request = new MockHttpServletRequest(GET, "/foo~a-1_a-2_b-3.html");
    adapter.handle(request, new MockHttpServletResponse(), new Controller() {


      public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        String[] values = request.getParameterValues("a");
        assertEquals("Should have two values", 2, values.length);
        // there is no guarantee that the values will be in order; we must sort the names

View Full Code Here

  /**
   * Verify that if the {@link #controller} is a proxy, but isn't a {@link BaseCommandController}
   *  it still works correctly (o.e. no-op).
   */
  public void testHappyCaseWithProxiedPlainController() throws Exception {
    Controller plainController = new PlainController();
    ProxyFactory factory = new ProxyFactory(plainController);
    Object proxiedController = factory.getProxy();
    
    this.interceptor.postHandle(this.request, this.response, proxiedController, this.modelAndView);

View Full Code Here

  /**
   * Verify that the handler works correctly (i.e. is a no-op) when the {@link #controller}
   * isn't a {@link org.springframework.web.servlet.mvc.BaseCommandController}.
   */
  public void testWhenHandlerIsntBaseCommandController() throws Exception {
    Controller plainController = new PlainController();
    this.interceptor.postHandle(this.request, this.response, plainController, this.modelAndView);
    
    Map map = this.modelAndView.getModel();
    assertFalse("expected non BaseCommandControllers to be ignored", map.containsKey("ValangRules.command"));
  }

View Full Code Here

    return transformerFactory;
  }
  
  public HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {


    Controller controller = new InspectRequestManager().lookupController(request, getTransformerFactory());


    if (controller == null)
      return null;
    
    return new HandlerExecutionChain(controller);

View Full Code Here

TOP

Related Classes of org.springframework.web.servlet.mvc.Controller

com.googlecode.psiprobe.controllers.BeanToXmlController

org.salamandra.web.spring.view.SalamandraWebViewResolver

org.springmodules.validation.valang.javascript.taglib.ValangRulesExporterInterceptorTests

org.springmodules.web.servlet.mvc.SearchEngineFriendlyHandlerAdapterTest

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.