This project has retired. For details please refer to its Attic page.

org.apache.avalon.framework.service
Interface ServiceSelector

All Known Subinterfaces:

DataSourceSelector, Store

All Known Implementing Classes:

DefaultDataSourceSelector, DefaultServiceSelector, FortressServiceSelector, RepositoryManager, WrapperServiceSelector

public interface ServiceSelector

A ServiceSelector selects Objects based on a supplied policy. The contract is that all the Objects implement the same role.

Version:

$Id: ServiceSelector.java 30977 2004-07-30 08:57:54Z niclas $

Author:

Avalon Development Team

See Also:

Serviceable, ServiceSelector

Method Summary

boolean	isSelectable(java.lang.Object policy) Check to see if a Object exists relative to the supplied policy.
void	release(java.lang.Object object) Return the Object when you are finished with it.
java.lang.Object	select(java.lang.Object policy) Select the Object associated with the given policy.

Method Detail

select

public java.lang.Object select(java.lang.Object policy)
                        throws ServiceException

Select the Object associated with the given policy. For instance, If the ServiceSelector has a Generator stored and referenced by a URL, the following call could be used:

 try
 {
     Generator input;
     input = (Generator)selector.select( new URL("foo://demo/url") );
 }
 catch (...)
 {
     ...
 }
 

Parameters:

policy - A criteria against which a Object is selected.

Returns:

an Object value

Throws:

ServiceException - If the requested Object cannot be supplied

isSelectable

public boolean isSelectable(java.lang.Object policy)

Check to see if a Object exists relative to the supplied policy.

Parameters:

policy - a Object containing the selection criteria

Returns:

True if the component is available, False if it not.

release

public void release(java.lang.Object object)

Return the Object when you are finished with it. This allows the ServiceSelector to handle the End-Of-Life Lifecycle events associated with the Object. Please note, that no Exception should be thrown at this point. This is to allow easy use of the ServiceSelector system without having to trap Exceptions on a release.

Parameters:

object - The Object we are releasing, may also be a null reference