| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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.apache.felix.dm; |
| |
| import java.util.function.Consumer; |
| |
| import org.apache.felix.dm.compat.DependencyActivatorBaseCompat; |
| import org.osgi.framework.BundleActivator; |
| import org.osgi.framework.BundleContext; |
| |
| /** |
| * Base bundle activator class. Subclass this activator if you want to use dependency |
| * management in your bundle. There are two methods you should implement: |
| * <code>init()</code> and <code>destroy()</code>. Both methods take two arguments, |
| * the bundle context and the dependency manager. The dependency manager can be used |
| * to define all the dependencies. |
| * |
| * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a> |
| */ |
| public abstract class DependencyActivatorBase extends DependencyActivatorBaseCompat implements BundleActivator { |
| private BundleContext m_context; |
| private DependencyManager m_manager; |
| private Logger m_logger; |
| |
| /** |
| * Initialize the dependency manager. Here you can add all components and their dependencies. |
| * If something goes wrong and you do not want your bundle to be started, you can throw an |
| * exception. This exception will be passed on to the <code>start()</code> method of the |
| * bundle activator, causing the bundle not to start. |
| * |
| * @param context the bundle context |
| * @param manager the dependency manager |
| * @throws Exception if the initialization fails |
| */ |
| public abstract void init(BundleContext context, DependencyManager manager) throws Exception; |
| |
| /** |
| * Destroy the dependency manager. Here you can remove all components and their dependencies. |
| * Actually, the base class will clean up your dependencies anyway, so most of the time you |
| * don't need to do anything here. |
| * <p> |
| * If something goes wrong and you do not want your bundle to be stopped, you can throw an |
| * exception. This exception will be passed on to the <code>stop()</code> method of the |
| * bundle activator, causing the bundle not to stop. |
| * |
| * @param context the bundle context |
| * @param manager the dependency manager |
| * @throws Exception if the destruction fails |
| */ |
| public void destroy(BundleContext context, DependencyManager manager) throws Exception { } |
| |
| /** |
| * Start method of the bundle activator. Initializes the dependency manager |
| * and calls <code>init()</code>. |
| * |
| * @param context the bundle context |
| */ |
| public void start(BundleContext context) throws Exception { |
| m_context = context; |
| m_logger = new Logger(context); |
| m_manager = new DependencyManager(context, m_logger); |
| setDependencyManager(m_manager); |
| init(m_context, m_manager); |
| } |
| |
| /** |
| * Stop method of the bundle activator. Calls the <code>destroy()</code> method |
| * and cleans up all left over dependencies. |
| * |
| * @param context the bundle context |
| */ |
| public void stop(BundleContext context) throws Exception { |
| destroy(m_context, m_manager); |
| m_manager.clear(); |
| m_manager = null; |
| m_context = null; |
| } |
| |
| /** |
| * Returns the bundle context that is associated with this bundle. |
| * |
| * @return the bundle context |
| */ |
| public BundleContext getBundleContext() { |
| return m_context; |
| } |
| |
| /** |
| * Returns the dependency manager that is associated with this bundle. |
| * |
| * @return the dependency manager |
| */ |
| public DependencyManager getDependencyManager() { |
| return m_manager; |
| } |
| |
| /** |
| * Returns the logger that is associated with this bundle. A logger instance |
| * is a proxy that will log to a real OSGi logservice if available and standard |
| * out if not. |
| * |
| * @return the logger |
| */ |
| public Logger getLogger() { |
| return m_logger; |
| } |
| |
| /** |
| * Creates a new component. |
| * |
| * @return the new component |
| */ |
| public Component createComponent() { |
| return m_manager.createComponent(); |
| } |
| |
| /** |
| * Creates a new bundle adapter component. |
| * |
| * @return the bundle adapter component |
| */ |
| public BundleComponent createBundleComponent() { |
| return m_manager.createBundleComponent(); |
| } |
| |
| /** |
| * Creates a new aspect component. |
| * |
| * @return the aspect component |
| * @see DependencyManager#createAspectComponent() |
| */ |
| public AspectComponent createAspectComponent() { |
| return m_manager.createAspectComponent(); |
| } |
| |
| /** |
| * Creates a new adapter service. |
| * |
| * @return the adapter service |
| * @see DependencyManager#createAdapterService(Class, String) |
| */ |
| public AdapterComponent createAdapterComponent() { |
| return m_manager.createAdapterComponent(); |
| } |
| |
| /** |
| * Creates a new factory configuration component. |
| * @return the factory configuration component |
| * @see DependencyManager#createFactoryComponent() |
| */ |
| public FactoryComponent createFactoryComponent() { |
| return m_manager.createFactoryComponent(); |
| } |
| |
| /** |
| * Creates a new service dependency. |
| * |
| * @return the service dependency |
| */ |
| public ServiceDependency createServiceDependency() { |
| return m_manager.createServiceDependency(); |
| } |
| |
| /** |
| * Creates a new temporal service dependency. |
| * |
| * @param timeout the max number of milliseconds to wait for a service availability. |
| * @return the service dependency |
| */ |
| public ServiceDependency createTemporalServiceDependency(long timeout) { |
| return m_manager.createTemporalServiceDependency(timeout); |
| } |
| |
| /** |
| * Creates a new configuration dependency. |
| * |
| * @return the configuration dependency |
| */ |
| public ConfigurationDependency createConfigurationDependency() { |
| return m_manager.createConfigurationDependency(); |
| } |
| |
| /** |
| * Creates a new configuration property metadata. |
| * |
| * @return the configuration property metadata |
| */ |
| public PropertyMetaData createPropertyMetaData() { |
| return m_manager.createPropertyMetaData(); |
| } |
| |
| /** |
| * Creates a new bundle dependency. |
| * |
| * @return the bundle dependency |
| */ |
| public BundleDependency createBundleDependency() { |
| return m_manager.createBundleDependency(); |
| } |
| |
| /** |
| * Creates a new resource dependency. |
| * |
| * @return the resource dependency |
| */ |
| public ResourceDependency createResourceDependency() { |
| return m_manager.createResourceDependency(); |
| } |
| |
| /** |
| * Creates a new resource adapter component. |
| * |
| * @return the resource adapter component |
| */ |
| public ResourceComponent createResourceComponent() { |
| return m_manager.createResourceComponent(); |
| } |
| |
| } |