Author: asanka
Date: Fri Feb 13 03:48:31 2009
New Revision: 743970
URL: http://svn.apache.org/viewvc?rev=743970&view=rev
Log:
Adding doc comments to the eventing api.
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java?rev=743970&r1=743969&r2=743970&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java
Fri Feb 13 03:48:31 2009
@@ -22,9 +22,13 @@
import org.apache.synapse.MessageContext;
/**
- *
+ * Synapse Event Filter that use the message context to do filtering.
*/
public interface SynapseEventFilter {
-
+ /**
+ * Check the incoming event satisfied with the defined filter
+ * @param mc Message Context
+ * @return True|False
+ */
public boolean isSatisfied(MessageContext mc);
}
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java?rev=743970&r1=743969&r2=743970&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java
Fri Feb 13 03:48:31 2009
@@ -45,7 +45,7 @@
import java.util.List;
/**
- *
+ * Eventsource that accepts the event requests using a message reciver.
*/
public class SynapseEventSource extends SynapseMessageReceiver {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java?rev=743970&r1=743969&r2=743970&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java
Fri Feb 13 03:48:31 2009
@@ -25,7 +25,7 @@
import org.wso2.eventing.Subscription;
/**
- *
+ * Bean that keep subscription and subscription metadata.
*/
public class SynapseSubscription extends Subscription {
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java?rev=743970&r1=743969&r2=743970&view=diff
==============================================================================
---
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java
(original)
+++
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java
Fri Feb 13 03:48:31 2009
@@ -27,22 +27,65 @@
import java.util.List;
import java.util.Map;
+/**
+ * Subscription Manager for Synapse
+ */
public abstract class SynapseSubscriptionManager implements
SubscriptionManager {
private Map<String, String> properties = new HashMap<String, String>();
+ /**
+ * Return all Active subscriptions
+ *
+ * @return List of subscriptions
+ */
public abstract List<SynapseSubscription> getSynapseSubscribers();
+ /**
+ * Get the matching subscriptions for a given filter.
+ *
+ * @param mc Message context
+ * @return List of subscriptions
+ */
public abstract List<SynapseSubscription>
getMatchingSubscribers(MessageContext mc);
+ /**
+ * Get the static subscription defined in the configuration
+ *
+ * @return List of static subscriptions
+ */
public abstract List<SynapseSubscription> getStaticSubscribers();
+ /**
+ * Get a subscription by subscription ID
+ *
+ * @param id subscription ID
+ * @return SynapseSubscription
+ */
public abstract SynapseSubscription getSubscription(String id);
+ /**
+ * Add a new subscription to the store
+ *
+ * @param subs Subscription object
+ * @return String subscription ID
+ */
public abstract String addSubscription(SynapseSubscription subs);
+ /**
+ * Delete a given subscription
+ *
+ * @param id Subscription ID
+ * @return True|False
+ */
public abstract boolean deleteSubscription(String id);
+ /**
+ * Renew a given subscription
+ *
+ * @param subscription subscription object
+ * @return True|False
+ */
public abstract boolean renewSubscription(SynapseSubscription
subscription);
public abstract void init();
