thredds.servlet

Interface DataRootHandler.ConfigListener

All Known Implementing Classes:

RestrictedAccessConfigListener

Enclosing class:

DataRootHandler

public static interface DataRootHandler.ConfigListener

To receive notice of TDS configuration events, implement this interface and use the DataRootHandler.registerConfigListener() method to register an instance with a DataRootHandler instance.

Configuration events include start and end of configuration, inclusion of a catalog in configuration, and finding a dataset in configuration.

Concurrency issues:
1) As this is a servlet framework, requests that configuration be reinitialized may occur concurrently with requests for the information the listener is keeping. Be careful not to allow access to the information during configuration.
2) The longer the configuration process, the more time there is to have a concurrency issue come up. So, try to keep responses to these events fairly light weight. Or build new configuration information and synchronize and switch only when the already built config information is being switched with the existing config information.

Method Summary

Methods

Modifier and Type	Method and Description
void	configCatalog(InvCatalog catalog) Recieve notification on the inclusion of a configuration catalog.
void	configDataset(InvDataset dataset) Recieve notification that configuration has found a dataset.
void	configEnd() Recieve notification that configuration has completed.
void	configStart() Recieve notification that configuration has started.

Method Detail

configStart

void configStart()

Recieve notification that configuration has started.

configEnd

void configEnd()

Recieve notification that configuration has completed.

configCatalog

void configCatalog(InvCatalog catalog)

Recieve notification on the inclusion of a configuration catalog.

Parameters:

catalog - the catalog being included in configuration.

configDataset

void configDataset(InvDataset dataset)

Recieve notification that configuration has found a dataset.

Parameters:

dataset - the dataset found during configuration.