/*
* 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.impl.dependencies;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Proxy;
import java.util.ArrayList;
import java.util.Dictionary;
import java.util.List;
import org.apache.felix.dm.BundleDependency;
import org.apache.felix.dm.ComponentDependencyDeclaration;
import org.apache.felix.dm.Dependency;
import org.apache.felix.dm.DependencyService;
import org.apache.felix.dm.InvocationUtil;
import org.apache.felix.dm.impl.DefaultNullObject;
import org.apache.felix.dm.impl.Logger;
import org.apache.felix.dm.tracker.BundleTracker;
import org.apache.felix.dm.tracker.BundleTrackerCustomizer;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.Filter;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.service.log.LogService;
/**
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
*/
public class BundleDependencyImpl extends DependencyBase implements BundleDependency, BundleTrackerCustomizer, ComponentDependencyDeclaration {
private final BundleContext m_context;
private BundleTracker m_tracker;
private int m_stateMask = Bundle.INSTALLED | Bundle.RESOLVED | Bundle.ACTIVE;
private List m_services = new ArrayList();
private boolean m_isAvailable;
private Object m_callbackInstance;
private String m_callbackAdded;
private String m_callbackChanged;
private String m_callbackRemoved;
private boolean m_autoConfig;
private Bundle m_bundleInstance;
private Filter m_filter;
private long m_bundleId = -1;
private String m_autoConfigInstance;
private Object m_nullObject;
private boolean m_autoConfigInvoked;
private boolean m_propagate;
private Object m_propagateCallbackInstance;
private String m_propagateCallbackMethod;
public BundleDependencyImpl(BundleContext context, Logger logger) {
super(logger);
m_context = context;
m_autoConfig = true;
}
public BundleDependencyImpl(BundleDependencyImpl prototype) {
super(prototype);
m_context = prototype.m_context;
m_autoConfig = prototype.m_autoConfig;
m_stateMask = prototype.m_stateMask;
m_nullObject = prototype.m_nullObject;
m_bundleInstance = prototype.m_bundleInstance;
m_filter = prototype.m_filter;
m_bundleId = prototype.m_bundleId;
m_propagate = prototype.m_propagate;
m_callbackInstance = prototype.m_callbackInstance;
m_callbackAdded = prototype.m_callbackAdded;
m_callbackChanged = prototype.m_callbackChanged;
m_callbackRemoved = prototype.m_callbackRemoved;
m_autoConfigInstance = prototype.m_autoConfigInstance;
}
public Dependency createCopy() {
return new BundleDependencyImpl(this);
}
public BundleDependency setInstanceBound(boolean isInstanceBound) {
setIsInstanceBound(isInstanceBound);
return this;
}
public synchronized boolean isAvailable() {
return m_isAvailable;
}
public void start(DependencyService service) {
boolean needsStarting = false;
synchronized (this) {
m_services.add(service);
if (!m_isStarted) {
m_tracker = new BundleTracker(m_context, m_stateMask, this);
m_isStarted = true;
needsStarting = true;
}
}
if (needsStarting) {
m_tracker.open();
}
}
public void stop(DependencyService service) {
boolean needsStopping = false;
synchronized (this) {
if (m_services.size() == 1 && m_services.contains(service)) {
m_isStarted = false;
needsStopping = true;
}
}
if (needsStopping) {
m_tracker.close();
m_tracker = null;
m_services.remove(service);
}
}
public String getName() {
StringBuilder sb = new StringBuilder();
if ((m_stateMask & Bundle.ACTIVE) != 0) {
sb.append("active ");
}
if ((m_stateMask & Bundle.INSTALLED) != 0) {
sb.append("installed ");
}
if ((m_stateMask & Bundle.RESOLVED) != 0) {
sb.append("resolved ");
}
if (m_filter != null) {
sb.append(m_filter.toString());
}
if (m_bundleId != -1) {
sb.append("bundle.id=" + m_bundleId);
}
return sb.toString();
}
public String getType() {
return "bundle";
}
public Object addingBundle(Bundle bundle, BundleEvent event) {
// if we don't like a bundle, we could reject it here by returning null
long bundleId = bundle.getBundleId();
if (m_bundleId >= 0 && m_bundleId != bundleId) {
return null;
}
Filter filter = m_filter;
if (filter != null) {
Dictionary headers = bundle.getHeaders();
if (!m_filter.match(headers)) {
return null;
}
}
return bundle;
}
public void addedBundle(Bundle bundle, BundleEvent event, Object object) {
boolean makeAvailable = makeAvailable();
Object[] services = m_services.toArray();
for (int i = 0; i < services.length; i++) {
DependencyService ds = (DependencyService) services[i];
if (makeAvailable) {
ds.dependencyAvailable(this);
if (!isRequired()) {
invokeAdded(ds, bundle);
}
}
else {
ds.dependencyChanged(this);
invokeAdded(ds, bundle);
}
}
}
public void modifiedBundle(Bundle bundle, BundleEvent event, Object object) {
Object[] services = m_services.toArray();
for (int i = 0; i < services.length; i++) {
DependencyService ds = (DependencyService) services[i];
ds.dependencyChanged(this);
if (ds.isInstantiated()) {
invokeChanged(ds, bundle);
}
}
}
public void removedBundle(Bundle bundle, BundleEvent event, Object object) {
boolean makeUnavailable = makeUnavailable();
Object[] services = m_services.toArray();
for (int i = 0; i < services.length; i++) {
DependencyService ds = (DependencyService) services[i];
if (makeUnavailable) {
ds.dependencyUnavailable(this);
if (!isRequired()) {
invokeRemoved(ds, bundle);
}
}
else {
ds.dependencyChanged(this);
invokeRemoved(ds, bundle);
}
}
}
private synchronized boolean makeAvailable() {
if (!isAvailable()) {
m_isAvailable = true;
return true;
}
return false;
}
private synchronized boolean makeUnavailable() {
if ((isAvailable()) && (m_tracker.getTrackingCount() == 0)) {
m_isAvailable = false;
return true;
}
return false;
}
public void invokeAdded(DependencyService dependencyService, Bundle service) {
invoke(dependencyService, service, m_callbackAdded);
}
public void invokeChanged(DependencyService dependencyService, Bundle service) {
invoke(dependencyService, service, m_callbackChanged);
}
public void invokeRemoved(DependencyService dependencyService, Bundle service) {
invoke(dependencyService, service, m_callbackRemoved);
}
public void invoke(DependencyService dependencyService, Bundle service, String name) {
if (name != null) {
dependencyService.invokeCallbackMethod(getCallbackInstances(dependencyService), name,
new Class[][] {{Bundle.class}, {Object.class}, {}},
new Object[][] {{service}, {service}, {}}
);
}
}
private synchronized Object[] getCallbackInstances(DependencyService dependencyService) {
if (m_callbackInstance == null) {
return dependencyService.getCompositionInstances();
}
else {
return new Object[] { m_callbackInstance };
}
}
/**
* Sets the callbacks for this service. These callbacks can be used as hooks whenever a
* dependency is added or removed. When you specify callbacks, the auto configuration
* feature is automatically turned off, because we're assuming you don't need it in this
* case.
*
* @param added the method to call when a service was added
* @param removed the method to call when a service was removed
* @return this service dependency
*/
public synchronized BundleDependency setCallbacks(String added, String removed) {
return setCallbacks(null, added, null, removed);
}
/**
* Sets the callbacks for this service. These callbacks can be used as hooks whenever a
* dependency is added, changed or removed. When you specify callbacks, the auto
* configuration feature is automatically turned off, because we're assuming you don't
* need it in this case.
*
* @param added the method to call when a service was added
* @param changed the method to call when a service was changed
* @param removed the method to call when a service was removed
* @return this service dependency
*/
public synchronized BundleDependency setCallbacks(String added, String changed, String removed) {
return setCallbacks(null, added, changed, removed);
}
/**
* Sets the callbacks for this service. These callbacks can be used as hooks whenever a
* dependency is added or removed. They are called on the instance you provide. When you
* specify callbacks, the auto configuration feature is automatically turned off, because
* we're assuming you don't need it in this case.
*
* @param instance the instance to call the callbacks on
* @param added the method to call when a service was added
* @param removed the method to call when a service was removed
* @return this service dependency
*/
public synchronized BundleDependency setCallbacks(Object instance, String added, String removed) {
return setCallbacks(instance, added, null, removed);
}
/**
* Sets the callbacks for this service. These callbacks can be used as hooks whenever a
* dependency is added, changed or removed. They are called on the instance you provide. When you
* specify callbacks, the auto configuration feature is automatically turned off, because
* we're assuming you don't need it in this case.
*
* @param instance the instance to call the callbacks on
* @param added the method to call when a service was added
* @param changed the method to call when a service was changed
* @param removed the method to call when a service was removed
* @return this service dependency
*/
public synchronized BundleDependency setCallbacks(Object instance, String added, String changed, String removed) {
ensureNotActive();
// if at least one valid callback is specified, we turn off auto configuration
if ((added != null || removed != null || changed != null) && ! m_autoConfigInvoked) {
setAutoConfig(false);
}
m_callbackInstance = instance;
m_callbackAdded = added;
m_callbackChanged = changed;
m_callbackRemoved = removed;
return this;
}
private void ensureNotActive() {
if (m_tracker != null) {
throw new IllegalStateException("Cannot modify state while active.");
}
}
public synchronized BundleDependency setAutoConfig(boolean autoConfig) {
ensureNotActive();
m_autoConfig = autoConfig;
m_autoConfigInvoked = true;
return this;
}
public synchronized BundleDependency setAutoConfig(String instanceName) {
ensureNotActive();
m_autoConfig = (instanceName != null);
m_autoConfigInstance = instanceName;
m_autoConfigInvoked = true;
return this;
}
public synchronized BundleDependency setRequired(boolean required) {
ensureNotActive();
setIsRequired(required);
return this;
}
public BundleDependency setBundle(Bundle bundle) {
m_bundleId = bundle.getBundleId();
return this;
}
public BundleDependency setFilter(String filter) throws IllegalArgumentException {
if (filter != null) {
try {
m_filter = m_context.createFilter(filter);
}
catch (InvalidSyntaxException e) {
throw new IllegalArgumentException(e.getMessage());
}
}
return this;
}
public BundleDependency setStateMask(int mask) {
m_stateMask = mask;
return this;
}
public synchronized boolean isAutoConfig() {
return m_autoConfig;
}
public Bundle getBundle() {
Bundle[] bundles = m_tracker.getBundles();
if (bundles != null && bundles.length > 0) {
return bundles[0];
}
return null;
}
public Object getAutoConfigInstance() {
return lookupBundle();
}
public Bundle lookupBundle() {
Bundle service = null;
if (m_isStarted) {
service = getBundle();
}
else {
Bundle[] bundles = m_context.getBundles();
for (int i = 0; i < bundles.length; i++) {
if ((bundles[i].getState() & m_stateMask) > 0) {
Filter filter = m_filter;
if (filter == null) {
service = bundles[i];
break;
}
else if (filter.match(bundles[i].getHeaders())) {
service = bundles[i];
break;
}
}
}
}
if (service == null && isAutoConfig()) {
// TODO does it make sense to add support for custom bundle impls?
// service = getDefaultImplementation();
if (service == null) {
service = getNullObject();
}
}
return service;
}
private Bundle getNullObject() {
if (m_nullObject == null) {
try {
m_nullObject = Proxy.newProxyInstance(getClass().getClassLoader(), new Class[] { Bundle.class }, new DefaultNullObject());
}
catch (Exception e) {
m_logger.log(Logger.LOG_ERROR, "Could not create null object for Bundle.", e);
}
}
return (Bundle) m_nullObject;
}
public String getAutoConfigName() {
return m_autoConfigInstance;
}
public Class getAutoConfigType() {
return Bundle.class;
}
public void invokeAdded(DependencyService service) {
// we remember these for future reference, needed for required service callbacks
m_bundleInstance = lookupBundle();
invokeAdded(service, m_bundleInstance);
}
public void invokeRemoved(DependencyService service) {
invokeRemoved(service, m_bundleInstance);
m_bundleInstance = null;
}
public BundleDependency setPropagate(boolean propagate) {
ensureNotActive();
m_propagate = propagate;
return this;
}
public BundleDependency setPropagate(Object instance, String method) {
setPropagate(instance != null && method != null);
m_propagateCallbackInstance = instance;
m_propagateCallbackMethod = method;
return this;
}
public Dictionary getProperties() {
Bundle bundle = lookupBundle();
if (bundle != null) {
if (m_propagateCallbackInstance != null && m_propagateCallbackMethod != null) {
try {
return (Dictionary) InvocationUtil.invokeCallbackMethod(m_propagateCallbackInstance, m_propagateCallbackMethod, new Class[][] {{ Bundle.class }}, new Object[][] {{ bundle }});
}
catch (InvocationTargetException e) {
m_logger.log(LogService.LOG_WARNING, "Exception while invoking callback method", e.getCause());
}
catch (Exception e) {
m_logger.log(LogService.LOG_WARNING, "Exception while trying to invoke callback method", e);
}
throw new IllegalStateException("Could not invoke callback");
}
else {
return bundle.getHeaders();
}
}
else {
throw new IllegalStateException("cannot find bundle");
}
}
public boolean isPropagated() {
return m_propagate;
}
}