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 dd...@apache.org on 2004/10/09 02:13:27 UTC
svn commit: rev 54135 - in portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver: . core services
Author: ddewolf
Date: Fri Oct 8 17:13:26 2004
New Revision: 54135
Modified:
portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/PortalDriverServlet.java
portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalServletRequest.java
portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalURL.java
portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/ContainerServicesImpl.java
portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/DynamicInformationProviderImpl.java
portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/PortalContextImpl.java
Log:
Javadoc updates.
Modified: portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/PortalDriverServlet.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/PortalDriverServlet.java (original)
+++ portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/PortalDriverServlet.java Fri Oct 8 17:13:26 2004
@@ -38,13 +38,16 @@
import org.apache.pluto.driver.core.PortletWindowImpl;
/**
- * The controller servlet used to driver the Portal Driver. All requests mapped
+ * The controller servlet used to drive the Portal Driver. All requests mapped
* to this servlet will be processed as Portal Requests.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
* @version 1.0
* @since Sep 22, 2004
*/
public class PortalDriverServlet extends HttpServlet {
+
+ /** Internal Logger. */
private static final Log LOG = LogFactory.getLog(PortalDriverServlet.class);
/**
@@ -124,6 +127,17 @@
}
}
-
+ /**
+ * Pass all requests on to {@link #doPost(HttpServletRequest, HttpServletResponse)}.
+ * @param req the request
+ * @param res the response
+ * @throws ServletException if an exception occurs.
+ * @throws IOException if an exception occurs writing to the response.
+ */
+ public void doPost(HttpServletRequest req,
+ HttpServletResponse res)
+ throws ServletException, IOException {
+ doPost(req, res);
+ }
}
Modified: portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalServletRequest.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalServletRequest.java (original)
+++ portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalServletRequest.java Fri Oct 8 17:13:26 2004
@@ -110,7 +110,7 @@
/**
* Get an enumeration which contains each of the names for which parameters
* exist.
- * @return
+ * @return an enumeration of all names bound as parameters.
*/
public Enumeration getParameterNames() {
return Collections.enumeration(getParameterMap().keySet());
@@ -119,7 +119,7 @@
/**
* Get the values associated with the given parameter key.
* @param name the Parameter name used to key the parameter.
- * @return
+ * @return a String[] of all values bound to the given name as a parameter.
*/
public String[] getParameterValues(String name) {
return (String[]) getParameterMap().get(name);
Modified: portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalURL.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalURL.java (original)
+++ portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/core/PortalURL.java Fri Oct 8 17:13:26 2004
@@ -157,7 +157,7 @@
/**
* Retrieve the server uri, (protocol, name, port).
- * @return
+ * @return the server uri portion of the url.
*/
public String getServerUri() {
return server.toString();
Modified: portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/ContainerServicesImpl.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/ContainerServicesImpl.java (original)
+++ portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/ContainerServicesImpl.java Fri Oct 8 17:13:26 2004
@@ -51,6 +51,10 @@
propertyService = new PropertyManagerProviderImpl();
}
+ /**
+ * Standard Getter.
+ * @return the portal context for the portal which we service.
+ */
public PortalContext getPortalContext() {
return context;
}
@@ -58,7 +62,7 @@
/**
* The PortletPreferencesFactory provides access to the portal's
* PortletPreference persistence mechanism.
- * @return
+ * @return a PortletPreferencesFactory instance.
*/
public PortletPreferencesFactory getPortletPreferencesFactory() {
return preferencesFactory;
@@ -67,8 +71,8 @@
/**
* The DynamicInformationProvider provides dynamic, runtime evaluated,
* information.
- * @param req
- * @return
+ * @param req the HttpServletRequest identifying the request
+ * @return a DynamicInformationProvider implementation.
*/
public DynamicInformationProvider getDynamicInformationProvider(
HttpServletRequest req) {
@@ -76,11 +80,19 @@
}
+ /**
+ * The PortalCallbackProvider allows the container to communicate
+ * actions back to the portal.
+ * @return a PortalCallbackProvider implementation.
+ */
public PortalCallbackProvider getPortalCallbackProvider() {
return callback;
}
-
+ /**
+ * The PropertyManagerService manages portal properties.
+ * @return a PropertyManagerService implemenatation.
+ */
public PropertyManagerService getPropertyManagerService() {
return this.propertyService;
}
Modified: portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/DynamicInformationProviderImpl.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/DynamicInformationProviderImpl.java (original)
+++ portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/DynamicInformationProviderImpl.java Fri Oct 8 17:13:26 2004
@@ -67,7 +67,7 @@
}
/**
- * @return
+ * @return Iterator of all response mimeTypes.
* @todo not implemented properly.
*/
public Iterator getResponseContentTypes() {
Modified: portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/PortalContextImpl.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/PortalContextImpl.java (original)
+++ portals/pluto/branches/pluto-1.1/portal/src/java/org/apache/pluto/driver/services/PortalContextImpl.java Fri Oct 8 17:13:26 2004
@@ -87,7 +87,7 @@
/**
* Get an enumeration containing all names of the portal properties.
- * @return
+ * @return an enumeration of all keys to which properties are bound.
*/
public Enumeration getPropertyNames() {
Vector names = new Vector(properties.keySet());
@@ -98,7 +98,7 @@
/**
* Get an enumeration of all <code>PortletMode</code>s supported by this
* portal.
- * @return
+ * @return enumeration of all supported portlet modes.
*/
public Enumeration getSupportedPortletModes() {
if (portletModes == null) {
@@ -115,7 +115,7 @@
/**
* Get an enumeration of all <code>WindowState</code>s supported by this
* portal.
- * @return
+ * @return an enumeration of all supported window states.
*/
public Enumeration getSupportedWindowStates() {
if (windowStates == null) {
@@ -131,7 +131,7 @@
/**
* Get the portal info for this portal.
- * @return
+ * @return the portal information for this context.
*/
public String getPortalInfo() {
return info;