Open Source Repository

Home /spring/spring-web-portlet-3.0.5 | Repository Home


org/springframework/web/portlet/multipart/DefaultMultipartActionRequest.java
/*
 * Copyright 2002-2008 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.web.portlet.multipart;

import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.List;
import javax.portlet.ActionRequest;
import javax.portlet.filter.ActionRequestWrapper;

import org.springframework.web.multipart.MultipartFile;
import org.springframework.util.MultiValueMap;
import org.springframework.util.LinkedMultiValueMap;

/**
 * Default implementation of the {@link MultipartActionRequest} interface.
 * Provides management of pre-generated parameter values.
 *
 @author Juergen Hoeller
 @author Arjen Poutsma
 @since 2.0
 @see PortletMultipartResolver
 */
public class DefaultMultipartActionRequest extends ActionRequestWrapper implements MultipartActionRequest {

  private MultiValueMap<String, MultipartFile> multipartFiles;

  private Map<String, String[]> multipartParameters;


  /**
   * Wrap the given Portlet ActionRequest in a MultipartActionRequest.
   @param request the request to wrap
   @param mpFiles a map of the multipart files
   @param mpParams a map of the parameters to expose,
   * with Strings as keys and String arrays as values
   */
  public DefaultMultipartActionRequest(
      ActionRequest request, MultiValueMap<String, MultipartFile> mpFiles, Map<String, String[]> mpParams) {

    super(request);
    setMultipartFiles(mpFiles);
    setMultipartParameters(mpParams);
  }

  /**
   * Wrap the given Portlet ActionRequest in a MultipartActionRequest.
   @param request the request to wrap
   */
  protected DefaultMultipartActionRequest(ActionRequest request) {
    super(request);
  }


  public Iterator<String> getFileNames() {
    return getMultipartFiles().keySet().iterator();
  }

  public MultipartFile getFile(String name) {
    return getMultipartFiles().getFirst(name);
  }

  public List<MultipartFile> getFiles(String name) {
    List<MultipartFile> multipartFiles = getMultipartFiles().get(name);
    if (multipartFiles != null) {
      return multipartFiles;
    }
    else {
      return Collections.emptyList();
    }
  }
  

  public Map<String, MultipartFile> getFileMap() {
    return getMultipartFiles().toSingleValueMap();
  }

  public MultiValueMap<String, MultipartFile> getMultiFileMap() {
    return getMultipartFiles();
  }

  @Override
  public Enumeration<String> getParameterNames() {
    Set<String> paramNames = new HashSet<String>();
    Enumeration paramEnum = super.getParameterNames();
    while (paramEnum.hasMoreElements()) {
      paramNames.add((StringparamEnum.nextElement());
    }
    paramNames.addAll(getMultipartParameters().keySet());
    return Collections.enumeration(paramNames);
  }

  @Override
  public String getParameter(String name) {
    String[] values = getMultipartParameters().get(name);
    if (values != null) {
      return (values.length > ? values[0null);
    }
    return super.getParameter(name);
  }

  @Override
  public String[] getParameterValues(String name) {
    String[] values = getMultipartParameters().get(name);
    if (values != null) {
      return values;
    }
    return super.getParameterValues(name);
  }

  @Override
  @SuppressWarnings("unchecked")
  public Map<String, String[]> getParameterMap() {
    Map<String, String[]> paramMap = new HashMap<String, String[]>();
    paramMap.putAll(super.getParameterMap());
    paramMap.putAll(getMultipartParameters());
    return paramMap;
  }


  /**
   * Set a Map with parameter names as keys and list of MultipartFile objects as values.
   * To be invoked by subclasses on initialization.
   */
  protected final void setMultipartFiles(MultiValueMap<String, MultipartFile> multipartFiles) {
    this.multipartFiles =
        new LinkedMultiValueMap<String, MultipartFile>(Collections.unmodifiableMap(multipartFiles));
  }

  /**
   * Obtain the MultipartFile Map for retrieval,
   * lazily initializing it if necessary.
   @see #initializeMultipart()
   */
  protected MultiValueMap<String, MultipartFile> getMultipartFiles() {
    if (this.multipartFiles == null) {
      initializeMultipart();
    }
    return this.multipartFiles;
  }

  /**
   * Set a Map with parameter names as keys and String array objects as values.
   * To be invoked by subclasses on initialization.
   */
  protected final void setMultipartParameters(Map<String, String[]> multipartParameters) {
    this.multipartParameters = multipartParameters;
  }

  /**
   * Obtain the multipart parameter Map for retrieval,
   * lazily initializing it if necessary.
   @see #initializeMultipart()
   */
  protected Map<String, String[]> getMultipartParameters() {
    if (this.multipartParameters == null) {
      initializeMultipart();
    }
    return this.multipartParameters;
  }

  /**
   * Lazily initialize the multipart request, if possible.
   * Only called if not already eagerly initialized.
   */
  protected void initializeMultipart() {
    throw new IllegalStateException("Multipart request not initialized");
  }

}