Top Description Fields Constructors Methods
com.oracle.bmc.util.internal

public Class RefreshAuthTokenTransformingFuture<FROM, TO>

extends Object
implements Future<TO>
Class Inheritance
All Implemented Interfaces
java.util.concurrent.Future
Type Parameters
<FROM>
The type returned by the delegate Future.
<TO>
The type to convert to.
Imports
java.util.concurrent.ExecutionException, .Future, .TimeUnit, .TimeoutException, com.oracle.bmc.auth.RefreshableOnNotAuthenticatedProvider, com.oracle.bmc.model.BmcException, java.util.function.Function, .Supplier, jakarta.annotation.Nonnull, org.slf4j.Logger

Deprecated

in favor of RefreshAuthTokenWrapper -- versions after 1.25.1 do not use RefreshAuthTokenTransformingFuture anymore

Future that both delegates to another one and provides the ability to transform the response to another type. This is intended to work with some authenticated calls, like instance principals, and has handling so that if we receive a 401, we'll refresh the auth token and then try again.

This is to account for scenarios where we have a valid/non-expired token but the permissions for the instance have changed since the token was issued and so on the server-side the presented token is considered invalid.

Field Summary

Modifier and TypeField and Description
private final RefreshableOnNotAuthenticatedProvider<?>
authProvider

private Future<FROM>
delegate

private final Supplier<Future<FROM>>
generateNewFutureForRetry

private static final Logger
LOG

private final Function<FROM, TO>
transformer

Constructor Summary

AccessConstructor and Description
public
RefreshAuthTokenTransformingFuture(Future<FROM> delegate, Function<FROM, TO> transformer, RefreshableOnNotAuthenticatedProvider<?> authProvider, Supplier<Future<FROM>> generateNewFutureForRetry)

Method Summary

Modifier and TypeMethod and Description
public boolean
cancel(boolean
true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete
mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task.

public TO
get()

Implements java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

public TO
get(long
the maximum time to wait
timeout, TimeUnit
the time unit of the timeout argument
unit)

Implements java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

public boolean
isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

public boolean
isDone()

Implements java.util.concurrent.Future.isDone.

Returns true if this task completed.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

authProviderback to summary
private final RefreshableOnNotAuthenticatedProvider<?> authProvider
delegateback to summary
private Future<FROM> delegate
Annotations
@Nonnull
generateNewFutureForRetryback to summary
private final Supplier<Future<FROM>> generateNewFutureForRetry
LOGback to summary
private static final Logger LOG
transformerback to summary
private final Function<FROM, TO> transformer

Constructor Detail

RefreshAuthTokenTransformingFutureback to summary
public RefreshAuthTokenTransformingFuture(Future<FROM> delegate, Function<FROM, TO> transformer, RefreshableOnNotAuthenticatedProvider<?> authProvider, Supplier<Future<FROM>> generateNewFutureForRetry)

Method Detail

cancelback to summary
public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Parameters
mayInterruptIfRunning:boolean

true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete

Returns:boolean

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations
@Override
getback to summary
public TO get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:TO

the computed result

Annotations
@Override
Exceptions
InterruptedException:
if the current thread was interrupted while waiting
ExecutionException:
if the computation threw an exception
getback to summary
public TO get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters
timeout:long

the maximum time to wait

unit:TimeUnit

the time unit of the timeout argument

Returns:TO

the computed result

Annotations
@Override
Exceptions
InterruptedException:
if the current thread was interrupted while waiting
ExecutionException:
if the computation threw an exception
TimeoutException:
if the wait timed out
isCancelledback to summary
public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations
@Override
isDoneback to summary
public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations
@Override