Constructor Detail

• BundleContextImpl

  public BundleContextImpl(BundleImpl bundle)

  Create a BundleContext for specified bundle.

Method Detail

• getProperty

  public java.lang.String getProperty(java.lang.String key)

  Retrieve the value of the named environment property.

  Specified by:

  getProperty in interface BundleContext

  Parameters:

  key - The name of the requested property.

  Returns:

  The value of the requested property, or null if the property is undefined.

  See Also:

  BundleContext.getProperty(java.lang.String)

• installBundle

  public Bundle installBundle(java.lang.String location)
                       throws BundleException

  Install a bundle from location.

  Specified by:

  installBundle in interface BundleContext

  Parameters:

  location - The location identifier of the bundle to install.

  Returns:

  The Bundle object of the installed bundle.

  Throws:

  BundleException - If the installation failed. BundleException types thrown by this method include: BundleException.READ_ERROR , BundleException.DUPLICATE_BUNDLE_ERROR, BundleException.MANIFEST_ERROR, and BundleException.REJECTED_BY_HOOK.

  See Also:

  BundleContext.installBundle(java.lang.String, java.io.InputStream)

• installBundle

  public Bundle installBundle(java.lang.String location,
                              java.io.InputStream in)
                       throws BundleException

  Install a bundle from an InputStream.

  Specified by:

  installBundle in interface BundleContext

  Parameters:

  location - The location identifier of the bundle to install.

  in - The InputStream object from which this bundle will be read or null to indicate the Framework must create the input stream from the specified location identifier. The input stream must always be closed when this method completes, even if an exception is thrown.

  Returns:

  The Bundle object of the installed bundle.

  Throws:

  BundleException - If the installation failed. BundleException types thrown by this method include: BundleException.READ_ERROR , BundleException.DUPLICATE_BUNDLE_ERROR, BundleException.MANIFEST_ERROR, and BundleException.REJECTED_BY_HOOK.

  See Also:

  BundleContext.installBundle(java.lang.String, java.io.InputStream)

• getBundle

  public Bundle getBundle()

  Retrieve the Bundle object for the calling bundle.

  Specified by:

  getBundle in interface BundleContext

  Specified by:

  getBundle in interface BundleReference

  Returns:

  The Bundle object associated with this BundleContext.

  See Also:

  BundleContext.getBundle()

• getBundle

  public Bundle getBundle(long id)

  Retrieve the bundle that has the given unique identifier.

  Specified by:

  getBundle in interface BundleContext

  Parameters:

  id - The identifier of the bundle to retrieve.

  Returns:

  A Bundle object or null if the identifier does not match any installed bundle.

  See Also:

  BundleContext.getBundle()

• getBundles

  public Bundle[] getBundles()

  Retrieve a list of all installed bundles.

  Specified by:

  getBundles in interface BundleContext

  Returns:

  An array of Bundle objects, one object per installed bundle.

  See Also:

  BundleContext.getBundles()

• addServiceListener

  public void addServiceListener(ServiceListener listener,
                                 java.lang.String filter)
                          throws InvalidSyntaxException

  Add a service listener with a filter.

  Specified by:

  addServiceListener in interface BundleContext

  Parameters:

  listener - The ServiceListener object to be added.

  filter - The filter criteria.

  Throws:

  InvalidSyntaxException - If filter contains an invalid filter string that cannot be parsed.

  See Also:

  BundleContext.addServiceListener(org.osgi.framework.ServiceListener, java.lang.String)

• addServiceListener

  public void addServiceListener(ServiceListener listener)

  Add a service listener.

  Specified by:

  addServiceListener in interface BundleContext

  Parameters:

  listener - The ServiceListener object to be added.

  See Also:

  BundleContext.addServiceListener(org.osgi.framework.ServiceListener, java.lang.String)

• removeServiceListener

  public void removeServiceListener(ServiceListener listener)

  Remove a service listener.

  Specified by:

  removeServiceListener in interface BundleContext

  Parameters:

  listener - The ServiceListener to be removed.

  See Also:

  BundleContext.removeServiceListener(org.osgi.framework.ServiceListener)

