bundles/org.eclipse.osgi/osgi/src/org/osgi/framework/hooks/service/PublishHook.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.ServiceEvent;

/**
 * OSGi Framework Service Publish Hook Service.
 * 
 * <p>
 * Bundles registering this service will be called during framework service
 * publish (register, modify, and unregister service) operations. Service hooks
 * are not called for service operations on other service hooks.
 * 
 * @ThreadSafe
 * @version $Revision: 5215 $
 */

public interface PublishHook {
	/**
	 * Event hook method. This method is called prior to service event delivery
	 * when a publishing bundle registers, modifies or unregisters a service and
	 * can filter the bundles which receive the event.
	 * 
	 * @param event The service event to be delivered.
	 * @param bundles A <code>Collection</code> of Bundles which have listeners
	 *        to which the event may be delivered. The method implementation may
	 *        remove bundles from the collection to prevent the event from being
	 *        delivered to those bundles. 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 event(ServiceEvent event, Collection bundles);
}