org.apache.aries.mocks
Class BundleContextMock

java.lang.Object
  org.apache.aries.mocks.BundleContextMock

public class BundleContextMock
extends Object

This class is a partial implementation of BundleContext. Its main function is to provide a service registry implementation

Constructor Summary

BundleContextMock()
Default constructor, widely used in the tests.

BundleContextMock(org.osgi.framework.Bundle b)
Constructor used by BundleMock, it ensures the bundle and its context are wired together correctly.

Method Summary

void	addBundle(org.osgi.framework.Bundle b)
void	addServiceListener(org.osgi.framework.ServiceListener listener) Add a service listener.
void	addServiceListener(org.osgi.framework.ServiceListener listener, String filter) Add a service listener.
static void	assertNoServiceExists(String interfaceName) This checks that we have at no services with this interface name.
static void	assertServiceExists(String interfaceName) This checks that we have at least one service with this interface name.
static void	clear() This method clears the service registry.
org.osgi.framework.ServiceReference[]	getAllServiceReferences(String className, String filter) This method finds all the service references in the registry with the matching class name and filter.
org.osgi.framework.Bundle	getBundle()
org.osgi.framework.Bundle[]	getBundles()
String	getProperty(String name)
Object	getService(org.osgi.framework.ServiceReference ref) Retrieve a service from the registry.
static Object	getService(String interfaceName, org.osgi.framework.Bundle bundle) This helper method is used to get the service from the registry with the given interface name.
static List<org.osgi.framework.ServiceListener>	getServiceListeners()
org.osgi.framework.ServiceReference	getServiceReference(String className) Gets the first matching service reference.
org.osgi.framework.ServiceReference[]	getServiceReferences(String className, String filter) A mock implementation of the getServiceReferences method.
org.osgi.framework.Bundle	installBundle(String location) Asks to install an OSGi bundle from the given location.
org.osgi.framework.Bundle	installBundle(String location, InputStream is) This method implements the installBundle method from BundleContext.
org.osgi.framework.ServiceRegistration	registerService(String[] interfaces, Object service, Dictionary<String,Object> properties) This implements the registerService method from BundleContext.
org.osgi.framework.ServiceRegistration	registerService(String interFace, Object service, Dictionary<String,Object> properties) This implements the registerService method from BundleContext.
void	removeServiceListener(org.osgi.framework.ServiceListener listener) Remove a service listener

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleContextMock

public BundleContextMock()

Default constructor, widely used in the tests.

BundleContextMock

public BundleContextMock(org.osgi.framework.Bundle b)

Constructor used by BundleMock, it ensures the bundle and its context are wired together correctly. TODO We have to many Bundle mocks objects for a single OSGi bundle, we need to update this.

Parameters:

b -

Method Detail

assertServiceExists

public static void assertServiceExists(String interfaceName)

This checks that we have at least one service with this interface name.

Parameters:

interfaceName - the name of the interface.

assertNoServiceExists

public static void assertNoServiceExists(String interfaceName)

This checks that we have at no services with this interface name.

Parameters:

interfaceName - the name of the interface.

registerService

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

This implements the registerService method from BundleContext.

Parameters:

interFace -

service -

properties -

Returns:

the ServiceRegistration object for this service.

registerService

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

This implements the registerService method from BundleContext.

Parameters:

interfaces -

service -

properties -

Returns:

the ServiceRegistration object for this service.

getService

public static Object getService(String interfaceName,
                                org.osgi.framework.Bundle bundle)

This helper method is used to get the service from the registry with the given interface name.

This should really return multiple services.

Parameters:

interfaceName - the interface name.

bundle - the bundle name.

Returns:

the registered service.

getServiceReferences

public org.osgi.framework.ServiceReference[] getServiceReferences(String className,
                                                                  String filter)
                                                           throws org.osgi.framework.InvalidSyntaxException

A mock implementation of the getServiceReferences method. It does not currently process the filter, this is probably a bit hard, so we might cheat when we do.

Note this does not check that the service classes are visible to the caller as OSGi does. It is equivalent to getAllServiceReferences.

Parameters:

className - the name of the class the lookup is for.

filter -

Returns:

an array of matching service references.

Throws:

org.osgi.framework.InvalidSyntaxException

getServiceReference

public org.osgi.framework.ServiceReference getServiceReference(String className)

Gets the first matching service reference.

Parameters:

className - the class name wanted.

Returns:

the matchine service, or null if one cannot be found.

getAllServiceReferences

public org.osgi.framework.ServiceReference[] getAllServiceReferences(String className,
                                                                     String filter)
                                                              throws org.osgi.framework.InvalidSyntaxException

This method finds all the service references in the registry with the matching class name and filter.

Parameters:

className -

filter -

Returns:

the matching service references.

Throws:

org.osgi.framework.InvalidSyntaxException

getService

public Object getService(org.osgi.framework.ServiceReference ref)

Retrieve a service from the registry.

Parameters:

ref - the service reference.

Returns:

the returned service.

installBundle

public org.osgi.framework.Bundle installBundle(String location,
                                               InputStream is)
                                        throws org.osgi.framework.BundleException

This method implements the installBundle method from BundleContext. It makes use of the java.util.jar package to parse the manifest from the input stream.

Parameters:

location - the location of the bundle.

is - the input stream to read from.

Returns:

the created bundle.

Throws:

org.osgi.framework.BundleException

installBundle

public org.osgi.framework.Bundle installBundle(String location)
                                        throws org.osgi.framework.BundleException

Asks to install an OSGi bundle from the given location.

Parameters:

location - the location of the bundle on the file system.

Returns:

the installed bundle.

Throws:

org.osgi.framework.BundleException

getBundles

public org.osgi.framework.Bundle[] getBundles()

Returns:

all the bundles in the system

addServiceListener

public void addServiceListener(org.osgi.framework.ServiceListener listener,
                               String filter)

Add a service listener.

Parameters:

listener -

filter -

addServiceListener

public void addServiceListener(org.osgi.framework.ServiceListener listener)

Add a service listener.

Parameters:

listener -

removeServiceListener

public void removeServiceListener(org.osgi.framework.ServiceListener listener)

Remove a service listener

Parameters:

listener -

getProperty

public String getProperty(String name)

getBundle

public org.osgi.framework.Bundle getBundle()

Returns:

the bundle associated with this bundle context (if we created one).

clear

public static void clear()

This method clears the service registry.

getServiceListeners

public static List<org.osgi.framework.ServiceListener> getServiceListeners()

addBundle

public void addBundle(org.osgi.framework.Bundle b)