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

Class ComponentRevisionImpl.Builder<C>

java.lang.Object

org.everit.osgi.ecm.component.ri.internal.resource.ComponentRevisionImpl.Builder<C>

Type Parameters:

C - The type of the component implementation.

Enclosing class:

ComponentRevisionImpl<C>

public static class ComponentRevisionImpl.Builder<C>
extends Object

The builder class of the ComponentRevision offers thread safe functionality to collect information about the state of the component and build ComponentRevision instances.

Constructor Summary

Constructors

Constructor and Description
Builder(org.everit.osgi.ecm.component.resource.ComponentContainer<C> container, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	active() Called when the component instance becomes active.
void	addServiceRegistration(org.osgi.framework.ServiceRegistration<?> serviceRegistration) Called when the component registers a new OSGi service that is shown as the capability of the component.
ComponentRevisionImpl<C>	build() Builds a new ComponentRevision based on the snapshot of the component state.
void	fail(Throwable cause, boolean permanent) Called when the component fails.
Set<org.osgi.framework.ServiceRegistration<?>>	getCloneOfServiceRegistrations() Returns a clone of the held service registrations.
Map<String,Object>	getProperties()
org.everit.osgi.ecm.component.resource.ComponentState	getState()
void	inactive() Called when the component is stopped due to some reason (it is stopped completely or the component has to be restarted due to updating non-dynamic attributes).
void	removeServiceRegistration(org.osgi.framework.ServiceRegistration<?> serviceRegistration)
void	setOrAddSuppressedCause(Throwable cause) In case there is no cause, this will be the new one, otherwise the passed cause parameter will be add as a suppressed cause of the original.
void	starting() Called when the component is starting (activate method is called but it has not finished yet).
void	stopping() Called when the component is stopping (The deactivate method runs).
void	unsatisfied() Called when the component becomes unsatisfied.
void	updateProperties(Map<String,Object> properties) Called when the component properties are updated.
void	updateSuitingsForAttribute(org.everit.osgi.ecm.metadata.ReferenceMetadata referenceMetadata, org.everit.osgi.capabilitycollector.Suiting<?>[] suitings)
void	updatingConfiguration() Called when the state is changed to ComponentState.UPDATING_CONFIGURATION.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(org.everit.osgi.ecm.component.resource.ComponentContainer<C> container,
               Map<String,Object> properties)

Method Detail

active

public void active()

Called when the component instance becomes active.

addServiceRegistration

public void addServiceRegistration(org.osgi.framework.ServiceRegistration<?> serviceRegistration)

Called when the component registers a new OSGi service that is shown as the capability of the component.

Parameters:

serviceRegistration - The service that was registered.

build

public ComponentRevisionImpl<C> build()

Builds a new ComponentRevision based on the snapshot of the component state.

Returns:

The freshly created ComponentRevision.

fail

public void fail(Throwable cause,
                 boolean permanent)

Called when the component fails.

Parameters:

cause - The cause of the failure.

permanent - Whether the failure is permanent or temporary.

getCloneOfServiceRegistrations

public Set<org.osgi.framework.ServiceRegistration<?>> getCloneOfServiceRegistrations()

Returns a clone of the held service registrations.

Returns:

A clone of the service registrations of the component.

getProperties

public Map<String,Object> getProperties()

getState

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

inactive

public void inactive()

Called when the component is stopped due to some reason (it is stopped completely or the component has to be restarted due to updating non-dynamic attributes).

removeServiceRegistration

public void removeServiceRegistration(org.osgi.framework.ServiceRegistration<?> serviceRegistration)

setOrAddSuppressedCause

public void setOrAddSuppressedCause(Throwable cause)

In case there is no cause, this will be the new one, otherwise the passed cause parameter will be add as a suppressed cause of the original.

starting

public void starting()

Called when the component is starting (activate method is called but it has not finished yet).

stopping

public void stopping()

Called when the component is stopping (The deactivate method runs).

unsatisfied

public void unsatisfied()

Called when the component becomes unsatisfied.

updateProperties

public void updateProperties(Map<String,Object> properties)

Called when the component properties are updated.

Parameters:

properties - The new properties of the component.s

updateSuitingsForAttribute

public void updateSuitingsForAttribute(org.everit.osgi.ecm.metadata.ReferenceMetadata referenceMetadata,
                                       org.everit.osgi.capabilitycollector.Suiting<?>[] suitings)

updatingConfiguration

public void updatingConfiguration()

Called when the state is changed to ComponentState.UPDATING_CONFIGURATION.