com.yahoo.bard.webservice.web.ratelimit

Interface RateLimitRequestToken

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BypassRateLimitRequestToken, CallbackRateLimitRequestToken

public interface RateLimitRequestToken
extends Closeable

Resource representing an outstanding request.

Method Summary

Modifier and Type	Method and Description
boolean	bind() Bind the counters to the token.
default void	close() By default, close will trigger unbind.
boolean	isBound() Check if the token is bound.
void	unBind() Release the token's counters.

Method Detail

isBound

boolean isBound()

Check if the token is bound.

Returns:

true if bound or false if rejected

bind

boolean bind()

Bind the counters to the token.

Returns:

true if the token was able to be bound or is already bounf, or false if rejected.

unBind

void unBind()

Release the token's counters.

close

default void close()
            throws IOException

By default, close will trigger unbind.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if close fails