org.eclipse.gemini.blueprint.service.importer.support.internal.collection

Class OsgiServiceCollection

java.lang.Object

org.eclipse.gemini.blueprint.service.importer.support.internal.collection.OsgiServiceCollection

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, CollectionProxy, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

OsgiServiceList, OsgiServiceSet

public class OsgiServiceCollection
extends java.lang.Object
implements java.util.Collection, org.springframework.beans.factory.InitializingBean, CollectionProxy, org.springframework.beans.factory.DisposableBean

OSGi service dynamic collection - allows iterating while the underlying storage is being shrunk/expanded. This collection is read-only - its content is being retrieved dynamically from the OSGi platform.

This collection and its iterators are thread-safe. That is, multiple threads can access the collection. However, since the collection is read-only, it cannot be modified by the client.

See Also:

Collection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	OsgiServiceCollection.BaseListener Listener tracking the OSGi services which form the dynamic collection.
private static class	OsgiServiceCollection.EventResult
protected class	OsgiServiceCollection.OsgiServiceIterator Read-only iterator wrapper around the dynamic collection iterator.
private class	OsgiServiceCollection.ServiceInstanceListener

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.ClassLoader	classLoader TCCL to set between calling listeners
private org.osgi.framework.BundleContext	context
private OsgiServiceDependency	dependency dependency object
private java.lang.Object	eventSource dependable service importer
private org.osgi.framework.Filter	filter
private org.osgi.framework.ServiceListener	listener
private OsgiServiceLifecycleListener[]	listeners
private java.lang.Object	lock
private static org.apache.commons.logging.Log	log
private ServiceProxyCreator	proxyCreator Service proxy creator
private static org.apache.commons.logging.Log	PUBLIC_LOGGER
private boolean	serviceRequiredAtStartup
protected DynamicCollection<java.lang.Object>	services The dynamic collection.
protected java.util.Map<java.lang.Long,ProxyPlusCallback>	servicesIdMap
private java.lang.String	sourceName event source (importer) name
private java.util.List<ImporterStateListener>	stateListeners state listener
private boolean	useBlueprintExceptions
private boolean	useServiceReferences use references instead of instances inside the collection

Constructor Summary

Constructors

Constructor and Description
OsgiServiceCollection(org.osgi.framework.Filter filter, org.osgi.framework.BundleContext context, java.lang.ClassLoader classLoader, ServiceProxyCreator proxyCreator, boolean useServiceReference)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object o)
boolean	addAll(java.util.Collection c)
void	afterPropertiesSet()
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection c)
protected DynamicCollection<java.lang.Object>	createInternalDynamicStorage() Create the dynamic storage used internally.
void	destroy()
private void	invalidateProxy(ProxyPlusCallback ppc)
boolean	isEmpty()
boolean	isSatisfied() Is the underlying proxy satisfied? For dynamic, mandatory imports, this checks the service reference.
java.util.Iterator<java.lang.Object>	iterator()
protected void	mandatoryServiceCheck() Check to see whether at least one service is available.
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection c)
boolean	retainAll(java.util.Collection c)
void	setListeners(OsgiServiceLifecycleListener[] listeners)
void	setRequiredAtStartup(boolean serviceRequiredAtStartup)
void	setServiceImporter(java.lang.Object importer)
void	setServiceImporterName(java.lang.String name)
void	setStateListeners(java.util.List<ImporterStateListener> stateListeners)
void	setUseBlueprintExceptions(boolean useBlueprintExceptions)
int	size()
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] array)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

log

private static final org.apache.commons.logging.Log log

PUBLIC_LOGGER

private static final org.apache.commons.logging.Log PUBLIC_LOGGER

servicesIdMap

protected final java.util.Map<java.lang.Long,ProxyPlusCallback> servicesIdMap

services

protected DynamicCollection<java.lang.Object> services

The dynamic collection.

serviceRequiredAtStartup

private volatile boolean serviceRequiredAtStartup

filter

private final org.osgi.framework.Filter filter

context

private final org.osgi.framework.BundleContext context

classLoader

private final java.lang.ClassLoader classLoader

TCCL to set between calling listeners

proxyCreator

private final ServiceProxyCreator proxyCreator

Service proxy creator

listeners

private OsgiServiceLifecycleListener[] listeners

listener

private final org.osgi.framework.ServiceListener listener

stateListeners

private java.util.List<ImporterStateListener> stateListeners

state listener

lock

private final java.lang.Object lock

dependency

private OsgiServiceDependency dependency

dependency object

eventSource

private java.lang.Object eventSource

dependable service importer

sourceName

private java.lang.String sourceName

event source (importer) name

useServiceReferences

private final boolean useServiceReferences

use references instead of instances inside the collection

useBlueprintExceptions

private volatile boolean useBlueprintExceptions

Constructor Detail

OsgiServiceCollection

public OsgiServiceCollection(org.osgi.framework.Filter filter,
                             org.osgi.framework.BundleContext context,
                             java.lang.ClassLoader classLoader,
                             ServiceProxyCreator proxyCreator,
                             boolean useServiceReference)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

mandatoryServiceCheck

protected void mandatoryServiceCheck()

Check to see whether at least one service is available.

isSatisfied

public boolean isSatisfied()

Description copied from interface: CollectionProxy

Is the underlying proxy satisfied? For dynamic, mandatory imports, this checks the service reference. For optional imports, it always returns true.

Specified by:

isSatisfied in interface CollectionProxy

Returns:

createInternalDynamicStorage

protected DynamicCollection<java.lang.Object> createInternalDynamicStorage()

Create the dynamic storage used internally. The storage has to be thread-safe.

invalidateProxy

private void invalidateProxy(ProxyPlusCallback ppc)

setServiceImporter

public void setServiceImporter(java.lang.Object importer)

setServiceImporterName

public void setServiceImporterName(java.lang.String name)

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

size

public int size()

Specified by:

size in interface java.util.Collection

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.Collection

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.Collection

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.Collection

clear

public void clear()

Specified by:

clear in interface java.util.Collection

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.Collection

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.Collection

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] array)

Specified by:

toArray in interface java.util.Collection

setListeners

public void setListeners(OsgiServiceLifecycleListener[] listeners)

Parameters:

listeners - The listeners to set.

setRequiredAtStartup

public void setRequiredAtStartup(boolean serviceRequiredAtStartup)

setStateListeners

public void setStateListeners(java.util.List<ImporterStateListener> stateListeners)

setUseBlueprintExceptions

public void setUseBlueprintExceptions(boolean useBlueprintExceptions)