1 files changed, 88 insertions, 0 deletions
diff --git a/plugins/org.eclipse.dd.dsf/src/org/eclipse/dd/dsf/service/IDsfService.java b/plugins/org.eclipse.dd.dsf/src/org/eclipse/dd/dsf/service/IDsfService.java
new file mode 100644
index 00000000000..82e5c310e32
--- /dev/null
+++ b/plugins/org.eclipse.dd.dsf/src/org/eclipse/dd/dsf/service/IDsfService.java
@@ -0,0 +1,88 @@
+/*******************************************************************************
+ * Copyright (c) 2006 Wind River Systems and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ * 
+ * Contributors:
+ *     Wind River Systems - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.dd.dsf.service;
+
+import java.util.Dictionary;
+
+import org.eclipse.dd.dsf.concurrent.Done;
+import org.eclipse.dd.dsf.concurrent.DsfExecutor;
+
+/**
+ * The inteface that all Riverbed services must implement.  It only privides a 
+ * few features to help manage and identify the servies using the OSGI services 
+ * framework.
+ * <p>
+ * Each service should register itself with OSGI services framework using
+ * the BundleContext.registerService() method.  And each service should use the 
+ * session ID that it is registering with as one of the service properties.  If there
+ * is more than one instance of the service to be instanciated for a given session, 
+ * additional properties should be used when registering the service to allow clients 
+ * to uniquely identify the services.
+ * <p>
+ * By convention, all methods of Riverbed services can be called only on the dispatch
+ * thread of the Riverbed executor that is associated with the service.  If a 
+ * service exposes a method that is to be called on non-dispatch thread, it should 
+ * be documented so. 
+ *  
+ * TODO: Add IStatus error code constants for common service related failures. 
+ *   
+ * @see org.osgi.framework.BundleContext#registerService(String[], Object, Dictionary)
+ */
+public interface IDsfService {
+    
+    /**
+     * Property name for the session-id of this service.  This property should be set by 
+     * all Riverbed services when they are registered with OSGI service framework. 
+     */
+    static String PROP_SESSION_ID = "org.eclipse.dd.dsf.service.IService.session_id";
+    
+    /**
+     * Returns the executor that should be used to call methods of this service.
+     * @return 
+     */
+    DsfExecutor getExecutor();
+    
+    /**
+     * Returns a filter string that can be used to uniquely identify this 
+     * service. This filter string should be based on the properties and class 
+     * name, which were used to register this service.
+     * @see org.osgi.framework.BundleContext#getServiceReferences
+     */
+    String getServiceFilter();
+    
+    /**
+     * Performs initialization and registration of the given service.  Implementation 
+     * should initialize the service, so that all methods and events belonging to this 
+     * service can be used  following the initialization.  
+     * <br>Note: Since service initializaiton should be performed by an external
+     * logic, if this service depends on other services, the implementaion should 
+     * assume that these services are already present, and if they are not, the 
+     * initializaiton should fail.  
+     * @param done callback to be submitted when the initialization is complete
+     */
+    void initialize(Done done);
+    
+    /**
+     * Performs shutdown and de-registration of the given service.    
+     * @param done callback to be submitted when shutdown is complete
+     */
+    void shutdown(Done done);
+    
+    /**
+     * Returns the startup order number of this service among services in the same session.
+     * Implementations should get this number during initialization by calling 
+     * Session.getAndIncrementServiceStartupCounter().  This counter is used to Session 
+     * objects to prioritize the listeners of service events.
+     * @return startup order number of this service
+     * @see org.eclipse.dd.dsf.service.DsfSession#getAndIncrementServiceStartupCounter()
+     */
+    int getStartupNumber();
+}