public interface ComponentContext
A component instance may have an activate method. If a component instance has
a suitable and accessible activate method, this method will be called when a
component configuration is activated. If the activate method takes a
ComponentContext
argument, it will be passed the component
instance's Component Context object. If the activate method takes a
BundleContext
argument, it will be passed the component
instance's Bundle Context object. If the activate method takes a
Map
argument, it will be passed an unmodifiable Map containing
the component properties.
A component instance may have a deactivate method. If a component instance
has a suitable and accessible deactivate method, this method will be called
when the component configuration is deactivated. If the deactivate method
takes a ComponentContext
argument, it will be passed the
component instance's Component Context object. If the deactivate method takes
a BundleContext
argument, it will be passed the component
instance's Bundle Context object. If the deactivate method takes a
Map
argument, it will be passed an unmodifiable Map containing
the component properties. If the deactivate method takes an int
or Integer
argument, it will be passed the reason code for the
component instance's deactivation.
Modifier and Type | Method and Description |
---|---|
void |
disableComponent(String name)
Disables the specified component name.
|
void |
enableComponent(String name)
Enables the specified component name.
|
BundleContext |
getBundleContext()
Returns the
BundleContext of the bundle which contains this
component. |
ComponentInstance |
getComponentInstance()
Returns the Component Instance object for the component instance
associated with this Component Context.
|
Dictionary |
getProperties()
Returns the component properties for this Component Context.
|
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. |
Bundle |
getUsingBundle()
If the component instance is registered as a service using the
servicefactory="true" attribute, then this method
returns the bundle using the service provided by the component instance. |
Object |
locateService(String name)
Returns the service object for the specified reference name.
|
Object |
locateService(String name,
ServiceReference reference)
Returns the service object for the specified reference name and
ServiceReference . |
Object[] |
locateServices(String name)
Returns the service objects for the specified reference name.
|
Dictionary getProperties()
Object locateService(String name)
If the cardinality of the reference is 0..n
or
1..n
and multiple services are bound to the reference, 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.
name
- The name of a reference as specified in a
reference
element in this component's description.null
if the reference cardinality is 0..1
or
0..n
and no bound service is available.ComponentException
- If the Service Component Runtime catches an
exception while activating the bound service.Object locateService(String name, ServiceReference reference)
ServiceReference
.name
- The name of a reference as specified in a
reference
element in this component's description.reference
- 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.null
if the specified ServiceReference
is not a bound
service for the specified reference name.ComponentException
- If the Service Component Runtime catches an
exception while activating the bound service.Object[] locateServices(String name)
name
- The name of a reference as specified in a
reference
element in this component's description.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.ComponentException
- If the Service Component Runtime catches an
exception while activating a bound service.BundleContext getBundleContext()
BundleContext
of the bundle which contains this
component.BundleContext
of the bundle containing this
component.Bundle getUsingBundle()
servicefactory="true"
attribute, then this method
returns the bundle using the service provided by the component instance.
This method will return null
if:
servicefactory="true"
attribute, then all bundles
using the service provided by the component instance will share the same
component instance.
null
.ComponentInstance getComponentInstance()
void enableComponent(String name)
name
- The name of a component or null
to indicate all
components in the bundle.void disableComponent(String name)
name
- The name of a component.ServiceReference getServiceReference()
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.
ServiceReference
object for the component
instance or null
if the component instance is not
registered as a service.Copyright © 2018 JBoss by Red Hat. All rights reserved.