Open Source Repository

Home /spring/spring-test-3.0.5 | Repository Home



org/springframework/mock/web/MockRequestDispatcher.java
/*
 * Copyright 2002-2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.mock.web;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.util.Assert;

/**
 * Mock implementation of the {@link javax.servlet.RequestDispatcher} interface.
 *
 <p>Used for testing the web framework; typically not necessary for
 * testing application controllers.
 *
 @author Rod Johnson
 @author Juergen Hoeller
 @since 1.0.2
 */
public class MockRequestDispatcher implements RequestDispatcher {

  private final Log logger = LogFactory.getLog(getClass());

  private final String url;


  /**
   * Create a new MockRequestDispatcher for the given URL.
   @param url the URL to dispatch to.
   */
  public MockRequestDispatcher(String url) {
    Assert.notNull(url, "URL must not be null");
    this.url = url;
  }


  public void forward(ServletRequest request, ServletResponse response) {
    Assert.notNull(request, "Request must not be null");
    Assert.notNull(response, "Response must not be null");
    if (response.isCommitted()) {
      throw new IllegalStateException("Cannot perform forward - response is already committed");
    }
    getMockHttpServletResponse(response).setForwardedUrl(this.url);
    if (logger.isDebugEnabled()) {
      logger.debug("MockRequestDispatcher: forwarding to URL [" this.url + "]");
    }
  }

  public void include(ServletRequest request, ServletResponse response) {
    Assert.notNull(request, "Request must not be null");
    Assert.notNull(response, "Response must not be null");
    getMockHttpServletResponse(response).addIncludedUrl(this.url);
    if (logger.isDebugEnabled()) {
      logger.debug("MockRequestDispatcher: including URL [" this.url + "]");
    }
  }

  /**
   * Obtain the underlying MockHttpServletResponse,
   * unwrapping {@link HttpServletResponseWrapper} decorators if necessary.
   */
  protected MockHttpServletResponse getMockHttpServletResponse(ServletResponse response) {
    if (response instanceof MockHttpServletResponse) {
      return (MockHttpServletResponseresponse;
    }
    if (response instanceof HttpServletResponseWrapper) {
      return getMockHttpServletResponse(((HttpServletResponseWrapperresponse).getResponse());
    }
    throw new IllegalArgumentException("MockRequestDispatcher requires MockHttpServletResponse");
  }

}