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/08 22:17:57 UTC
svn commit: rev 54110 - in portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto: . core core/impl tags util
Author: ddewolf
Date: Fri Oct 8 13:17:56 2004
New Revision: 54110
Modified:
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainer.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainerException.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletWindow.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalActionResponse.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalPortletWindow.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContainerImpl.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContextManager.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/Environment.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/InternalImplConverter.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/PortletRequestImpl.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/ParamTag.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/RenderURLTag.java
portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/util/StringUtils.java
Log:
Cleaning javadocs to get a clean javadoc report. The first step of flushing out the documentation.
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainer.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainer.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainer.java Fri Oct 8 13:17:56 2004
@@ -122,13 +122,13 @@
/**
* Retrieve the unique container name
- * @return
+ * @return the container name.
*/
public String getName();
/**
* Retreive the container services associated with this container.
- * @return
+ * @return the container services associated with this container.
*/
public PortletContainerServices getContainerServices();
}
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainerException.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainerException.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletContainerException.java Fri Oct 8 13:17:56 2004
@@ -27,19 +27,16 @@
* @version 1.0
*/
public class PortletContainerException extends Exception {
-
private Throwable cause;
-
/**
- * Constructs a new PortletContainerException. This exception will have no
- * message and no root cause.
+ * Constructs a new PortletContainerException.
+ * This exception will have no message and no root cause.
*/
public PortletContainerException() {
}
-
/**
* Constructs a new PortletContainerException with the given message.
* @param text the message explaining the exception occurance
@@ -60,23 +57,20 @@
}
/**
- * * Constructs a new portlet invoker exception when the portlet needs to
- * throw an * exception. The exception's message is based on the localized
- * message * of the underlying exception. * * @param cause * the
- * root cause
+ * Constructs a new portlet invoker exception when the portlet needs to
+ * throw an exception. The exception's message is based on the localized
+ * message of the underlying exception.
+ * @param cause the root cause
*/
-
public PortletContainerException(Throwable cause) {
super(cause.getLocalizedMessage());
-
this.cause = cause;
}
/**
- * * Returns the exception that cause this portlet exception. * * @return
- * the <CODE>Throwable</CODE> that caused this portlet exception.
+ * Returns the exception that cause this portlet exception.
+ * @return the <CODE>Throwable</CODE> that caused this portlet exception.
*/
-
public Throwable getRootCause() {
return (cause);
}
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletWindow.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletWindow.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/PortletWindow.java Fri Oct 8 13:17:56 2004
@@ -57,13 +57,13 @@
/**
* Retrieve the current window state for this window.
- * @return
+ * @return the current window state.
*/
WindowState getWindowState();
/**
* Retrieve the current portlet mode for this window.
- * @return
+ * @return the current portlet mode.
*/
PortletMode getPortletMode();
}
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalActionResponse.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalActionResponse.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalActionResponse.java Fri Oct 8 13:17:56 2004
@@ -40,20 +40,20 @@
/**
* Retrieve the portlet mode.
- * @return
+ * @return the changed portlet mode.
*/
public PortletMode getChangedPortletMode();
/**
* Retrieve the window state.
- * @return
+ * @return the changed window state.
*/
public WindowState getChangedWindowState();
/**
* Retreive the location for which the action should
* be redirected.
- * @return
+ * @return the redirect location.
*/
public String getRedirectLocation();
}
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalPortletWindow.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalPortletWindow.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/InternalPortletWindow.java Fri Oct 8 13:17:56 2004
@@ -54,18 +54,34 @@
this.window = window;
}
+ /**
+ * Standard Getter.
+ * @return the context path.
+ */
public String getContextPath() {
return window.getContextPath();
}
+ /**
+ * Standard getter.
+ * @return the portlet name as defined in the deployment descriptor.
+ */
public String getPortletName() {
return window.getPortletName();
}
+ /**
+ * Standard getter.
+ * @return the window state.
+ */
public WindowState getWindowState() {
return window.getWindowState();
}
+ /**
+ * Standard getter.
+ * @return the portlet mode the portlet mode
+ */
public PortletMode getPortletMode() {
return window.getPortletMode();
}
@@ -82,7 +98,7 @@
/**
* The Context from which this window can be serviced.
- * @return
+ * @return the associated servlet context.
*/
public ServletContext getServletContext() {
return context;
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContainerImpl.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContainerImpl.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContainerImpl.java Fri Oct 8 13:17:56 2004
@@ -36,24 +36,37 @@
import org.apache.pluto.services.PortletURLProvider;
/**
- * Container implementation.
+ * Default Pluto Container implementation.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
* @version 1.0
* @since Sep 18, 2004
*/
public class PortletContainerImpl implements PortletContainer {
+ /** Internal logger. */
private static final Log LOG =
LogFactory.getLog(PortletContainerImpl.class);
+ /** The portlet container name. */
private String name;
+
+ /** The PortletContainerServices associated with this container. */
private PortletContainerServices containerServices;
- private ServletContext context;
+ /** The ServletContext associated with this container. */
+ private ServletContext context;
+ /** Flag indicating whether or not we've been initialized. */
private boolean initialized;
+ /** Default Constructor. Create a container implementation
+ * whith the given name and given services.
+ *
+ * @param name the name of the container.
+ * @param services the container services implementation.
+ */
public PortletContainerImpl(String name,
PortletContainerServices services) {
this.name = name;
@@ -75,7 +88,7 @@
/**
* Determine whether this container has been initialized or not.
- * @return
+ * @return true if the container has been initialized.
*/
public boolean isInitialized() {
return initialized;
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContextManager.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContextManager.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/PortletContextManager.java Fri Oct 8 13:17:56 2004
@@ -28,16 +28,25 @@
import org.apache.pluto.core.impl.PortletContextImpl;
/**
+ * Manager used to cache the portlet configurations which have
+ * been previously parsed.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
* @version 1.0
* @since Sep 20, 2004
*/
public class PortletContextManager {
+ /** Portlet deployment descriptor location. */
private static final String PORTLET_XML = "/WEB-INF/portlet.xml";
+ /** Singleton instance. */
private static PortletContextManager manager;
+ /**
+ * Singleton accessor method.
+ * @return the PortletContextManager implementation.
+ */
public static PortletContextManager getManager() {
if (manager == null) {
manager = new PortletContextManager();
@@ -45,17 +54,20 @@
return manager;
}
+ /** The PortletContext cache. */
private Map contexts;
+ /** Singleton Constructor. */
private PortletContextManager() {
contexts = new java.util.HashMap();
}
/**
- * Retrieve the PortletContext associated with the given ServletContext. If
- * one does not exist, it is created.
- * @param context
- * @return
+ * Retrieve the PortletContext associated with the given ServletContext.
+ * If one does not exist, it is created.
+ *
+ * @param context the servlet context
+ * @return the portlet context existing within the ServletContext.
* @throws PortletContainerException
*/
public InternalPortletContext getContext(ServletContext context)
@@ -68,6 +80,13 @@
return (InternalPortletContext) contexts.get(context);
}
+ /**
+ * Create the portlet.xml deployment descriptor representation.
+ *
+ * @param ctx
+ * @return
+ * @throws PortletContainerException
+ */
private PortletAppDD createDefinition(ServletContext ctx)
throws PortletContainerException {
PortletAppDD app = null;
@@ -80,7 +99,5 @@
}
return app;
}
-
-
}
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/Environment.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/Environment.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/Environment.java Fri Oct 8 13:17:56 2004
@@ -34,14 +34,26 @@
}
+ /**
+ * Retrieve the name of the container.
+ * @return the container name.
+ */
public static final String getPortletContainerName() {
return PROPS.getString("pluto.container.name");
}
+ /**
+ * Retrieve the major version number.
+ * @return the major version number.
+ */
public static final String getPortletContainerMajorVersion() {
return PROPS.getString("pluto.container.version.major");
}
+ /**
+ * Retrieve the minor version number.
+ * @return the minor version number.
+ */
public static final String getPortletContainerMinorVersion() {
return PROPS.getString("pluto.container.version.minor");
}
@@ -49,7 +61,7 @@
/**
* Retrieve the major version number of the specification which this version
* of pluto supports.
- * @return
+ * @return te major specification version.
*/
public static final int getMajorSpecificationVersion() {
return Integer.parseInt(PROPS.getString("javax.portlet.version.major"));
@@ -58,7 +70,7 @@
/**
* Retrieve the minor version number of the specification which this version
* of pluto supports.
- * @return
+ * @return the minor specification version.
*/
public static final int getMinorSpecificationVersion() {
return Integer.parseInt(PROPS.getString("javax.portlet.version.minor"));
@@ -67,7 +79,7 @@
/**
* Retrieve the formatted server info String required to be returned by the
* PortletContext.
- * @return
+ * @return the server info.
*/
public static final String getServerInfo() {
StringBuffer sb = new StringBuffer(getPortletContainerName())
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/InternalImplConverter.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/InternalImplConverter.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/InternalImplConverter.java Fri Oct 8 13:17:56 2004
@@ -27,6 +27,12 @@
import org.apache.pluto.portlet.PortletRequestWrapper;
import org.apache.pluto.portlet.PortletResponseWrapper;
+/**
+ * Utility used to convert a generic PortletRequest or
+ * PortletResponse object into an Internal respresentation
+ * of the same object.
+ *
+ */
class InternalImplConverter {
@@ -35,8 +41,8 @@
* PortletRequestWrapper defined by the spec. Because of this, there's a
* chance someone might implement their own wrapper and we won't be able to
* get the real internal one!
- * @param request
- * @return
+ * @param request the request to be converted.
+ * @return the internal request.
*/
public static InternalPortletRequest getInternalRequest(
PortletRequest request) {
@@ -55,8 +61,8 @@
* PortletRequestWrapper defined by the spec. Because of this, there's a
* chance someone might implement their own wrapper and we won't be able to
* get the real internal one!
- * @param response
- * @return
+ * @param response the response being converted
+ * @return the internal response.
*/
public static InternalPortletResponse getInternalResponse(
PortletResponse response) {
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/PortletRequestImpl.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/PortletRequestImpl.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/core/impl/PortletRequestImpl.java Fri Oct 8 13:17:56 2004
@@ -49,6 +49,7 @@
/**
* <code>PortletRequest</code> Implementation.
+ *
*/
public abstract class PortletRequestImpl extends HttpServletRequestWrapper
implements PortletRequest, InternalPortletRequest {
@@ -110,8 +111,8 @@
/**
* Determine whether or not the specified WindowState is allowed for this
* portlet.
- * @param state
- * @return
+ * @param state the state in question
+ * @return true if the state is allowed.
*/
public boolean isWindowStateAllowed(WindowState state) {
Enumeration supportedStates = portalContext.getSupportedWindowStates();
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/ParamTag.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/ParamTag.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/ParamTag.java Fri Oct 8 13:17:56 2004
@@ -25,10 +25,11 @@
/**
- * * Supporting class for the <CODE>param</CODE> tag. * defines a parameter that
- * can be added to a <CODE>actionURL</CODE> or * a <CODE>renderURL</CODE> *
- * <BR>The following attributes are mandatory * <UL> * <LI><CODE>name</CODE> *
- * <LI><CODE>value</CODE> * </UL>
+ * Supporting class for the <CODE>param</CODE> tag. Defines a parameter that
+ * can be added to a <CODE>actionURL</CODE> or a <CODE>renderURL</CODE>
+ * <BR>The following attributes are mandatory:
+ * <UL><LI><CODE>name</CODE>
+ * <LI><CODE>value</CODE></UL>
*/
public class ParamTag extends TagSupport {
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/RenderURLTag.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/RenderURLTag.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/tags/RenderURLTag.java Fri Oct 8 13:17:56 2004
@@ -35,7 +35,7 @@
import javax.servlet.jsp.PageContext;
/**
- * * Supporting class for the <CODE>renderURL</CODE> tag. * Creates a url that
+ * Supporting class for the <CODE>renderURL</CODE> tag. Creates a url that
* points to the current Portlet and triggers an render request * with the
* supplied parameters. *
*/
Modified: portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/util/StringUtils.java
==============================================================================
--- portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/util/StringUtils.java (original)
+++ portals/pluto/branches/pluto-1.1/container/src/java/org/apache/pluto/util/StringUtils.java Fri Oct 8 13:17:56 2004
@@ -24,10 +24,9 @@
import java.util.Map;
/**
- * * <CODE>StringUtils</CODE> hosts a couple of utility methods around *
+ * <CODE>StringUtils</CODE> hosts a couple of utility methods around
* strings.
*/
-
public class StringUtils {
static java.util.BitSet dontNeedEncoding;
@@ -55,7 +54,7 @@
}
/**
- * * The operating system's line separator ('\n' on UNIX, '\r\n' on
+ * The operating system's line separator ('\n' on UNIX, '\r\n' on
* Windows)
*/
@@ -63,12 +62,12 @@
"line.separator");
/**
- * * Returns the name of the package of the specified class. * The package
- * will not include the common (short) name of the * class or the file
- * extension. * * @param aClass * a class object * * @return
- * its package
+ * Returns the name of the package of the specified class. The package
+ * will not include the common (short) name of the class or the file
+ * extension.
+ * @param aClass a class object
+ * @return its package
*/
-
public static String packageOf(Class aClass) {
if (aClass == null) {
throw (new IllegalArgumentException(