Author: ips
Date: Fri May 6 14:16:38 2005
New Revision: 168654
URL: http://svn.apache.org/viewcvs?rev=168654&view=rev
Log:
added more Javadoc
Modified:
incubator/hermes/trunk/src/java/org/apache/ws/notification/base/Subscription.java
Modified:
incubator/hermes/trunk/src/java/org/apache/ws/notification/base/Subscription.java
URL:
http://svn.apache.org/viewcvs/incubator/hermes/trunk/src/java/org/apache/ws/notification/base/Subscription.java?rev=168654&r1=168653&r2=168654&view=diff
==============================================================================
---
incubator/hermes/trunk/src/java/org/apache/ws/notification/base/Subscription.java
(original)
+++
incubator/hermes/trunk/src/java/org/apache/ws/notification/base/Subscription.java
Fri May 6 14:16:38 2005
@@ -32,23 +32,23 @@
{
/**
- * Get the topic expression associated with this subscription.
+ * Gets the topic expression associated with this subscription.
*
- * @return The topic expression
+ * @return the topic expression
*/
TopicExpression getTopicExpression();
/**
- * Get the precondition associated with this subscription.
+ * Gets the precondition associated with this subscription.
*
- * @return the precondition, or null if no precondition was specified in
the subscription
+ * @return the precondition, or null if no precondition was specified in
the subscribe request
*/
QueryExpression getPrecondition();
/**
- * Get the selector expression associated with this subscription.
+ * Gets the selector associated with this subscription.
*
- * @return the selector, or null if no selector was specified in the
subscription
+ * @return the selector, or null if no selector was specified in the
subscribe request
*/
QueryExpression getSelector();
@@ -59,27 +59,51 @@
*/
boolean getUseNotify();
- public boolean isPaused();
-
- public void pause() throws Exception;
-
- public void resume() throws Exception;
+ /**
+ * Returns true if this subscription is currently paused, or false
otherwise.
+ *
+ * @return true if this subscription is currently paused, or false
otherwise
+ */
+ boolean isPaused();
+
+ /**
+ * Temporarily suspends the delivery of notification messages for this
subscription.
+ *
+ * @throws Exception if unable to suspend message delivery
+ */
+ void pause() throws Exception;
/**
- * Get the producer resource associated with this subscription.
+ * Resumes the delivery of notification messages for this subscription.
+ *
+ * @throws Exception if unable to resume message delivery
+ */
+ void resume() throws Exception;
+
+ /**
+ * Gets the producer resource associated with this subscription.
*
* @return the producer resource
*/
NotificationProducerResource getProducerResource() throws Exception;
+ //TODO: remove this method once getEPR() method is added to Resource
interface
void setEpr(EndpointReference epr);
+ // TODO: remove this method once getEPR() method is added to Resource
interface
EndpointReference getEpr();
+ // TODO: figure out if we need this...
void setNotificationConsumer(NotificationConsumer notificationConsumer);
+ // TODO: figure out if we need this...
void setNotificationProducer(NotificationProducer notificationProducer);
+ /**
+ * Gets the consumer EPR associated with this subscription.
+ *
+ * @return the consumer EPR associated with this subscription
+ */
EndpointReference getConsumerReference();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
