Package io.joynr.jeeintegration

Class JeeJoynrServiceLocator.JeeJoynrServiceFutureProxyBuilder<T>

java.lang.Object

io.joynr.jeeintegration.JeeJoynrServiceLocator.JeeJoynrServiceFutureProxyBuilder<T>

All Implemented Interfaces:

ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>

Enclosing class:

JeeJoynrServiceLocator

public class JeeJoynrServiceLocator.JeeJoynrServiceFutureProxyBuilder<T>
extends Object
implements ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>

Method Summary

Modifier and Type	Method	Description
CompletableFuture<T>	build()	Create the service proxy using all of the settings previously setup using the 'with*' methods.
ServiceLocator.ServiceProxyBuilder<CompletableFuture<CompletableFuture<T>>>	useFuture()	If you want to have a CompletableFuture returned which will complete when the proxy has been fully created and initialised successfully, then call this method before calling ServiceLocator.ServiceProxyBuilder.build().
ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>	withCallback(ProxyBuilder.ProxyCreatedCallback<CompletableFuture<T>> callback)	Set the callback to use when creating the proxy.
ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>	withDiscoveryQos(DiscoveryQos discoveryQos)	Set the discovery quality-of-service to use when looking up the service which the proxy will talk to.
ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>	withGbids(String[] gbids)	Set the GBIDs to use when looking up the service which the proxy will talk to.
ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>	withMessagingQos(MessagingQos messagingQos)	Set the messaging quality-of-service to use when sending messages from the resulting proxy.
ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>	withTtl(long ttl)	Set the time to live for messages being sent from the resulting proxy.
ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>>	withUseCase(String useCase)	Set the stateless async use case name use to find the relevant CallbackHandler to use for processing stateless async replies resulting from requests sent from this proxy.

Methods inherited from class java.lang.Object

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

Method Detail

withTtl

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>> withTtl(long ttl)

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Set the time to live for messages being sent from the resulting proxy. Subsequent calls to ServiceLocator.ServiceProxyBuilder.withMessagingQos(MessagingQos) will override any value you set via this method. If you want to set other messaging QoS values, then you should simply set the TTL on a messaging QoS instance and call ServiceLocator.ServiceProxyBuilder.withMessagingQos(MessagingQos).

Specified by:

withTtl in interface ServiceLocator.ServiceProxyBuilder<T>

Parameters:

ttl - the time to live to use when sending messages from the proxy.

Returns:

the builder.

withMessagingQos

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>> withMessagingQos(MessagingQos messagingQos)

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Set the messaging quality-of-service to use when sending messages from the resulting proxy.

Specified by:

withMessagingQos in interface ServiceLocator.ServiceProxyBuilder<T>

Parameters:

messagingQos - the messaging quality-of-service to use.

Returns:

the builder.

withDiscoveryQos

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>> withDiscoveryQos(DiscoveryQos discoveryQos)

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Set the discovery quality-of-service to use when looking up the service which the proxy will talk to.

Specified by:

withDiscoveryQos in interface ServiceLocator.ServiceProxyBuilder<T>

Parameters:

discoveryQos - the discovery quality-of-service to use.

Returns:

the builder.

withUseCase

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>> withUseCase(String useCase)

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Set the stateless async use case name use to find the relevant CallbackHandler to use for processing stateless async replies resulting from requests sent from this proxy.

Specified by:

withUseCase in interface ServiceLocator.ServiceProxyBuilder<T>

Parameters:

useCase - stateless async use case name

Returns:

the builder.

withGbids

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>> withGbids(String[] gbids)

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Set the GBIDs to use when looking up the service which the proxy will talk to.

Specified by:

withGbids in interface ServiceLocator.ServiceProxyBuilder<T>

Parameters:

gbids - an array of GBIDs

Returns:

the builder.

withCallback

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<T>> withCallback(ProxyBuilder.ProxyCreatedCallback<CompletableFuture<T>> callback)

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Set the callback to use when creating the proxy. The callback can be used to be informed of when the proxy is successfully attached to the provider or in the case that this fails.

Specified by:

withCallback in interface ServiceLocator.ServiceProxyBuilder<T>

Parameters:

callback - the callback to use when building the proxy.

Returns:

the builder.

useFuture

public ServiceLocator.ServiceProxyBuilder<CompletableFuture<CompletableFuture<T>>> useFuture()

Description copied from interface: ServiceLocator.ServiceProxyBuilder

If you want to have a CompletableFuture returned which will complete when the proxy has been fully created and initialised successfully, then call this method before calling ServiceLocator.ServiceProxyBuilder.build(). This also allows you to react to any error encountered while attempting to initialise the proxy, such as encountering discovery timeouts if the requested provider isn't available in time. If you want to additionally use a callback make sure to set the callback on the builder before calling this method, as it will not be possible any more after the call to useFuture().

Specified by:

useFuture in interface ServiceLocator.ServiceProxyBuilder<T>

Returns:

returns a version of the proxy builder which returns a CompletableFuture for the proxy rather than the proxy itself.

build

public CompletableFuture<T> build()

Description copied from interface: ServiceLocator.ServiceProxyBuilder

Create the service proxy using all of the settings previously setup using the 'with*' methods.

Specified by:

build in interface ServiceLocator.ServiceProxyBuilder<T>

Returns:

the service proxy. Alternatively a CompletableFuture which will yield the service proxy upon successful completion if you previously called ServiceLocator.ServiceProxyBuilder.useFuture().