portleturlprovider.java.svn-base

portal越来越流行了

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.pluto.spi;

import java.util.Map;

import javax.portlet.PortletMode;
import javax.portlet.PortletSecurityException;
import javax.portlet.WindowState;
import javax.servlet.http.HttpServletRequest;

/**
 * Defines the interface used by the portlet container to create Portal URLs.
 * This provider must be implemented by the Portal and provided via the
 * container services upon initialization of the container.
 * 
 * @version 1.0
 */
public interface PortletURLProvider {


    /**
     * Sets the new portlet mode at the URL. If no mode is set at the URL the
     * currently active mode is used.
     * @param mode the new portlet mode
     */
    public void setPortletMode(PortletMode mode);

    /**
     * Sets the new window state at the URL. If no state is set at the URL the
     * currently active state is used.
     * @param state the new window state
     */
    public void setWindowState(WindowState state);

    /**
     * Specifies whether or not this request should be considered an action
     * request. If the value specified is false, a render request will be
     * assumed.
     */
    public void setAction(boolean action);

    /**
     * Specifies whether or not this request should be considered an resource Serving
     * request. 
     * @since 2.0
     */
    public void setResourceServing(boolean resource);
    
    /**
     * Shows you if the lifecycle is serveResource
     * @return true if ResourceServing else false
     * @since 2.0
     */
    public boolean isResourceServing();
    
    /**
     * By calling this method the URL is defined as a secure URL.
     */
    public void setSecure() throws PortletSecurityException ;

    /**
     * Determine whether or not this url provider
     * supports secure urls.
     * 
     * @return
     * @throws PortletSecurityException
     */
    public boolean isSecureSupported();
    
    /**
     * Removes all pre-existing parameters in this URL
     */
    public void clearParameters();

    /**
     * Sets the given parameters as parameters into the URL, Removes all
     * previously set parameters.
     * @param parameters a map containing the name [java.lang.String] and value
     *                   [java.lang.String[]] of the parameters.
     */
    public void setParameters(Map parameters);

    /**
     * Sets the given public-render-parameters as parameters into the URL.
     * @param parameters a map containing the name [java.lang.String] and value
     *                   [java.lang.String[]] of the parameters.
     */
    public void setPublicRenderParameters(Map parameters);

    /**
     * Returns the URL in string format. This method should only be called
     * once.
     * @return the URL
     */
    public String toString();
    
    public void savePortalURL(HttpServletRequest request);
    
    /**
     * Gets the values from the current public-render-parameters from this request.
     * @param name Parametername
     * @return the values for the Parameter, can be null, if there is no Parameter with this name.
     */
    public String[] getPublicRenderParameters(String name);
    
    /**
     * Gets the values from the parameters from this request. This is only used for ServeResource.
     * @param name Parametername
     * @return the values for the Parameter, can be null, if there is no Parameter with this name.
     */
    public String[] getPrivateRenderParameters(String name);

    public Map<String, String[]> parseRenderParameters(Map<String, String[]> parentMap, String queryString);
    
    public Map<String, String[]> getRenderParameters();
}