org.osgi.framework.ServiceFactory Maven / Gradle / Ivy
/*
* Copyright (c) OSGi Alliance (2000, 2012). 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;
/**
* Allows services to provide customized service objects in the OSGi
* environment.
*
*
* When registering a service, a {@code ServiceFactory} object can be used
* instead of a service object, so that the bundle developer can gain control of
* the specific service object granted to a bundle that is using the service.
*
*
* When this happens, the {@code BundleContext.getService(ServiceReference)}
* method calls the {@code ServiceFactory.getService} method to create a service
* object specifically for the requesting bundle. The service object returned by
* the {@code ServiceFactory} is cached by the Framework until the bundle
* releases its use of the service.
*
*
* When the bundle's use count for the service is decremented to zero (including
* the bundle stopping or the service being unregistered), the
* {@code ServiceFactory.ungetService} method is called.
*
*
* {@code ServiceFactory} objects are only used by the Framework and are not
* made available to other bundles in the OSGi environment. The Framework may
* concurrently call a {@code ServiceFactory}.
*
* @param Type of Service
* @see BundleContext#getService(ServiceReference)
* @ThreadSafe
* @version $Id: 535776e702ec5ace54f577218ff8f7920741558b $
*/
public interface ServiceFactory {
/**
* Creates a new service object.
*
*
* The Framework invokes this method the first time the specified
* {@code bundle} requests a service object using the
* {@code BundleContext.getService(ServiceReference)} method. The service
* factory can then return a specific service object for each bundle.
*
*
* The Framework must check that the returned service object is valid. If
* the returned service object is {@code null} or is not an
* {@code instanceof} all the classes named when the service was registered,
* a framework event of type {@link FrameworkEvent#ERROR} is fired
* containing a service exception of type
* {@link ServiceException#FACTORY_ERROR} and {@code null} is returned to
* the bundle. If this method throws an exception, a framework event of type
* {@link FrameworkEvent#ERROR} is fired containing a service exception of
* type {@link ServiceException#FACTORY_EXCEPTION} with the thrown exception
* as the cause and {@code null} is returned to the bundle. If this method
* is recursively called for the specified bundle, a framework event of type
* {@link FrameworkEvent#ERROR} is fired containing a service exception of
* type {@link ServiceException#FACTORY_RECURSION} and {@code null} is
* returned to the bundle.
*
*
* The Framework caches the valid service object and will return the same
* service object on any future call to {@code BundleContext.getService} for
* the specified bundle. This means the Framework must not allow this method
* to be concurrently called for the specified bundle.
*
* @param bundle The bundle requesting the service.
* @param registration The {@code ServiceRegistration} object for the
* requested service.
* @return A service object that must be an instance of all
* the classes named when the service was registered.
* @see BundleContext#getService(ServiceReference)
*/
public S getService(Bundle bundle, ServiceRegistration registration);
/**
* Releases a service object.
*
*
* The Framework invokes this method when a service has been released by a
* bundle. The service object may then be destroyed.
*
*
* If this method throws an exception, a framework event of type
* {@link FrameworkEvent#ERROR} is fired containing a service exception of
* type {@link ServiceException#FACTORY_EXCEPTION} with the thrown exception
* as the cause.
*
* @param bundle The bundle releasing the service.
* @param registration The {@code ServiceRegistration} object for the
* service being released.
* @param service The service object returned by a previous call to the
* {@link #getService(Bundle, ServiceRegistration) getService}
* method.
* @see BundleContext#ungetService(ServiceReference)
*/
public void ungetService(Bundle bundle, ServiceRegistration registration, S service);
}