Service Activator Toolkit
Version 1.1.0 (20081206)

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

All Superinterfaces:
IServiceRecord

public interface IImportServiceRecord
extends IServiceRecord

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

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()
          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.
 void setOwner(IImportServiceRecordOwner owner)
          Set the import service record's owner.
 
Methods inherited from interface org.eclipse.soda.sat.core.record.interfaces.IServiceRecord
basicToString, getBundleContext, getProperty, getPropertyKeys, getService
 

Method Detail

acquire

void acquire()
Try and acquire the imported service from the OSGi framework.


getFilter

Filter getFilter()
Query the LDAP filter for the imported service.

Returns:
The filter used to acquire the imported service.

getName

String getName()
Query the name of the imported service.

Returns:
The name of the imported service.

isAcquired

boolean isAcquired()
Query whether the imported service is acquired.

Returns:
True if the imported service is acquired, otherwise false.

release

void release()
Release the imported service back to the OSGi framework.


setFilter

void setFilter(Filter filter)
Sets the filter used to acquire the imported service.

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

setOwner

void setOwner(IImportServiceRecordOwner owner)
Set the import service record's owner.

Parameters:
owner - The owner of the import service record.

Service Activator Toolkit
Version 1.1.0 (20081206)