org.eclipse.jetty.osgi.boot.BundleContextProvider Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.osgi.boot;
import java.util.ArrayList;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import org.eclipse.jetty.deploy.App;
import org.eclipse.jetty.osgi.boot.internal.serverfactory.ServerInstanceWrapper;
import org.eclipse.jetty.util.StringUtil;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.FrameworkUtil;
import org.osgi.framework.ServiceRegistration;
import org.osgi.util.tracker.BundleTracker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* BundleContextProvider
*
* Handles deploying OSGi bundles that define a context xml file for configuring them.
*/
public class BundleContextProvider extends AbstractContextProvider implements BundleProvider
{
private static final Logger LOG = LoggerFactory.getLogger(AbstractContextProvider.class);
private Map _appMap = new HashMap();
private Map> _bundleMap = new HashMap>();
private ServiceRegistration _serviceRegForBundles;
private BundleTracker _tracker;
public class ContextBundleTracker extends BundleTracker
{
protected String _managedServerName;
public ContextBundleTracker(BundleContext bundleContext, String managedServerName)
{
super(bundleContext, Bundle.ACTIVE | Bundle.STOPPING, null);
_managedServerName = managedServerName;
}
@Override
public Object addingBundle(Bundle bundle, BundleEvent event)
{
try
{
String serverName = (String)bundle.getHeaders().get(OSGiServerConstants.MANAGED_JETTY_SERVER_NAME);
if ((StringUtil.isBlank(serverName) && _managedServerName.equals(OSGiServerConstants.MANAGED_JETTY_SERVER_DEFAULT_NAME)) ||
(!StringUtil.isBlank(serverName) && (serverName.equals(_managedServerName))))
{
if (bundleAdded(bundle))
return bundle;
}
}
catch (Exception e)
{
LOG.warn("Unable to add bundle {}", bundle, e);
}
return null;
}
@Override
public void removedBundle(Bundle bundle, BundleEvent event, Object object)
{
try
{
bundleRemoved(bundle);
}
catch (Exception e)
{
LOG.warn("Unable to remove bundle {}", bundle, e);
}
}
}
public BundleContextProvider(ServerInstanceWrapper wrapper)
{
super(wrapper);
}
@Override
protected void doStart() throws Exception
{
//Track bundles that are ContextHandlers that should be deployed
_tracker = new ContextBundleTracker(FrameworkUtil.getBundle(this.getClass()).getBundleContext(), getServerInstanceWrapper().getManagedServerName());
_tracker.open();
//register as an osgi service for deploying contexts defined in a bundle, advertising the name of the jetty Server instance we are related to
Dictionary properties = new Hashtable();
properties.put(OSGiServerConstants.MANAGED_JETTY_SERVER_NAME, getServerInstanceWrapper().getManagedServerName());
_serviceRegForBundles = FrameworkUtil.getBundle(this.getClass()).getBundleContext().registerService(BundleProvider.class.getName(), this, properties);
super.doStart();
}
@Override
protected void doStop() throws Exception
{
_tracker.close();
//unregister ourselves
if (_serviceRegForBundles != null)
{
try
{
_serviceRegForBundles.unregister();
}
catch (Exception e)
{
LOG.warn("Unable to unregister {}", _serviceRegForBundles, e);
}
}
}
@Override
public boolean bundleAdded(Bundle bundle) throws Exception
{
if (bundle == null)
return false;
//If the bundle defines a Web-ContextPath then its probably a webapp and the BundleWebAppProvider should deploy it
if ((String)bundle.getHeaders().get(OSGiWebappConstants.RFC66_WEB_CONTEXTPATH) != null)
{
if (LOG.isDebugEnabled())
LOG.debug("BundleContextProvider ignoring bundle {} with {} set", bundle.getSymbolicName(), OSGiWebappConstants.RFC66_WEB_CONTEXTPATH);
return false;
}
String contextFiles = (String)bundle.getHeaders().get(OSGiWebappConstants.JETTY_CONTEXT_FILE_PATH);
if (contextFiles == null)
return false;
boolean added = false;
//bundle defines JETTY_CONTEXT_FILE_PATH header,
//a comma separated list of context xml files that each define a ContextHandler
//TODO: (could be WebAppContexts)
String[] tmp = contextFiles.split("[,;]");
for (String contextFile : tmp)
{
String originId = bundle.getSymbolicName() + "-" + bundle.getVersion().toString() + "-" + contextFile;
OSGiApp app = new OSGiApp(getDeploymentManager(), this, originId, bundle, contextFile);
_appMap.put(originId, app);
List apps = _bundleMap.get(bundle);
if (apps == null)
{
apps = new ArrayList();
_bundleMap.put(bundle, apps);
}
apps.add(app);
getDeploymentManager().addApp(app);
added = true;
}
return added; //true if even 1 context from this bundle was added
}
/**
* Bundle has been removed. If it was a context we deployed, undeploy it.
*
* @param bundle the bundle
* @return true if this was a context we had deployed, false otherwise
*/
@Override
public boolean bundleRemoved(Bundle bundle) throws Exception
{
List apps = _bundleMap.remove(bundle);
boolean removed = false;
if (apps != null)
{
for (App app : apps)
{
_appMap.remove(app.getOriginId());
getDeploymentManager().removeApp(app);
removed = true;
}
}
return removed; //true if even 1 context was removed associated with this bundle
}
}