thredds.server.catalogservice

Class LocalCatalogServiceController

java.lang.Object

thredds.server.catalogservice.LocalCatalogServiceController

@Component
@RequestMapping(value="**")
public class LocalCatalogServiceController
extends Object

Handle all requests for local catalog access and services. Supported services are subsetting of catalogs and HTML views of catalogs (full or subset) and datasets.

Can also handle non-catalog requests for XML andHTML files in publicDoc FileSource.

Currently, handles the following TDS requests:

• Mapping="/catalog/*" -- e.g., ServletPath="/catalog" and PathInfo="/some/path/*.html"
• Mapping="*.xml" -- ServletPath="/some/path/*.xml" and PathInfo=null
• Mapping="*.html" -- ServletPath="/some/path/*.html" and PathInfo=null

Note: When "/catalog/*" request paths end in "/", a suffix is appended to the path. The suffix default value is "catalog.html" but can be set in LocalCatalogRequestDataBinder.

Uses the following information from an HTTP request:

• The "local catalog path" identifies the local catalog to use. Its value is either getPathInfo() or getServletPath() depending on how the requests are mapped to the servlet, see TdsPathUtils.extractPath().
• The "local catalog path" extension (which must be either ".xml" or ".html") determines whether the catalog is displayed with an XML or an HTML view. [Note: the ".html" ending is replaced with ".xml" when the path is used to locate the local catalog.]
• The "command" parameter must either be empty or have a value of "SHOW" or "SUBSET", see Command;
• The parameter "dataset" identifies a dataset contained by the local catalog.

Constraints on the above information:

• The "local catalog path" may end in either ".xml" or ".html" and must reference an existing local catalog. A ".html" ending is replaced with ".xml" when the path is used to locate the local catalog.
• 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 LocalCatalogRequest command object, default values are set during binding by LocalCatalogRequestDataBinder), and constraints are enforced by LocalCatalogRequestValidator.

Since:

4.0

Author:

edavis

See Also:

thredds.util.TdsPathUtils#extractPath(javax.servlet.http.HttpServletRequest), LocalCatalogRequest, LocalCatalogRequestDataBinder, LocalCatalogRequestValidator

Constructor Summary

Constructors

Constructor and Description
LocalCatalogServiceController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<String>	handle(FileNotFoundException ncsse)
protected org.springframework.web.servlet.ModelAndView	handleHtmlRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected org.springframework.web.servlet.ModelAndView	handleXmlRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	isCatalogSupportOnly()
void	setCatalogSupportOnly(boolean catalogSupportOnly)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalCatalogServiceController

public LocalCatalogServiceController()

Method Detail

isCatalogSupportOnly

public boolean isCatalogSupportOnly()

setCatalogSupportOnly

public void setCatalogSupportOnly(boolean catalogSupportOnly)

handleXmlRequest

@RequestMapping(value="**/*.xml",
                method=GET)
protected org.springframework.web.servlet.ModelAndView handleXmlRequest(javax.servlet.http.HttpServletRequest request,
                                                                           javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

Throws:

Exception

handleHtmlRequest

@RequestMapping(value="**/*.html",
                method=GET)
protected org.springframework.web.servlet.ModelAndView handleHtmlRequest(javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)
                                                                  throws Exception

Throws:

Exception

handle

@ExceptionHandler(value=java.io.FileNotFoundException.class)
public org.springframework.http.ResponseEntity<String> handle(FileNotFoundException ncsse)