The BaseBundleActivator Class

Central to SAT is the abstract class BaseBundleActivator that is a subclass of Object and an implementer of the OSGi defined interface BundleActivator.

When creating an SAT bundle its activator is a concrete subclass of BaseBundleActivator. The most important methods defined by the BaseBundleActivator class can be categorized as follows:

• Hook API: These methods are executed by SAT and are often overridden by a BaseBundleActivator subclass to define the appropriate behavior for the bundle.
  • void activate()
  • void deactivate()
  • void start()
  • void stop()
• Configuration API: These methods are typically executed by a BaseBundleActivator subclass from within a hook method to configure the bundle.
  • void addExportedService(String, Object, Dictionary)
  • void addExportedServices(String[], Object, Dictionary)
  • void addExportedProxyService(Class, IProxyServiceHandler, Dictionary)
  • void addExportedProxyServices(Class[], IProxyServiceHandler, Dictionary)
  • void addImportedServiceFilter(String, String)
  • void releaseImportedServices()
  • void releaseOptionalImportedServices()
  • void removeExportedService(String)
  • void removeExportedService(String, Object)
  • void removeExportedServices(String)
  • void removeImportedServiceFilter(String)
  • void setExportedServiceProperties(String, Dictionary)
  • void setExportedServiceProperties(String, Object, Dictionary)
• Configuration Parameter API: These methods are executed by SAT to provide configuration parameters for the bundle and are sometimes overridden by a BaseBundleActivator subclass to configure the behavior of the bundle.
  • int getAsyncStartPriority()
  • InputStream getPropertiesInputStream()
  • boolean isUninstallable()
  • boolean isStartAsync()
  • boolean isTransient()
• Query API: These methods are typically executed by a BaseBundleActivator subclass from within a hook method to query the configuration of the bundle.
  • Object getExportedService(String)
  • Object[] getExportedServices(String)
  • String[] getExportedServiceNames()
  • String[] getExportedServiceNamesFromManifest()
  • Dictionary getExportedServiceProperties(String)
  • Dictionary getExportedServiceProperties(String, Object)
  • Object getImportedService(String)
  • String getImportedServiceFilter(String)
  • String[] getImportedServiceNames()
  • String[] getImportedServiceNamesFromManifest()
  • Object getImportedServiceProperty(String, String)
  • String[] getImportedServicePropertyKeys(String)
  • Object getOptionalImportedService(String)
  • Properties getProperties()
  • InputStream getFilePropertiesInputStream() throws IOException
  • InputStream getFilePropertiesInputStream(String) throws IOException
  • InputStream getResourcePropertiesInputStream() throws IOException
  • InputStream getResourcePropertiesInputStream(String) throws IOException
• Handler Hook API: These methods are rarely needed, but when they are, they are executed by SAT and overridden by the BaseBundleActivator subclasses.
  • void handleAcquiredImportedService(Object)
  • void handleReleasedImportedService(Object)
  • void handleAcquiredOptionalImportedService(Object)
  • void handleReleasedOptionalImportedService(Object)
  • boolean handleException(Exception)
  • boolean handleFailedToFindProperties(String filename)
• Persistent Bundle Storage API: The OSGi framework defines that each bundle has a persistent bundle store that can be used for storing private data. These methods provide access to the persistent bundle store directory and the files that it contains.
  • File getDataDirectory()
  • File getDataFile(String)
• Bundle Activator API: The OSGi framework implements and executes these methods. These methods were purposely made final to protect the integrity of the SAT framework algorithm and cannot be overridden by subclasses.
  • void start(BundleContext) throws Exception
  • void stop(BundleContext) throws Exception
  If you ever find yourself wanting to override start(BundleContext) and stop(BundleContext), consider overriding the hook methods start() and stop().
• OSGi Query API: These methods are provided to expose the underlying OSGi framework abstractions for native OSGi framework support. These methods are typically not used.
  • Bundle getBundle()
  • BundleContext getBundleContext()
  • String getBundleName()
• OSGi Framework API: These methods are provided to directly control the execution of the OSGi framework.
  • void shutdownFramework() throws BundleException
  • void restartFramework() throws BundleException

---

|

---

Copyright © 2001, 2007 IBM Corporation and others. All Rights Reserved.