org.everit.osgi.ecm.component.resource

Interface ComponentRevision<C>

Type Parameters:

C - The type of the component instance.

All Superinterfaces:

org.everit.osgi.linkage.ConfigurableResource, org.everit.osgi.linkage.EmbeddedResource, org.osgi.resource.Resource

public interface ComponentRevision<C>
extends org.everit.osgi.linkage.ConfigurableResource, org.everit.osgi.linkage.EmbeddedResource

A snapshot of the state of a component instance.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() The cause of the failure of the component.
ComponentContainer<C>	getComponentContainer() The container that this component revision belongs to.
org.osgi.framework.wiring.BundleRevision	getDeclaringResource()
Thread	getProcessingThread() In case of ComponentState.STARTING or ComponentState.STOPPING state the method returns the thread that initiatied the state change on the component.
Map<String,Object>	getProperties() The configuration properties of the component.
ComponentState	getState() The state of the component.

Methods inherited from interface org.osgi.resource.Resource

equals, getCapabilities, getRequirements, hashCode

Method Detail

getCause

Throwable getCause()

The cause of the failure of the component.

Returns:

The cause of the failure or null if the component is not in ComponentState.FAILED state.

getComponentContainer

ComponentContainer<C> getComponentContainer()

The container that this component revision belongs to.

Returns:

the container that this component revision belongs to.

getDeclaringResource

org.osgi.framework.wiring.BundleRevision getDeclaringResource()

Specified by:

getDeclaringResource in interface org.everit.osgi.linkage.EmbeddedResource

getProcessingThread

Thread getProcessingThread()

In case of ComponentState.STARTING or ComponentState.STOPPING state the method returns the thread that initiatied the state change on the component. This information can be useful if there is a long-running task or a deadlock during the state change.

Returns:

The thread that initiated ComponentState.STARTING or ComponentState.STOPPING or null if the component has a different state.

getProperties

Map<String,Object> getProperties()

The configuration properties of the component.

Specified by:

getProperties in interface org.everit.osgi.linkage.ConfigurableResource

getState

ComponentState getState()

The state of the component.