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

public interface IServiceDetecter

An IServiceDetecter declares the role of an object that will detect the registration and unregistration of services of a specified type. The following responsibilities are declared:

• Acquiring the existing services and detected future services.
• Releasing the detected services.
• Knowing the services detected so far.
• Knowing the filter used to detect services.

An IServiceDetecter can have listeners that are an implementation of the interface ServiceDetecterListener that are notified when a service of the specified type has been added to, or removed from, the IServiceDetecter. An IServiceDetecter may include a filter that allows for finer grained service detection within a specified type.

Note: In most situations it is simply not necessary to use an IServiceDetecter, since explicit service registration is preferable. Situations where using IServiceDetecter is helpful include:

• When there is a need to pick from one of many registered services of a particular type. Service selection could be based on either the ranking of the registered service, or on some aspect of the domain model.
• For the detection of services to which you do not have the source code. For example, detecting when LogService objects are registered or unregistered.

Note: Instances of this interface can be created using the FactoryUtility class.

Method Summary

void	acquire() Acquire the imported services.
void	addServiceDetecterListener(ServiceDetecterListener listener) Add ServiceDetecterListener to the detecter.
String	getName() Get the name of the service being detected.
List	getServiceReferences() Query the service references that have been detected.
List	getServiceReferences(String filter) Query the service references that have been detected, filtered by the specified LDAP filter.
List	getServices() Query the services that have been detected.
List	getServices(String filter) Query the services that have been detected, filtered by the specified LDAP filter.
boolean	isAcquired() Query whether the detecter is acquired or not.
void	release() Release the services contained in the IServiceDetecter.
void	removeServiceDetecterListener(ServiceDetecterListener listener) Add ServiceDetecterListener to the detecter.
void	setFilter(String filter) Sets the IServiceDetecter object's service filter.

Method Detail

acquire

public void acquire()

Acquire the imported services.

addServiceDetecterListener

public void addServiceDetecterListener(ServiceDetecterListener listener)

Add ServiceDetecterListener to the detecter.

Parameters:

listener - A ServiceDetecterListener.

getName

public String getName()

Get the name of the service being detected.

Returns:

A service name.

getServiceReferences

public List getServiceReferences()

Query the service references that have been detected.

Returns:

The detected service reference objects.

getServiceReferences

public List getServiceReferences(String filter)
                          throws InvalidSyntaxException

Query the service references that have been detected, filtered by the specified LDAP filter.

Parameters:

filter - An LDAP filter with which to filter the service references objects.

Returns:

The detected service reference objects.

Throws:

InvalidSyntaxException - when the filter parameter is invalid.

getServices

public List getServices()

Query the services that have been detected.

Returns:

The detected service objects.

getServices

public List getServices(String filter)
                 throws InvalidSyntaxException

Query the services that have been detected, filtered by the specified LDAP filter.

Parameters:

filter - An LDAP filter with which to filter the service objects.

Returns:

The detected service objects.

Throws:

InvalidSyntaxException - when the filter parameter is invalid.

isAcquired

public boolean isAcquired()

Query whether the detecter is acquired or not.

Returns:

True if the detecter is acquired, otherwise false.

release

public void release()

Release the services contained in the IServiceDetecter.

removeServiceDetecterListener

public void removeServiceDetecterListener(ServiceDetecterListener listener)

Add ServiceDetecterListener to the detecter.

Parameters:

listener - A ServiceDetecterListener.

setFilter

public void setFilter(String filter)
               throws InvalidSyntaxException

Sets the IServiceDetecter object's service filter. The filter is applied to existing services and services that are subsequently registered with the OSGi framework. Services that do not match the filter are removed from the IServiceDetecter. Registered services that match the filter, will be added to the IServiceDetecter.

Parameters:

filter - The LDAP service filter.

Throws:

InvalidSyntaxException - when the specified filter is invalid.