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

Class ObjectPool<KeyT extends @NonNull Object,ObjectT extends @NonNull Object>

java.lang.Object

org.apache.beam.sdk.io.aws2.common.ObjectPool<KeyT,ObjectT>

Type Parameters:

KeyT - > Key to share objects by

ObjectT - > Shared object

Direct Known Subclasses:

ObjectPool.ClientPool

@Internal
public class ObjectPool<KeyT extends @NonNull Object,ObjectT extends @NonNull Object>
extends Object

Reference counting object pool to easily share invalid input: '&' destroy objects.

Internal only, subject to incompatible changes or removal at any time!

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectPool.ClientPool<ClientT extends SdkClient>	Client pool to easily share AWS clients per configuration.

Constructor Summary

Constructors

Constructor	Description
ObjectPool(Function<KeyT,ObjectT> builder)
ObjectPool(Function<KeyT,ObjectT> builder, @Nullable ThrowingConsumer<Exception,ObjectT> finalizer)

Method Summary

Modifier and Type	Method	Description
static <ClientT extends SdkClient, BuilderT extends AwsClientBuilder<BuilderT, ClientT>> ObjectPool.ClientPool<ClientT>	pooledClientFactory(BuilderT builder)
void	release(ObjectT object)	Release a reference to a shared client instance.
void	releaseByKey(KeyT key)	Release a reference to a shared object instance using ObjectPool.
ObjectT	retain(KeyT key)	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 Details

ObjectPool

public ObjectPool(Function<KeyT,ObjectT> builder)

ObjectPool

public ObjectPool(Function<KeyT,ObjectT> builder,
 @Nullable ThrowingConsumer<Exception,ObjectT> finalizer)

Method Details

retain

public ObjectT retain(KeyT key)

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

releaseByKey

public void releaseByKey(KeyT key)

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

release

public void release(ObjectT object)

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

pooledClientFactory

public static <ClientT extends SdkClient,
BuilderT extends AwsClientBuilder<BuilderT,
ClientT>>
ObjectPool.ClientPool<ClientT> pooledClientFactory(BuilderT builder)