thredds.server.catalogservice

Class RemoteCatalogServiceController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

thredds.server.catalogservice.RemoteCatalogServiceController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class RemoteCatalogServiceController
extends org.springframework.web.servlet.mvc.AbstractController

Handle all requests for catalog services on remote catalogs. Supported services are:

1. catalog validation,
2. catalog subsetting, and
3. HTML views of catalogs (full or subset) and datasets.
Currently, handles the following TDS requests:
• Mapping="/remoteCatalogService"

NOTE: Only supported if CatalogServices/allowRemote is set to "true" in threddsConfig.xml.

Uses the following information from an HTTP request:

• The "catalog" parameter gives the URI of a remote catalog.
• The "command" parameter must either be empty or have one of the following values: "SHOW", "SUBSET", or "VALIDATE", see Command.
• The "dataset" parameter identifies a dataset contained by the local catalog. [Used only in "SUBSET" requests.]
• The "htmlView" parameter indicates if an HTML or XML view is desired. [Used only in "SUBSET" requests.]
• The "verbose" parameter indicates if the output of a "VALIDATE" request should be verbose ("true") or not ("false" or not given).

Constraints on the above information:

• The catalog URI must be absolute and is expected to reference a THREDDS catalog XML document.
• The "dataset" parameter must either be empty or contain the value of a dataset ID contained in the catalog.
• If the "command" parameter is empty, it will default to "SHOW" if the "dataset" parameter is empty, otherwise it will default to "SUBSET".

The above information is contained in a RemoteCatalogRequest command object, default values are set during binding by RemoteCatalogRequestDataBinder, and constraints are enforced by RemoteCatalogRequestValidator.

Since:

4.0

Author:

edavis

See Also:

TdsPathUtils.extractPath(javax.servlet.http.HttpServletRequest), Command, RemoteCatalogRequest, RemoteCatalogRequestDataBinder, RemoteCatalogRequestValidator

Field Summary

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
RemoteCatalogServiceController()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setHtmlWriter(HtmlWriter htmlWriter)
void	setTdsContext(TdsContext tdsContext)

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCatalogServiceController

public RemoteCatalogServiceController()

Method Detail

setTdsContext

public void setTdsContext(TdsContext tdsContext)

setHtmlWriter

public void setHtmlWriter(HtmlWriter htmlWriter)

handleRequestInternal

protected org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

Specified by:

handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController

Throws:

Exception