svn commit: r543153 - /portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java

[at...@apache.org]

Author: ate
Date: Thu May 31 08:11:49 2007
New Revision: 543153

URL: http://svn.apache.org/viewvc?view=rev&rev=543153
Log:
PB-65:  A new generic interface for direct access to a portlet, a lightweight version of what Portlet 2.0 ResourceURL will provide
See: https://issues.apache.org/jira/browse/PB-65

Added:
    portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java   (with props)

Added: portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java
URL: http://svn.apache.org/viewvc/portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java?view=auto&rev=543153
==============================================================================
--- portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java (added)
+++ portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java Thu May 31 08:11:49 2007
@@ -0,0 +1,50 @@
+/*
+ * 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.portals.bridges.common;
+
+import java.util.Map;
+
+import javax.portlet.PortletConfig;
+import javax.portlet.PortletException;
+import javax.portlet.RenderRequest;
+import javax.portlet.RenderResponse;
+
+/**
+ * A PortletResourceURLFactory can be used to generate an url for direct rendering of a Portlet, comparable (but more limited) 
+ * to what Portlet 2.0 (likely) is going to provide when it introduces ResourceURLs.
+ * <p>
+ * In a Portlet API 1.0 environment one is required to use portal specific extensions for directly rendering a Portlet.
+ * </p>
+ * <p>
+ * This interface can be implemented by portals which provide this type of extension to allow portal agnostic usage of it.
+ * Implementation classsz are required to provide a default constructor and only depend on the parameters provided on the
+ * {@link createResourceURL(PortletConfig, RenderRequest, RenderResponse, Map) createResourceURL} method.
+ * </p>
+ * <p>
+ * It is expected that portals will implement this interface as a RenderURL.
+ * </p>
+ * <p>
+ * Note: this interface will be defined obsolete as soon as Portlet API 2.0 is available and this functionality then is provided natively.
+ * </p>
+ * 
+ * @author <a href="mailto:ate@douma.nu">Ate Douma</a>
+ * @version $Id$
+ */
+public interface PortletResourceURLFactory
+{
+    public String createResourceURL(PortletConfig config, RenderRequest request, RenderResponse response, Map parameters) throws PortletException;
+}

Propchange: portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/bridges/trunk/common/src/java/org/apache/portals/bridges/common/PortletResourceURLFactory.java
------------------------------------------------------------------------------
    svn:keywords = Id



---------------------------------------------------------------------
To unsubscribe, e-mail: bridges-commits-unsubscribe@portals.apache.org
For additional commands, e-mail: bridges-commits-help@portals.apache.org