jmsnell 2002/10/28 13:59:45
Modified: java/src/org/apache/axis/ime MessageExchange.java
ConfigurableMessageExchange.java
ConfigurableMessageExchangeFactory.java
MessageExchangeFactory.java
Log:
Minor javadoc edits
Revision Changes Path
1.4 +36 -3 xml-axis/java/src/org/apache/axis/ime/MessageExchange.java
Index: MessageExchange.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/org/apache/axis/ime/MessageExchange.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MessageExchange.java 28 Oct 2002 21:45:59 -0000 1.3
+++ MessageExchange.java 28 Oct 2002 21:59:45 -0000 1.4
@@ -71,6 +71,9 @@
* need to create a new MessageExchangeCorrelator and
* put it into the MessageContext if one does not already
* exist.)
+ * @param MessageContext The Axis MessageContext being sent
+ * @return MessageExchangeCorrelator The correlator for the sent MessageContext
+ * @throws AxisFault
*/
public MessageExchangeCorrelator send(
MessageContext context)
@@ -83,6 +86,9 @@
* response indicates that the MessageContext could not
* be removed from the outbound channel for whatever
* reason.
+ * @param MessageExchangeCorrelator The correlator for the message being
canceled
+ * @return MessageContext The canceled MessageContext
+ * @throws AxisFault
*/
public MessageContext cancel(
MessageExchangeCorrelator correlator)
@@ -90,6 +96,8 @@
/**
* Waits indefinitely for a message to be received
+ * @return MessageContext The received MessageContext
+ * @throws AxisFault
*/
public MessageContext receive()
throws AxisFault;
@@ -97,6 +105,9 @@
/**
* Waits the specified amount of time for a message to
* be received
+ * @param long The amount of time (ms) to wait
+ * @return MessageContext The received MessageContext
+ * @throws AxisFault
*/
public MessageContext receive(
long timeout)
@@ -105,24 +116,34 @@
/**
* Will instruct the MessageExchange provider to
* wait for a message to be received.
+ * @throws AxisFault
*/
- public void startListening();
+ public void startListening()
+ throws AxisFault;
/**
* Will instruct the MessageExchange provider to
* wait for a specific MessageExchangeCorrelator
+ * @param MessageExchangeCorrelator The correlator of the MessageContext to
listen for
+ * @throws AxisFault
*/
public void startListening(
- MessageExchangeCorrelator correlator);
+ MessageExchangeCorrelator correlator)
+ throws AxisFault;
/**
* Will instruct the MessageExchange provider to
* stop listening
+ * @throws AxisFault
*/
- public void stopListening();
+ public void stopListening()
+ throws AxisFault;
/**
* Synchronized send and receive
+ * @param MessageContext The MessageContext to send
+ * @return MessageContext The received MessageContext (not guaranteed to be the
same object instance as the sent MessageContext)
+ * @throws AxisFault
*/
public MessageContext sendAndReceive(
MessageContext context)
@@ -130,6 +151,10 @@
/**
* Synchronized send and receive with timeout
+ * @param MessageContext The MessageContext to send
+ * @param long The length of time (ms) to wait for a response. If a response is
not received within the specified amount of time, an AxisFault indicating timeout must
be thrown
+ * @return MessageContext The received MessageContext (not guaranteed to be the
same object instance as the sent MessageContext)
+ * @throws AxisFault
*/
public MessageContext sendAndReceive(
MessageContext context,
@@ -140,6 +165,8 @@
* Allows applications to listen for changes to
* the current disposition of the MessageExchange operation
* (push model)
+ * @param MessageExchangeStatusListener
+ * @throws AxisFault
*/
public void setMessageExchangeStatusListener(
MessageExchangeStatusListener listener)
@@ -148,6 +175,8 @@
/**
* Allows applications to listen for inbound messages
* (push model)
+ * @param MessageExchangeReceiveListener
+ * @throws AxisFault
*/
public void setMessageExchangeReceiveListener(
MessageExchangeReceiveListener listener)
@@ -156,6 +185,8 @@
/**
* Allows applications to listen for faults/exceptions
* (push model)
+ * @param MessageExchangeFaultListener
+ * @throws AxisFault
*/
public void setMessageExchangeFaultListener(
MessageExchangeFaultListener listener)
@@ -164,12 +195,14 @@
/**
* Allows MessageExchange consumers low level access
* to the Send message channel
+ * @return MessageChannel
*/
public MessageChannel getSendChannel();
/**
* Allows MessageExchange consumers low level access
* to the Receive message channel
+ * @return MessageChannel
*/
public MessageChannel getReceiveChannel();
1.4 +39 -6
xml-axis/java/src/org/apache/axis/ime/ConfigurableMessageExchange.java
Index: ConfigurableMessageExchange.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/org/apache/axis/ime/ConfigurableMessageExchange.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfigurableMessageExchange.java 28 Oct 2002 21:45:59 -0000 1.3
+++ ConfigurableMessageExchange.java 28 Oct 2002 21:59:45 -0000 1.4
@@ -55,6 +55,7 @@
package org.apache.axis.ime;
import java.util.Map;
+import org.apache.axis.AxisFault;
/**
* Extends the basic MessageExchange interface to allow
@@ -69,23 +70,55 @@
public interface ConfigurableMessageExchange
extends MessageExchange {
- public void enableFeature(String featureId);
-
- public void disableFeature(String featureId);
-
- public boolean isFeatureEnabled(String featureId);
-
+ /**
+ * @param String The id of the feature to enable
+ * @throws AxisFault
+ */
+ public void enableFeature(String featureId)
+ throws AxisFault;
+
+ /**
+ * @param String The id of the feature to disable
+ * @throws AxisFault
+ */
+ public void disableFeature(String featureId)
+ throws AxisFault;
+
+ /**
+ * @param String The id of the feature to check
+ * @return boolean
+ * @throws AxisFault
+ */
+ public boolean isFeatureEnabled(String featureId)
+ throws AxisFault;
+
+ /**
+ * @param String The id of the property
+ * @param Object The value of the property
+ */
public void setProperty(
String propertyId,
Object propertyValue);
+ /**
+ * @param String The id of the property
+ * @return Object The value of the property
+ */
public Object getProperty(
String propertyId);
+ /**
+ * @param String The id of the property
+ * @param Object The default value of the property
+ * @return Object The value of the property
+ */
public Object getProperty(
String propertyId,
Object defaultValue);
+ /**
+ * @return java.lang.Map The collection of properties
+ */
public Map getProperties();
public void clearProperties();
1.4 +8 -1
xml-axis/java/src/org/apache/axis/ime/ConfigurableMessageExchangeFactory.java
Index: ConfigurableMessageExchangeFactory.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/org/apache/axis/ime/ConfigurableMessageExchangeFactory.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConfigurableMessageExchangeFactory.java 28 Oct 2002 21:45:59 -0000 1.3
+++ ConfigurableMessageExchangeFactory.java 28 Oct 2002 21:59:45 -0000 1.4
@@ -55,6 +55,7 @@
package org.apache.axis.ime;
import java.util.Map;
+import org.apache.axis.AxisFault;
/**
* @author James M Snell ([EMAIL PROTECTED])
@@ -62,8 +63,14 @@
public interface ConfigurableMessageExchangeFactory
extends MessageExchangeFactory {
+ /**
+ * @param java.lang.Map Collection of properties
+ * @param String Array of feature id's to enable
+ * @return ConfigurableMessageExchange
+ */
public ConfigurableMessageExchange createMessageExchange(
Map properties,
- String[] enabledFeatures);
+ String[] enabledFeatures)
+ throws AxisFault;
}
1.4 +8 -1
xml-axis/java/src/org/apache/axis/ime/MessageExchangeFactory.java
Index: MessageExchangeFactory.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/org/apache/axis/ime/MessageExchangeFactory.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MessageExchangeFactory.java 28 Oct 2002 21:45:59 -0000 1.3
+++ MessageExchangeFactory.java 28 Oct 2002 21:59:45 -0000 1.4
@@ -54,11 +54,18 @@
*/
package org.apache.axis.ime;
+import org.apache.axis.AxisFault;
+
/**
* @author James M Snell ([EMAIL PROTECTED])
*/
public interface MessageExchangeFactory {
- public MessageExchange createMessageExchange();
+ /**
+ * @return MessageExchange
+ * @throws AxisFault
+ */
+ public MessageExchange createMessageExchange()
+ throws AxisFault;
}
