org.opendaylight.controller.config.api.osgi

Class WaitingServiceTracker<T>

java.lang.Object

org.opendaylight.controller.config.api.osgi.WaitingServiceTracker<T>

All Implemented Interfaces:

AutoCloseable

public final class WaitingServiceTracker<T>
extends Object
implements AutoCloseable

Tracker that waits for an OSGi service.

Author:

Thomas Pantelis

Field Summary

Fields

Modifier and Type	Field and Description
static long	FIVE_MINUTES

Method Summary

Modifier and Type	Method and Description
void	close()
static <T> WaitingServiceTracker<T>	create(Class<T> serviceInterface, org.osgi.framework.BundleContext context) Creates an instance.
static <T> WaitingServiceTracker<T>	create(Class<T> serviceInterface, org.osgi.framework.BundleContext context, String filter) Creates an instance.
T	waitForService(long timeoutInMillis) Waits for an OSGi services.

Methods inherited from class java.lang.Object

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

Field Detail

FIVE_MINUTES

public static final long FIVE_MINUTES

Method Detail

waitForService

public T waitForService(long timeoutInMillis)
                 throws ServiceNotFoundException

Waits for an OSGi services.

Parameters:

timeoutInMillis - the timeout in millis

Returns:

the service instance

Throws:

ServiceNotFoundException - if it times out or is interrupted

create

public static <T> WaitingServiceTracker<T> create(@Nonnull
                                                  Class<T> serviceInterface,
                                                  @Nonnull
                                                  org.osgi.framework.BundleContext context)

Creates an instance.

Parameters:

serviceInterface - the service interface

context - the BundleContext

Returns:

new WaitingServiceTracker instance

create

public static <T> WaitingServiceTracker<T> create(@Nonnull
                                                  Class<T> serviceInterface,
                                                  @Nonnull
                                                  org.osgi.framework.BundleContext context,
                                                  @Nonnull
                                                  String filter)

Creates an instance.

Parameters:

serviceInterface - the service interface

context - the BundleContext

filter - the OSGi service filter

Returns:

new WaitingServiceTracker instance

close

public void close()

Specified by:

close in interface AutoCloseable