com.ibm.cos.v2.services.s3.internal.s3express

Class CachedS3ExpressCredentials

java.lang.Object

com.ibm.cos.v2.services.s3.internal.s3express.CachedS3ExpressCredentials

All Implemented Interfaces:

SdkAutoCloseable, AutoCloseable

public final class CachedS3ExpressCredentials
extends Object
implements SdkAutoCloseable

This class represents a single cached S3Express credential. It utilizes the existing class CachedSupplier to wrap the credential value and provide refresh capabilities, set with the NonBlocking prefetch strategy in order to get asynchronous refresh with a common thread pool.

Each time the value is requested through the get() method, the class delegates to the cached supplier to get the value. The cached supplier uses the refreshResult(Function, S3ExpressIdentityKey) function to retrieve the value.

Stale time - the time before, and relative to, the expiration time that the credentials are considered stale (invalid) Prefetch time - the time before, and relative, the expiration time that the credentials are eligible for refresh

       prefetch   stale expiration
 ---------|---------|---|---------------
          <-------->
           refresh
 

Make sure to close() instances when they are no longer used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachedS3ExpressCredentials.Builder

Method Summary

Modifier and Type	Method and Description
static CachedS3ExpressCredentials.Builder	builder(Function<S3ExpressIdentityKey,SessionCredentials> supplier)
void	close()
boolean	equals(Object o)
SessionCredentials	get()
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CachedS3ExpressCredentials.Builder builder(Function<S3ExpressIdentityKey,SessionCredentials> supplier)

get

public SessionCredentials get()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface SdkAutoCloseable

Specified by:

close in interface AutoCloseable