Package org.osgi.service.cdi.reference
Interface BeanServiceObjects<S>
- Type Parameters:
S
- Type of Service
@ProviderType
public interface BeanServiceObjects<S>
Allows multiple service objects for a service to be obtained.
A component instance can receive a BeanServiceObjects
object via a
reference that is typed BeanServiceObjects
.
For services with prototype
scope, multiple
service objects for the service can be obtained. For services with
singleton
or bundle
scope, only one, use-counted service object is available.
Any unreleased service objects obtained from this BeanServiceObjects
object are automatically released by Service Component Runtime when the
service becomes unbound.
- See Also:
- "ThreadSafe"
-
Method Summary
Modifier and TypeMethodDescriptionReturns a service object for theassociated
service.Returns theServiceReference
for the service associated with thisBeanServiceObjects
object.void
ungetService
(S service) Releases a service object for theassociated
service.
-
Method Details
-
getService
S getService()Returns a service object for theassociated
service.This method will always return
null
when the associated service has been become unbound.- Returns:
- A service object for the associated service or
null
if the service is unbound, the customized service object returned by aServiceFactory
does not implement the classes under which it was registered or theServiceFactory
threw an exception. - Throws:
IllegalStateException
- If the component instance that received thisBeanServiceObjects
object has been deactivated.- See Also:
-
ungetService
Releases a service object for theassociated
service.The specified service object must no longer be used and all references to it should be destroyed after calling this method.
- Parameters:
service
- A service object previously provided by thisReferenceServiceObjects
object.- Throws:
IllegalStateException
- If the component instance that received thisReferenceServiceObjects
object has been deactivated.IllegalArgumentException
- If the specified service object was not provided by thisBeanServiceObjects
object.- See Also:
-
getServiceReference
ServiceReference<S> getServiceReference()Returns theServiceReference
for the service associated with thisBeanServiceObjects
object.- Returns:
- The
ServiceReference
for the service associated with thisBeanServiceObjects
object.
-