thredds.servlet

Interface DataServiceProvider

public interface DataServiceProvider

Implement this interface to recognize and handle dataset requests.

Since:

Mar 24, 2006 10:57:44 AM

Author:

edavis

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DataServiceProvider.DatasetRequest Contain information on the dataset request.

Method Summary

Methods

Modifier and Type	Method and Description
DataServiceProvider.DatasetRequest	getRecognizedDatasetRequest(String path, javax.servlet.http.HttpServletRequest req) If this DataServiceProvider recognizes the request as a dataset request, return the dataset path as a DatasetRequest object.
void	handleRequestForDataset(DataServiceProvider.DatasetRequest dsReq, CrawlableDataset crDs, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle a dataset request.
void	handleUnrecognizedRequest(CrawlableDataset crDs, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle requests that are not recognized by this DataServiceProvider and where the CrawlableDataset is not a collection.
void	handleUnrecognizedRequestForCollection(CrawlableDataset crDs, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle requests that are not recognized by this DataServiceProvider and where the CrawlableDataset is a collection.

Method Detail

getRecognizedDatasetRequest

DataServiceProvider.DatasetRequest getRecognizedDatasetRequest(String path,
                                                             javax.servlet.http.HttpServletRequest req)

If this DataServiceProvider recognizes the request as a dataset request, return the dataset path as a DatasetRequest object. Otherwise, return null. The DatasetRequest object can contain information specific to this type of DataServiceProvider beyond just the dataset path.

Parameters:

path - the request path.

req - the request.

Returns:

the dataset path as a DatasetRequest object.

handleRequestForDataset

void handleRequestForDataset(DataServiceProvider.DatasetRequest dsReq,
                           CrawlableDataset crDs,
                           javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse res)
                             throws IOException

Handle a dataset request. Should only be called if getRecognizedDatasetRequest() returns a non-null DatasetRequest. Implementations should check that the request is for an allowed dataset by using CatalogRootHandler.findRequestedDatasets(). If it is not an allowed dataset, should respond with an HTTP 404 (Not Found) response.

Parameters:

dsReq - the dataset request info, should be the output of getRecognizedDatasetRequest().

crDs - the CrawlableDataset to be served (corresponds to the DatasetRequest path).

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if can't complete request due to IO problems.

IllegalArgumentException - if the DatasetRequest is null or the CrawlableDataset is null.

handleUnrecognizedRequest

void handleUnrecognizedRequest(CrawlableDataset crDs,
                             javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
                               throws IOException

Handle requests that are not recognized by this DataServiceProvider and where the CrawlableDataset is not a collection.

Parameters:

crDs - the CrawlableDataset that corresponds to the request path.

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if the request can't be completed due to IO problems.

handleUnrecognizedRequestForCollection

void handleUnrecognizedRequestForCollection(CrawlableDataset crDs,
                                          javax.servlet.http.HttpServletRequest req,
                                          javax.servlet.http.HttpServletResponse res)
                                            throws IOException

Handle requests that are not recognized by this DataServiceProvider and where the CrawlableDataset is a collection. Note: This method is to allow some flexibility in how unrecognized requests are handled. Can be handled in the same way as handleUnrecognizedRequest() if desired.

Parameters:

crDs - the CrawlableDataset that corresponds to the request path.

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if the request can't be completed due to IO problems.