Open Source Repository

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


org/springframework/mock/web/portlet/MockResourceRequest.java
/*
 * Copyright 2002-2009 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.portlet;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.portlet.PortalContext;
import javax.portlet.PortletContext;
import javax.portlet.RenderRequest;
import javax.portlet.ResourceRequest;

/**
 * Mock implementation of the {@link javax.portlet.ResourceRequest} interface.
 *
 @author Juergen Hoeller
 @since 3.0
 */
public class MockResourceRequest extends MockClientDataRequest implements ResourceRequest {

  private String resourceID;

  private String cacheability;

  private final Map<String, String[]> privateRenderParameterMap = new LinkedHashMap<String, String[]>();


  /**
   * Create a new MockResourceRequest with a default {@link MockPortalContext}
   * and a default {@link MockPortletContext}.
   @see org.springframework.mock.web.portlet.MockPortalContext
   @see org.springframework.mock.web.portlet.MockPortletContext
   */
  public MockResourceRequest() {
    super();
  }

  /**
   * Create a new MockResourceRequest with a default {@link MockPortalContext}
   * and a default {@link MockPortletContext}.
   @param resourceID the resource id for this request
   */
  public MockResourceRequest(String resourceID) {
    super();
    this.resourceID = resourceID;
  }

  /**
   * Create a new MockResourceRequest with a default {@link MockPortalContext}
   * and a default {@link MockPortletContext}.
   @param url the resource URL for this request
   */
  public MockResourceRequest(MockResourceURL url) {
    super();
    this.resourceID = url.getResourceID();
    this.cacheability = url.getCacheability();
  }

  /**
   * Create a new MockResourceRequest with a default {@link MockPortalContext}.
   @param portletContext the PortletContext that the request runs in
   */
  public MockResourceRequest(PortletContext portletContext) {
    super(portletContext);
  }

  /**
   * Create a new MockResourceRequest.
   @param portalContext the PortalContext that the request runs in
   @param portletContext the PortletContext that the request runs in
   */
  public MockResourceRequest(PortalContext portalContext, PortletContext portletContext) {
    super(portalContext, portletContext);
  }


  @Override
  protected String getLifecyclePhase() {
    return RESOURCE_PHASE;
  }

  public void setResourceID(String resourceID) {
    this.resourceID = resourceID;
  }

  public String getResourceID() {
    return this.resourceID;
  }

  public void setCacheability(String cacheLevel) {
    this.cacheability = cacheLevel;
  }

  public String getCacheability() {
    return this.cacheability;
  }

  public String getETag() {
    return getProperty(RenderRequest.ETAG);
  }

  public void addPrivateRenderParameter(String key, String value) {
    this.privateRenderParameterMap.put(key, new String[] {value});
  }

  public void addPrivateRenderParameter(String key, String[] values) {
    this.privateRenderParameterMap.put(key, values);
  }

  public Map<String, String[]> getPrivateRenderParameterMap() {
    return Collections.unmodifiableMap(this.privateRenderParameterMap);
  }

}