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

Class ReferenceHelper<CAPABILITY,COMPONENT,METADATA extends org.everit.osgi.ecm.metadata.ReferenceMetadata>

java.lang.Object

org.everit.osgi.ecm.component.ri.internal.attribute.ReferenceHelper<CAPABILITY,COMPONENT,METADATA>

Type Parameters:

CAPABILITY - The type of the capability that the reference requires.

COMPONENT - The type of the component implementation.

METADATA - The type of the metadata class that belongs to the reference.

Direct Known Subclasses:

BundleCapabilityReferenceAttributeHelper, ServiceReferenceAttributeHelper

public abstract class ReferenceHelper<CAPABILITY,COMPONENT,METADATA extends org.everit.osgi.ecm.metadata.ReferenceMetadata>
extends Object

Super class of classes that help managing the lifecycle and actions of references.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ReferenceHelper.ReferenceCapabilityConsumer CapabilityConsumer implementation for references that call the necessary ReferenceEventHandler of the component if a change happens.

Constructor Summary

Constructors

Constructor and Description
ReferenceHelper(METADATA referenceMetadata, ComponentContextImpl<COMPONENT> componentContext, ReferenceEventHandler eventHandler) Constructor of ReferenceHelper.

Method Summary

Modifier and Type	Method and Description
void	bind() Calls the setter method with the current referenced object(s).
protected abstract void	bindInternal()
void	close()
protected abstract org.everit.osgi.capabilitycollector.AbstractCapabilityCollector<CAPABILITY>	createCollector(ReferenceHelper.ReferenceCapabilityConsumer consumer, org.everit.osgi.capabilitycollector.RequirementDefinition<CAPABILITY>[] items)
abstract void	free() Called when the component failes and every attached resource should be unattached.
ComponentContextImpl<COMPONENT>	getComponentContext()
METADATA	getReferenceMetadata()
MethodHandle	getSetterMethodHandle()
org.everit.osgi.capabilitycollector.Suiting<CAPABILITY>[]	getSuitings()
boolean	isArray()
boolean	isHolder()
boolean	isOpened()
boolean	isSatisfied()
void	open()
void	updateConfiguration() Called when the configuration of the component is updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceHelper

public ReferenceHelper(METADATA referenceMetadata,
                       ComponentContextImpl<COMPONENT> componentContext,
                       ReferenceEventHandler eventHandler)
                throws IllegalAccessException

Constructor of ReferenceHelper.

Parameters:

referenceMetadata - The metadata that describes the attributes of the reference.

componentContext - The context of the component that the reference blongs to.

eventHandler - The event handler that should be called if there is any change in the state of the reference.

Throws:

IllegalAccessException - if there is an issue during resolving the setter method.

Method Detail

bind

public void bind()

Calls the setter method with the current referenced object(s).

bindInternal

protected abstract void bindInternal()

close

public void close()

createCollector

protected abstract org.everit.osgi.capabilitycollector.AbstractCapabilityCollector<CAPABILITY> createCollector(ReferenceHelper.ReferenceCapabilityConsumer consumer,
                                                                                                               org.everit.osgi.capabilitycollector.RequirementDefinition<CAPABILITY>[] items)

free

public abstract void free()

Called when the component failes and every attached resource should be unattached. E.g.: unget services that were previously got.

getComponentContext

public ComponentContextImpl<COMPONENT> getComponentContext()

getReferenceMetadata

public METADATA getReferenceMetadata()

getSetterMethodHandle

public MethodHandle getSetterMethodHandle()

getSuitings

public org.everit.osgi.capabilitycollector.Suiting<CAPABILITY>[] getSuitings()

isArray

public boolean isArray()

isHolder

public boolean isHolder()

isOpened

public boolean isOpened()

isSatisfied

public boolean isSatisfied()

open

public void open()

updateConfiguration

public void updateConfiguration()

Called when the configuration of the component is updated.