husted 2002/11/24 07:53:53
Modified: scaffold/src/java/org/apache/commons/scaffold/util
ProcessResultBase.java ProcessResult.java
BizServiceImpl.java BizService.java
BizResponseImpl.java BizResponse.java
BizRequestImpl.java BizRequest.java
Log:
+ Javadoc updates.
Revision Changes Path
1.5 +2 -1
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResultBase.java
Index: ProcessResultBase.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResultBase.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ProcessResultBase.java 23 Nov 2002 02:45:55 -0000 1.4
+++ ProcessResultBase.java 24 Nov 2002 15:53:53 -0000 1.5
@@ -16,6 +16,7 @@
* used "as-is" to manage a response from the business tier.
*
* @author Ted Husted
+ * @author Synthis Corporation
* @version $Revision$ $Date$
*/
public class ProcessResultBase implements ProcessResult {
1.3 +3 -1
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResult.java
Index: ProcessResult.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResult.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ProcessResult.java 23 Nov 2002 02:45:55 -0000 1.2
+++ ProcessResult.java 24 Nov 2002 15:53:53 -0000 1.3
@@ -26,7 +26,9 @@
* (see <code>isSingleForm()</code>).
*
* @author Ted Husted
+ * @author Synthis Corporation
* @version $Revision$ $Date$
+ * @deprecated Use BizResponse instead
*/
public interface ProcessResult {
1.2 +4 -3
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizServiceImpl.java
Index: BizServiceImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizServiceImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizServiceImpl.java 23 Nov 2002 19:05:49 -0000 1.1
+++ BizServiceImpl.java 24 Nov 2002 15:53:53 -0000 1.2
@@ -3,7 +3,7 @@
/**
* Sample business service object.
- * Returns copy of request object.
+ * Returns copy of request object as a "single form" response.
*
* @author Ted Husted
* @version $Revision$ $Date$
@@ -12,12 +12,13 @@
/**
* Sample business service method.
- * Returns copy of request object.
+ * Returns copy of request object as a "single form" response.
*
* @exception Throws Exception on any error.
* A <code>ChainedException</code> is recommended..
* @param request The bean containing the runtime parameters for
* this service.
+ * @return A business response
*/
public BizResponse process(BizRequest request) throws Exception {
1.2 +14 -3
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizService.java
Index: BizService.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizService.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizService.java 23 Nov 2002 19:05:49 -0000 1.1
+++ BizService.java 24 Nov 2002 15:53:53 -0000 1.2
@@ -2,7 +2,9 @@
/**
- * A business service facade.
+ * A business service facade designed to be invoked
+ * through a <code>process</code> method.
+ *
* @author Ted Husted
* @version $Revision$ $Date$
*/
@@ -10,12 +12,21 @@
/**
* Perform the business logic for this service, by retrieving any
- * runtime properties from the <code>BizRequest</code> bean.
+ * runtime properties from the business request
+ * [<code>org.apache.commons.util.BizRequest</code>]
+ * and providing the result as a business response
+ * [<code>org.apache.commons.util.BizResponse</code>].
+ * <p>
+ * The business service may often be a facade that is used to
+ * connect to other services.
*
* @exception Throws Exception on any error.
* A <code>ChainedException</code> is recommended..
* @param request The bean containing the runtime parameters for
* this service.
+ * @author Ted Husted
+ * @author Nationwide Insurance Company
+ * @version $Revision$ $Date$
*/
public BizResponse process(BizRequest request) throws Exception;
1.2 +9 -0
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizResponseImpl.java
Index: BizResponseImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizResponseImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizResponseImpl.java 23 Nov 2002 19:05:49 -0000 1.1
+++ BizResponseImpl.java 24 Nov 2002 15:53:53 -0000 1.2
@@ -5,6 +5,15 @@
import org.apache.commons.scaffold.lang.Tokens;
+/**
+ * Concrete implementation of a business response
+ * [<code>org,apache.commons.util.BizResponse</code>]
+ * that can be used "as-is" to manage a response from the business tier.
+ *
+ * @author Ted Husted
+ * @author Synthis Corporation
+ * @version $Revision$ $Date$
+ */
public class BizResponseImpl implements Serializable,BizResponse {
1.2 +3 -1
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizResponse.java
Index: BizResponse.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizResponse.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizResponse.java 23 Nov 2002 19:05:49 -0000 1.1
+++ BizResponse.java 24 Nov 2002 15:53:53 -0000 1.2
@@ -24,6 +24,8 @@
* (see <code>isSingleForm()</code>).
*
* @author Ted Husted
+ * @author Synthis Corporation
+ * @author Nationwide Insurance Company
* @version $Revision$ $Date$
*/
public interface BizResponse {
1.2 +11 -34
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizRequestImpl.java
Index: BizRequestImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizRequestImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizRequestImpl.java 23 Nov 2002 19:05:49 -0000 1.1
+++ BizRequestImpl.java 24 Nov 2002 15:53:53 -0000 1.2
@@ -1,81 +1,64 @@
package org.apache.commons.scaffold.util;
-// ------------------------------------------------------------------------ 78
-
import java.io.Serializable;
import java.util.Locale;
-public abstract class BizRequestImpl implements Serializable, BizRequest {
+// ------------------------------------------------------------------------ 78
+/**
+ * Concrete implementation of a business request.
+ * [<code>org,apache.commons.util.BizRequest</code>]
+ *
+ * @author Ted Husted
+ * @version $Revision$ $Date$
+ */
+public abstract class BizRequestImpl implements Serializable, BizRequest {
/**
* The locale for this bean instance, if any.
*/
private Locale locale = null;
-
// See interface for JavaDoc
public Locale getSessionLocale() {
return this.locale;
}
-
// See interface for JavaDoc
public void setSessionLocale(Locale locale) {
this.locale = locale;
}
-
/**
* The remoteNode for this bean instance, if any.
*/
private Integer remoteNode = null;
-
// See interface for JavaDoc
public Integer getRemoteNode() {
return this.remoteNode;
}
-
// See interface for JavaDoc
public void setRemoteNode(Integer remoteNode) {
this.remoteNode = remoteNode;
}
-
- /**
- * Set the remoteNode using a String in
- * the format usually given
- * by the REMOTE_ADDR CGI variable, or
- * ServletRequest.getRemoteAddr().
- * NOTE: <b>not implemented; returns 0</b>.
- * @returns An Integer value based on RemoteAddr string.
- */
+ // See interface for JavaDoc
public void setRemoteHost(String remoteHost) {
setRemoteNode(new Integer(0)); // :FIXME:
}
-
- /**
- * Return the String representation
- * of an IP address expressed
- * as an Integer, into the format usually given
- * by the REMOTE_ADDR CGI variable, or
- * ServletRequest.getRemoteAddr().
- * NOTE: <b>not implemented; returns zeros.</b>
- * @returns An Integer value based on RemoteAddr string.
- */
+ // See interface for JavaDoc
public String getRemoteHost() {
return new String("000.000.000.000"); // :FIXME:
}
-
/**
* The remote server object for this bean instance, if any.
* This is often an application-scope object that can be used
@@ -86,36 +69,30 @@
*/
private Object server = null;
-
// See interface for JavaDoc
public Object getRemoteServer() {
return this.server;
}
-
// See interface for JavaDoc
public void setRemoteServer(Object server) {
this.server = server;
}
-
/**
* The parameter
*/
private String parameter = null;
-
// See interface for JavaDoc
public String getParameter() {
return (this.parameter);
}
-
// See interface for JavaDoc
public void setParameter(String parameter) {
this.parameter = parameter;
}
-
// See interface for JavaDoc
public Messages validate(String parameter){
1.2 +26 -3
jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizRequest.java
Index: BizRequest.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/BizRequest.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BizRequest.java 23 Nov 2002 19:05:49 -0000 1.1
+++ BizRequest.java 24 Nov 2002 15:53:53 -0000 1.2
@@ -4,9 +4,32 @@
import java.util.Locale;
/**
- * Simple helper bean that can be used to encapsulate the runtime
- * properties needed by a business process.
+ * A helper bean used to encapsulate the runtime
+ * properties needed by a business service
+ * [<code>org.apache.commons.scaffold.util.BizSevice</code>].
+ * <p>
+ * This is a whitebox class that is meant to be extended
+ * with new properties to meet the requirements of a
+ * particular business service.
+ * <p>
+ * A number of base properties are provided to meet common needs.
+ * <p>
+ * <ul>
+ * <li>
+ * <b>SessionLocale</b> - A locale object for the client making this request.
+ * <li>
+ * <b>RemoteNode</b> - The network address of the client making this request
+ * (or its proxy host).
+ * <li>
+ * <b>RemoteServer</b> - A general-purpose Object that may be used by a business
+ * service to obtain a reference to other services (JBDC, JNDI, and so forth).
+ * <li>
+ * <b>Parameter</b> - A general-purpose String that may be used to select a
+ * sub-service or pass other information to the service.
+ * </ul>
+ *
* @author Ted Husted
+ * @author Nationwide Insurance Company
* @version $Revision$ $Date$
*/
public interface BizRequest {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
