org.apache.beam.sdk.io.aws2.common

Class ClientPool<ProviderT,ConfigT,ClientT extends java.lang.AutoCloseable>

java.lang.Object

org.apache.beam.sdk.io.aws2.common.ClientPool<ProviderT,ConfigT,ClientT>

Type Parameters:

ProviderT - Client provider

ConfigT - Optional, nullable configuration

ClientT - Client

public class ClientPool<ProviderT,ConfigT,ClientT extends java.lang.AutoCloseable>
extends java.lang.Object

Reference counting pool to easily share AWS clients or similar by individual client provider and configuration (optional).

NOTE: This relies heavily on the implementation of Object.equals(Object) for ProviderT and ConfigT. If not implemented properly, clients can't be shared between instances of DoFn.

Constructor Summary

Constructors

Constructor and Description
ClientPool(java.util.function.BiFunction<ProviderT,ConfigT,ClientT> builder)

Method Summary

Modifier and Type	Method and Description
static <ClientT extends java.lang.AutoCloseable,BuilderT extends AwsClientBuilder<BuilderT,ClientT>> ClientPool<AwsOptions,ClientConfiguration,ClientT>	pooledClientFactory(BuilderT builder)
void	release(ClientT client) Release a reference to a shared client instance.
void	release(ProviderT provider, ConfigT config) Release a reference to a shared client instance using ProviderT and ConfigT .
ClientT	retain(ProviderT provider, ConfigT config) Retain a reference to a shared client instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientPool

public ClientPool(java.util.function.BiFunction<ProviderT,ConfigT,ClientT> builder)

Method Detail

pooledClientFactory

public static <ClientT extends java.lang.AutoCloseable,BuilderT extends AwsClientBuilder<BuilderT,ClientT>> ClientPool<AwsOptions,ClientConfiguration,ClientT> pooledClientFactory(BuilderT builder)

retain

public ClientT retain(ProviderT provider,
                      ConfigT config)

Retain a reference to a shared client instance. If not available, an instance is created.

release

public void release(ProviderT provider,
                    ConfigT config)
             throws java.lang.Exception

Release a reference to a shared client instance using ProviderT and ConfigT . If that instance is not used anymore, it will be removed and destroyed.

Throws:

java.lang.Exception

release

public void release(ClientT client)
             throws java.lang.Exception

Release a reference to a shared client instance. If that instance is not used anymore, it will be removed and destroyed.

Throws:

java.lang.Exception