• addBundleListener

  public void addBundleListener(BundleListener listener)

  Add a bundle listener.

  Specified by:

  addBundleListener in interface BundleContext

  Parameters:

  listener - The BundleListener to be added.

  See Also:

  BundleContext.addBundleListener(org.osgi.framework.BundleListener)

• removeBundleListener

  public void removeBundleListener(BundleListener listener)

  Remove a bundle listener.

  Specified by:

  removeBundleListener in interface BundleContext

  Parameters:

  listener - The BundleListener object to be removed.

  See Also:

  BundleContext.removeBundleListener(org.osgi.framework.BundleListener)

• addFrameworkListener

  public void addFrameworkListener(FrameworkListener listener)

  Add a framework listener.

  Specified by:

  addFrameworkListener in interface BundleContext

  Parameters:

  listener - The FrameworkListener object to be added.

  See Also:

  BundleContext.addFrameworkListener(org.osgi.framework.FrameworkListener)

• removeFrameworkListener

  public void removeFrameworkListener(FrameworkListener listener)

  Remove a framework listener.

  Specified by:

  removeFrameworkListener in interface BundleContext

  Parameters:

  listener - The FrameworkListener object to be removed.

  See Also:

  BundleContext.removeFrameworkListener(org.osgi.framework.FrameworkListener)

• registerService

  public ServiceRegistration<?> registerService(java.lang.String[] clazzes,
                                                java.lang.Object service,
                                                java.util.Dictionary<java.lang.String,?> properties)

  Register a service with multiple names.

  Specified by:

  registerService in interface BundleContext

  Parameters:

  clazzes - The class names under which the service can be located. The class names in this array will be stored in the service's properties under the key Constants.OBJECTCLASS.

  service - The service object or an object implementing ServiceFactory.

  properties - The properties for this service. The keys in the properties object must all be String objects. See Constants for a list of standard service property keys. Changes should not be made to this object after calling this method. To update the service's properties the ServiceRegistration.setProperties(Dictionary) method must be called. The set of properties may be null if the service has no properties.

  Returns:

  A ServiceRegistration object for use by the bundle registering the service to update the service's properties or to unregister the service.

  See Also:

  BundleContext.registerService(java.lang.String[], java.lang.Object, java.util.Dictionary<java.lang.String, ?>)

• registerService

  public ServiceRegistration<?> registerService(java.lang.String clazz,
                                                java.lang.Object service,
                                                java.util.Dictionary<java.lang.String,?> properties)

  Register a service with a single name.

  Specified by:

  registerService in interface BundleContext

  Parameters:

  clazz - The class name under which the service can be located.

  service - The service object or an object implementing ServiceFactory.

  properties - The properties for this service.

  Returns:

  A ServiceRegistration object for use by the bundle registering the service to update the service's properties or to unregister the service.

  See Also:

  BundleContext.registerService(java.lang.String[], java.lang.Object, java.util.Dictionary<java.lang.String, ?>)

• registerService

  public <S> ServiceRegistration<S> registerService(java.lang.Class<S> clazz,
                                                    S service,
                                                    java.util.Dictionary<java.lang.String,?> properties)

  Registers the specified service object with the specified properties under the name of the specified class with the Framework.

  Specified by:

  registerService in interface BundleContext

  Type Parameters:

  S - Type of Service.

  Parameters:

  clazz - The class under whose name the service can be located.

  service - The service object or an object implementing ServiceFactory.

  properties - The properties for this service.

  Returns:

  A ServiceRegistration object for use by the bundle registering the service to update the service's properties or to unregister the service.

  See Also:

  BundleContext.registerService(java.lang.String[], java.lang.Object, java.util.Dictionary<java.lang.String, ?>)

