com.ibm.cos.v2.retries.api.internal

Class AcquireInitialTokenRequestImpl

java.lang.Object

com.ibm.cos.v2.retries.api.internal.AcquireInitialTokenRequestImpl

All Implemented Interfaces:

AcquireInitialTokenRequest

public final class AcquireInitialTokenRequestImpl
extends Object
implements AcquireInitialTokenRequest

Implementation of the AcquireInitialTokenRequest interface.

Method Summary

Modifier and Type	Method and Description
static AcquireInitialTokenRequest	create(String scope) Creates a new AcquireInitialTokenRequestImpl instance with the given scope.
String	scope() An abstract scope for the attempts about to be executed.

Methods inherited from class java.lang.Object

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

Method Detail

scope

public String scope()

Description copied from interface: AcquireInitialTokenRequest

An abstract scope for the attempts about to be executed.

A scope should be a unique string describing the smallest possible scope of failure for the attempts about to be executed. In practical terms, this is a key for the token bucket used to throttle request attempts. All attempts with the same scope share the same token bucket within the same RetryStrategy, ensuring that token-bucket throttling for requests against one resource do not result in throttling for requests against other, unrelated resources.

Specified by:

scope in interface AcquireInitialTokenRequest

create

public static AcquireInitialTokenRequest create(String scope)

Creates a new AcquireInitialTokenRequestImpl instance with the given scope.

Specified by:

create in interface AcquireInitialTokenRequest