org.eclipse.soda.sat.core.record.interfaces
Interface IImportServiceRecord

All Superinterfaces:

IServiceRecord

public interface IImportServiceRecord

extends IServiceRecord

An IImportServiceRecord represents a service imported by a bundle and acquired from the OSGi framework. The following responsibilities are declared:

• Acquiring an imported service from the OSGi framework.
• Releasing an imported service back to the OSGi framework.
• Managing the filter used to acquire an imported service from the OSGi framework.
• Knowing the service name used to register an imported service with the OSGi framework.

Every IImportServiceRecord must having an owner that is an implementation of the interface IImportServiceRecordOwner. The owner is responsible for handling call-back notifications such as when a service is acquired and released.

Note: Since this abstraction is used internally by the SAT bundle this interface is typically not used directly by bundle developers. For cases where subclassing the BaseBundleActivator is not appropriate, instances of this interface can be created using the FactoryUtility class.

Method Summary

void	acquire(IImportServiceRecordOwner owner) Try and acquire the imported service from the OSGi framework.
Filter	getFilter() Query the LDAP filter for the imported service.
String	getName() Query the name of the imported service.
boolean	isAcquired() Query whether the imported service is acquired.
void	release() Release the imported service back to the OSGi framework.
void	setFilter(Filter filter) Sets the filter used to acquire the imported service.

Methods inherited from interface org.eclipse.soda.sat.core.record.interfaces.IServiceRecord

getProperty, getPropertyKeys, getService, hasService, setService

Method Detail

acquire

public void acquire(IImportServiceRecordOwner owner)

Try and acquire the imported service from the OSGi framework.

Parameters:

owner - The owner of the import service record.

getFilter

public Filter getFilter()

Query the LDAP filter for the imported service.

Returns:

The filter used to acquire the imported service.

getName

public String getName()

Query the name of the imported service.

Returns:

The name of the imported service.

isAcquired

public boolean isAcquired()

Query whether the imported service is acquired.

Returns:

True if the imported service is acquired, otherwise false.

release

public void release()

Release the imported service back to the OSGi framework.

setFilter

public void setFilter(Filter filter)

Sets the filter used to acquire the imported service.

Parameters:

filter - The LDAP filter used to acquire the imported service.