Author: asankaa Date: Thu Feb 12 19:43:54 2009 New Revision: 30741 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=30741
Log: Adding doc comments for the API Modified: branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java Modified: branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java URL: http://wso2.org/svn/browse/wso2/branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java?rev=30741&r1=30740&r2=30741&view=diff ============================================================================== --- branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java (original) +++ branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventFilter.java Thu Feb 12 19:43:54 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: branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java URL: http://wso2.org/svn/browse/wso2/branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java?rev=30741&r1=30740&r2=30741&view=diff ============================================================================== --- branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java (original) +++ branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseEventSource.java Thu Feb 12 19:43:54 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: branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java URL: http://wso2.org/svn/browse/wso2/branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java?rev=30741&r1=30740&r2=30741&view=diff ============================================================================== --- branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java (original) +++ branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscription.java Thu Feb 12 19:43:54 2009 @@ -25,7 +25,7 @@ import org.wso2.eventing.Subscription; /** - * + * Bean that keep subscription and subscription metadata. */ public class SynapseSubscription extends Subscription { Modified: branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java URL: http://wso2.org/svn/browse/wso2/branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java?rev=30741&r1=30740&r2=30741&view=diff ============================================================================== --- branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java (original) +++ branches/synapse/1.2.wso2v1/modules/core/src/main/java/org/apache/synapse/eventing/SynapseSubscriptionManager.java Thu Feb 12 19:43:54 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(); _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
