org.eclipse.jetty.osgi.util.Util Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-osgi Show documentation
Show all versions of jetty-osgi Show documentation
Support for OSGi integration
//
// ========================================================================
// 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.util;
import java.io.File;
import java.net.URI;
import java.net.URL;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Dictionary;
import java.util.List;
import java.util.Objects;
import java.util.StringTokenizer;
import org.eclipse.jetty.osgi.OSGiServerConstants;
import org.eclipse.jetty.util.StringUtil;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Filter;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.service.packageadmin.PackageAdmin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Various useful functions utility methods for OSGi wide use.
*/
public class Util
{
private static final Logger LOG = LoggerFactory.getLogger(Util.class);
/**
* Resolve a path either absolutely or against the bundle install location, or
* against jetty home.
*
* @param path the path to resolve
* @param bundle the bundle
* @param jettyHome the path to jetty home
* @return the URI resolved either absolutely or against the bundle install location or jetty home.
*/
public static URI resolvePathAsLocalizedURI(String path, Bundle bundle, Path jettyHome)
throws Exception
{
if (StringUtil.isBlank(path))
return null;
if (path.startsWith("file:/"))
return new URI(path);
if (path.startsWith("/") && File.separatorChar != '/')
return new URI("file:" + path);
try
{
Path p = FileSystems.getDefault().getPath(path);
if (p.isAbsolute())
return p.toUri();
}
catch (InvalidPathException x)
{
//ignore and try via the jetty bundle instead
LOG.trace("IGNORED", x);
}
//relative location
//try inside the bundle first
if (bundle != null)
{
URL url = bundle.getEntry(path);
if (url != null)
{
return BundleFileLocatorHelper.DEFAULT.getLocalURL(url).toURI();
}
}
//try resolving against jetty.home
if (jettyHome != null)
{
Path p = jettyHome.resolve(path);
if (Files.exists(p))
return p.toUri();
}
return null;
}
public static URL getLocalURL(URL url)
throws Exception
{
if (url == null)
return null;
return BundleFileLocatorHelper.DEFAULT.getLocalURL(url);
}
public static URL getLocalizedEntry(String file, Bundle bundle)
throws Exception
{
if (file == null || bundle == null)
return null;
URL url = bundle.getEntry(file);
if (url == null)
return null;
return BundleFileLocatorHelper.DEFAULT.getLocalURL(url);
}
/**
* Resolve the file system paths to bundles identified by their symbolic names.
*
* @param bundleSymbolicNames comma separated list of symbolic bundle names
* @param bundleContext the bundle on whose behalf to resolve
* @return List of resolved Paths matching the bundle symbolic names
*/
public static List getPathsToBundlesBySymbolicNames(String bundleSymbolicNames, BundleContext bundleContext)
throws Exception
{
if (bundleSymbolicNames == null)
return Collections.emptyList();
Objects.requireNonNull(bundleContext);
ServiceReference ref = bundleContext.getServiceReference(org.osgi.service.packageadmin.PackageAdmin.class.getName());
PackageAdmin packageAdmin = (ref == null) ? null : (PackageAdmin)bundleContext.getService(ref);
if (packageAdmin == null)
throw new IllegalStateException("Unable to get PackageAdmin reference to locate required Tld bundles");
List paths = new ArrayList<>();
String[] symbNames = bundleSymbolicNames.split("[, ]");
for (String symbName : symbNames)
{
Bundle[] bs = packageAdmin.getBundles(symbName, null);
if (bs == null || bs.length == 0)
{
throw new IllegalArgumentException("Unable to locate the bundle '" + symbName + "' specified in manifest of " +
bundleContext.getBundle().getSymbolicName());
}
File f = BundleFileLocatorHelperFactory.getFactory().getHelper().getBundleInstallLocation(bs[0]);
paths.add(f.toPath());
}
return paths;
}
/**
* Create an osgi filter for the given classname and server name.
*
* @param bundleContext the {@link BundleContext} instance to use
* @param classname the class to match on the filter
* @param managedServerName the name of the jetty server instance
* @return a new filter
* @throws InvalidSyntaxException If the filter contains an invalid string that cannot be parsed.
*/
public static Filter createFilter(BundleContext bundleContext, String classname, String managedServerName) throws InvalidSyntaxException
{
if (StringUtil.isBlank(managedServerName) || managedServerName.equals(OSGiServerConstants.MANAGED_JETTY_SERVER_DEFAULT_NAME))
{
return bundleContext.createFilter("(&(objectclass=" + classname + ")(|(managedServerName=" + managedServerName + ")(!(managedServerName=*))))");
}
else
{
return bundleContext.createFilter("(&(objectclass=" + classname + ")(managedServerName=" + managedServerName + "))");
}
}
/**
* Get the value of a manifest header.
*
* @param name the name of the header
* @param altName an alternative name for the header (useful for deprecated names)
* @param manifest the dictionary
* @return the value from the manifest
*/
public static String getManifestHeaderValue(String name, String altName, Dictionary manifest)
{
if (manifest == null)
return null;
if (name == null && altName == null)
return null;
if (name != null)
return (String)manifest.get(name);
return (String)manifest.get(altName);
}
/**
* Get the value of a manifest header.
*
* @param name the name of the header
* @param manifest the dictionary
* @return the value from the manifest
*/
public static String getManifestHeaderValue(String name, Dictionary manifest)
{
return getManifestHeaderValue(name, null, manifest);
}
/**
* Treating the string as a separated list of filenames,
* convert and return the list of urls.
*
* @param val the separated list of filenames
* @param delims the separators (default is ,;
)
* @return the list of URLs found in the input list
* @throws Exception if unable to convert entry to a URL
*/
public static List fileNamesAsURLs(String val, String delims)
throws Exception
{
String separators = StringUtil.DEFAULT_DELIMS;
if (delims == null)
delims = separators;
StringTokenizer tokenizer = new StringTokenizer(val, delims, false);
List urls = new ArrayList<>();
while (tokenizer.hasMoreTokens())
{
urls.add(BundleFileLocatorHelperFactory.getFactory().getHelper().getLocalURL(new URL(tokenizer.nextToken())));
}
return urls;
}
public static void setProperty(Dictionary properties, String key, Object value)
{
if (value != null)
{
properties.put(key, value);
}
}
/**
* recursively substitute the ${sysprop}
by their actual system property.
* ${sysprop,defaultvalue}
will use 'defaultvalue'
as the value if no
* sysprop is defined. Not the most efficient code but we are shooting for
* simplicity and speed of development here.
*
* @param value the input string
* @return the string with replaced properties
*/
public static String resolvePropertyValue(String value)
{
int ind = value.indexOf("${");
if (ind == -1)
{
return value;
}
int ind2 = value.indexOf('}', ind);
if (ind2 == -1)
{
return value;
}
String sysprop = value.substring(ind + 2, ind2);
String defaultValue = null;
int comma = sysprop.indexOf(',');
if (comma != -1 && comma + 1 != sysprop.length())
{
defaultValue = sysprop.substring(comma + 1);
defaultValue = resolvePropertyValue(defaultValue);
sysprop = sysprop.substring(0, comma);
}
else
{
defaultValue = "${" + sysprop + "}";
}
String v = System.getProperty(sysprop);
String reminder = value.length() > ind2 + 1 ? value.substring(ind2 + 1) : "";
reminder = resolvePropertyValue(reminder);
if (v != null)
{
return value.substring(0, ind) + v + reminder;
}
else
{
return value.substring(0, ind) + defaultValue + reminder;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy