com.google.api.control.aggregator

Class CheckRequestAggregator

java.lang.Object

com.google.api.control.aggregator.CheckRequestAggregator

public class CheckRequestAggregator
extends java.lang.Object

Caches and aggregates CheckRequests.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NON_CACHING The flush interval returned by getFlushIntervalMillis() when an instance is configured to be non-caching.

Constructor Summary

Constructors

Constructor and Description
CheckRequestAggregator(java.lang.String serviceName, CheckAggregationOptions options) Constructor.
CheckRequestAggregator(java.lang.String serviceName, CheckAggregationOptions options, java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds) Constructor.
CheckRequestAggregator(java.lang.String serviceName, CheckAggregationOptions options, java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds, com.google.common.base.Ticker ticker) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addResponse(com.google.api.servicecontrol.v1.CheckRequest req, com.google.api.servicecontrol.v1.CheckResponse resp) Adds the response from sending req to this instances cache.
com.google.api.servicecontrol.v1.CheckResponse	check(com.google.api.servicecontrol.v1.CheckRequest req) Determine if a cached response corresponds to req.
void	clear() Clears this instances cache of aggregated operations.
com.google.api.servicecontrol.v1.CheckRequest[]	flush() Flushes this instance's cache.
int	getFlushIntervalMillis()
java.lang.String	getServiceName()
static com.google.common.hash.HashCode	sign(com.google.api.servicecontrol.v1.CheckRequest value) Obtains the HashCode for the contents of value.

Methods inherited from class java.lang.Object

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

Field Detail

NON_CACHING

public static final int NON_CACHING

The flush interval returned by getFlushIntervalMillis() when an instance is configured to be non-caching.

See Also:

Constant Field Values

Constructor Detail

CheckRequestAggregator

public CheckRequestAggregator(java.lang.String serviceName,
                              CheckAggregationOptions options,
                              @Nullable
                              java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds,
                              @Nullable
                              com.google.common.base.Ticker ticker)

Constructor.

Parameters:

serviceName - the service whose CheckRequests are being aggregated

options - configures this instance's caching behavior

kinds - specifies the MetricDescriptor.MetricKind for specific metric names

ticker - the time source used to determine expiration. When not specified, this defaults to Ticker.systemTicker()

CheckRequestAggregator

public CheckRequestAggregator(java.lang.String serviceName,
                              CheckAggregationOptions options,
                              @Nullable
                              java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds)

Constructor.

Parameters:

serviceName - the service whose CheckRequests are being aggregated

options - configures this instances caching behavior

kinds - specifies the MetricDescriptor.MetricKind for specific metric names

CheckRequestAggregator

public CheckRequestAggregator(java.lang.String serviceName,
                              CheckAggregationOptions options)

Constructor.

Parameters:

serviceName - the service whose CheckRequests are being aggregated

options - configures this instances caching behavior

Method Detail

getFlushIntervalMillis

public int getFlushIntervalMillis()

Returns:

the interval in milliseconds between calls to flush()

getServiceName

public java.lang.String getServiceName()

Returns:

the service whose CheckRequests are being aggregated

clear

public void clear()

Clears this instances cache of aggregated operations. Is intended to be called by the driver before shutdown.

flush

public com.google.api.servicecontrol.v1.CheckRequest[] flush()

Flushes this instance's cache. The instance's driver should call the this method every getFlushIntervalMillis() milliseconds, and send the results to the check service.

Returns:

CheckRequest[] containing the CheckRequests that were pending

addResponse

public void addResponse(com.google.api.servicecontrol.v1.CheckRequest req,
                        com.google.api.servicecontrol.v1.CheckResponse resp)

Adds the response from sending req to this instances cache.

Parameters:

req - a CheckRequest

resp - the response from sending CheckResponse

check

@Nullable
public com.google.api.servicecontrol.v1.CheckResponse check(com.google.api.servicecontrol.v1.CheckRequest req)

Determine if a cached response corresponds to req. Determine if there are cache hits for the request in this instance as follows: Not in the Cache If req is not in the cache, it returns null, to indicate that the caller should send the request. Cache Hit, the response has errors When a cached response has errors, it's assumed that req, would fail as well, so the cached response is returned. However, the first request after the check interval has elapsed should be sent to the server to refresh the response - until its response is received, the subsequent reqs should still return the failed response. Cache Hit, the response passed When the cached response has no errors, it's assumed that the req would pass as well, so the response is return, with quota tracking updated so that it matches that in req.

Parameters:

req - a request to be sent to the service control service

Returns:

a CheckResponse if an applicable one is cached by this instance, otherwise null

sign

public static com.google.common.hash.HashCode sign(com.google.api.servicecontrol.v1.CheckRequest value)

Obtains the HashCode for the contents of value.

Parameters:

value - a CheckRequest to be signed

Returns:

the HashCode corresponding to value