PortletPreferencesParameterProvider.java

/*
 * This program is free software; you can redistribute it and/or modify it under the 
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software 
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this 
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html 
 * or from the Free Software Foundation, Inc., 
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright 2007 - 2009 Pentaho Corporation.  All rights reserved.
 *
 */
package org.pentaho.platform.web.portal;

import java.util.Map;

import javax.portlet.PortletPreferences;

import org.pentaho.platform.api.engine.IParameterSetter;
import org.pentaho.platform.engine.core.solution.SimpleParameterProvider;

/**
 * Parameter Provider whose parameter data comes from the Portlet Preferences.
 * 
 * Note: JSR 168 specifices that portlet preferences are defined in the
 * WEB-INF/portlet.xml file.
 * 
 * @author Steven Barkdull
 * 
 */
public class PortletPreferencesParameterProvider extends SimpleParameterProvider implements IParameterSetter {

  public static final String SCOPE_PORTLET_PREFERENCES = "portletPreferences"; //$NON-NLS-1$

  private PortletPreferences portletPrefs;

  public PortletPreferencesParameterProvider(final PortletPreferences portletPrefs) {
    this.portletPrefs = portletPrefs;
    Map portletPrefsParams = portletPrefs.getMap();
    copyAndConvertParameters(portletPrefsParams);
    copyAndConvertAdditionalParameters(portletPrefsParams);
  }

  public PortletPreferences getPorteletPreferences() {
    return portletPrefs;
  }
}