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 2005/03/11 04:44:42 UTC
svn commit: r157038 - in
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors:
common/IconDD.java common/InitParamDD.java common/SecurityRoleRefDD.java
common/package.html package.html portlet/PortletAppDD.java
portlet/PortletDD.java services/PortletAppDescriptorService.java
services/WebAppDescriptorService.java
Author: ddewolf
Date: Thu Mar 10 19:44:40 2005
New Revision: 157038
URL: http://svn.apache.org/viewcvs?view=rev&rev=157038
Log:
Adding Java Docs to my recent changes. :)
Added:
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/package.html
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/package.html
Modified:
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/IconDD.java
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/InitParamDD.java
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/SecurityRoleRefDD.java
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletAppDD.java
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletDD.java
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/PortletAppDescriptorService.java
portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/WebAppDescriptorService.java
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/IconDD.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/IconDD.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/IconDD.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/IconDD.java Thu Mar 10 19:44:40 2005
@@ -16,32 +16,55 @@
package org.apache.pluto.descriptors.common;
/**
- * <B>TODO</B>: Document
+ * Resource Icon configuration.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
- * @version $Id:$
+ * @version $Id$
* @since Feb 28, 2005
*/
public class IconDD{
+ /** The large icon uri. */
private String largeIcon;
+
+ /** The small icon uri. */
private String smallIcon;
+ /**
+ * Default Constructor.
+ */
public IconDD() {
}
+ /**
+ * Retrieve the large icon uri.
+ * @return the uri to the large icon (relative to the context path).
+ */
public String getLargeIcon() {
return largeIcon;
}
+ /**
+ * Set the large icon uri.
+ * @param largeIcon the relative path to the icon resource.
+ */
public void setLargeIcon(String largeIcon) {
this.largeIcon = largeIcon;
}
+ /**
+ * Retrieve the small icon uri.
+ * @return the uri to the small icon (relative to the context path).
+ */
public String getSmallIcon() {
return smallIcon;
}
+ /**
+ * Set the small Icon uri.
+ * @param smallIcon the relative path to the icon resource.
+ */
public void setSmallIcon(String smallIcon) {
this.smallIcon = smallIcon;
}
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/InitParamDD.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/InitParamDD.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/InitParamDD.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/InitParamDD.java Thu Mar 10 19:44:40 2005
@@ -16,41 +16,74 @@
package org.apache.pluto.descriptors.common;
/**
- * <B>TODO</B>: Document
+ * Initialization Parameter configuration.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
- * @version $Id:$
+ * @version $Id$
* @since Feb 28, 2005
*/
public class InitParamDD {
+ /** The name of the parameter. */
private String paramName;
+
+ /** The value of the parameter. */
private String paramValue;
+
+ /** The description of the parameter. */
private String description;
+ /**
+ * Default Constructor.
+ */
public InitParamDD() {
}
+ /**
+ * Retrieve the name of the parameter.
+ * @return
+ */
public String getParamName() {
return paramName;
}
+ /**
+ * Set the name of the parameter.
+ * @param paramName
+ */
public void setParamName(String paramName) {
this.paramName = paramName;
}
+ /**
+ * Get the name of the parameter.
+ * @return
+ */
public String getParamValue() {
return paramValue;
}
+ /**
+ * Set the value of the parameter.
+ * @param paramValue
+ */
public void setParamValue(String paramValue) {
this.paramValue = paramValue;
}
+ /**
+ * Retrieve the description.
+ * @return
+ */
public String getDescription() {
return description;
}
+ /**
+ * Set the description of the parameter.
+ * @param description
+ */
public void setDescription(String description) {
this.description = description;
}
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/SecurityRoleRefDD.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/SecurityRoleRefDD.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/SecurityRoleRefDD.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/SecurityRoleRefDD.java Thu Mar 10 19:44:40 2005
@@ -16,44 +16,76 @@
package org.apache.pluto.descriptors.common;
/**
- * <B>TODO</B>: Document
+ * Security Role Reference Configuration.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
- * @version $Id:$
+ * @version $Id$
* @since Feb 28, 2005
*/
public class SecurityRoleRefDD {
+ /** The name of the role reference. */
private String roleName;
+
+ /** The role to which the reference is linked. */
private String roleLink;
+
+ /** The description of what the role is utilized for. */
private String description;
+ /**
+ * Default Constructor.
+ */
public SecurityRoleRefDD() {
}
+ /**
+ * Retrieve the name of the role reference.
+ * @return
+ */
public String getRoleName() {
return roleName;
}
+ /**
+ * Set the name of the role reference.
+ * @param roleName
+ */
public void setRoleName(String roleName) {
this.roleName = roleName;
}
+ /**
+ * Retrieve then role to which the reference is linked.
+ * @return
+ */
public String getRoleLink() {
return roleLink;
}
+ /**
+ * Set the role to which the reference is linked.
+ * @param roleLink
+ */
public void setRoleLink(String roleLink) {
this.roleLink = roleLink;
}
+ /**
+ * Retrieve the description of the role reference.
+ * @return
+ */
public String getDescription() {
return description;
}
+ /**
+ * Set the description of the role reference.
+ * @param description
+ */
public void setDescription(String description) {
this.description = description;
}
-
}
Added: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/package.html
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/package.html?view=auto&rev=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/package.html (added)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/common/package.html Thu Mar 10 19:44:40 2005
@@ -0,0 +1,5 @@
+<HTML>
+<BODY>
+Common deployment descriptor elements used in many descriptors.
+</BODY>
+</HTML>
\ No newline at end of file
Added: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/package.html
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/package.html?view=auto&rev=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/package.html (added)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/package.html Thu Mar 10 19:44:40 2005
@@ -0,0 +1,6 @@
+<HTML>
+<BODY>
+Object Model and Read/Write Services for deployment descriptors.
+Specifically used to represent web.xml and portlet.xml files.
+</BODY>
+</HTML>
\ No newline at end of file
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletAppDD.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletAppDD.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletAppDD.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletAppDD.java Thu Mar 10 19:44:40 2005
@@ -19,6 +19,7 @@
import java.util.Set;
/**
+ * Portlet Application Configuration.
*
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
* @version $Id$
@@ -26,15 +27,27 @@
*/
public class PortletAppDD {
+ /** The defined portlets within the system. */
private Set portlets = new HashSet();
+ /**
+ * Default Constructor.
+ */
public PortletAppDD() {
}
+ /**
+ * Retrieve the portlets which exist within this application.
+ * @return
+ */
public Set getPortlets() {
return portlets;
}
+ /**
+ * Set the portlets that exist within this application.
+ * @param portlets
+ */
public void setPortlets(Set portlets) {
this.portlets = portlets;
}
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletDD.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletDD.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletDD.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/portlet/PortletDD.java Thu Mar 10 19:44:40 2005
@@ -23,42 +23,73 @@
* of timing I'll be lazy for now.
*
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
- * @version $Id:$
+ * @version $Id$
* @since Mar 6, 2005
*/
public class PortletDD {
+ /** The unique name of the portlet. */
private String portletName;
+
+ /** The class which implements the portlet interface. */
private String portletClass;
+
+ /** All security role references. */
private List securityRoleRefs;
+ /**
+ * Default Constructor.
+ */
public PortletDD() {
}
+ /**
+ * Retrieve the unique name of the portlet.
+ * @return
+ */
public String getPortletName() {
return portletName;
}
+ /**
+ * Set the unique name of the portlet.
+ * @param portletName
+ */
public void setPortletName(String portletName) {
this.portletName = portletName;
}
+ /**
+ * Retrieve the name of the portlet class.
+ * @return the fully qualified portlet class name.
+ */
public String getPortletClass() {
return portletClass;
}
+ /**
+ * Set the name of the portlet class.
+ * @param portletClass
+ */
public void setPortletClass(String portletClass) {
this.portletClass = portletClass;
}
+ /**
+ * Retrieve the security role references for this portlet.
+ * @return
+ */
public List getSecurityRoleRefs() {
return securityRoleRefs;
}
+ /**
+ * Set the security role references for this portlet.
+ * @param securityRoleRefs
+ */
public void setSecurityRoleRefs(List securityRoleRefs) {
this.securityRoleRefs = securityRoleRefs;
}
-
}
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/PortletAppDescriptorService.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/PortletAppDescriptorService.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/PortletAppDescriptorService.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/PortletAppDescriptorService.java Thu Mar 10 19:44:40 2005
@@ -21,16 +21,37 @@
import org.apache.pluto.descriptors.portlet.PortletAppDD;
/**
- *
+ * Read/Write services for Portlet Application configuration
+ * This service reads the portlet.xml and converts it to a
+ * standard bean model.
+ *
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
- * @version $Id:$
+ * @version $Id$
* @since Mar 6, 2005
*/
public interface PortletAppDescriptorService {
+ /**
+ * Retrieve the name of the context path
+ * within which PortletApps retrieved from this
+ * service reside.
+ * @return
+ */
String getContextPath();
+ /**
+ * Retrieve the PortletApp deployment descriptor
+ * (web.xml).
+ * @return Object representation of the descriptor.
+ * @throws IOException if an IO error occurs.
+ */
PortletAppDD read() throws IOException;
+ /**
+ * Write the PortletApp deployment descriptor
+ * (web.xml).
+ * @param pd
+ * @throws IOException if an IO error occurs.
+ */
void write(PortletAppDD pd) throws IOException;
}
Modified: portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/WebAppDescriptorService.java
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/WebAppDescriptorService.java?view=diff&r1=157037&r2=157038
==============================================================================
--- portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/WebAppDescriptorService.java (original)
+++ portals/pluto/trunk/descriptors/src/java/org/apache/pluto/descriptors/services/WebAppDescriptorService.java Thu Mar 10 19:44:40 2005
@@ -24,14 +24,32 @@
* within the web.xml Deployment Descriptor.
*
* @author <a href="ddewolf@apache.org">David H. DeWolf</a>
- * @version $Id:$
+ * @version $Id$
* @since Feb 28, 2005
*/
public interface WebAppDescriptorService {
+ /**
+ * Retrieve the name of the context path
+ * within which WebApps retrieved from this
+ * service reside.
+ * @return
+ */
String getContextPath();
+ /**
+ * Retrieve the WebApp deployment descriptor
+ * (web.xml).
+ * @return Object representation of the descriptor.
+ * @throws IOException if an IO error occurs.
+ */
WebAppDD read() throws IOException;
+ /**
+ * Write the WebApp deployment descriptor
+ * (web.xml).
+ * @param dd
+ * @throws IOException if an IO error occurs.
+ */
void write(WebAppDD dd) throws IOException;
}