1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.portals.bridges.common;
18
19 import java.util.Map;
20
21 import javax.portlet.PortletConfig;
22 import javax.portlet.PortletException;
23 import javax.portlet.RenderRequest;
24 import javax.portlet.RenderResponse;
25
26 /***
27 * A PortletResourceURLFactory can be used to generate an url for direct rendering of a Portlet, comparable (but more limited)
28 * to what Portlet 2.0 (likely) is going to provide when it introduces ResourceURLs.
29 * <p>
30 * In a Portlet API 1.0 environment one is required to use portal specific extensions for directly rendering a Portlet.
31 * </p>
32 * <p>
33 * This interface can be implemented by portals which provide this type of extension to allow portal agnostic usage of it.
34 * Implementation classsz are required to provide a default constructor and only depend on the parameters provided on the
35 * {@link createResourceURL(PortletConfig, RenderRequest, RenderResponse, Map) createResourceURL} method.
36 * </p>
37 * <p>
38 * It is expected that portals will implement this interface as a RenderURL.
39 * </p>
40 * <p>
41 * Note: this interface will be defined obsolete as soon as Portlet API 2.0 is available and this functionality then is provided natively.
42 * </p>
43 *
44 * @author <a href="mailto:ate@douma.nu">Ate Douma</a>
45 * @version $Id: PortletResourceURLFactory.java 543153 2007-05-31 15:11:49Z ate $
46 */
47 public interface PortletResourceURLFactory
48 {
49 public String createResourceURL(PortletConfig config, RenderRequest request, RenderResponse response, Map parameters) throws PortletException;
50 }