Open Source Repository

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



org/springframework/mock/web/portlet/MockPortletURL.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.Map;
import javax.portlet.PortalContext;
import javax.portlet.PortletMode;
import javax.portlet.PortletModeException;
import javax.portlet.PortletURL;
import javax.portlet.WindowState;
import javax.portlet.WindowStateException;

import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;

/**
 * Mock implementation of the {@link javax.portlet.PortletURL} interface.
 *
 @author John A. Lewis
 @author Juergen Hoeller
 @since 2.0
 */
public class MockPortletURL extends MockBaseURL implements PortletURL {

  public static final String URL_TYPE_RENDER = "render";

  public static final String URL_TYPE_ACTION = "action";


  private final PortalContext portalContext;

  private final String urlType;

  private WindowState windowState;

  private PortletMode portletMode;


  /**
   * Create a new MockPortletURL for the given URL type.
   @param portalContext the PortalContext defining the supported
   * PortletModes and WindowStates
   @param urlType the URL type, for example "render" or "action"
   @see #URL_TYPE_RENDER
   @see #URL_TYPE_ACTION
   */
  public MockPortletURL(PortalContext portalContext, String urlType) {
    Assert.notNull(portalContext, "PortalContext is required");
    this.portalContext = portalContext;
    this.urlType = urlType;
  }


  //---------------------------------------------------------------------
  // PortletURL methods
  //---------------------------------------------------------------------

  public void setWindowState(WindowState windowStatethrows WindowStateException {
    if (!CollectionUtils.contains(this.portalContext.getSupportedWindowStates(), windowState)) {
      throw new WindowStateException("WindowState not supported", windowState);
    }
    this.windowState = windowState;
  }

  public WindowState getWindowState() {
    return this.windowState;
  }

  public void setPortletMode(PortletMode portletModethrows PortletModeException {
    if (!CollectionUtils.contains(this.portalContext.getSupportedPortletModes(), portletMode)) {
      throw new PortletModeException("PortletMode not supported", portletMode);
    }
    this.portletMode = portletMode;
  }

  public PortletMode getPortletMode() {
    return this.portletMode;
  }

  public void removePublicRenderParameter(String name) {
    this.parameters.remove(name);
  }


  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append(encodeParameter("urlType"this.urlType));
    if (this.windowState != null) {
      sb.append(";").append(encodeParameter("windowState"this.windowState.toString()));
    }
    if (this.portletMode != null) {
      sb.append(";").append(encodeParameter("portletMode"this.portletMode.toString()));
    }
    for (Map.Entry<String, String[]> entry : this.parameters.entrySet()) {
      sb.append(";").append(encodeParameter("param_" + entry.getKey(), entry.getValue()));
    }
    return (isSecure() "https:" "http:"+
        "//localhost/mockportlet?" + sb.toString();
  }

}