/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *     "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache" or
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jetspeed.portal;


//jetspeed support
import org.apache.jetspeed.om.registry.RegistryEntry;
import org.apache.jetspeed.om.registry.PortletEntry;
import org.apache.jetspeed.services.Registry;

//turbine
import org.apache.turbine.util.DynamicURI;
import org.apache.turbine.util.ParameterParser;
import org.apache.turbine.util.RunData;

/**
<p>
Handles providing URIs to Portlet interface providers.
</p>

<p>
The URIs are based on the individual actions such as Edit/Max.  Editing a
portlet allows you to preview it and perform certain actions such as subscribing
to it or adding it to your Mozilla sidebar.  Maximizing a portlet allows you to
view this portlet at full screen.
</p>

<p>
The following HTTP parameters are used to allow Jetspeed to figure out what to
render:

    <pre>
        name: fetches the name from the portlet registry and then adds some more info:
            - url: the URL on which this portlet is based
            - parameter-{NAME]:  allows the client to add params to a Portlet
            - metainfo-[NAME}: allows the client to supply the title or description
              of the Portlet
    </pre>

</p>

@author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
@author <a href="mailto:sgala@hisitech.com">Santiago Gala</a>
@version $Id: PortletURIManager.java,v 1.39 2003/05/07 15:16:49 morciuch Exp $
*/

public class PortletURIManager {

    //Utility methods

    /**
    Get a PortletURI by it's name and rundata

    @see #getPortletMaxURI( RegistryEntry, RunData)
    */
    public static DynamicURI getPortletMaxURI( String name, RunData data ) {
        return getPortletMaxURI( 
            Registry.getEntry(Registry.PORTLET, name ),
            data );
    }
        
    /**
    Get a URI for viewing this portlet by itself.  This is the only method that
    will work if the user has disabled cookies.
    */

    public static DynamicURI getPortletEditURI( Portlet portlet,
                                                RunData data) {

        DynamicURI uri = new DynamicURI( data, "Info" );
        uri.addPathInfo( "portlet", portlet.getName() );

        return uri;

    }

    
    /**
    Get a URL for viewing this URL full screen. This is the only method that
    will work if the user has disabled cookies.
    */
    public static DynamicURI getPortletMaxURI( RegistryEntry entry, RunData data ) {

        DynamicURI uri = new DynamicURI( data );

        uri.addPathInfo( "portlet", entry.getName() );

        return uri;

    }

    /**
    <p>
    Given a ParameterParser, get a PortletEntry.  This is used so that when you have a
    URI created from PortletURIManager you can get back the PortletEntry that created
    it originally.
    </p>

    <p>
    Return null if we aren't able to figure out the PortletEntry
    </p>
    */
    public static final PortletEntry getEntry( ParameterParser params )
    {
        String name = params.getString( "portlet" );
        return (PortletEntry)Registry.getEntry(Registry.PORTLET, name );
    }

}
