thredds.core

Class DataRootHandler

java.lang.Object

thredds.core.DataRootHandler

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public final class DataRootHandler
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean

The DataRootHandler manages all the "data roots" for a given web application and provides mappings from URLs to catalog and datasets

The "data roots" are read in from one or more trees of config catalogs and are defined by the datasetScan and datasetRoot elements in the config catalogs.

Uses the singleton design pattern.

Since:

1/23/2015

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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.
static class	DataRootHandler.DataRootMatch

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
java.lang.String	findDataRootLocation(java.lang.String path) Find the location match for a dataRoot.
DataRootHandler.DataRootMatch	findDataRootMatch(javax.servlet.http.HttpServletRequest req) Extract the DataRoot from the request.
DataRootHandler.DataRootMatch	findDataRootMatch(java.lang.String spath)
thredds.client.catalog.Catalog	getCatalog(java.lang.String path, java.net.URI baseURI) If a catalog exists and is allowed (not filtered out) for the given path, return the catalog as an Catalog.
thredds.inventory.MFile	getFileFromRequestPath(java.lang.String path) Return the the MFile to which the given path maps.
static DataRootHandler	getInstance() Get the singleton.
PathMatcher	getPathMatcher()
boolean	hasDataRootMatch(java.lang.String path) Return true if the given path matches a dataRoot, otherwise return false.
void	makeDebugActions()
boolean	registerConfigListener(DataRootHandler.ConfigListener cl)
void	reinit() Reinitialize lists of static catalogs, data roots, dataset Ids.
void	setDataRootLocationAliasExpanders(java.util.Map<java.lang.String,java.lang.String> aliases)
static void	setInstance(DataRootHandler drh) Initialize the DataRootHandler singleton instance.
void	showRoots(java.util.Formatter f)
boolean	unregisterConfigListener(DataRootHandler.ConfigListener cl)

Methods inherited from class java.lang.Object

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

Field Detail

debug

public static final boolean debug

See Also:

Constant Field Values

Method Detail

setInstance

public static void setInstance(DataRootHandler drh)

Initialize the DataRootHandler singleton instance.

This method should only be called once. Additional calls will be ignored.

Parameters:

drh - the singleton instance of DataRootHandler being used

getInstance

public static DataRootHandler getInstance()

Get the singleton.

The setInstance() method must be called before this method is called.

Returns:

the singleton instance.

Throws:

java.lang.IllegalStateException - if setInstance() has not been called.

setDataRootLocationAliasExpanders

public void setDataRootLocationAliasExpanders(java.util.Map<java.lang.String,java.lang.String> aliases)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

registerConfigListener

public boolean registerConfigListener(DataRootHandler.ConfigListener cl)

unregisterConfigListener

public boolean unregisterConfigListener(DataRootHandler.ConfigListener cl)

reinit

public void reinit()

Reinitialize lists of static catalogs, data roots, dataset Ids.

findDataRootLocation

public java.lang.String findDataRootLocation(java.lang.String path)

Find the location match for a dataRoot. Aliasing has been done.

Parameters:

path - the dataRoot path name

Returns:

best DataRoot location or null if no match.

findDataRootMatch

public DataRootHandler.DataRootMatch findDataRootMatch(javax.servlet.http.HttpServletRequest req)

Extract the DataRoot from the request. Use this when you need to manipulate the path based on the part that matches a DataRoot.

Parameters:

req - the request

Returns:

the DataRootMatch, or null if not found

findDataRootMatch

public DataRootHandler.DataRootMatch findDataRootMatch(java.lang.String spath)

hasDataRootMatch

public boolean hasDataRootMatch(java.lang.String path)

Return true if the given path matches a dataRoot, otherwise return false. A succesful match means that the request is either for a dynamic catalog or a dataset.

Parameters:

path - the request path, ie req.getServletPath() + req.getPathInfo()

Returns:

true if the given path matches a dataRoot, otherwise false.

getFileFromRequestPath

public thredds.inventory.MFile getFileFromRequestPath(java.lang.String path)

Return the the MFile to which the given path maps. Null is returned if the dataset does not exist, the matching DatasetScan or DataRoot filters out the requested MFile, the MFile does not represent a File (i.e., it is not a CrawlableDatasetFile), or an I/O error occurs

Parameters:

path - the request path.

Returns:

the requested java.io.File or null.

Throws:

java.lang.IllegalStateException - if the request is not for a descendant of (or the same as) the matching DatasetRoot collection location.

getCatalog

public thredds.client.catalog.Catalog getCatalog(java.lang.String path,
                                                 java.net.URI baseURI)
                                          throws java.io.IOException

If a catalog exists and is allowed (not filtered out) for the given path, return the catalog as an Catalog. Otherwise, return null.

The validity of the returned catalog is not guaranteed. Use Catalog.check() to check that the catalog is valid.

Parameters:

path - the path for the requested catalog.

baseURI - the base URI for the catalog, used to resolve relative URLs.

Returns:

the requested Catalog, or null if catalog does not exist or is not allowed.

Throws:

java.io.IOException

getPathMatcher

public PathMatcher getPathMatcher()

showRoots

public void showRoots(java.util.Formatter f)

makeDebugActions

public void makeDebugActions()