domino.java

Interface ServiceConsuming

All Known Implementing Classes:

OsgiContext

public interface ServiceConsuming

Provides convenient methods to consume OSGi services.

Method Summary

Modifier and Type	Method and Description
<S> de.tototec.utils.functional.Optional<S>	service(java.lang.Class<S> type) Returns the highest-ranked service of the specified type if available.
<S> de.tototec.utils.functional.Optional<S>	service(java.lang.Class<S> type, java.lang.String filter) Returns the first available service of the specified class which satisfies the filter if available.
<S> de.tototec.utils.functional.Optional<org.osgi.framework.ServiceReference<S>>	serviceRef(java.lang.Class<? super S> type) Like service(Class) but returns the reference so you can access meta information about that service.
<S> de.tototec.utils.functional.Optional<org.osgi.framework.ServiceReference<S>>	serviceRef(java.lang.Class<S> type, java.lang.String filter) Like service(Class, String) with filter but returns the service reference.
<S> java.util.Collection<org.osgi.framework.ServiceReference<S>>	serviceRefs(java.lang.Class<S> type, java.lang.String filter) Like services(Class, String) with filters but returns the references.
<S> java.util.List<S>	services(java.lang.Class<S> type) Returns all services of the given type.
<S> java.util.List<S>	services(java.lang.Class<S> type, java.lang.String filter) Returns all services of the specified type which satisfy the given filter.
<S,R> R	withService(java.lang.Class<S> type, de.tototec.utils.functional.F1<de.tototec.utils.functional.Optional<S>,R> f) Executes the given handler with the highest-ranked service of the specified type.

Method Detail

withService

<S,R> R withService(java.lang.Class<S> type,
                    de.tototec.utils.functional.F1<de.tototec.utils.functional.Optional<S>,R> f)

Executes the given handler with the highest-ranked service of the specified type. If it's not available, it still executes it but with `None`. Doesn't take type parameters into account! When the handler returns, the service is released using BundleContext.ungetService(org.osgi.framework.ServiceReference).

Parameters:

f - Handler that uses the service.

Returns:

The handler result.

serviceRef

<S> de.tototec.utils.functional.Optional<org.osgi.framework.ServiceReference<S>> serviceRef(java.lang.Class<? super S> type)

Like service(Class) but returns the reference so you can access meta information about that service. An implicit conversion adds a `service` property to the reference, so you can simply use that to obtain the service. Doesn't take type parameters into account!

serviceRef

<S> de.tototec.utils.functional.Optional<org.osgi.framework.ServiceReference<S>> serviceRef(java.lang.Class<S> type,
                                                                                            java.lang.String filter)

Like service(Class, String) with filter but returns the service reference.

serviceRefs

<S> java.util.Collection<org.osgi.framework.ServiceReference<S>> serviceRefs(java.lang.Class<S> type,
                                                                             java.lang.String filter)

Like services(Class, String) with filters but returns the references.

service

<S> de.tototec.utils.functional.Optional<S> service(java.lang.Class<S> type)

Returns the highest-ranked service of the specified type if available. The service is not explicitly released. It's assumed that the service will be used until the bundle stops. Doesn't take type parameters into account!

Returns:

service if available

service

<S> de.tototec.utils.functional.Optional<S> service(java.lang.Class<S> type,
                                                    java.lang.String filter)

Returns the first available service of the specified class which satisfies the filter if available. If the service is not available, it returns `None`. The service is not explicitly released.

Parameters:

filter - filter expression

Returns:

service if available

services

<S> java.util.List<S> services(java.lang.Class<S> type,
                               java.lang.String filter)

Returns all services of the specified type which satisfy the given filter.

Parameters:

filter - filter expression

Returns:

services

services

<S> java.util.List<S> services(java.lang.Class<S> type)

Returns all services of the given type.