You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by ms...@apache.org on 2016/01/26 14:46:08 UTC
[2/2] portals-pluto git commit: Added new PortletResponse methods
getProperty, getPropertyNames,
getPropertyValues and ResourceResponse methods getStatus and
setContentLengthLong according to Jira issue PORTLETSPEC3-60. Extended the
HeaderPortlet and the
Added new PortletResponse methods getProperty, getPropertyNames,
getPropertyValues and ResourceResponse methods getStatus and
setContentLengthLong according to Jira issue PORTLETSPEC3-60.
Extended the HeaderPortlet and the AuthSCPortlet in the
PortletV3Demo portlet application to display the newly-available info.
Project: http://git-wip-us.apache.org/repos/asf/portals-pluto/repo
Commit: http://git-wip-us.apache.org/repos/asf/portals-pluto/commit/cefde630
Tree: http://git-wip-us.apache.org/repos/asf/portals-pluto/tree/cefde630
Diff: http://git-wip-us.apache.org/repos/asf/portals-pluto/diff/cefde630
Branch: refs/heads/V3Prototype
Commit: cefde6305f8c47f977d62433e819903010da6a1a
Parents: b30217e
Author: Scott Nicklous <ms...@apache.org>
Authored: Tue Jan 26 14:43:51 2016 +0100
Committer: Scott Nicklous <ms...@apache.org>
Committed: Tue Jan 26 14:43:51 2016 +0100
----------------------------------------------------------------------
.../main/java/basic/portlet/AuthSCPortlet.java | 10 +-
.../src/main/java/basic/portlet/Constants.java | 3 +
.../main/java/basic/portlet/HeaderPortlet.java | 19 ++
.../src/main/webapp/WEB-INF/jsp/view-hdp.jsp | 6 +
.../PortletResourceResponseContext.java | 2 +
.../pluto/container/PortletResponseContext.java | 5 +
.../container/impl/PortletResponseImpl.java | 16 ++
.../container/impl/ResourceResponseImpl.java | 11 +
.../fixtures/mocks/MockPortletResponse.java | 17 ++
.../fixtures/mocks/MockResourceResponse.java | 9 +
.../PortletResourceResponseContextImpl.java | 15 +-
.../container/PortletResponseContextImpl.java | 33 +++
.../java/javax/portlet/PortletResponse.java | 63 ++++++
.../java/javax/portlet/ResourceResponse.java | 35 ++-
.../portlet/filter/PortletResponseWrapper.java | 212 ++++++++++---------
.../portlet/filter/ResourceResponseWrapper.java | 10 +
16 files changed, 362 insertions(+), 104 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/PortletV3Demo/src/main/java/basic/portlet/AuthSCPortlet.java
----------------------------------------------------------------------
diff --git a/PortletV3Demo/src/main/java/basic/portlet/AuthSCPortlet.java b/PortletV3Demo/src/main/java/basic/portlet/AuthSCPortlet.java
index 744a867..0b0735b 100644
--- a/PortletV3Demo/src/main/java/basic/portlet/AuthSCPortlet.java
+++ b/PortletV3Demo/src/main/java/basic/portlet/AuthSCPortlet.java
@@ -88,9 +88,15 @@ public class AuthSCPortlet extends GenericPortlet {
resp.setStatus(sc);
}
- txt.append("<p>serveResource</p>")
- .append("<p>Status code: ").append(scText).append("</p>");
+ txt.append("<p>serveResource</p>");
+ txt.append("<p>Status code: ").append(scText);
+ txt.append("<br>Status code from getStatus(): ").append(resp.getStatus());
+ txt.append("<br>Content length: ");
+ int len = txt.length() + "</p>".length() + 3;
+ txt.append(String.format("%3d", len));
+ txt.append("</p>");
+ resp.setContentLengthLong(txt.length());
writer.write(txt.toString());
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/PortletV3Demo/src/main/java/basic/portlet/Constants.java
----------------------------------------------------------------------
diff --git a/PortletV3Demo/src/main/java/basic/portlet/Constants.java b/PortletV3Demo/src/main/java/basic/portlet/Constants.java
index 32be9a8..b7e922c 100644
--- a/PortletV3Demo/src/main/java/basic/portlet/Constants.java
+++ b/PortletV3Demo/src/main/java/basic/portlet/Constants.java
@@ -52,6 +52,9 @@ public class Constants {
public final static String DELIM = ";%;";
+ // For header portlet
+ public final static String ATTRIB_PROPS = "properties";
+
// For PortletConfig portlet
public final static String ATTRIB_PRPS = "prps";
public final static String ATTRIB_PMS = "portletModes";
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/PortletV3Demo/src/main/java/basic/portlet/HeaderPortlet.java
----------------------------------------------------------------------
diff --git a/PortletV3Demo/src/main/java/basic/portlet/HeaderPortlet.java b/PortletV3Demo/src/main/java/basic/portlet/HeaderPortlet.java
index 98466c0..e034f75 100644
--- a/PortletV3Demo/src/main/java/basic/portlet/HeaderPortlet.java
+++ b/PortletV3Demo/src/main/java/basic/portlet/HeaderPortlet.java
@@ -18,9 +18,14 @@
package basic.portlet;
+import static basic.portlet.Constants.ATTRIB_PROPS;
+
import java.io.IOException;
import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.Collection;
import java.util.Collections;
+import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -88,6 +93,20 @@ public class HeaderPortlet extends GenericPortlet {
// Set header
resp.addProperty("Portlet", this.getPortletName());
resp.setProperty("Portal", "Pluto");
+ resp.addProperty("Portal", "Apache");
+
+ // get header info
+
+ Collection<String> names = resp.getPropertyNames();
+ List<String> hdrInfo = new ArrayList<String>();
+ for (String name: names) {
+ StringBuilder txt = new StringBuilder(128);
+ txt.append("Property name: ").append(name);
+ txt.append(", value: ").append(resp.getProperty(name));
+ txt.append(", values: ").append(resp.getPropertyValues(name));
+ hdrInfo.add(txt.toString());
+ }
+ req.getPortletSession().setAttribute(ATTRIB_PROPS, hdrInfo);
PrintWriter writer = resp.getWriter();
writer.println("<!-- before JSP include -->");
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/PortletV3Demo/src/main/webapp/WEB-INF/jsp/view-hdp.jsp
----------------------------------------------------------------------
diff --git a/PortletV3Demo/src/main/webapp/WEB-INF/jsp/view-hdp.jsp b/PortletV3Demo/src/main/webapp/WEB-INF/jsp/view-hdp.jsp
index d78f9b4..75ce495 100644
--- a/PortletV3Demo/src/main/webapp/WEB-INF/jsp/view-hdp.jsp
+++ b/PortletV3Demo/src/main/webapp/WEB-INF/jsp/view-hdp.jsp
@@ -39,4 +39,10 @@ The following section shows cookie information inserted by JavaScript code that
output stream during the header phase processing.
</p>
<div class='markupSection' id='<portlet:namespace/>cookieDiv'></div>
+<h5>Portlet Response Properties (read from HeaderResponse):</h5>
+<ul>
+<c:forEach items="<%=portletSession.getAttribute(ATTRIB_PROPS) %>" var="prop">
+ <li><c:out value="${prop}"></c:out></li>
+</c:forEach>
+</ul>
</div>
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResourceResponseContext.java
----------------------------------------------------------------------
diff --git a/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResourceResponseContext.java b/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResourceResponseContext.java
index e14ea1e..3160397 100644
--- a/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResourceResponseContext.java
+++ b/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResourceResponseContext.java
@@ -28,4 +28,6 @@ public interface PortletResourceResponseContext extends PortletMimeResponseConte
void setCharacterEncoding(String charset);
void setContentLength(int len);
void setStatus(int sc);
+ int getStatus();
+ void setContentLengthLong(long len);
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResponseContext.java
----------------------------------------------------------------------
diff --git a/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResponseContext.java b/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResponseContext.java
index ef541ef..430df13 100644
--- a/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResponseContext.java
+++ b/pluto-container-api/src/main/java/org/apache/pluto/container/PortletResponseContext.java
@@ -16,6 +16,8 @@
*/
package org.apache.pluto.container;
+import java.util.Collection;
+
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@@ -53,6 +55,9 @@ public interface PortletResponseContext
void addProperty(String key, String value);
void setProperty(String key, String value);
Element createElement(String tagName) throws DOMException;
+ String getProperty(String key);
+ Collection<String> getPropertyValues(String name);
+ Collection<String> getPropertyNames();
/**
* Closing the response context means processing has been completed and
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-container/src/main/java/org/apache/pluto/container/impl/PortletResponseImpl.java
----------------------------------------------------------------------
diff --git a/pluto-container/src/main/java/org/apache/pluto/container/impl/PortletResponseImpl.java b/pluto-container/src/main/java/org/apache/pluto/container/impl/PortletResponseImpl.java
index 79e9281..f74c029 100644
--- a/pluto-container/src/main/java/org/apache/pluto/container/impl/PortletResponseImpl.java
+++ b/pluto-container/src/main/java/org/apache/pluto/container/impl/PortletResponseImpl.java
@@ -16,6 +16,7 @@
*/
package org.apache.pluto.container.impl;
+import java.util.Collection;
import java.util.Enumeration;
import javax.portlet.PortalContext;
@@ -191,4 +192,19 @@ public abstract class PortletResponseImpl implements PortletResponse
ArgumentUtility.validateNotEmpty("key", key);
responseContext.setProperty(key, value);
}
+
+ @Override
+ public String getProperty(String key) {
+ return responseContext.getProperty(key);
+ }
+
+ @Override
+ public Collection<String> getPropertyValues(String name) {
+ return responseContext.getPropertyValues(name);
+ }
+
+ @Override
+ public Collection<String> getPropertyNames() {
+ return responseContext.getPropertyNames();
+ }
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-container/src/main/java/org/apache/pluto/container/impl/ResourceResponseImpl.java
----------------------------------------------------------------------
diff --git a/pluto-container/src/main/java/org/apache/pluto/container/impl/ResourceResponseImpl.java b/pluto-container/src/main/java/org/apache/pluto/container/impl/ResourceResponseImpl.java
index aba15c6..16a9ce3 100644
--- a/pluto-container/src/main/java/org/apache/pluto/container/impl/ResourceResponseImpl.java
+++ b/pluto-container/src/main/java/org/apache/pluto/container/impl/ResourceResponseImpl.java
@@ -169,7 +169,18 @@ public class ResourceResponseImpl extends MimeResponseImpl implements ResourceRe
}
}
+ @Override
public void setStatus(int sc) {
responseContext.setStatus(sc);
}
+
+ @Override
+ public int getStatus() {
+ return responseContext.getStatus();
+ }
+
+ @Override
+ public void setContentLengthLong(long len) {
+ responseContext.setContentLengthLong(len);
+ }
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockPortletResponse.java
----------------------------------------------------------------------
diff --git a/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockPortletResponse.java b/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockPortletResponse.java
index ffa0aca..c746781 100644
--- a/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockPortletResponse.java
+++ b/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockPortletResponse.java
@@ -19,6 +19,8 @@
package org.apache.pluto.container.bean.processor.fixtures.mocks;
+import java.util.Collection;
+
import javax.portlet.PortletResponse;
import javax.servlet.http.Cookie;
@@ -83,4 +85,19 @@ public class MockPortletResponse implements PortletResponse {
public void setProperty(String arg0, String arg1) {
}
+ @Override
+ public String getProperty(String key) {
+ return null;
+ }
+
+ @Override
+ public Collection<String> getPropertyValues(String name) {
+ return null;
+ }
+
+ @Override
+ public Collection<String> getPropertyNames() {
+ return null;
+ }
+
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockResourceResponse.java
----------------------------------------------------------------------
diff --git a/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockResourceResponse.java b/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockResourceResponse.java
index e0d734a..c082cd5 100644
--- a/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockResourceResponse.java
+++ b/pluto-container/src/test/java/org/apache/pluto/container/bean/processor/fixtures/mocks/MockResourceResponse.java
@@ -57,4 +57,13 @@ public class MockResourceResponse extends MockMimeResponse implements ResourceRe
public void setStatus(int arg0) {
}
+ @Override
+ public int getStatus() {
+ return 0;
+ }
+
+ @Override
+ public void setContentLengthLong(long len) {
+ }
+
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResourceResponseContextImpl.java
----------------------------------------------------------------------
diff --git a/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResourceResponseContextImpl.java b/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResourceResponseContextImpl.java
index 94818ed..a219142 100644
--- a/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResourceResponseContextImpl.java
+++ b/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResourceResponseContextImpl.java
@@ -25,7 +25,6 @@ import javax.servlet.http.HttpServletResponse;
import org.apache.pluto.container.PortletContainer;
import org.apache.pluto.container.PortletResourceResponseContext;
import org.apache.pluto.container.PortletWindow;
-import org.apache.pluto.container.impl.ResourceResponseImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -68,6 +67,15 @@ public class PortletResourceResponseContextImpl extends PortletMimeResponseConte
}
}
+ @Override
+ public void setContentLengthLong(long len)
+ {
+ if (!isClosed())
+ {
+ getServletResponse().setContentLengthLong(len);
+ }
+ }
+
public void setLocale(Locale locale)
{
if (!isClosed())
@@ -87,4 +95,9 @@ public class PortletResourceResponseContextImpl extends PortletMimeResponseConte
getServletResponse().setStatus(sc);
}
}
+
+ @Override
+ public int getStatus() {
+ return getServletResponse().getStatus();
+ }
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResponseContextImpl.java
----------------------------------------------------------------------
diff --git a/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResponseContextImpl.java b/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResponseContextImpl.java
index 3898fda..0d698f6 100644
--- a/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResponseContextImpl.java
+++ b/pluto-portal-driver-impl/src/main/java/org/apache/pluto/driver/services/container/PortletResponseContextImpl.java
@@ -20,8 +20,11 @@ import static javax.portlet.PortletRequest.HEADER_PHASE;
import static javax.portlet.PortletRequest.RENDER_PHASE;
import static javax.portlet.PortletRequest.RESOURCE_PHASE;
+import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collection;
import java.util.HashSet;
+import java.util.List;
import java.util.Set;
import javax.portlet.MimeResponse;
@@ -194,6 +197,36 @@ public abstract class PortletResponseContextImpl implements PortletResponseConte
return headerData.createElement(tagName);
}
+ @Override
+ public String getProperty(String key) {
+ String val = null;
+ if (!isClosed() && isSetPropsAllowed) {
+ List<String> vals = headerData.getHttpHeaders().get(key);
+ if (!vals.isEmpty()) {
+ val = vals.get(0);
+ }
+ }
+ return val;
+ }
+
+ @Override
+ public Collection<String> getPropertyValues(String key) {
+ List<String> vals = new ArrayList<String>();
+ if (!isClosed() && isSetPropsAllowed) {
+ vals.addAll(headerData.getHttpHeaders().get(key));
+ }
+ return vals;
+ }
+
+ @Override
+ public Collection<String> getPropertyNames() {
+ List<String> names = new ArrayList<String>();
+ if (!isClosed() && isSetPropsAllowed) {
+ names.addAll(headerData.getHttpHeaders().keySet());
+ }
+ return names;
+ }
+
public void close() {
closed = true;
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/portlet-api/src/main/java/javax/portlet/PortletResponse.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletResponse.java b/portlet-api/src/main/java/javax/portlet/PortletResponse.java
index ddc3e48..5d9da1e 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletResponse.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletResponse.java
@@ -24,6 +24,8 @@
package javax.portlet;
+import java.util.Collection;
+
/**
* <span class="changed_modified_3_0">The</span>
* <CODE>PortletResponse</CODE> defines the base interface to assist a
@@ -199,5 +201,66 @@ public interface PortletResponse {
*/
org.w3c.dom.Element createElement(String tagName) throws org.w3c.dom.DOMException;
+
+ /**
+ * <div class="changed_added_3_0">
+ * Gets the value of the response property with the given name.
+ * <p>
+ * If a response property with the given name exists and contains multiple
+ * values, the value that was added first will be returned.
+ * <p>
+ * This method considers only response properties set or added via
+ * <code>setProperty(java.lang.String, java.lang.String)</code> or
+ * <code>addProperty(java.lang.String, java.lang.String)</code>.
+ * </div>
+ *
+ * @param name the name of the response property whose value is to be returned
+ * @return the value of the response property with the given name, or null if
+ * no property with the given name has been set on this response
+ *
+ * @since 3.0
+ */
+ String getProperty(String key);
+
+
+ /**
+ * <div class="changed_added_3_0">
+ * Gets the values of the response property with the given name.
+ * <p>
+ * This method considers only response properties set or added via
+ * <code>setProperty(java.lang.String, java.lang.String)</code> or
+ * <code>addProperty(java.lang.String, java.lang.String)</code>.
+ * <p>
+ * Altering the returned collection will not affect the properties set on the
+ * response.
+ * </div>
+ *
+ * @param name the name of the response property whose values are to be returned
+ * @return the values of the response property with the given name, or an empty collection if
+ * no property with the given name has been set on this response
+ *
+ * @since 3.0
+ */
+ Collection<String> getPropertyValues(String name);
+
+
+ /**
+ * <div class="changed_added_3_0">
+ * Gets the names of all response properties set on the response.
+ * <p>
+ * This method considers only response properties set or added via
+ * <code>setProperty(java.lang.String, java.lang.String)</code> or
+ * <code>addProperty(java.lang.String, java.lang.String)</code>.
+ * <p>
+ * Altering the returned collection will not affect the properties set on the
+ * response.
+ * </div>
+ *
+ * @return the names of the response properties with the given name,
+ * or an empty collection if no properties have been set on this response
+ *
+ * @since 3.0
+ */
+ Collection<String> getPropertyNames();
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/ResourceResponse.java b/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
index afc5d8a..04d61ff 100644
--- a/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
+++ b/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
@@ -109,7 +109,7 @@ public interface ResourceResponse extends MimeResponse {
* after the response has been committed.
* </span>
*
- * @param len an integer specifying the length of the content being returned
+ * @param len an integer specifying the length of the content being returned; sets the Content-Length header
*/
public void setContentLength(int len);
@@ -138,6 +138,39 @@ public interface ResourceResponse extends MimeResponse {
public void setStatus(int sc);
+ /**
+ * <div class="changed_added_3_0">
+ * Gets the current HTTP status code for the response.
+ * </div>
+ *
+ * @return The HTTP status code
+ *
+ * @see javax.servlet.http.HttpServletResponse
+ * @see javax.servlet.http.HttpServletResponse#getStatus
+ *
+ * @since 3.0
+ */
+ public int getStatus();
+
+
+ /**
+ * <div class="changed_added_3_0">
+ * Sets the length of the content body in the response.
+ * <p>
+ * This method has no effect if it is called after
+ * after the response has been committed.
+ * </div>
+ *
+ * @param len a <code>long</code> specifying the length of the content being returned; sets the Content-Length header
+ *
+ * @see javax.servlet.http.HttpServletResponse
+ * @see javax.servlet.http.HttpServletResponse#setContentLengthLong
+ *
+ * @since 3.0
+ */
+ public void setContentLengthLong(long len);
+
+
/**
* @throws java.lang.IllegalStateException
* if the cacheability level of the resource URL
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/portlet-api/src/main/java/javax/portlet/filter/PortletResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletResponseWrapper.java
index 0fa5e25..0dad801 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletResponseWrapper.java
@@ -24,114 +24,126 @@
package javax.portlet.filter;
+import java.util.Collection;
+
import javax.portlet.PortletResponse;
import javax.servlet.http.Cookie;
/**
- * <span class="changed_modified_3_0">The</span>
- * <code>PortletResponseWrapper</code> provides a convenient
- * implementation of the <code>PortletResponse</code> interface
- * and is extended by other response wrappers.
- * This class implements the Wrapper or Decorator pattern.
- * Methods default to calling through to the wrapped response object.
- *
+ * <span class="changed_modified_3_0">The</span> <code>PortletResponseWrapper</code> provides a convenient
+ * implementation of the <code>PortletResponse</code> interface and is extended by other response wrappers. This class
+ * implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.
+ *
* @since 2.0
* @see PortletResponse
*/
public class PortletResponseWrapper implements PortletResponse {
- PortletResponse response;
-
- /**
- * Creates an <code>ActionResponse</code> adaptor
- * wrapping the given response object.
- *
- * @param response the action response to wrap
- * @throws java.lang.IllegalArgumentException if the response is <code>null</code>
- */
- public PortletResponseWrapper(PortletResponse response) {
- if ( response == null)
- throw new java.lang.IllegalArgumentException("Response is null");
-
- this.response = response;
- }
-
- /**
- * The default behavior of this method is to call
- * <code>addProperty(key, value)</code> on the wrapped response object.
- */
- public void addProperty(String key, String value) {
- response.addProperty(key, value);
- }
-
- /**
- * The default behavior of this method is to call
- * <code>encodeURL(path)</code> on the wrapped response object.
- */
- public String encodeURL(String path) {
- return response.encodeURL(path);
- }
-
- /**
- * The default behavior of this method is to call
- * <code>getNamespace()</code> on the wrapped response object.
- */
- public String getNamespace() {
- return response.getNamespace();
- }
-
- /**
- * The default behavior of this method is to call
- * <code>setProperty(key, value)</code> on the wrapped response object.
- */
- public void setProperty(String key, String value) {
- response.setProperty(key, value);
- }
-
- /**
- * Return the wrapped response object.
- *
- * @return the wrapped response
- */
- public PortletResponse getResponse() {
- return response;
- }
-
- /**
- * Sets the response object being wrapped.
- *
- * @param response the response to set
- * @throws java.lang.IllegalArgumentException if the response is null.
- */
- public void setResponse(PortletResponse response) {
- if ( response == null)
- throw new java.lang.IllegalArgumentException("Response is null");
-
- this.response = response;
- }
-
- /**
- * The default behavior of this method is to call
- * <code>addProperty()</code> on the wrapped response object.
- */
- public void addProperty(String key, org.w3c.dom.Element element) {
- response.addProperty(key, element);
- }
-
- /**
- * The default behavior of this method is to call
- * <code>createElement()</code> on the wrapped response object.
- */
- public org.w3c.dom.Element createElement(String tagName) {
- return response.createElement(tagName);
- }
-
- /**
- * The default behavior of this method is to call
- * <code>addProperty()</code> on the wrapped response object.
- */
- public void addProperty(Cookie cookie) {
- response.addProperty(cookie);
- }
+ PortletResponse response;
+
+ /**
+ * Creates an <code>ActionResponse</code> adaptor wrapping the given response object.
+ *
+ * @param response
+ * the action response to wrap
+ * @throws java.lang.IllegalArgumentException
+ * if the response is <code>null</code>
+ */
+ public PortletResponseWrapper(PortletResponse response) {
+ if (response == null)
+ throw new java.lang.IllegalArgumentException("Response is null");
+
+ this.response = response;
+ }
+
+ /**
+ * The default behavior of this method is to call <code>addProperty(key, value)</code> on the wrapped response
+ * object.
+ */
+ public void addProperty(String key, String value) {
+ response.addProperty(key, value);
+ }
+
+ /**
+ * The default behavior of this method is to call <code>encodeURL(path)</code> on the wrapped response object.
+ */
+ public String encodeURL(String path) {
+ return response.encodeURL(path);
+ }
+
+ /**
+ * The default behavior of this method is to call <code>getNamespace()</code> on the wrapped response object.
+ */
+ public String getNamespace() {
+ return response.getNamespace();
+ }
+
+ /**
+ * The default behavior of this method is to call <code>setProperty(key, value)</code> on the wrapped response
+ * object.
+ */
+ public void setProperty(String key, String value) {
+ response.setProperty(key, value);
+ }
+
+ /**
+ * Return the wrapped response object.
+ *
+ * @return the wrapped response
+ */
+ public PortletResponse getResponse() {
+ return response;
+ }
+
+ /**
+ * Sets the response object being wrapped.
+ *
+ * @param response
+ * the response to set
+ * @throws java.lang.IllegalArgumentException
+ * if the response is null.
+ */
+ public void setResponse(PortletResponse response) {
+ if (response == null)
+ throw new java.lang.IllegalArgumentException("Response is null");
+
+ this.response = response;
+ }
+
+ /**
+ * The default behavior of this method is to call <code>addProperty()</code> on the wrapped response object.
+ */
+ public void addProperty(String key, org.w3c.dom.Element element) {
+ response.addProperty(key, element);
+ }
+
+ /**
+ * The default behavior of this method is to call <code>createElement()</code> on the wrapped response object.
+ */
+ public org.w3c.dom.Element createElement(String tagName) {
+ return response.createElement(tagName);
+ }
+
+ /**
+ * The default behavior of this method is to call <code>addProperty()</code> on the wrapped response object.
+ */
+ public void addProperty(Cookie cookie) {
+ response.addProperty(cookie);
+ }
+
+ @Override
+ public String getProperty(String key) {
+ return response.getProperty(key);
+ }
+
+ @Override
+ public Collection<String> getPropertyValues(String name) {
+ return response.getPropertyValues(name);
+ }
+
+ @Override
+ public Collection<String> getPropertyNames() {
+ return response.getPropertyNames();
+ }
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/cefde630/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
index 42fa22a..c8fc998 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
@@ -107,5 +107,15 @@ public class ResourceResponseWrapper extends MimeResponseWrapper implements Reso
((ResourceResponse)response).setStatus(sc);
}
+ @Override
+ public int getStatus() {
+ return ((ResourceResponse)response).getStatus();
+ }
+
+ @Override
+ public void setContentLengthLong(long len) {
+ ((ResourceResponse)response).setContentLengthLong(len);
+ }
+
}