org.eclipse.soda.sat.core.framework.interfaces
Interface IBundleActivationManagerOwner

All Known Implementing Classes:

BundleActivationManagerOwnerAdapter

public interface IBundleActivationManagerOwner

The IBundleActivatorManagerManagerOwner interface is implemented by the owner of an IBundleActivationManager instance. The owner is responsible for handling call-backs from the manager.

Field Summary

static String[]

NO_SERVICES

Method Summary

void	activate() Hook Method: You have been activated.
void	deactivate() Hook Method: You have been deactivated.
int	getAsyncStartPriority() Configuration Parameter Method: Get the async start thread priority.
String[]	getImportedServiceNames() Query Method: Answers the names of all the services that are imported by the bundle.
String[]	getOptionalImportedServiceNames() Query Method: Answers the names of all the services that are optionally imported by the bundle.
InputStream	getPropertiesInputStream() Hook Method: Get an input stream to the bundle's properties.
void	handleAcquiredOptionalImportedService(String serviceName, Object service) Hook Handler Method: When an optional imported service is acquired, this method is called.
boolean	handleException(Exception exception) Hook Handler Method: Handles a thrown exception.
void	handleFailedToFindProperties(String filename) Hook Handler Method: Handle the fact that the specified properties file could not be found.
void	handleReleasedOptionalImportedService(String serviceName, Object service) Hook Handler Method: When an optional imported service is released this method is called.
boolean	isStartAsync() Configuration Parameter Method: Specifies whether the bundle should start asynchronously.
boolean	isTransient() Configuration Parameter Method: Specify whether the bundle should be treated as transient.
boolean	isUninstallable() Configuration Parameter Method: Specify whether the bundle should be treated as uninstalled.
void	start() Hook Method: This method is called when the IBundleActivatorManager executes its start(BundleContext) method.
void	stop() Hook Method: This method is called when the IBundleActivatorManager executes its stop(BundleContext) method.

Field Detail

NO_SERVICES

public static final String[] NO_SERVICES

Method Detail

activate

public void activate()

Hook Method: You have been activated. This method is implemented by bundles that wish to execute domain specific activation.

deactivate

public void deactivate()

Hook Method: You have been deactivated. This method is implemented to execute domain specific deactivation.

getAsyncStartPriority

public int getAsyncStartPriority()

Configuration Parameter Method: Get the async start thread priority. This method is implemented by bundles that have implemented the method isStartAsync() to return true and wish to specify a thread priority other than Thread.NORM_PRIORITY .

Returns:

The async start thread priority.

See Also:

isStartAsync()

getImportedServiceNames

public String[] getImportedServiceNames()

Query Method: Answers the names of all the services that are imported by the bundle.

Returns:

A String array containing the imported service names, or an empty String array if there are no imported service names.

getOptionalImportedServiceNames

public String[] getOptionalImportedServiceNames()

Query Method: Answers the names of all the services that are optionally imported by the bundle.

Returns:

A String array containing the optionally imported service names, or an empty String array if there are no optionally imported service names.

getPropertiesInputStream

public InputStream getPropertiesInputStream()
                                     throws IOException

Hook Method: Get an input stream to the bundle's properties. This method is implemented by bundles that possess properties.

Returns:

An input stream to the properties or null if the bundle does not have any properties.

Throws:

IOException

See Also:

IBundleActivationManager.getFilePropertiesInputStream(), IBundleActivationManager.getFilePropertiesInputStream(String)

handleAcquiredOptionalImportedService

public void handleAcquiredOptionalImportedService(String serviceName,
                                                  Object service)

Hook Handler Method: When an optional imported service is acquired, this method is called. This method should be implemented to handle the domain specific case where an optional imported service is acquired. Since all acquired optional imported services will arrive via this method, it is important to handle each service separately.

Parameters:

serviceName - The fully-qualified name of the optional imported service.

service - The acquired optional imported service.

handleException

public boolean handleException(Exception exception)

Hook Handler Method: Handles a thrown exception. This method can be implemented by bundles that wish to handle thrown exceptions themselves.

Parameters:

exception - The unhandled exception.

Returns:

True if the exception was fully handled, otherwise false.

handleFailedToFindProperties

public void handleFailedToFindProperties(String filename)

Hook Handler Method: Handle the fact that the specified properties file could not be found.

Parameters:

filename - The name of the properties file.

handleReleasedOptionalImportedService

public void handleReleasedOptionalImportedService(String serviceName,
                                                  Object service)

Hook Handler Method: When an optional imported service is released this method is called. This method should be implemented to handle the domain specific case where an optional imported service is released. Since all released optional imported services will arrive via this method, it is important to handle each service separately.

Parameters:

serviceName - The fully-qualified name of the optional imported service.

service - The released optional imported service.

isStartAsync

public boolean isStartAsync()

Configuration Parameter Method: Specifies whether the bundle should start asynchronously. This method should be implemented by bundles that wish to start asynchronously.

Returns:

True if the bundle should start asynchronously, otherwise false.

isTransient

public boolean isTransient()

Configuration Parameter Method: Specify whether the bundle should be treated as transient. Transient bundles are automatically uninstalled once they have started and entered the Bundle.ACTIVE state. This method should be implemented by bundles that are to be considered transient. Note:

• A transient bundle typically does not export any services.
• It makes no sense for a transient bundle to also implement the method isUninstallable().

Returns:

True if the bundle should be treated as transient, otherwise false.

isUninstallable

public boolean isUninstallable()

Configuration Parameter Method: Specify whether the bundle should be treated as uninstalled. Uninstalled bundles are automatically uninstalled when their last dependent bundle is uninstalled. This method should be implemented to return true by bundles that are uninstallable prerequisites.

Note:

• An uninstallable bundle is always a prerequisite of another bundle.
• It makes no sense for an uninstallable bundle to also implement the method isTransient().

Returns:

True if the bundle should be treated as uninstallable, otherwise false.

start

public void start()
           throws Exception

Hook Method: This method is called when the IBundleActivatorManager executes its start(BundleContext) method. This method is implemented by bundles that wish to perform behavior exactly once when the bundle starts.

Throws:

Exception

stop

public void stop()
          throws Exception

Hook Method: This method is called when the IBundleActivatorManager executes its stop(BundleContext) method. This method is implemented by bundles that wish to perform behavior exactly once when the bundle stops.

Throws:

Exception