Package thredds.server.metadata.controller

Class AbstractMetadataController

java.lang.Object

thredds.server.metadata.controller.AbstractMetadataController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware, IMetadataContoller

Direct Known Subclasses:

IsoController, NcmlController, UddcController

public abstract class AbstractMetadataController
extends Object
implements org.springframework.web.context.ServletContextAware, IMetadataContoller

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_allow
protected static org.slf4j.Logger	_logServerStartup
protected String	_metadataServiceType
protected String	_servletPath
protected jakarta.servlet.ServletContext	sc

Constructor Summary

Constructors

Constructor	Description
AbstractMetadataController()

Method Summary

Modifier and Type	Method	Description
protected String	getInfoPath(jakarta.servlet.http.HttpServletRequest req)
protected abstract String	getPath()
protected thredds.client.catalog.Dataset	getThreddsDataset(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)	Get the THREDDS dataset object where catalogString and dataset are passed in the request string
void	handleMetadataRequest(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)	All metadata controllers must implement a handleMetadataRequest method.
protected void	isAllowed(boolean allow, String metadataServiceType, jakarta.servlet.http.HttpServletResponse res)
protected void	returnError(String message, String metadataServiceType, jakarta.servlet.http.HttpServletResponse res)
void	setServletContext(jakarta.servlet.ServletContext sc)

Methods inherited from class java.lang.Object

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

Field Details

_logServerStartup

protected static org.slf4j.Logger _logServerStartup

_allow

protected boolean _allow

_metadataServiceType

protected String _metadataServiceType

_servletPath

protected String _servletPath

sc

protected jakarta.servlet.ServletContext sc

Constructor Details

AbstractMetadataController

public AbstractMetadataController()

Method Details

setServletContext

public void setServletContext(jakarta.servlet.ServletContext sc)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

isAllowed

protected void isAllowed(boolean allow,
 String metadataServiceType,
 jakarta.servlet.http.HttpServletResponse res)
                  throws Exception

Throws:

Exception

returnError

protected void returnError(String message,
 String metadataServiceType,
 jakarta.servlet.http.HttpServletResponse res)
                    throws Exception

Throws:

Exception

handleMetadataRequest

public void handleMetadataRequest(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse res)
                           throws jakarta.servlet.ServletException,
IOException

All metadata controllers must implement a handleMetadataRequest method.

Specified by:

handleMetadataRequest in interface IMetadataContoller

Parameters:

req - incoming url request

res - outgoing web based response

Throws:

jakarta.servlet.ServletException - if ServletException occurred

IOException - if IOException occurred

getThreddsDataset

protected thredds.client.catalog.Dataset getThreddsDataset(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse res)

Get the THREDDS dataset object where catalogString and dataset are passed in the request string

Parameters:

req - incoming url request

getPath

protected abstract String getPath()

getInfoPath

protected String getInfoPath(jakarta.servlet.http.HttpServletRequest req)