Package com.illumon.iris.db.v2.locations.util

Interface TableDataRefreshService

All Known Implementing Classes:

ExecutorTableDataRefreshService, TableDataRefreshService.Null

public interface TableDataRefreshService

For TableDataService and related components, this allows a simple implementation for subscription support.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TableDataRefreshService.CancellableSubscriptionToken	A subscription token interface with cancellation support.
static final class	TableDataRefreshService.Helper	Static helper class for holding and building the shared instance.
static final class	TableDataRefreshService.Null	"Null" instance, intended for unit tests and other standalone scenarios.

Method Summary

Modifier and Type	Method	Description
static TableDataRefreshService	getSharedRefreshService()	Get (and possibly construct) a shared instance.
TableDataRefreshService.CancellableSubscriptionToken	scheduleTableLocationProviderRefresh(AbstractTableLocationProvider tableLocationProvider)	Schedule refresh for an AbstractTableLocationProvider.
TableDataRefreshService.CancellableSubscriptionToken	scheduleTableLocationRefresh(AbstractTableLocation tableLocation)	Schedule refresh for an AbstractTableLocation.
void	shutdown()	Shutdown the service.
void	submitOneTimeAsyncTask(Runnable task)	Submit a one-time task to be run asynchronously.

Method Details

submitOneTimeAsyncTask

void submitOneTimeAsyncTask(@NotNull
 Runnable task)

Submit a one-time task to be run asynchronously.

Parameters:

task - The task to run

scheduleTableLocationProviderRefresh

TableDataRefreshService.CancellableSubscriptionToken scheduleTableLocationProviderRefresh(@NotNull
 AbstractTableLocationProvider tableLocationProvider)

Schedule refresh for an AbstractTableLocationProvider.

Parameters:

tableLocationProvider - The table location provider

Returns:

A subscription token to be used for matching, which also supports cancellation

scheduleTableLocationRefresh

TableDataRefreshService.CancellableSubscriptionToken scheduleTableLocationRefresh(@NotNull
 AbstractTableLocation tableLocation)

Schedule refresh for an AbstractTableLocation.

Parameters:

tableLocation - The table location

Returns:

A subscription token to be used for matching, which also supports cancellation

shutdown

void shutdown()

Shutdown the service. It will no longer be used.

getSharedRefreshService

static TableDataRefreshService getSharedRefreshService()

Get (and possibly construct) a shared instance.

Returns:

The shared instance