org.ops4j.pax.swissbox.tracker

Class ServiceLookup

java.lang.Object

org.ops4j.pax.swissbox.tracker.ServiceLookup

public class ServiceLookup
extends Object

A utility class for looking up services from the OSGi registry. The methods of this class wait for the service for a given timeout (default 10 seconds) and throw a TestContainerException when no matching service becomes available during this period.

NOTE: Prefixing some method calls with our own class name is a workaround for a bug in the Oracle Java compiler, which does not occur when compiling in Eclipse.

Author:

Harald Wellmann

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT Default timeout used for service lookup when no explicit timeout is specified.

Constructor Summary

Constructors

Constructor and Description
ServiceLookup()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	getService(org.osgi.framework.BundleContext bc, Class<T> type) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, Class<T> type, long timeout) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, Class<T> type, long timeout, Map<String,String> props) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, Class<T> type, long timeout, String filter) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, Class<T> type, Map<String,String> props) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, String className) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, String className, long timeout, Map<String,String> props) Returns a service matching the given criteria.
static <T> T	getService(org.osgi.framework.BundleContext bc, String className, long timeout, String filter) Returns a service matching the given criteria.
static Object	getServiceByFilter(org.osgi.framework.BundleContext bc, String ldapFilter) Returns a service matching the given filter.
static Object	getServiceByFilter(org.osgi.framework.BundleContext bc, String ldapFilter, long timeout) Returns a service matching the given filter.
static org.osgi.framework.ServiceReference	getServiceReference(org.osgi.framework.BundleContext bc, String className, long timeout, String filter) Returns a service reference matching the given criteria.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

Default timeout used for service lookup when no explicit timeout is specified.

See Also:

Constant Field Values

Constructor Detail

ServiceLookup

public ServiceLookup()

Method Detail

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               String className)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

className - name of class implemented or extended by the service

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               Class<T> type)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

type - class implemented or extended by the service

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               Class<T> type,
               Map<String,String> props)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

type - class implemented or extended by the service

props - properties to be matched by the service

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               Class<T> type,
               long timeout,
               Map<String,String> props)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

type - class implemented or extended by the service

timeout - maximum wait period in milliseconds

props - properties to be matched by the service

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               Class<T> type,
               long timeout)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

type - class implemented or extended by the service

timeout - maximum wait period in milliseconds

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               Class<T> type,
               long timeout,
               String filter)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

type - class implemented or extended by the service

timeout - maximum wait period in milliseconds

filter - LDAP filter to be matched by the service. The class name will be added to the filter.

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               String className,
               long timeout,
               Map<String,String> props)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

className - name of class implemented or extended by the service

timeout - maximum wait period in milliseconds

props - properties to be matched by the service

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getService

public static <T> T getService(org.osgi.framework.BundleContext bc,
               String className,
               long timeout,
               String filter)

Returns a service matching the given criteria.

Type Parameters:

T - class implemented or extended by the service

Parameters:

bc - bundle context for accessing the OSGi registry

className - name of class implemented or extended by the service

timeout - maximum wait period in milliseconds

filter - LDAP filter to be matched by the service. The class name will be added to the filter.

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout

getServiceReference

public static org.osgi.framework.ServiceReference getServiceReference(org.osgi.framework.BundleContext bc,
                                                      String className,
                                                      long timeout,
                                                      String filter)

Returns a service reference matching the given criteria.

Parameters:

bc - bundle context for accessing the OSGi registry

className - name of class implemented or extended by the service

timeout - maximum wait period in milliseconds

filter - LDAP filter to be matched by the service. The class name will be added to the filter.

Returns:

matching service reference (not null)

Throws:

ServiceLookupException

getServiceByFilter

public static Object getServiceByFilter(org.osgi.framework.BundleContext bc,
                        String ldapFilter)

Returns a service matching the given filter.

Parameters:

bc - bundle context for accessing the OSGi registry

ldapFilter - LDAP filter to be matched by the service. The class name must be part of the filter.

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the default timeout

getServiceByFilter

public static Object getServiceByFilter(org.osgi.framework.BundleContext bc,
                        String ldapFilter,
                        long timeout)

Returns a service matching the given filter.

Parameters:

bc - bundle context for accessing the OSGi registry

ldapFilter - LDAP filter to be matched by the service. The class name must be part of the filter.

timeout - maximum wait period in milliseconds

Returns:

matching service (not null)

Throws:

ServiceLookupException - when no matching service has been found after the timeout