OSGi 8.1.0 · org.osgi.service.component.ComponentContext

Method Summary

Modifier and Type	Method and Description
public void	disableComponent(String The name of a component. name) Disables the specified component name.
public void	enableComponent(String The name of a component or `null` to indicate all components in the bundle. name) Enables the specified component name.
public BundleContext	Returns: The `BundleContext` of the bundle declares this component. getBundleContext() Returns the `BundleContext` of the bundle which declares this component.
public <S> ComponentInstance<S>	Returns: The Component Instance object for the component instance. getComponentInstance() Returns the Component Instance object for the component instance associated with this Component Context.
public Dictionary<String, Object>	Returns: The properties for this Component Context. The Dictionary is read only and cannot be modified. getProperties() Returns the component properties for this Component Context.
public ServiceReference<?>	Returns: The `ServiceReference` object for the component instance or `null` if the component instance is not registered as a service. getServiceReference() If the component instance is registered as a service using the `service` element, then this method returns the service reference of the service provided by this component instance.
public Bundle	Returns: The bundle using the component instance as a service or `null`. getUsingBundle() If the component instance is registered as a service using the `servicescope="bundle"` or `servicescope="prototype"` attribute, then this method returns the bundle using the service provided by the component instance.
public <S> S	Returns: A service object for the referenced service or `null` if the reference cardinality is `0..1` or `0..n` and no bound service is available. locateService(String The name of a reference as specified in a `reference` element in this component's description. name) Returns the service object for the specified reference name.
public < Type of Service. S> S	Returns: A service object for the referenced service or `null` if the specified `ServiceReference` is not a bound service for the specified reference name. locateService(String The name of a reference as specified in a `reference` element in this component's description. name, ServiceReference<S> The `ServiceReference` to a bound service. This must be a `ServiceReference` provided to the component via the bind or unbind method for the specified reference name. reference) Returns the service object for the specified reference name and `ServiceReference`.
public Object[]	Returns: An array of service objects for the referenced service or `null` if the reference cardinality is `0..1` or `0..n` and no bound service is available. If the reference cardinality is `0..1` or `1..1` and a bound service is available, the array will have exactly one element. There is no guarantee that the service objects in the array will be in any specific order. locateServices(String The name of a reference as specified in a `reference` element in this component's description. name) Returns the service objects for the specified reference name.

Method Detail

disableComponent	back to summary
public void disableComponent(String name) Disables the specified component name. The specified component name must be in the same bundle as this component. This method must return after changing the enabled state of the specified component name. Any actions that result from this, such as activating or deactivating a component configuration, must occur asynchronously to this method call. Parameters name:String The name of a component.

disableComponent

back to summary

public void disableComponent(String name)

Disables the specified component name. The specified component name must be in the same bundle as this component.

This method must return after changing the enabled state of the specified component name. Any actions that result from this, such as activating or deactivating a component configuration, must occur asynchronously to this method call.

Parameters

name:String: The name of a component.

enableComponent back to summary

enableComponent	back to summary
public void enableComponent(String name) Enables the specified component name. The specified component name must be in the same bundle as this component. This method must return after changing the enabled state of the specified component name. Any actions that result from this, such as activating or deactivating a component configuration, must occur asynchronously to this method call. Parameters name:String The name of a component or `null` to indicate all components in the bundle.

public void enableComponent(String name)

Enables the specified component name. The specified component name must be in the same bundle as this component.

Parameters

name:String: The name of a component or null to indicate all components in the bundle.

getBundleContext back to summary

getBundleContext	back to summary
public BundleContext getBundleContext() Returns the `BundleContext` of the bundle which declares this component. Returns:BundleContext The `BundleContext` of the bundle declares this component.

public BundleContext getBundleContext()

Returns the BundleContext of the bundle which declares this component.

Returns:BundleContext: The BundleContext of the bundle declares this component.

getComponentInstance	back to summary
public <S> ComponentInstance<S> getComponentInstance() Returns the Component Instance object for the component instance associated with this Component Context. Returns:ComponentInstance<S> The Component Instance object for the component instance.

getComponentInstance

back to summary

public <S> ComponentInstance<S> getComponentInstance()

Returns the Component Instance object for the component instance associated with this Component Context.

Returns:ComponentInstance<S>: The Component Instance object for the component instance.

getProperties	back to summary
public Dictionary<String, Object> getProperties() Returns the component properties for this Component Context. Returns:Dictionary<String, Object> The properties for this Component Context. The Dictionary is read only and cannot be modified.

getProperties

back to summary

public Dictionary<String, Object> getProperties()

Returns the component properties for this Component Context.

Returns:Dictionary<String, Object>: The properties for this Component Context. The Dictionary is read only and cannot be modified.

getServiceReference back to summary

getServiceReference	back to summary
public ServiceReference<?> getServiceReference() If the component instance is registered as a service using the `service` element, then this method returns the service reference of the service provided by this component instance. This method will return `null` if the component instance is not registered as a service. Returns:ServiceReference<?> The `ServiceReference` object for the component instance or `null` if the component instance is not registered as a service.

public ServiceReference<?> getServiceReference()

If the component instance is registered as a service using the service element, then this method returns the service reference of the service provided by this component instance.

This method will return null if the component instance is not registered as a service.

Returns:ServiceReference<?>: The ServiceReference object for the component instance or null if the component instance is not registered as a service.

getUsingBundle back to summary

getUsingBundle	back to summary
public Bundle getUsingBundle() If the component instance is registered as a service using the `servicescope="bundle"` or `servicescope="prototype"` attribute, then this method returns the bundle using the service provided by the component instance. This method will return `null` if: The component instance is not a service, then no bundle can be using it as a service. The component instance is a service but did not specify the `servicescope="bundle"` or `servicescope="prototype"` attribute, then all bundles using the service provided by the component instance will share the same component instance. The service provided by the component instance is not currently being used by any bundle. Returns:Bundle The bundle using the component instance as a service or `null`.

public Bundle getUsingBundle()

If the component instance is registered as a service using the servicescope="bundle" or servicescope="prototype" attribute, then this method returns the bundle using the service provided by the component instance.

This method will return null if:

The component instance is not a service, then no bundle can be using it as a service.
The component instance is a service but did not specify the servicescope="bundle" or servicescope="prototype" attribute, then all bundles using the service provided by the component instance will share the same component instance.
The service provided by the component instance is not currently being used by any bundle.

Returns:Bundle: The bundle using the component instance as a service or null.

locateService back to summary

locateService	back to summary
public <S> S locateService(String name) Returns the service object for the specified reference name. If the cardinality of the reference is `0..n` or `1..n` and multiple services are bound to the reference, the service whose `ServiceReference` is first in the ranking order is returned. See `ServiceReference.compareTo(Object)`. Parameters name:String The name of a reference as specified in a `reference` element in this component's description. Returns:S A service object for the referenced service or `null` if the reference cardinality is `0..1` or `0..n` and no bound service is available. Exceptions ComponentException: If Service Component Runtime catches an exception while activating the bound service.

public <S> S locateService(String name)

Returns the service object for the specified reference name.

If the cardinality of the reference is 0..n or 1..n and multiple services are bound to the reference, the service whose ServiceReference is first in the ranking order is returned. See ServiceReference.compareTo(Object).

Parameters

name:String: The name of a reference as specified in a reference element in this component's description.

Returns:S

A service object for the referenced service or null if the reference cardinality is 0..1 or 0..n and no bound service is available.

Exceptions

ComponentException:: If Service Component Runtime catches an exception while activating the bound service.

locateService back to summary

locateService	back to summary
public <S> S locateService(String name, ServiceReference<S> reference) Returns the service object for the specified reference name and `ServiceReference`. Parameters <S> Type of Service. name:String The name of a reference as specified in a `reference` element in this component's description. reference:ServiceReference<S> The `ServiceReference` to a bound service. This must be a `ServiceReference` provided to the component via the bind or unbind method for the specified reference name. Returns:S A service object for the referenced service or `null` if the specified `ServiceReference` is not a bound service for the specified reference name. Exceptions ComponentException: If Service Component Runtime catches an exception while activating the bound service.

public <S> S locateService(String name, ServiceReference<S> reference)

Returns the service object for the specified reference name and ServiceReference.

Parameters

<S>: Type of Service.
name:String: The name of a reference as specified in a reference element in this component's description.
reference:ServiceReference<S>: The ServiceReference to a bound service. This must be a ServiceReference provided to the component via the bind or unbind method for the specified reference name.

Returns:S

A service object for the referenced service or null if the specified ServiceReference is not a bound service for the specified reference name.

Exceptions

ComponentException:: If Service Component Runtime catches an exception while activating the bound service.

locateServices back to summary

locateServices	back to summary
public Object[] locateServices(String name) Returns the service objects for the specified reference name. Parameters name:String The name of a reference as specified in a `reference` element in this component's description. Returns:Object[] An array of service objects for the referenced service or `null` if the reference cardinality is `0..1` or `0..n` and no bound service is available. If the reference cardinality is `0..1` or `1..1` and a bound service is available, the array will have exactly one element. There is no guarantee that the service objects in the array will be in any specific order. Exceptions ComponentException: If Service Component Runtime catches an exception while activating a bound service.

public Object[] locateServices(String name)

Returns the service objects for the specified reference name.

Parameters

name:String: The name of a reference as specified in a reference element in this component's description.

Returns:Object[]

An array of service objects for the referenced service or null if the reference cardinality is 0..1 or 0..n and no bound service is available. If the reference cardinality is 0..1 or 1..1 and a bound service is available, the array will have exactly one element. There is no guarantee that the service objects in the array will be in any specific order.

Exceptions

ComponentException:: If Service Component Runtime catches an exception while activating a bound service.

public Interface ComponentContext

Method Summary

Method Detail