Interface ServiceReference<S>

Method Details

• getProperty

  Object getProperty(String key)

  Returns the property value to which the specified property key is mapped in the properties Dictionary object of the service referenced by this ServiceReference object.

  Property keys are case-insensitive.

  This method must continue to return property values after the service has been unregistered. This is so references to unregistered services (for example, ServiceReference objects stored in the log) can still be interrogated.

  Parameters:

  key - The property key.

  Returns:

  The property value to which the key is mapped; null if there is no property named after the key.

• getPropertyKeys

  String[] getPropertyKeys()

  Returns an array of the keys in the properties Dictionary object of the service referenced by this ServiceReference object.

  This method will continue to return the keys after the service has been unregistered. This is so references to unregistered services (for example, ServiceReference objects stored in the log) can still be interrogated.

  This method is case-preserving ; this means that every key in the returned array must have the same case as the corresponding key in the properties Dictionary that was passed to the BundleContext.registerService(String[],Object,Dictionary) or ServiceRegistration.setProperties(Dictionary) methods.

  Returns:

  An array of property keys.

• getBundle

  Bundle getBundle()

  Returns the bundle that registered the service referenced by this ServiceReference object.

  This method must return null when the service has been unregistered. This can be used to determine if the service has been unregistered.

  Specified by:

  getBundle in interface BundleReference

  Returns:

  The bundle that registered the service referenced by this ServiceReference object; null if that service has already been unregistered.

  See Also:

  • BundleContext.registerService(String[],Object,Dictionary)

• getUsingBundles

  Bundle[] getUsingBundles()

  Returns the bundles that are using the service referenced by this ServiceReference object. Specifically, this method returns the bundles whose usage count for that service is greater than zero.

  Returns:

  An array of bundles whose usage count for the service referenced by this ServiceReference object is greater than zero; null if no bundles are currently using that service.

  Since:

  1.1

• isAssignableTo

  boolean isAssignableTo(Bundle bundle, String className)

  Tests if the bundle that registered the service referenced by this ServiceReference and the specified bundle use the same source for the package of the specified class name.

  This method performs the following checks:

  1. If the specified bundle is equal to the bundle that registered the service referenced by this ServiceReference (registrant bundle) return true.
  2. Get the package name from the specified class name.
  3. For the specified bundle; find the source for the package. If no source is found then return true (use of reflection is assumed by the specified bundle).
  4. For the registrant bundle; find the source for the package. If the package source is found then return true if the package source equals the package source of the specified bundle; otherwise return false.
  5. If no package source is found for the registrant bundle then determine the package source based on the service object. If the service object is a ServiceFactory and the factory implementation is not from the registrant bundle return true; otherwise attempt to find the package source based on the service object class. If the package source is found and is equal to package source of the specified bundle return true; otherwise return false.

  Parameters:

  bundle - The Bundle object to check.

  className - The class name to check.

  Returns:

  true if the bundle which registered the service referenced by this ServiceReference and the specified bundle use the same source for the package of the specified class name. Otherwise false is returned.

  Throws:

  IllegalArgumentException - If the specified Bundle was not created by the same framework instance as this ServiceReference.

  Since:

  1.3

• compareTo

  int compareTo(Object reference)

  Compares this ServiceReference with the specified ServiceReference for order.

  If this ServiceReference and the specified ServiceReference have the same service id they are equal. This ServiceReference is less than the specified ServiceReference if it has a lower service ranking and greater if it has a higher service ranking. Otherwise, if this ServiceReference and the specified ServiceReference have the same service ranking, this ServiceReference is less than the specified ServiceReference if it has a higher service id and greater if it has a lower service id.

  Specified by:

  compareTo in interface Comparable<S>

  Parameters:

  reference - The ServiceReference to be compared.

  Returns:

  Returns a negative integer, zero, or a positive integer if this ServiceReference is less than, equal to, or greater than the specified ServiceReference.

  Throws:

  IllegalArgumentException - If the specified ServiceReference was not created by the same framework instance as this ServiceReference.

  Since:

  1.4

• getProperties

  Dictionary<String,Object> getProperties()

  Returns a copy of the properties of the service referenced by this ServiceReference object.

  This method will continue to return the properties after the service has been unregistered. This is so references to unregistered services (for example, ServiceReference objects stored in the log) can still be interrogated.

  The returned Dictionary object:

  • Must map property values by using property keys in a case-insensitive manner.
  • Must return property keys is a case-preserving manner. This means that the keys must have the same case as the corresponding key in the properties Dictionary that was passed to the BundleContext.registerService(String[],Object,Dictionary) or ServiceRegistration.setProperties(Dictionary) methods.
  • Is the property of the caller and can be modified by the caller but any changes are not reflected in the properties of the service. ServiceRegistration.setProperties(Dictionary) must be called to modify the properties of the service.

  Returns:

  A copy of the properties of the service referenced by this ServiceReference object

  Since:

  1.9

• adapt

  <A> A adapt(Class<A> type)

  Adapt this ServiceReference object to the specified type.

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

  Type Parameters:

  A - The type to which this ServiceReference object is to be adapted.

  Parameters:

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

  Returns:

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

  Throws:

  SecurityException - If the caller does not have the appropriate AdaptPermission[type,this,ADAPT], and the Java Runtime Environment supports permissions.

  Since:

  1.10