Field Detail

• generations

  protected final java.util.Vector<BundleGeneration> generations

  Bundle generation data.

• bundleDir

  protected FileTree bundleDir

  Directory for bundle data.

• bundleContext

  protected BundleContextImpl bundleContext

  BundleContext for bundle.

• bactivator

  protected BundleActivator bactivator

  BundleActivator for bundle.

• operation

  protected volatile int operation

  Type of operation in progress. Blocks bundle calls during activator and listener calls

Method Detail

• getState

  public int getState()

  Get bundle state.

  Specified by:

  getState in interface Bundle

  Returns:

  An element of UNINSTALLED,INSTALLED, RESOLVED, STARTING, STOPPING, ACTIVE.

  See Also:

  Bundle.getState()

• start

  public void start()
             throws BundleException

  Description copied from interface: Bundle
  Starts this bundle with no options.

  This method performs the same function as calling start(0).

  Specified by:

  start in interface Bundle

  Throws:

  BundleException - If this bundle could not be started. BundleException types thrown by this method include: BundleException.NATIVECODE_ERROR, BundleException.RESOLVE_ERROR, BundleException.STATECHANGE_ERROR, and BundleException.ACTIVATOR_ERROR.

  See Also:

  Bundle.start(int)

• start

  public void start(int options)
             throws BundleException

  Start this bundle.

  Specified by:

  start in interface Bundle

  Parameters:

  options - The options for starting this bundle. See Bundle.START_TRANSIENT and Bundle.START_ACTIVATION_POLICY. The Framework must ignore unrecognized options.

  Throws:

  BundleException - If this bundle could not be started. BundleException types thrown by this method include: BundleException.START_TRANSIENT_ERROR, BundleException.NATIVECODE_ERROR, BundleException.RESOLVE_ERROR, BundleException.STATECHANGE_ERROR, and BundleException.ACTIVATOR_ERROR.

  See Also:

  Bundle.start(int)

• stop

  public void stop()
            throws BundleException

  Stop this bundle.

  Specified by:

  stop in interface Bundle

  Throws:

  BundleException - BundleException types thrown by this method include: BundleException.STATECHANGE_ERROR and BundleException.ACTIVATOR_ERROR.

  See Also:

  Bundle.stop(int)

• stop

  public void stop(int options)
            throws BundleException

  Stop this bundle.

  Specified by:

  stop in interface Bundle

  Parameters:

  options - The options for stopping this bundle. See Bundle.STOP_TRANSIENT. The Framework must ignore unrecognized options.

  Throws:

  BundleException - BundleException types thrown by this method include: BundleException.STATECHANGE_ERROR and BundleException.ACTIVATOR_ERROR.

  See Also:

  Bundle.stop(int)

• update

  public void update()
              throws BundleException

  Update this bundle.

  Specified by:

  update in interface Bundle

  Throws:

  BundleException - If this bundle could not be updated. BundleException types thrown by this method include: BundleException.READ_ERROR, BundleException.DUPLICATE_BUNDLE_ERROR, BundleException.MANIFEST_ERROR, BundleException.NATIVECODE_ERROR, BundleException.RESOLVE_ERROR, BundleException.STATECHANGE_ERROR, and BundleException.ACTIVATOR_ERROR.

  See Also:

  Bundle.update(java.io.InputStream)

• update

  public void update(java.io.InputStream in)
              throws BundleException

  Update this bundle.

  Specified by:

  update in interface Bundle

  Parameters:

  in - The InputStream from which to read the new bundle or null to indicate the Framework must create the input stream from this bundle's Bundle-UpdateLocation Manifest header, if present, or this bundle's original location. The input stream must always be closed when this method completes, even if an exception is thrown.

  Throws:

  BundleException - If this bundle could not be updated. BundleException types thrown by this method include: BundleException.READ_ERROR, BundleException.DUPLICATE_BUNDLE_ERROR, BundleException.MANIFEST_ERROR, BundleException.NATIVECODE_ERROR, BundleException.RESOLVE_ERROR, BundleException.STATECHANGE_ERROR, and BundleException.ACTIVATOR_ERROR.

  See Also:

  Bundle.update(java.io.InputStream)

• uninstall

  public void uninstall()
                 throws BundleException

  Uninstall this bundle.

  Specified by:

  uninstall in interface Bundle

  Throws:

  BundleException - If the uninstall failed. This can occur if another thread is attempting to change this bundle's state and does not complete in a timely manner. BundleException types thrown by this method include: BundleException.STATECHANGE_ERROR

  See Also:

  Bundle.uninstall()

• getHeaders

  public java.util.Dictionary<java.lang.String,java.lang.String> getHeaders()

  Get header data. This is all entries in the bundles MANIFEST file.

  Specified by:

  getHeaders in interface Bundle

  Returns:

  An unmodifiable Dictionary object containing this bundle's Manifest headers and values.

  See Also:

  Bundle.getHeaders()

• getBundleId

  public long getBundleId()

  Get bundle identifier.

  Specified by:

  getBundleId in interface Bundle

  Returns:

  The unique identifier of this bundle.

  See Also:

  org.osgi.fwCtx.Bundle#getBundleId

• getLocation

  public java.lang.String getLocation()

  Get bundle location.

  Specified by:

  getLocation in interface Bundle

  Returns:

  The string representation of this bundle's location identifier.

  See Also:

  Bundle.getLocation()

• getRegisteredServices

  public ServiceReference<?>[] getRegisteredServices()

  Get services that this bundle has registrated.

  Specified by:

  getRegisteredServices in interface Bundle

  Returns:

  An array of ServiceReference objects or null.

  See Also:

  Bundle.getRegisteredServices()

• getServicesInUse

  public ServiceReference<?>[] getServicesInUse()

  Get services that this bundle uses.

  Specified by:

  getServicesInUse in interface Bundle

  Returns:

  An array of ServiceReference objects or null.

  See Also:

  Bundle.getServicesInUse()

• hasPermission

  public boolean hasPermission(java.lang.Object permission)

  Determine whether the bundle has the requested permission.

  Specified by:

  hasPermission in interface Bundle

  Parameters:

  permission - The permission to verify.

  Returns:

  true if this bundle has the specified permission or the permissions possessed by this bundle imply the specified permission; false if this bundle does not have the specified permission or permission is not an instanceof java.security.Permission.

  See Also:

  Bundle.hasPermission(java.lang.Object)

• getBundleContext

  public BundleContext getBundleContext()

  Returns this bundle's BundleContext.

  Specified by:

  getBundleContext in interface Bundle

  Returns:

  A BundleContext for this bundle or null if this bundle has no valid BundleContext.

  Since:

  org.osgi.framework 1.4

  See Also:

  Bundle.getBundleContext()

• getResource

  public java.net.URL getResource(java.lang.String name)

  Description copied from interface: Bundle
  Find the specified resource from this bundle's class loader. This bundle's class loader is called to search for the specified resource. If this bundle's state is INSTALLED, this method must attempt to resolve this bundle before attempting to get the specified resource. If this bundle cannot be resolved, then only this bundle must be searched for the specified resource. Imported packages cannot be searched when this bundle has not been resolved. If this bundle is a fragment bundle then null is returned.

  Note: Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the bundle contents do not contain directory entries.

  Specified by:

  getResource in interface Bundle

  Parameters:

  name - The name of the resource. See ClassLoader.getResource for a description of the format of a resource name.

  Returns:

  A URL to the named resource, or null if the resource could not be found or if this bundle is a fragment bundle or if the caller does not have the appropriate AdminPermission[this,RESOURCE], and the Java Runtime Environment supports permissions.

  See Also:

  Bundle.getResource(String name)

• getSymbolicName

  public java.lang.String getSymbolicName()

  Description copied from interface: Bundle
  Returns the symbolic name of this bundle as specified by its Bundle-SymbolicName manifest header. The bundle symbolic name should be based on the reverse domain name naming convention like that used for java packages.

  This method must continue to return this bundle's symbolic name while this bundle is in the UNINSTALLED state.

  Specified by:

  getSymbolicName in interface Bundle

  Returns:

  The symbolic name of this bundle or null if this bundle does not have a symbolic name.

  See Also:

  Bundle.getSymbolicName()

• getLastModified

  public long getLastModified()

  Description copied from interface: Bundle
  Returns the time when this bundle was last modified. A bundle is considered to be modified when it is installed, updated or uninstalled.

  The time value is the number of milliseconds since January 1, 1970, 00:00:00 UTC.

  Specified by:

  getLastModified in interface Bundle

  Returns:

  The time when this bundle was last modified.

  See Also:

  Bundle.getLastModified()

• getSignerCertificates

  public java.util.Map<java.security.cert.X509Certificate,java.util.List<java.security.cert.X509Certificate>> getSignerCertificates(int signersType)

  Description copied from interface: Bundle
  Return the certificates for the signers of this bundle and the certificate chains for those signers.

  Specified by:

  getSignerCertificates in interface Bundle

  Parameters:

  signersType - If Bundle.SIGNERS_ALL is specified, then information on all signers of this bundle is returned. If Bundle.SIGNERS_TRUSTED is specified, then only information on the signers of this bundle trusted by the framework is returned.

  Returns:

  The X509Certificates for the signers of this bundle and the X509Certificate chains for those signers. The keys of the Map are the X509Certificates of the signers of this bundle. The value for a key is a List containing the X509Certificate chain for the signer. The first item in the List is the signer's X509Certificate which is then followed by the rest of the X509Certificate chain. The returned Map will be empty if there are no signers. The returned Map is the property of the caller who is free to modify it.

  See Also:

  org.osgi.framework.Bundle#getSignerCertificates()

• getVersion

  public Version getVersion()

  Description copied from interface: Bundle
  Returns the version of this bundle as specified by its Bundle-Version manifest header. If this bundle does not have a specified version then Version.emptyVersion is returned.

  This method must continue to return this bundle's version while this bundle is in the UNINSTALLED state.

  Specified by:

  getVersion in interface Bundle

  Returns:

  The version of this bundle.

  See Also:

  Bundle.getVersion()

• adapt

  public <A> A adapt(java.lang.Class<A> type)

  Description copied from interface: Bundle
  Adapt this bundle to the specified type.

  Adapting this bundle to the specified type may require certain checks, including security checks, to succeed. If a check does not succeed, then this bundle cannot be adapted and null is returned.

  Specified by:

  adapt in interface Bundle

  Type Parameters:

  A - The type to which this bundle is to be adapted.

  Parameters:

  type - Class object for the type to which this bundle is to be adapted.

  Returns:

  The object, of the specified type, to which this bundle has been adapted or null if this bundle cannot be adapted to the specified type.

• getDataFile

  public java.io.File getDataFile(java.lang.String filename)

  Description copied from interface: Bundle
  Creates a File object for a file in the persistent storage area provided for this bundle by the Framework. This method will return null if the platform does not have file system support or this bundle is a fragment bundle.

  A File object for the base directory of the persistent storage area provided for this bundle by the Framework can be obtained by calling this method with an empty string as filename.

  If the Java Runtime Environment supports permissions, the Framework will ensure that this bundle has the java.io.FilePermission with actions read,write,delete for all files (recursively) in the persistent storage area provided for this bundle.

  Specified by:

  getDataFile in interface Bundle

  Parameters:

  filename - A relative name to the file to be accessed.

  Returns:

  A File object that represents the requested file or null if the platform does not have file system support or this bundle is a fragment bundle.

• compareTo

  public int compareTo(Bundle bundle)

  Specified by:

  compareTo in interface java.lang.Comparable<Bundle>

• toString

  public java.lang.String toString()

  Return a string representing this bundle. Only return identifier, since it requires AdminPermisson to get the location.

  Overrides:

  toString in class java.lang.Object

  Returns:

  a String representing this bundle.

• findEntries

  public java.util.Enumeration<java.net.URL> findEntries(java.lang.String path,
                                                         java.lang.String filePattern,
                                                         boolean recurse)

  Get bundle data. Get resources from bundle or fragment jars.

  Specified by:

  findEntries in interface Bundle

  Parameters:

  path - The path name in which to look. The path is always relative to the root of this bundle and may begin with "/". A path value of "/" indicates the root of this bundle.

  filePattern - The file name pattern for selecting entries in the specified path. The pattern is only matched against the last element of the entry path. If the entry is a directory then the trailing "/" is not used for pattern matching. Substring matching is supported, as specified in the Filter specification, using the wildcard character ("*"). If null is specified, this is equivalent to "*" and matches all files.

  recurse - If true, recurse into subdirectories. Otherwise only return entries from the specified path.

  Returns:

  An enumeration of URL objects for each matching entry, or null if no matching entry could be found or if the caller does not have the appropriate AdminPermission[this,RESOURCE], and the Java Runtime Environment supports permissions. The URLs are sorted such that entries from this bundle are returned first followed by the entries from attached fragments in attachment order. If this bundle is a fragment, then only matching entries in this fragment are returned.

  See Also:

  Bundle.findEntries(java.lang.String, java.lang.String, boolean)

• getEntry

  public java.net.URL getEntry(java.lang.String name)

  Description copied from interface: Bundle
  Returns a URL to the entry at the specified path in this bundle. This bundle's class loader is not used to search for the entry. Only the contents of this bundle are searched for the entry.

  The specified path is always relative to the root of this bundle and may begin with "/". A path value of "/" indicates the root of this bundle.

  Note: Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the bundle contents do not contain directory entries.

  Specified by:

  getEntry in interface Bundle

  Parameters:

  name - The path name of the entry.

  Returns:

  A URL to the entry, or null if no entry could be found or if the caller does not have the appropriate AdminPermission[this,RESOURCE] and the Java Runtime Environment supports permissions.

• getEntryPaths

  public java.util.Enumeration<java.lang.String> getEntryPaths(java.lang.String path)

  Description copied from interface: Bundle
  Returns an Enumeration of all the paths (String objects) to entries within this bundle whose longest sub-path matches the specified path. This bundle's class loader is not used to search for entries. Only the contents of this bundle are searched.

  The specified path is always relative to the root of this bundle and may begin with a "/". A path value of "/" indicates the root of this bundle.

  Returned paths indicating subdirectory paths end with a "/". The returned paths are all relative to the root of this bundle and must not begin with "/".

  Note: Jar and zip files are not required to include directory entries. Paths to directory entries will not be returned if the bundle contents do not contain directory entries.

  Specified by:

  getEntryPaths in interface Bundle

  Parameters:

  path - The path name for which to return entry paths.

  Returns:

  An Enumeration of the entry paths (String objects) or null if no entry could be found or if the caller does not have the appropriate AdminPermission[this,RESOURCE] and the Java Runtime Environment supports permissions.

• getHeaders

  public java.util.Dictionary<java.lang.String,java.lang.String> getHeaders(java.lang.String locale)

  Description copied from interface: Bundle
  Returns this bundle's Manifest headers and values localized to the specified locale.

  This method performs the same function as Bundle.getHeaders() except the manifest header values are localized to the specified locale.

  If a Manifest header value starts with "%", it must be localized according to the specified locale. If a locale is specified and cannot be found, then the header values must be returned using the default locale. Localizations are searched for in the following order:

     bn + "_" + Ls + "_" + Cs + "_" + Vs
     bn + "_" + Ls + "_" + Cs
     bn + "_" + Ls
     bn + "_" + Ld + "_" + Cd + "_" + Vd
     bn + "_" + Ld + "_" + Cd
     bn + "_" + Ld
     bn
   

  Where bn is this bundle's localization basename, Ls, Cs and Vs are the specified locale (language, country, variant) and Ld, Cd and Vd are the default locale (language, country, variant). If null is specified as the locale string, the header values must be localized using the default locale. If the empty string ("") is specified as the locale string, the header values must not be localized and the raw (unlocalized) header values, including any leading "%", must be returned. If no localization is found for a header value, the header value without the leading "%" is returned.

  This method must continue to return Manifest header information while this bundle is in the UNINSTALLED state, however the header values must only be available in the raw and default locale values.

  Specified by:

  getHeaders in interface Bundle

  Parameters:

  locale - The locale name into which the header values are to be localized. If the specified locale is null then the locale returned by java.util.Locale.getDefault is used. If the specified locale is the empty string, this method will return the raw (unlocalized) manifest headers including any leading "%".

  Returns:

  An unmodifiable Dictionary object containing this bundle's Manifest headers and values.

  See Also:

  Bundle.getHeaders(String locale)

• getResources

  public java.util.Enumeration<java.net.URL> getResources(java.lang.String name)
                                                   throws java.io.IOException

  Description copied from interface: Bundle
  Find the specified resources from this bundle's class loader. This bundle's class loader is called to search for the specified resources. If this bundle's state is INSTALLED, this method must attempt to resolve this bundle before attempting to get the specified resources. If this bundle cannot be resolved, then only this bundle must be searched for the specified resources. Imported packages cannot be searched when a bundle has not been resolved. If this bundle is a fragment bundle then null is returned.

  Note: Jar and zip files are not required to include directory entries. URLs to directory entries will not be returned if the bundle contents do not contain directory entries.

  Specified by:

  getResources in interface Bundle

  Parameters:

  name - The name of the resource. See ClassLoader.getResources for a description of the format of a resource name.

  Returns:

  An enumeration of URLs to the named resources, or null if the resource could not be found or if this bundle is a fragment bundle or if the caller does not have the appropriate AdminPermission[this,RESOURCE], and the Java Runtime Environment supports permissions.

  Throws:

  java.io.IOException - If there is an I/O error.

  See Also:

  Bundle.getResources(String name)

• loadClass

  public java.lang.Class<?> loadClass(java.lang.String name)
                               throws java.lang.ClassNotFoundException

  Description copied from interface: Bundle
  Loads the specified class using this bundle's class loader.

  If this bundle is a fragment bundle then this method must throw a ClassNotFoundException.

  If this bundle's state is INSTALLED, this method must attempt to resolve this bundle before attempting to load the class.

  If this bundle cannot be resolved, a Framework event of type FrameworkEvent.ERROR is fired containing a BundleException with details of the reason this bundle could not be resolved. This method must then throw a ClassNotFoundException.

  If this bundle's state is UNINSTALLED, then an IllegalStateException is thrown.

  Specified by:

  loadClass in interface Bundle

  Parameters:

  name - The name of the class to load.

  Returns:

  The Class object for the requested class.

  Throws:

  java.lang.ClassNotFoundException - If no such class can be found or if this bundle is a fragment bundle or if the caller does not have the appropriate AdminPermission[this,CLASS], and the Java Runtime Environment supports permissions.

  See Also:

  org.osgi.framework.Bundle#loadClass()