• registerService

  public <S> ServiceRegistration<S> registerService(java.lang.Class<S> clazz,
                                                    ServiceFactory<S> factory,
                                                    java.util.Dictionary<java.lang.String,?> properties)

  Registers the specified service factory object with the specified properties under the name of the specified class with the Framework.

  Specified by:

  registerService in interface BundleContext

  Type Parameters:

  S - Type of Service.

  Parameters:

  clazz - The class under whose name the service can be located.

  factory - The ServiceFactory object.

  properties - The properties for this service.

  Returns:

  A ServiceRegistration object for use by the bundle registering the service to update the service's properties or to unregister the service.

  See Also:

  BundleContext.registerService(java.lang.String[], java.lang.Object, java.util.Dictionary<java.lang.String, ?>)

• getServiceReferences

  public ServiceReference<?>[] getServiceReferences(java.lang.String clazz,
                                                    java.lang.String filter)
                                             throws InvalidSyntaxException

  Get a list of service references.

  Specified by:

  getServiceReferences in interface BundleContext

  Parameters:

  clazz - The class name with which the service was registered or null for all services.

  filter - The filter expression or null for all services.

  Returns:

  An array of ServiceReference objects or null if no services are registered which satisfy the search.

  Throws:

  InvalidSyntaxException - If the specified filter contains an invalid filter expression that cannot be parsed.

  See Also:

  BundleContext.getServiceReferences(java.lang.String, java.lang.String)

• getAllServiceReferences

  public ServiceReference<?>[] getAllServiceReferences(java.lang.String clazz,
                                                       java.lang.String filter)
                                                throws InvalidSyntaxException

  Get a list of service references.

  Specified by:

  getAllServiceReferences in interface BundleContext

  Parameters:

  clazz - The class name with which the service was registered or null for all services.

  filter - The filter expression or null for all services.

  Returns:

  An array of ServiceReference objects or null if no services are registered which satisfy the search.

  Throws:

  InvalidSyntaxException - If the specified filter contains an invalid filter expression that cannot be parsed.

  See Also:

  BundleContext.getAllServiceReferences(java.lang.String, java.lang.String)

• getServiceReference

  public ServiceReference<?> getServiceReference(java.lang.String clazz)

  Get a service reference.

  Specified by:

  getServiceReference in interface BundleContext

  Parameters:

  clazz - The class name with which the service was registered.

  Returns:

  A ServiceReference object, or null if no services are registered which implement the named class.

  See Also:

  BundleContext.getServiceReference(java.lang.String)

• getService

  public <S> S getService(ServiceReference<S> reference)

  Get the service object.

  Specified by:

  getService in interface BundleContext

  Type Parameters:

  S - Type of Service.

  Parameters:

  reference - A reference to the service.

  Returns:

  A service object for the service associated with reference or null if the service is not registered, the service object returned by a ServiceFactory does not implement the classes under which it was registered or the ServiceFactory threw an exception.

  See Also:

  BundleContext.getService(org.osgi.framework.ServiceReference<S>)

• ungetService

  public boolean ungetService(ServiceReference<?> reference)

  Unget the service object.

  Specified by:

  ungetService in interface BundleContext

  Parameters:

  reference - A reference to the service to be released.

  Returns:

  false if the context bundle's use count for the service is zero or if the service has been unregistered; true otherwise.

  See Also:

  BundleContext.ungetService(org.osgi.framework.ServiceReference<?>)

• getServiceObjects

  public <S> ServiceObjects<S> getServiceObjects(ServiceReference<S> reference)

  Returns the ServiceObjects object for the service referenced by the specified ServiceReference object.

  Specified by:

  getServiceObjects in interface BundleContext

  Type Parameters:

  S - Type of Service.

  Parameters:

  reference - A reference to the service.

  Returns:

  A ServiceObjects object for the service associated with the specified reference or null if the service is not registered.

  See Also:

  BundleContext.getServiceObjects(org.osgi.framework.ServiceReference<S>)

• getDataFile

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

  Creates a File object for a file in the persistent storage area provided for the bundle.

  Specified by:

  getDataFile in interface BundleContext

  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.

  See Also:

  BundleContext.getDataFile(java.lang.String)

