org.everit.osgi.ecm.component.ri.internal

Class ComponentContextImpl<C>

java.lang.Object

org.everit.osgi.ecm.component.ri.internal.ComponentContextImpl<C>

Type Parameters:

C - The type of the component implementation.

All Implemented Interfaces:

org.everit.osgi.ecm.component.ComponentContext<C>

public class ComponentContextImpl<C>
extends Object
implements org.everit.osgi.ecm.component.ComponentContext<C>

The context of a component instance. This is the most important class that manages the entire lifecycle of one instance of the component.

Constructor Summary

Constructors

Constructor and Description
ComponentContextImpl(AbstractComponentContainer<C> componentContainer, org.osgi.framework.BundleContext bundleContext)
ComponentContextImpl(AbstractComponentContainer<C> componentContainer, org.osgi.framework.BundleContext bundleContext, Dictionary<String,Object> properties) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closing the component context that stops the component instance as well if it is started.
void	fail(Throwable e, boolean permanent) Sets FAILED state for the ComponentContext, unregisters the OSGi services registered via the ComponentContext and removes the instance object.
org.osgi.framework.BundleContext	getBundleContext()
org.everit.osgi.ecm.component.resource.ComponentContainer<C>	getComponentContainer()
ComponentRevisionImpl<C>	getComponentRevision()
org.osgi.framework.ServiceReference<?>	getComponentServiceReference()
Class<C>	getComponentType()
C	getInstance()
Map<String,Object>	getProperties()
org.everit.osgi.ecm.component.resource.ComponentState	getState()
boolean	isFailed()
boolean	isSatisfied() Whether the component is satisfied based on the currently satisfied references or not.
void	open() Opens the component that means that configuration will be processed, all references will be tracked and if all references are satisfied the component will be started.
<S> org.osgi.framework.ServiceRegistration<S>	registerService(Class<S> clazz, S service, Dictionary<String,?> properties)
org.osgi.framework.ServiceRegistration<?>	registerService(String[] clazzes, Object service, Dictionary<String,?> properties)
org.osgi.framework.ServiceRegistration<?>	registerService(String clazz, Object service, Dictionary<String,?> properties)
void	updateConfiguration(Dictionary<String,?> properties) Updates the configuration on the component instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentContextImpl

public ComponentContextImpl(AbstractComponentContainer<C> componentContainer,
                            org.osgi.framework.BundleContext bundleContext)

ComponentContextImpl

public ComponentContextImpl(AbstractComponentContainer<C> componentContainer,
                            org.osgi.framework.BundleContext bundleContext,
                            Dictionary<String,Object> properties)

Constructor.

Parameters:

componentContainer - The component container that created this context.

bundleContext - The context of the bundle that opened the Component Container.

properties - The configuration of the component.

Method Detail

close

public void close()

Closing the component context that stops the component instance as well if it is started.

fail

public void fail(Throwable e,
                 boolean permanent)

Sets FAILED state for the ComponentContext, unregisters the OSGi services registered via the ComponentContext and removes the instance object.

Parameters:

e - The cause of the component failure.

permanent - Whether the failure is permanent or not. In case of non-permanent failure, a configuration update will change the state of the component, while a permanent failure can be changed only by upgrading the component instance binary.

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Specified by:

getBundleContext in interface org.everit.osgi.ecm.component.ComponentContext<C>

getComponentContainer

public org.everit.osgi.ecm.component.resource.ComponentContainer<C> getComponentContainer()

Specified by:

getComponentContainer in interface org.everit.osgi.ecm.component.ComponentContext<C>

getComponentRevision

public ComponentRevisionImpl<C> getComponentRevision()

Specified by:

getComponentRevision in interface org.everit.osgi.ecm.component.ComponentContext<C>

getComponentServiceReference

public org.osgi.framework.ServiceReference<?> getComponentServiceReference()

Specified by:

getComponentServiceReference in interface org.everit.osgi.ecm.component.ComponentContext<C>

getComponentType

public Class<C> getComponentType()

Specified by:

getComponentType in interface org.everit.osgi.ecm.component.ComponentContext<C>

getInstance

public C getInstance()

Specified by:

getInstance in interface org.everit.osgi.ecm.component.ComponentContext<C>

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface org.everit.osgi.ecm.component.ComponentContext<C>

getState

public org.everit.osgi.ecm.component.resource.ComponentState getState()

isFailed

public boolean isFailed()

isSatisfied

public boolean isSatisfied()

Whether the component is satisfied based on the currently satisfied references or not.

Returns:

true if all of the references are satisfied, otherwise false.

open

public void open()

Opens the component that means that configuration will be processed, all references will be tracked and if all references are satisfied the component will be started.

registerService

public <S> org.osgi.framework.ServiceRegistration<S> registerService(Class<S> clazz,
                                                                     S service,
                                                                     Dictionary<String,?> properties)

Specified by:

registerService in interface org.everit.osgi.ecm.component.ComponentContext<C>

registerService

public org.osgi.framework.ServiceRegistration<?> registerService(String clazz,
                                                                 Object service,
                                                                 Dictionary<String,?> properties)

Specified by:

registerService in interface org.everit.osgi.ecm.component.ComponentContext<C>

registerService

public org.osgi.framework.ServiceRegistration<?> registerService(String[] clazzes,
                                                                 Object service,
                                                                 Dictionary<String,?> properties)

Specified by:

registerService in interface org.everit.osgi.ecm.component.ComponentContext<C>

updateConfiguration

public void updateConfiguration(Dictionary<String,?> properties)

Updates the configuration on the component instance. In case non-dynamic properties or references are changed, the component instance will be restarted (during restart the old object will be dropped).

Parameters:

properties - The new configuration of the component.