bundles/org.eclipse.osgi/osgi/src/org/osgi/framework/hooks/service/FindHook.java

/*
 * $Date: 2008-07-31 15:04:40 -0400 (Thu, 31 Jul 2008) $
 * 
 * Copyright (c) OSGi Alliance (2008). All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.osgi.framework.hooks.service;

import java.util.Collection;

import org.osgi.framework.BundleContext;

/**
 * OSGi Framework Service Find Hook Service.
 * 
 * <p>
 * Bundles registering this service will be called during framework service find
 * (get service references) operations. Service hooks are not called for service
 * operations on other service hooks.
 * 
 * @ThreadSafe
 * @version $Revision: 5215 $
 */

public interface FindHook {
	/**
	 * Find hook method. This method is called during the service find (for
	 * example, {@link BundleContext#getServiceReferences(String, String)})
	 * operation by the finding bundle and can filter the result of the find
	 * operation.
	 * 
	 * @param context The bundle context of the finding bundle.
	 * @param name The class name of the services to find or <code>null</code>
	 *        to find all services.
	 * @param filter The filter criteria of the services to find or
	 *        <code>null</code> for no filter criteria.
	 * @param allServices <code>true</code> if the find operation is the result
	 *        of a call to
	 *        {@link BundleContext#getAllServiceReferences(String, String)}
	 * @param references A <code>Collection</code> of Service References to be
	 *        returned to the finding bundle. The method implementation may
	 *        remove references from the collection to prevent the references
	 *        from being returned to the finding bundle. The collection supports
	 *        all the optional <code>Collection</code> operations except
	 *        <code>add</code> and <code>addAll</code>. Attempting to add to the
	 *        collection will result in an
	 *        <code>UnsupportedOperationException</code>.
	 */
	void find(BundleContext context, String name, String filter,
			boolean allServices, Collection references);
}