com.yahoo.bard.webservice.web.ratelimit

Class CallbackRateLimitRequestToken

java.lang.Object

com.yahoo.bard.webservice.web.ratelimit.CallbackRateLimitRequestToken

All Implemented Interfaces:

RateLimitRequestToken, Closeable, AutoCloseable

public class CallbackRateLimitRequestToken
extends Object
implements RateLimitRequestToken

Request token that takes a rateLimitCleanup object on creation, and calls that to handle the cleanup when the request transaction is completed.

Constructor Summary

Constructors

Constructor and Description
CallbackRateLimitRequestToken(boolean isBound, RateLimitCleanupOnRequestComplete rateLimitCleanup) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	bind() Bind the counters to the token.
protected void	finalize()
boolean	isBound() Check if the token is bound.
void	unBind() Release the token's counters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.web.ratelimit.RateLimitRequestToken

close

Constructor Detail

CallbackRateLimitRequestToken

public CallbackRateLimitRequestToken(boolean isBound,
                                     RateLimitCleanupOnRequestComplete rateLimitCleanup)

Constructor.

Parameters:

isBound - Indicate whether or not the request associated with this token is valid (bound) or not

rateLimitCleanup - The callback for cleaning up after the request associated with this token is complete

Method Detail

isBound

public boolean isBound()

Description copied from interface: RateLimitRequestToken

Check if the token is bound.

Specified by:

isBound in interface RateLimitRequestToken

Returns:

true if bound or false if rejected

bind

public boolean bind()

Description copied from interface: RateLimitRequestToken

Bind the counters to the token.

Specified by:

bind in interface RateLimitRequestToken

Returns:

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

unBind

public void unBind()

Description copied from interface: RateLimitRequestToken

Release the token's counters.

Specified by:

unBind in interface RateLimitRequestToken

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable