Class Util

java.lang.Object
org.eclipse.jetty.osgi.util.Util
public class Util extends Object
Utility methods.

  • Constructor Details

    • Util

      public Util()

  • Method Details

    • createFilter

      public static org.osgi.framework.Filter createFilter(org.osgi.framework.BundleContext bundleContext, String classname, String managedServerName) throws org.osgi.framework.InvalidSyntaxException
      Create an osgi filter for the given classname and server name.
      Parameters:
      bundleContext - the BundleContext instance to use
      classname - the class to match on the filter
      managedServerName - the name of the jetty server instance
      Returns:
      a new filter
      Throws:
      org.osgi.framework.InvalidSyntaxException - If the filter contains an invalid string that cannot be parsed.

    • deregisterAsOSGiService

      public static void deregisterAsOSGiService(ContextHandler contextHandler)

    • fileNamesAsURLs

      public static List<URL> fileNamesAsURLs(String val, String delims) throws Exception
      Treating the string as a separated list of filenames, convert and return the list of urls.
      Parameters:
      val - the separated list of filenames
      delims - the separators (default is ,;)
      Returns:
      the list of URLs found in the input list
      Throws:
      Exception - if unable to convert entry to a URL

    • getBundlePath

      public static Path getBundlePath(org.osgi.framework.Bundle bundle) throws Exception
      Get the install location of a Bundle as a Path
      Parameters:
      bundle - the Bundle whose location to return
      Returns:
      the installed location of the Bundle as a Path
      Throws:
      Exception

    • newBundleResource

      public static Resource newBundleResource(org.osgi.framework.Bundle bundle, ResourceFactory resourceFactory) throws Exception
      Convert a bundle installed location into a Resource, taking account of any locations that are actually packed jars, but without a ".jar" extension, eg as found on equinox. Eg file:///a/b/c/org.eclipse.osgi/89/0/bundleFile
      Parameters:
      bundle - the Bundle to convert
      resourceFactory - the ResourceFactory to create the new Resource in
      Returns:
      a new Resource representing the bundle's installed location
      Throws:
      Exception

    • getContextPath

      public static String getContextPath(org.osgi.framework.Bundle bundle)
      Get or create a contextPath from bundle headers and information
      Parameters:
      bundle - the bundle
      Returns:
      a contextPath

    • getLocalURL

      public static URL getLocalURL(URL url) throws Exception
      Throws:
      Exception

    • getLocalizedEntry

      public static URL getLocalizedEntry(String file, org.osgi.framework.Bundle bundle) throws Exception
      Throws:
      Exception

    • getManifestHeaderValue

      public static String getManifestHeaderValue(String name, String altName, Dictionary<String,String> manifest)
      Get the value of a manifest header.
      Parameters:
      name - the name of the header
      altName - an alternative name for the header (useful for deprecated names)
      manifest - the dictionary
      Returns:
      the value from the manifest

    • getManifestHeaderValue

      public static String getManifestHeaderValue(String name, Dictionary<String,String> manifest)
      Get the value of a manifest header.
      Parameters:
      name - the name of the header
      manifest - the dictionary
      Returns:
      the value from the manifest

    • getPathsToBundlesBySymbolicNames

      public static List<Path> getPathsToBundlesBySymbolicNames(String bundleSymbolicNames, org.osgi.framework.BundleContext bundleContext) throws Exception
      Resolve the file system paths to bundles identified by their symbolic names.
      Parameters:
      bundleSymbolicNames - comma separated list of symbolic bundle names
      bundleContext - the bundle on whose behalf to resolve
      Returns:
      List of resolved Paths matching the bundle symbolic names
      Throws:
      Exception

    • registerAsOSGiService

      public static void registerAsOSGiService(ContextHandler contextHandler)
      Register the Jetty deployed context/webapp as a service, as according to the OSGi Web Application Specification.

    • resolvePathAsLocalizedURI

      public static URI resolvePathAsLocalizedURI(String path, org.osgi.framework.Bundle bundle, Path jettyHome) throws Exception
      Resolve a path either absolutely or against the bundle install location, or against jetty home.
      Parameters:
      path - the path to resolve
      bundle - the bundle
      jettyHome - the path to jetty home
      Returns:
      the URI resolved either absolutely or against the bundle install location or jetty home.
      Throws:
      Exception

    • resolvePropertyValue

      public static String resolvePropertyValue(String 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.
      Parameters:
      value - the input string
      Returns:
      the string with replaced properties

    • setProperty

      public static void setProperty(Dictionary<String,Object> properties, String key, Object value)

    • getFragmentsAndRequiredBundles

      public static org.osgi.framework.Bundle[] getFragmentsAndRequiredBundles(org.osgi.framework.BundleContext bootBundleContext, org.osgi.framework.Bundle targetBundle)
      Returns the fragments and the required-bundles of a bundle. Recursively collect the required-bundles and fragment when the directive visibility:=reexport is added to a required-bundle.
      Parameters:
      bootBundleContext - BundleContext associated with the jetty boot bundle
      targetBundle - the bundle whose fragments and required bundles should be collected
      Returns:
      the flattened tree of all fragments and required bundles associated with the target bundle