[jboss-svn-commits] JBL Code SVN: r6518 - labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Mon Oct 2 06:32:13 EDT 2006
Author: mark.little at jboss.com
Date: 2006-10-02 06:32:02 -0400 (Mon, 02 Oct 2006)
New Revision: 6518
Modified:
labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Body.java
labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Context.java
labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Fault.java
labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Header.java
labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Message.java
labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Properties.java
Log:
Updated javadocs for public interfaces.
Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Body.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Body.java 2006-10-02 09:05:18 UTC (rev 6517)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Body.java 2006-10-02 10:32:02 UTC (rev 6518)
@@ -21,7 +21,7 @@
* @author mark.little at jboss.com
*/
-/*
+/**
* The message body holds arbitrary information which represents the
* payload as far as clients and services are concerned. A body may contain:
*
Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Context.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Context.java 2006-10-02 09:05:18 UTC (rev 6517)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Context.java 2006-10-02 10:32:02 UTC (rev 6518)
@@ -21,6 +21,12 @@
* @author mark.little at jboss.com
*/
+/**
+ * The context is the section of the message containing information such as session
+ * management, transaction information, security data etc. Entries in the context
+ * may be ordered.
+ */
+
public interface Context
{
// TODO add some methods!
Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Fault.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Fault.java 2006-10-02 09:05:18 UTC (rev 6517)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Fault.java 2006-10-02 10:32:02 UTC (rev 6518)
@@ -23,11 +23,39 @@
* @author mark.little at jboss.com
*/
+/**
+ * Faults may be returned from a service in response to receiving and acting upon messages.
+ * A fault consists of a unique code (MANDATORY) and a reason string (OPTIONAL).
+ */
+
public interface Fault
{
+ /**
+ * @return the unique code representing this fault.
+ */
+
public URI getCode ();
+
+ /**
+ * Set the unique code for this fault.
+ *
+ * @param code the code.
+ */
+
public void setCode (URI code);
+ /**
+ * @return a String representing the reason for the fault. Typically used for
+ * logging purposes.
+ */
+
public String getReason ();
+
+ /**
+ * Set the optional reason for this fault.
+ *
+ * @param reason the reason for the fault.
+ */
+
public void setReason (String reason);
}
\ No newline at end of file
Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Header.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Header.java 2006-10-02 09:05:18 UTC (rev 6517)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Header.java 2006-10-02 10:32:02 UTC (rev 6518)
@@ -29,6 +29,17 @@
public interface Header
{
+ /**
+ * @return get the Call information for this message.
+ */
+
public Call getCall ();
+
+ /**
+ * Set the call information for this message.
+ *
+ * @param call the information.
+ */
+
public void setCall (Call call);
}
\ No newline at end of file
Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Message.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Message.java 2006-10-02 09:05:18 UTC (rev 6517)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Message.java 2006-10-02 10:32:02 UTC (rev 6518)
@@ -34,6 +34,7 @@
* Body: the actual payload of the message.
* Fault: any fault information associated with the message.
* Attachment: any attachments associated with the message.
+ * Properties: any message specific properties.
*
* Each message, once created, has a corresponding element for these 5 components. That element
* may be empty (<b>NOT NULL</b>). The object representing the element can then be used to act
Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Properties.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Properties.java 2006-10-02 09:05:18 UTC (rev 6517)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/message/Properties.java 2006-10-02 10:32:02 UTC (rev 6518)
@@ -22,45 +22,65 @@
package org.jboss.soa.esb.message;
/**
- * The message properties hold arbitrary information in the form
- * of <String,Object> pairs
+ * The message properties hold arbitrary information in the form of
+ * <String,Object> pairs
*
*/
-public interface Properties {
+public interface Properties
+{
/**
* getProperty(name)
- * @param name String - name of property
+ *
+ * @param name
+ * String - name of property
* @return Object - the value stored under the specified name
*/
public Object getProperty(String name);
+
/**
* getProperty(name,defaultVal)
- * @param name String - name of property
- * @param defaultVal Object - value to return if no value found
+ *
+ * @param name
+ * String - name of property
+ * @param defaultVal
+ * Object - value to return if no value found
* @return Object - the value stored under the specified name
*/
public Object getProperty(String name, Object defaultVal);
+
/**
* setProperty(name,value)
- * @param name String - name of property to store
- * @param value Object - value of property to store under specified name
- * @return Object - the previous value of the specified name, or null if it did not have one
+ *
+ * @param name
+ * String - name of property to store
+ * @param value
+ * Object - value of property to store under specified name
+ * @return Object - the previous value of the specified name, or null if it
+ * did not have one
*/
public Object setProperty(String name, Object value);
+
/**
* remove(name)
- * @param name String - name of property to remove
- * @return Object - the previous value of the specified name, or null if it did not have one
+ *
+ * @param name
+ * String - name of property to remove
+ * @return Object - the previous value of the specified name, or null if it
+ * did not have one
*/
public Object remove(String name);
+
/**
* size()
+ *
* @return int - Returns the number of properties in this object
*/
public int size();
+
/**
* getNames()
+ *
* @return String[] - containing the names of all properties
*/
public String[] getNames();
More information about the jboss-svn-commits
mailing list