• createFilter

  public Filter createFilter(java.lang.String filter)
                      throws InvalidSyntaxException

  Constructs a Filter object. This filter object may be used to match a ServiceReference or a Dictionary.

  Specified by:

  createFilter in interface BundleContext

  Parameters:

  filter - the filter string.

  Returns:

  the Filter object encapsulating the filter string.

  Throws:

  InvalidSyntaxException - If the filter parameter contains an invalid filter string which cannot be parsed.

  Since:

  1.1

  See Also:

  "Framework specification for a description of the filter string syntax.", FrameworkUtil.createFilter(String)

• getServiceReference

  public <S> ServiceReference<S> getServiceReference(java.lang.Class<S> clazz)

  Description copied from interface: BundleContext
  Returns a ServiceReference object for a service that implements and was registered under the name of the specified class.

  The returned ServiceReference object is valid at the time of the call to this method. However as the Framework is a very dynamic environment, services can be modified or unregistered at any time.

  This method is the same as calling BundleContext.getServiceReferences(Class, String) with a null filter expression. It is provided as a convenience for when the caller is interested in any service that implements the specified class.

  If multiple such services exist, the service with the highest ranking (as specified in its Constants.SERVICE_RANKING property) is returned.

  If there is a tie in ranking, the service with the lowest service id (as specified in its Constants.SERVICE_ID property); that is, the service that was registered first is returned.

  Specified by:

  getServiceReference in interface BundleContext

  Type Parameters:

  S - Type of Service.

  Parameters:

  clazz - The class under whose name the service was registered. Must not be null.

  Returns:

  A ServiceReference object, or null if no services are registered which implement the specified class.

  See Also:

  BundleContext.getServiceReferences(Class, String)

• getServiceReferences

  public <S> java.util.Collection<ServiceReference<S>> getServiceReferences(java.lang.Class<S> clazz,
                                                                            java.lang.String filter)
                                                                     throws InvalidSyntaxException

  Description copied from interface: BundleContext
  Returns a collection of ServiceReference objects. The returned collection of ServiceReference objects contains services that were registered under the name of the specified class, match the specified filter expression, and the packages for the class names under which the services were registered match the context bundle's packages as defined in ServiceReference.isAssignableTo(Bundle, String).

  The collection is valid at the time of the call to this method. However since the Framework is a very dynamic environment, services can be modified or unregistered at any time.

  The specified filter expression is used to select the registered services whose service properties contain keys and values which satisfy the filter expression. See Filter for a description of the filter syntax. If the specified filter is null, all registered services are considered to match the filter. If the specified filter expression cannot be parsed, an InvalidSyntaxException will be thrown with a human readable message where the filter became unparsable.

  The result is a collection of ServiceReference objects for all services that meet all of the following conditions:

  • The service must have been registered with the name of the specified class. The complete list of class names with which a service was registered is available from the service's objectClass property.
  • If the specified filter is not null, the filter expression must match the service.
  • If the Java Runtime Environment supports permissions, the caller must have ServicePermission with the GET action for at least one of the class names under which the service was registered.
  • For each class name with which the service was registered, calling ServiceReference.isAssignableTo(Bundle, String) with the context bundle and the class name on the service's ServiceReference object must return true

  Specified by:

  getServiceReferences in interface BundleContext

  Type Parameters:

  S - Type of Service

  Parameters:

  clazz - The class under whose name the service was registered. Must not be null.

  filter - The filter expression or null for all services.

  Returns:

  A collection of ServiceReference objects. May be empty if no services are registered which satisfy the search.

  Throws:

  InvalidSyntaxException - If the specified filter contains an invalid filter expression that cannot be parsed.

• getBundle

  public Bundle getBundle(java.lang.String location)

  Description copied from interface: BundleContext
  Returns the bundle with the specified location.

  Specified by:

  getBundle in interface BundleContext

  Parameters:

  location - The location of the bundle to retrieve.

  Returns:

  A Bundle object or null if the location does not match any installed bundle.